blob: 7c6841015a507d100334d5c15c69f75389ecb6fe [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
Valerio Setti080a22b2023-03-20 15:22:47 +0100775#if defined(PSA_WANT_ALG_ECDH)
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}
Valerio Setti080a22b2023-03-20 15:22:47 +0100831#endif /* PSA_WANT_ALG_ECDH */
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
Valerio Setti080a22b2023-03-20 15:22:47 +0100835#if defined(PSA_WANT_ALG_ECDH)
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}
Valerio Setti080a22b2023-03-20 15:22:47 +0100936#endif /* PSA_WANT_ALG_ECDH */
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;
Ronald Crond540d992023-03-07 09:41:48 +01001244 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001245 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001246 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001247 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001248 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001249 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001250 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001251 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001252 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001253
Ronald Cron41a443a2022-10-04 16:38:25 +02001254#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001255 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001256 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001257 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001258#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001259
XiaokangQian7807f9f2022-02-15 10:04:37 +00001260 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001261 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001262 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001263 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001264 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001265 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001266 * .. . .. ciphersuite list length ( 2 bytes )
1267 * .. . .. ciphersuite list
1268 * .. . .. compression alg. list length ( 1 byte )
1269 * .. . .. compression alg. list
1270 * .. . .. extensions length ( 2 bytes, optional )
1271 * .. . .. extensions ( optional )
1272 */
1273
XiaokangQianb67384d2022-04-19 00:02:38 +00001274 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001275 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1277 * read at least up to session id length without worrying.
1278 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001279 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001280
1281 /* ...
1282 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1283 * ...
1284 * with ProtocolVersion defined as:
1285 * uint16 ProtocolVersion;
1286 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001287 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1288 MBEDTLS_SSL_VERSION_TLS1_2) {
1289 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1290 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1291 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1292 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001293 }
1294 p += 2;
1295
Jerry Yuc1be19f2022-04-23 16:11:39 +08001296 /* ...
1297 * Random random;
1298 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001299 * with Random defined as:
1300 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001301 */
Ronald Crond540d992023-03-07 09:41:48 +01001302 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001303 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001304
Jerry Yuc1be19f2022-04-23 16:11:39 +08001305 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001306 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001307 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308 */
Ronald Croncada4102023-03-07 09:51:39 +01001309 legacy_session_id_len = *(p++);
1310 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001311
XiaokangQianb67384d2022-04-19 00:02:38 +00001312 /*
1313 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001314 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001317 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320 p += 2;
1321
Ronald Cronfc7ae872023-02-16 15:32:19 +01001322 /*
1323 * The length of the ciphersuite list has to be even.
1324 */
1325 if (cipher_suites_len & 1) {
1326 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1327 MBEDTLS_ERR_SSL_DECODE_ERROR);
1328 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1329 }
1330
XiaokangQianb67384d2022-04-19 00:02:38 +00001331 /* Check we have enough data for the ciphersuite list, the legacy
1332 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001333 *
1334 * cipher_suites cipher_suites_len bytes
1335 * legacy_compression_methods 2 bytes
1336 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001337 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001338 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001339
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 /* ...
1341 * CipherSuite cipher_suites<2..2^16-2>;
1342 * ...
1343 * with CipherSuite defined as:
1344 * uint8 CipherSuite[2];
1345 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001346#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001347 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001348#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001349 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1351 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001352
1353 /*
Ronald Cron64582392023-03-07 09:21:40 +01001354 * Only support TLS 1.3 currently, temporarily set the version.
1355 */
1356 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1357
1358#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1359 /* Store minor version for later use with ticket serialization. */
1360 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1361 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1362#endif
1363
1364 /*
Ronald Crond540d992023-03-07 09:41:48 +01001365 * We are negotiation the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001366 * postponed: copy of the client random bytes, copy of the legacy session
1367 * identifier.
Ronald Crond540d992023-03-07 09:41:48 +01001368 */
1369 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1370 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1371 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1372
Ronald Croncada4102023-03-07 09:51:39 +01001373 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1374 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1375 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1376 }
1377 ssl->session_negotiate->id_len = legacy_session_id_len;
1378 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1379 legacy_session_id, legacy_session_id_len);
1380 memcpy(&ssl->session_negotiate->id[0],
1381 legacy_session_id, legacy_session_id_len);
1382
Ronald Crond540d992023-03-07 09:41:48 +01001383 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001384 * Search for a matching ciphersuite
1385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001387 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001389
Ronald Crond89360b2023-02-21 08:53:33 +01001390 /*
1391 * "cipher_suite_end - p is even" is an invariant of the loop. As
1392 * cipher_suites_end - p > 0, we have cipher_suites_end - p >= 2 and
1393 * it is thus safe to read two bytes.
1394 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001396 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 ssl, cipher_suite);
1398 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001399 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001401
Jerry Yu5725f1c2022-08-21 17:27:16 +08001402 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001403 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1405 cipher_suite,
1406 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001407 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001408 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001409
Gilles Peskine449bd832023-01-11 14:50:10 +01001410 if (handshake->ciphersuite_info == NULL) {
1411 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1412 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1413 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001414 }
Ronald Cron25e9ec62023-02-16 15:35:16 +01001415 p = cipher_suites_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001416
XiaokangQian4080a7f2022-04-11 09:55:18 +00001417 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001418 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001419 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001420 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1422 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1423 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1424 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1425 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001426 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001427 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001428
Jerry Yuc1be19f2022-04-23 16:11:39 +08001429 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001430 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001431 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001432 * with Extension defined as:
1433 * struct {
1434 * ExtensionType extension_type;
1435 * opaque extension_data<0..2^16-1>;
1436 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001437 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001439 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001441 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001442
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001444
Jerry Yu63a459c2022-10-31 13:38:40 +08001445 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001446
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001448 unsigned int extension_type;
1449 size_t extension_data_len;
1450 const unsigned char *extension_data_end;
1451
Jerry Yu0c354a22022-08-29 15:25:36 +08001452 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001453 *
1454 * The "pre_shared_key" extension MUST be the last extension in the
1455 * ClientHello (this facilitates implementation as described below).
1456 * Servers MUST check that it is the last extension and otherwise fail
1457 * the handshake with an "illegal_parameter" alert.
1458 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001460 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001461 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001462 MBEDTLS_SSL_PEND_FATAL_ALERT(
1463 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1465 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001466 }
1467
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1469 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1470 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001471 p += 4;
1472
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474 extension_data_end = p + extension_data_len;
1475
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001476 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1478 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1479 if (ret != 0) {
1480 return ret;
1481 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001482
Gilles Peskine449bd832023-01-11 14:50:10 +01001483 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001484#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1485 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1487 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1488 extension_data_end);
1489 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001490 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001491 1, "mbedtls_ssl_parse_servername_ext", ret);
1492 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001493 }
XiaokangQian40a35232022-05-07 09:02:40 +00001494 break;
1495#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1496
Valerio Setti080a22b2023-03-20 15:22:47 +01001497#if defined(PSA_WANT_ALG_ECDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001498 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001499 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500
1501 /* Supported Groups Extension
1502 *
1503 * When sent by the client, the "supported_groups" extension
1504 * indicates the named groups which the client supports,
1505 * ordered from most preferred to least preferred.
1506 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001507 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 ssl, p, extension_data_end);
1509 if (ret != 0) {
1510 MBEDTLS_SSL_DEBUG_RET(1,
1511 "mbedtls_ssl_parse_supported_groups_ext", ret);
1512 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513 }
1514
XiaokangQian7807f9f2022-02-15 10:04:37 +00001515 break;
Valerio Setti080a22b2023-03-20 15:22:47 +01001516#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001517
Valerio Setti080a22b2023-03-20 15:22:47 +01001518#if defined(PSA_WANT_ALG_ECDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001519 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001521
1522 /*
1523 * Key Share Extension
1524 *
1525 * When sent by the client, the "key_share" extension
1526 * contains the endpoint's cryptographic parameters for
1527 * ECDHE/DHE key establishment methods.
1528 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001529 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 ssl, p, extension_data_end);
1531 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1532 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001533 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001534 }
1535
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001537 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 1, "ssl_tls13_parse_key_shares_ext", ret);
1539 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001540 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001541
XiaokangQian7807f9f2022-02-15 10:04:37 +00001542 break;
Valerio Setti080a22b2023-03-20 15:22:47 +01001543#endif /* PSA_WANT_ALG_ECDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001544
1545 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001547
1548 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001549 ssl, p, extension_data_end);
1550 if (ret != 0) {
1551 MBEDTLS_SSL_DEBUG_RET(1,
1552 ("ssl_tls13_parse_supported_versions_ext"), ret);
1553 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001554 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001555 break;
1556
Ronald Cron41a443a2022-10-04 16:38:25 +02001557#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001558 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001560
1561 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001562 ssl, p, extension_data_end);
1563 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001564 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1566 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001567 }
1568
Jerry Yue19e3b92022-07-08 12:04:51 +00001569 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001570#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001571
Jerry Yu1c105562022-07-10 06:32:38 +00001572 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1574 if ((handshake->received_extensions &
1575 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001576 MBEDTLS_SSL_PEND_FATAL_ALERT(
1577 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1579 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001580 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001581#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001582 /* Delay processing of the PSK identity once we have
1583 * found out which algorithms to use. We keep a pointer
1584 * to the buffer and the size for later processing.
1585 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001586 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001587 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001588#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001589 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001590
XiaokangQianacb39922022-06-17 10:18:48 +00001591#if defined(MBEDTLS_SSL_ALPN)
1592 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001594
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1596 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001597 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001598 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1599 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001600 }
XiaokangQianacb39922022-06-17 10:18:48 +00001601 break;
1602#endif /* MBEDTLS_SSL_ALPN */
1603
Ronald Cron928cbd32022-10-04 16:14:26 +02001604#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001605 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001607
Gabor Mezei078e8032022-04-27 21:17:56 +02001608 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 ssl, p, extension_data_end);
1610 if (ret != 0) {
1611 MBEDTLS_SSL_DEBUG_MSG(1,
1612 (
1613 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1614 ret));
1615 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001616 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001617 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001618#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001619
Jan Bruckner151f6422023-02-10 12:45:19 +01001620#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1621 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1622 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1623
1624 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(ssl, p, extension_data_end);
1625
Jan Bruckner1a38e542023-03-15 14:15:11 +01001626 /* TODO: Return unconditionally here until we handle the record size limit correctly.
1627 * Once handled correctly, only return in case of errors. */
Jan Bruckner151f6422023-02-10 12:45:19 +01001628 return ret;
1629
1630 break;
1631#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1632
XiaokangQian7807f9f2022-02-15 10:04:37 +00001633 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001634 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001635 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001637 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001638 }
1639
1640 p += extension_data_len;
1641 }
1642
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1644 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001645
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001646 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1647 MBEDTLS_SSL_HS_CLIENT_HELLO,
1648 p - buf);
1649 if (0 != ret) {
1650 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1651 return ret;
1652 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001653
Ronald Cron41a443a2022-10-04 16:38:25 +02001654#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001655 /* Update checksum with either
1656 * - The entire content of the CH message, if no PSK extension is present
1657 * - The content up to but excluding the PSK extension, if present.
1658 */
Jerry Yu1c105562022-07-10 06:32:38 +00001659 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1661 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1662 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001663 ret = handshake->update_checksum(ssl, buf,
1664 pre_shared_key_ext - buf);
1665 if (0 != ret) {
1666 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1667 return ret;
1668 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001669 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1670 pre_shared_key_ext,
1671 pre_shared_key_ext_end,
1672 cipher_suites,
1673 cipher_suites_end);
1674 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1675 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1676 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001677 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1679 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001680 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001682#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001683 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001684 ret = handshake->update_checksum(ssl, buf, p - buf);
1685 if (0 != ret) {
1686 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1687 return ret;
1688 }
Jerry Yu1c105562022-07-10 06:32:38 +00001689 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1692 if (ret < 0) {
1693 return ret;
1694 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001697
Gilles Peskine449bd832023-01-11 14:50:10 +01001698 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001699}
1700
1701/* Update the handshake state machine */
1702
Ronald Cronce7d76e2022-07-08 18:56:49 +02001703MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001704static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001705{
1706 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1707
XiaokangQian7807f9f2022-02-15 10:04:37 +00001708 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001709 * Server certificate selection
1710 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1712 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1713 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001714 }
1715#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1716 ssl->handshake->sni_name = NULL;
1717 ssl->handshake->sni_name_len = 0;
1718#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1721 if (ret != 0) {
1722 MBEDTLS_SSL_DEBUG_RET(1,
1723 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1724 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001725 }
1726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001728
1729}
1730
1731/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001732 * Main entry point from the state machine; orchestrates the otherfunctions.
1733 */
1734
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001735MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001736static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001737{
1738
XiaokangQian08037552022-04-20 07:16:41 +00001739 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001741 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001742 int parse_client_hello_ret;
1743
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1747 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1748 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1751 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001752 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1753 * only SSL_CLIENT_HELLO_OK or
1754 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1755 * stage as negative error codes are handled
1756 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001757
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1761 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1762 } else {
1763 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1764 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001765
1766cleanup:
1767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1769 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001770}
1771
1772/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001773 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001774 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001775MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001776static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001777{
Jerry Yu637a3f12022-04-20 21:37:58 +08001778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1779 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1781 if (ssl->conf->f_rng == NULL) {
1782 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1783 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001784 }
1785
Gilles Peskine449bd832023-01-11 14:50:10 +01001786 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1787 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1788 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1789 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001790 }
1791
Gilles Peskine449bd832023-01-11 14:50:10 +01001792 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1793 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001794
1795#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001797#endif /* MBEDTLS_HAVE_TIME */
1798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001800}
1801
Jerry Yu3bf2c642022-03-30 22:02:12 +08001802/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001803 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001804 *
1805 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001806 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001807 * } SupportedVersions;
1808 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001809MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001810static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 mbedtls_ssl_context *ssl,
1812 unsigned char *buf,
1813 unsigned char *end,
1814 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001815{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001816 *out_len = 0;
1817
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001819
1820 /* Check if we have space to write the extension:
1821 * - extension_type (2 bytes)
1822 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001823 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001824 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001826
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001828
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001830
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 mbedtls_ssl_write_version(buf + 4,
1832 ssl->conf->transport,
1833 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001834
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1836 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001837
Jerry Yu349a6132022-04-14 20:52:56 +08001838 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839
Jerry Yub95dd362022-11-08 21:19:34 +08001840 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001842
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001844}
1845
Jerry Yud9436a12022-04-20 22:28:09 +08001846
Jerry Yu3bf2c642022-03-30 22:02:12 +08001847
1848/* Generate and export a single key share. For hybrid KEMs, this can
1849 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001850MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001851static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1852 uint16_t named_group,
1853 unsigned char *buf,
1854 unsigned char *end,
1855 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001856{
1857 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001858
1859 *out_len = 0;
1860
Valerio Setti080a22b2023-03-20 15:22:47 +01001861#if defined(PSA_WANT_ALG_ECDH)
Gilles Peskine449bd832023-01-11 14:50:10 +01001862 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001863 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 ssl, named_group, buf, end, out_len);
1865 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001866 MBEDTLS_SSL_DEBUG_RET(
1867 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 ret);
1869 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 } else
Valerio Setti080a22b2023-03-20 15:22:47 +01001872#endif /* PSA_WANT_ALG_ECDH */
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if (0 /* Other kinds of KEMs */) {
1874 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001875 ((void) ssl);
1876 ((void) named_group);
1877 ((void) buf);
1878 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001879 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1880 }
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883}
1884
1885/*
1886 * ssl_tls13_write_key_share_ext
1887 *
1888 * Structure of key_share extension in ServerHello:
1889 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001890 * struct {
1891 * NamedGroup group;
1892 * opaque key_exchange<1..2^16-1>;
1893 * } KeyShareEntry;
1894 * struct {
1895 * KeyShareEntry server_share;
1896 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001897 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001898MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001899static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1900 unsigned char *buf,
1901 unsigned char *end,
1902 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001903{
Jerry Yu955ddd72022-04-22 22:27:33 +08001904 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001905 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001906 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001907 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001908 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001909
1910 *out_len = 0;
1911
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1915 mbedtls_ssl_named_group_to_str(group),
1916 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001917
Jerry Yu3bf2c642022-03-30 22:02:12 +08001918 /* Check if we have space for header and length fields:
1919 * - extension_type (2 bytes)
1920 * - extension_data_length (2 bytes)
1921 * - group (2 bytes)
1922 * - key_exchange_length (2 bytes)
1923 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1925 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1926 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001927 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001928
Jerry Yu3bf2c642022-03-30 22:02:12 +08001929 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1930 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001931 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 ssl, group, server_share + 4, end, &key_exchange_length);
1933 if (ret != 0) {
1934 return ret;
1935 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001936 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001939
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001941
Jerry Yu57d48412022-04-20 21:50:42 +08001942 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001943
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001947}
Jerry Yud9436a12022-04-20 22:28:09 +08001948
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001949MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001950static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1951 unsigned char *buf,
1952 unsigned char *end,
1953 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001954{
1955 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1956 /* key_share Extension
1957 *
1958 * struct {
1959 * select (Handshake.msg_type) {
1960 * ...
1961 * case hello_retry_request:
1962 * NamedGroup selected_group;
1963 * ...
1964 * };
1965 * } KeyShare;
1966 */
1967
1968 *out_len = 0;
1969
Jerry Yub0ac10b2022-05-05 11:10:08 +08001970 /*
1971 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1972 * of the HRR is then to transmit a cookie to force the client to demonstrate
1973 * reachability at their apparent network address (primarily useful for DTLS).
1974 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001975 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1976 return 0;
1977 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001978
1979 /* We should only send the key_share extension if the client's initial
1980 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 if (ssl->handshake->offered_group_id != 0) {
1982 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1983 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001984 }
1985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 if (selected_group == 0) {
1987 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1988 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001989 }
1990
Jerry Yub0ac10b2022-05-05 11:10:08 +08001991 /* Check if we have enough space:
1992 * - extension_type (2 bytes)
1993 * - extension_data_length (2 bytes)
1994 * - selected_group (2 bytes)
1995 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001997
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1999 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2000 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 MBEDTLS_SSL_DEBUG_MSG(3,
2003 ("HRR selected_group: %s (%x)",
2004 mbedtls_ssl_named_group_to_str(selected_group),
2005 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002006
2007 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002008
Gilles Peskine449bd832023-01-11 14:50:10 +01002009 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002010
Gilles Peskine449bd832023-01-11 14:50:10 +01002011 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002012}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002013
2014/*
2015 * Structure of ServerHello message:
2016 *
2017 * struct {
2018 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2019 * Random random;
2020 * opaque legacy_session_id_echo<0..32>;
2021 * CipherSuite cipher_suite;
2022 * uint8 legacy_compression_method = 0;
2023 * Extension extensions<6..2^16-1>;
2024 * } ServerHello;
2025 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002026MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002027static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2028 unsigned char *buf,
2029 unsigned char *end,
2030 size_t *out_len,
2031 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002032{
Jerry Yu955ddd72022-04-22 22:27:33 +08002033 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002034 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002035 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002036 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002037
2038 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002039 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002040
Jerry Yucfc04b32022-04-21 09:31:58 +08002041 /* ...
2042 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2043 * ...
2044 * with ProtocolVersion defined as:
2045 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002046 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2048 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 p += 2;
2050
Jerry Yu1c3e6882022-04-20 21:23:40 +08002051 /* ...
2052 * Random random;
2053 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002054 * with Random defined as:
2055 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002056 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002057 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2058 if (is_hrr) {
2059 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2060 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2061 } else {
2062 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2063 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002064 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2066 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2068
Jerry Yucfc04b32022-04-21 09:31:58 +08002069 /* ...
2070 * opaque legacy_session_id_echo<0..32>;
2071 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002072 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2074 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2075 if (ssl->session_negotiate->id_len > 0) {
2076 memcpy(p, &ssl->session_negotiate->id[0],
2077 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002078 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2081 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002082 }
2083
Jerry Yucfc04b32022-04-21 09:31:58 +08002084 /* ...
2085 * CipherSuite cipher_suite;
2086 * ...
2087 * with CipherSuite defined as:
2088 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002089 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2091 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 MBEDTLS_SSL_DEBUG_MSG(3,
2094 ("server hello, chosen ciphersuite: %s ( id=%d )",
2095 mbedtls_ssl_get_ciphersuite_name(
2096 ssl->session_negotiate->ciphersuite),
2097 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002098
Jerry Yucfc04b32022-04-21 09:31:58 +08002099 /* ...
2100 * uint8 legacy_compression_method = 0;
2101 * ...
2102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002104 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002105
Jerry Yucfc04b32022-04-21 09:31:58 +08002106 /* ...
2107 * Extension extensions<6..2^16-1>;
2108 * ...
2109 * struct {
2110 * ExtensionType extension_type; (2 bytes)
2111 * opaque extension_data<0..2^16-1>;
2112 * } Extension;
2113 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002115 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002116 p += 2;
2117
Gilles Peskine449bd832023-01-11 14:50:10 +01002118 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2119 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002120 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2122 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002123 }
2124 p += output_len;
2125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2127 if (is_hrr) {
2128 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2129 } else {
2130 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2131 }
2132 if (ret != 0) {
2133 return ret;
2134 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002135 p += output_len;
2136 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002137
Ronald Cron41a443a2022-10-04 16:38:25 +02002138#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2140 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2141 if (ret != 0) {
2142 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2143 ret);
2144 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002145 }
2146 p += output_len;
2147 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002148#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002149
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002151
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2153 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002154
Jerry Yud9436a12022-04-20 22:28:09 +08002155 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002158
Jerry Yu7de2ff02022-11-08 21:43:46 +08002159 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002160 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_HS_SERVER_HELLO,
2162 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002165}
2166
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002167MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002168static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002169{
2170 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002171 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2172 if (ret != 0) {
2173 MBEDTLS_SSL_DEBUG_RET(1,
2174 "mbedtls_ssl_tls13_compute_handshake_transform",
2175 ret);
2176 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002177 }
2178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002180}
2181
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002182MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002183static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002184{
Jerry Yu637a3f12022-04-20 21:37:58 +08002185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002186 unsigned char *buf;
2187 size_t buf_len, msg_len;
2188
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002190
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2194 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2195 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2198 buf + buf_len,
2199 &msg_len,
2200 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002201
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002202 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002203 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2206 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002207
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002208 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002209
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002210#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2211 /* The server sends a dummy change_cipher_spec record immediately
2212 * after its first handshake message. This may either be after
2213 * a ServerHello or a HelloRetryRequest.
2214 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002215 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002216 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002217#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002218 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002219#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002220
Jerry Yuf4b27e42022-03-30 17:32:21 +08002221cleanup:
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2224 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002225}
2226
Jerry Yu23d1a252022-05-12 18:08:59 +08002227
2228/*
2229 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2230 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002231MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002232static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002233{
2234 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 if (ssl->handshake->hello_retry_request_count > 0) {
2236 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2237 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2238 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2239 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002240 }
2241
2242 /*
2243 * Create stateless transcript hash for HRR
2244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2246 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2247 if (ret != 0) {
2248 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2249 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002250 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002251 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002252
Gilles Peskine449bd832023-01-11 14:50:10 +01002253 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002254}
2255
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002256MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002257static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002258{
2259 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2260 unsigned char *buf;
2261 size_t buf_len, msg_len;
2262
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002264
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2268 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2269 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002270
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2272 buf + buf_len,
2273 &msg_len,
2274 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002275 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002276 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002277
2278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2280 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002281
2282 ssl->handshake->hello_retry_request_count++;
2283
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002284#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2285 /* The server sends a dummy change_cipher_spec record immediately
2286 * after its first handshake message. This may either be after
2287 * a ServerHello or a HelloRetryRequest.
2288 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002289 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002291#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002293#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002294
2295cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2297 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002298}
2299
Jerry Yu5b64ae92022-03-30 17:15:02 +08002300/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002301 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2302 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002303
2304/*
2305 * struct {
2306 * Extension extensions<0..2 ^ 16 - 1>;
2307 * } EncryptedExtensions;
2308 *
2309 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002310MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002311static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2312 unsigned char *buf,
2313 unsigned char *end,
2314 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002315{
XiaokangQianacb39922022-06-17 10:18:48 +00002316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002317 unsigned char *p = buf;
2318 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002319 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002320 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002321
Jerry Yu4d3841a2022-04-16 12:37:19 +08002322 *out_len = 0;
2323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002325 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002326 p += 2;
2327
Jerry Yu8937eb42022-05-03 12:12:14 +08002328 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002329 ((void) ret);
2330 ((void) output_len);
2331
2332#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2334 if (ret != 0) {
2335 return ret;
2336 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002337 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002338#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 extensions_len = (p - p_extensions_len) - 2;
2341 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002342
2343 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002344
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002346
Jerry Yu7de2ff02022-11-08 21:43:46 +08002347 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002351}
2352
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002353MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002354static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002355{
2356 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2357 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002358 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 mbedtls_ssl_set_outbound_transform(ssl,
2361 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002362 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002363 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002364
Gilles Peskine449bd832023-01-11 14:50:10 +01002365 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002366
Gilles Peskine449bd832023-01-11 14:50:10 +01002367 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2368 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2369 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002370
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2372 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002373
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002374 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002375 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002376
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2378 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002379
Ronald Cron928cbd32022-10-04 16:14:26 +02002380#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2382 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2383 } else {
2384 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2385 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002386#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002388#endif
2389
Jerry Yu4d3841a2022-04-16 12:37:19 +08002390cleanup:
2391
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2393 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002394}
2395
Ronald Cron928cbd32022-10-04 16:14:26 +02002396#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002397#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2398#define SSL_CERTIFICATE_REQUEST_SKIP 1
2399/* Coordination:
2400 * Check whether a CertificateRequest message should be written.
2401 * Returns a negative code on failure, or
2402 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2403 * - SSL_CERTIFICATE_REQUEST_SKIP
2404 * indicating if the writing of the CertificateRequest
2405 * should be skipped or not.
2406 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002407MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002408static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002409{
2410 int authmode;
2411
XiaokangQian40a35232022-05-07 09:02:40 +00002412#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002414 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002416#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002417 authmode = ssl->conf->authmode;
2418
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002420 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002421 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002422 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002423
XiaokangQianc3017f62022-05-13 05:55:41 +00002424 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002427}
2428
XiaokangQiancec9ae62022-05-06 07:28:50 +00002429/*
2430 * struct {
2431 * opaque certificate_request_context<0..2^8-1>;
2432 * Extension extensions<2..2^16-1>;
2433 * } CertificateRequest;
2434 *
2435 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002436MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002437static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2438 unsigned char *buf,
2439 const unsigned char *end,
2440 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002441{
2442 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2443 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002444 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002445 unsigned char *p_extensions_len;
2446
2447 *out_len = 0;
2448
2449 /* Check if we have enough space:
2450 * - certificate_request_context (1 byte)
2451 * - extensions length (2 bytes)
2452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002454
2455 /*
2456 * Write certificate_request_context
2457 */
2458 /*
2459 * We use a zero length context for the normal handshake
2460 * messages. For post-authentication handshake messages
2461 * this request context would be set to a non-zero value.
2462 */
2463 *p++ = 0x0;
2464
2465 /*
2466 * Write extensions
2467 */
2468 /* The extensions must contain the signature_algorithms. */
2469 p_extensions_len = p;
2470 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2472 if (ret != 0) {
2473 return ret;
2474 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002475
XiaokangQianec6efb92022-05-06 09:53:10 +00002476 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002478
2479 *out_len = p - buf;
2480
Jerry Yu7de2ff02022-11-08 21:43:46 +08002481 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002485}
2486
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002487MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002488static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002489{
2490 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2491
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002497 unsigned char *buf;
2498 size_t buf_len, msg_len;
2499
Gilles Peskine449bd832023-01-11 14:50:10 +01002500 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2501 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2502 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002503
Gilles Peskine449bd832023-01-11 14:50:10 +01002504 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2505 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002506
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002507 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002508 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2511 ssl, buf_len, msg_len));
2512 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2513 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002514 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 } else {
2516 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002517 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2518 goto cleanup;
2519 }
2520
Gilles Peskine449bd832023-01-11 14:50:10 +01002521 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002522cleanup:
2523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2525 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002526}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002527
Jerry Yu4d3841a2022-04-16 12:37:19 +08002528/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002529 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002530 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002531MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002532static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002533{
Jerry Yu5a26f302022-05-10 20:46:40 +08002534 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002535
2536#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2538 mbedtls_ssl_own_cert(ssl) == NULL) {
2539 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2540 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2541 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2542 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002543 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002544#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2547 if (ret != 0) {
2548 return ret;
2549 }
2550 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2551 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002552}
2553
2554/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002555 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002556 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002557MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002558static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002559{
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2561 if (ret != 0) {
2562 return ret;
2563 }
2564 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2565 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002566}
Ronald Cron928cbd32022-10-04 16:14:26 +02002567#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002568
2569/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002570 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002571 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002572MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002573static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002574{
Jerry Yud6e253d2022-05-18 13:59:24 +08002575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2578 if (ret != 0) {
2579 return ret;
2580 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2583 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002584 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002585 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2586 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2587 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002588 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002589
Gilles Peskine449bd832023-01-11 14:50:10 +01002590 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2591 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002592
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 if (ssl->handshake->certificate_request_sent) {
2594 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2595 } else {
2596 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2597 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2598 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002599 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002600
Gilles Peskine449bd832023-01-11 14:50:10 +01002601 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002602}
2603
2604/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002605 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002606 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002607MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002608static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002609{
Jerry Yud6e253d2022-05-18 13:59:24 +08002610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2611
Gilles Peskine449bd832023-01-11 14:50:10 +01002612 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2613 if (ret != 0) {
2614 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002615 }
2616
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2618 if (ret != 0) {
2619 MBEDTLS_SSL_DEBUG_RET(1,
2620 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2621 }
2622
2623 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2624 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002625}
2626
2627/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002628 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002629 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002630MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002631static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002632{
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002636
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002637#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2638 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002639/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2640 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2641 * expected to be resolved with issue#6395.
2642 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002643 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002644 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2645 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002646 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002647#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002648 {
2649 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2650 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002652}
2653
2654/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002655 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002656 */
2657#define SSL_NEW_SESSION_TICKET_SKIP 0
2658#define SSL_NEW_SESSION_TICKET_WRITE 1
2659MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002660static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002661{
2662 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 if (ssl->conf->f_ticket_write == NULL) {
2664 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2665 " callback is not set"));
2666 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002667 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 if (ssl->conf->new_session_tickets_count == 0) {
2669 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2670 " configured count is zero"));
2671 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002672 }
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 if (ssl->handshake->new_session_tickets_count == 0) {
2675 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2676 "been sent."));
2677 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002678 }
2679
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002681}
2682
2683#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002685static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2686 unsigned char *ticket_nonce,
2687 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002688{
2689 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2690 mbedtls_ssl_session *session = ssl->session;
2691 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2692 psa_algorithm_t psa_hash_alg;
2693 int hash_length;
2694
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002696
2697#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002699#endif
2700
Pengyu Lv9f926952022-11-17 15:22:33 +08002701 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002702 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002703 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002704#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002705 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002706 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002707#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002708 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002709
Jerry Yue67bef42022-07-07 07:29:42 +00002710 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002711 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2712 (unsigned char *) &session->ticket_age_add,
2713 sizeof(session->ticket_age_add)) != 0)) {
2714 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2715 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002716 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2718 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002719
2720 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2722 if (ret != 0) {
2723 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2724 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002725 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2727 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002728
2729 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2731 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2732 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2733 if (hash_length == -1 ||
2734 (size_t) hash_length > sizeof(session->resumption_key)) {
2735 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002736 }
2737
Jerry Yue67bef42022-07-07 07:29:42 +00002738 /* In this code the psk key length equals the length of the hash */
2739 session->resumption_key_len = hash_length;
2740 session->ciphersuite = ciphersuite_info->id;
2741
2742 /* Compute resumption key
2743 *
2744 * HKDF-Expand-Label( resumption_master_secret,
2745 * "resumption", ticket_nonce, Hash.length )
2746 */
2747 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 psa_hash_alg,
2749 session->app_secrets.resumption_master_secret,
2750 hash_length,
2751 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2752 ticket_nonce,
2753 ticket_nonce_size,
2754 session->resumption_key,
2755 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002756
Gilles Peskine449bd832023-01-11 14:50:10 +01002757 if (ret != 0) {
2758 MBEDTLS_SSL_DEBUG_RET(2,
2759 "Creating the ticket-resumed PSK failed",
2760 ret);
2761 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002762 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002763 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2764 session->resumption_key,
2765 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2768 session->app_secrets.resumption_master_secret,
2769 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002770
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002772}
2773
2774/* This function creates a NewSessionTicket message in the following format:
2775 *
2776 * struct {
2777 * uint32 ticket_lifetime;
2778 * uint32 ticket_age_add;
2779 * opaque ticket_nonce<0..255>;
2780 * opaque ticket<1..2^16-1>;
2781 * Extension extensions<0..2^16-2>;
2782 * } NewSessionTicket;
2783 *
2784 * The ticket inside the NewSessionTicket message is an encrypted container
2785 * carrying the necessary information so that the server is later able to
2786 * re-start the communication.
2787 *
2788 * The following fields are placed inside the ticket by the
2789 * f_ticket_write() function:
2790 *
2791 * - creation time (start)
2792 * - flags (flags)
2793 * - age add (ticket_age_add)
2794 * - key (key)
2795 * - key length (key_len)
2796 * - ciphersuite (ciphersuite)
2797 */
2798MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002799static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2800 unsigned char *buf,
2801 unsigned char *end,
2802 size_t *out_len,
2803 unsigned char *ticket_nonce,
2804 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002805{
2806 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2807 unsigned char *p = buf;
2808 mbedtls_ssl_session *session = ssl->session;
2809 size_t ticket_len;
2810 uint32_t ticket_lifetime;
2811
2812 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002814
2815 /*
2816 * ticket_lifetime 4 bytes
2817 * ticket_age_add 4 bytes
2818 * ticket_nonce 1 + ticket_nonce_size bytes
2819 * ticket >=2 bytes
2820 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002822
2823 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2825 session,
2826 p + 9 + ticket_nonce_size + 2,
2827 end,
2828 &ticket_len,
2829 &ticket_lifetime);
2830 if (ret != 0) {
2831 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2832 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002833 }
2834 /* RFC 8446 4.6.1
2835 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2836 * unsigned integer in network byte order from the time of ticket
2837 * issuance. Servers MUST NOT use any value greater than
2838 * 604800 seconds (7 days). The value of zero indicates that the
2839 * ticket should be discarded immediately. Clients MUST NOT cache
2840 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2841 * and MAY delete tickets earlier based on local policy. A server
2842 * MAY treat a ticket as valid for a shorter period of time than what
2843 * is stated in the ticket_lifetime.
2844 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002846 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 }
2848 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2849 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2850 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002851
2852 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2854 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2855 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002856
2857 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 p[8] = (unsigned char) ticket_nonce_size;
2859 if (ticket_nonce_size > 0) {
2860 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002861 }
2862 p += 9 + ticket_nonce_size;
2863
2864 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002866 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002868 p += ticket_len;
2869
2870 /* Ticket Extensions
2871 *
2872 * Note: We currently don't have any extensions.
2873 * Set length to zero.
2874 */
Jerry Yuedab6372022-10-31 14:37:31 +08002875 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2878 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002879 p += 2;
2880
2881 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2883 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002884
Jerry Yu7de2ff02022-11-08 21:43:46 +08002885 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002887
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002889}
2890
2891/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002892 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002893 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002894static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002895{
2896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2897
Gilles Peskine449bd832023-01-11 14:50:10 +01002898 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002899
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002901 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2902 unsigned char *buf;
2903 size_t buf_len, msg_len;
2904
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2906 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2909 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2910 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2913 ssl, buf, buf + buf_len, &msg_len,
2914 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2917 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002918
Jerry Yu359e65f2022-09-22 23:47:43 +08002919 /* Limit session tickets count to one when resumption connection.
2920 *
2921 * See document of mbedtls_ssl_conf_new_session_tickets.
2922 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002924 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002926 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002928
Jerry Yua8d3c502022-10-30 14:51:23 +08002929 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2931 } else {
2932 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002933 }
2934
Jerry Yue67bef42022-07-07 07:29:42 +00002935cleanup:
2936
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002938}
2939#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2940
2941/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002942 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002943 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002944int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002945{
XiaokangQian08037552022-04-20 07:16:41 +00002946 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002947
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2949 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2950 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002951
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2953 mbedtls_ssl_states_str(ssl->state),
2954 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002957 /* start state */
2958 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002960 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002961 break;
2962
XiaokangQian7807f9f2022-02-15 10:04:37 +00002963 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 ret = ssl_tls13_process_client_hello(ssl);
2965 if (ret != 0) {
2966 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2967 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002968 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002969
Jerry Yuf41553b2022-05-09 22:20:30 +08002970 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 ret = ssl_tls13_write_hello_retry_request(ssl);
2972 if (ret != 0) {
2973 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2974 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002975 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002976 break;
2977
Jerry Yu5b64ae92022-03-30 17:15:02 +08002978 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002980 break;
2981
Xiaofei Baicba64af2022-02-15 10:00:56 +00002982 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 ret = ssl_tls13_write_encrypted_extensions(ssl);
2984 if (ret != 0) {
2985 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2986 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002987 }
Jerry Yu48330562022-05-06 21:35:44 +08002988 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002989
Ronald Cron928cbd32022-10-04 16:14:26 +02002990#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002991 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002993 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002994
Jerry Yu83da34e2022-04-16 13:59:52 +08002995 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002997 break;
2998
2999 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003000 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003001 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003002#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 /*
3005 * Injection of dummy-CCS's for middlebox compatibility
3006 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003007#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003008 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3010 if (ret == 0) {
3011 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3012 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003013 break;
3014
3015 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003016 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3017 if (ret == 0) {
3018 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3019 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003020 break;
3021#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3022
Jerry Yu69dd8d42022-04-16 12:51:26 +08003023 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003025 break;
3026
3027 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003028 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003029 break;
3030
Jerry Yu69dd8d42022-04-16 12:51:26 +08003031 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003032 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003033 break;
3034
Ronald Cron766c0cd2022-10-18 12:17:11 +02003035#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003036 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3038 if (ret == 0) {
3039 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003040 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3042 } else {
3043 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003044 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003046 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003047 }
3048 break;
3049
3050 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003051 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3052 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003053 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003055 }
3056 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003057#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003058
Jerry Yue67bef42022-07-07 07:29:42 +00003059#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003060 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 ret = ssl_tls13_write_new_session_ticket(ssl);
3062 if (ret != 0) {
3063 MBEDTLS_SSL_DEBUG_RET(1,
3064 "ssl_tls13_write_new_session_ticket ",
3065 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003066 }
3067 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003068 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003069 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003070 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003071 * as part of ssl_prepare_handshake_step.
3072 */
3073 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003074
Gilles Peskine449bd832023-01-11 14:50:10 +01003075 if (ssl->handshake->new_session_tickets_count == 0) {
3076 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3077 } else {
3078 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3079 }
Jerry Yue67bef42022-07-07 07:29:42 +00003080 break;
3081
3082#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3083
XiaokangQian7807f9f2022-02-15 10:04:37 +00003084 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003085 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3086 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003087 }
3088
Gilles Peskine449bd832023-01-11 14:50:10 +01003089 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003090}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003091
Jerry Yufb4b6472022-01-27 15:03:26 +08003092#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */