blob: 858a7a364b39ef94b11bccbe9ba7ce1a6f5a7b74 [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)
Pengyu Lvf8e50a92023-01-18 17:07:19 +0800107MBEDTLS_CHECK_RETURN_CRITICAL
108static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl);
109MBEDTLS_CHECK_RETURN_CRITICAL
110static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl);
Jerry Yu95699e72022-08-21 19:22:23 +0800111
112MBEDTLS_CHECK_RETURN_CRITICAL
113static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100114 mbedtls_ssl_context *ssl,
115 const unsigned char *identity,
116 size_t identity_len,
117 uint32_t obfuscated_ticket_age,
118 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800119{
Jerry Yufd310eb2022-09-06 09:16:35 +0800120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800121 unsigned char *ticket_buffer;
Pengyu Lvf8e50a92023-01-18 17:07:19 +0800122 unsigned int ticket_flags;
123 unsigned int key_exchanges;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800124#if defined(MBEDTLS_HAVE_TIME)
125 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800126 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800127 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800128#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800129
130 ((void) obfuscated_ticket_age);
131
Gilles Peskine449bd832023-01-11 14:50:10 +0100132 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800133
Jerry Yufd310eb2022-09-06 09:16:35 +0800134 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100135 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
136 return 0;
137 }
Jerry Yu95699e72022-08-21 19:22:23 +0800138
Jerry Yu4746b102022-09-13 11:11:48 +0800139 /* We create a copy of the encrypted ticket since the ticket parsing
140 * function is allowed to use its input buffer as an output buffer
141 * (in-place decryption). We do, however, need the original buffer for
142 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800143 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100144 ticket_buffer = mbedtls_calloc(1, identity_len);
145 if (ticket_buffer == NULL) {
146 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
147 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800148 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100149 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800150
Gilles Peskine449bd832023-01-11 14:50:10 +0100151 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
152 session,
153 ticket_buffer, identity_len)) != 0) {
154 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
155 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
156 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
157 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
158 } else {
159 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
160 }
Jerry Yu95699e72022-08-21 19:22:23 +0800161 }
162
163 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800165
Gilles Peskine449bd832023-01-11 14:50:10 +0100166 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800167 goto exit;
168 }
Jerry Yu95699e72022-08-21 19:22:23 +0800169
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800170 /* RFC 8446 section 4.2.9
171 *
172 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
173 * compatible with the advertised modes; however, if a server does so,
174 * the impact will just be that the client's attempts at resumption fail.
175 *
176 * We regard the ticket with incompatible key exchange modes as not match.
177 */
Pengyu Lvf8e50a92023-01-18 17:07:19 +0800178 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
179 ticket_flags = mbedtls_ssl_session_get_ticket_flags(
180 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL);
181
182 key_exchanges = 0;
183 if ((ticket_flags & MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_EPHEMERAL_RESUMPTION) &&
184 ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
185 key_exchanges |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
186 }
187 if ((ticket_flags & MBEDTLS_SSL_TLS1_3_TICKET_ALLOW_PSK_RESUMPTION) &&
188 ssl_tls13_check_psk_key_exchange(ssl)) {
189 key_exchanges |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
190 }
191
192 if (key_exchanges == 0) {
193 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800194 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
195 goto exit;
196 }
197
Gilles Peskine449bd832023-01-11 14:50:10 +0100198 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
199#if defined(MBEDTLS_HAVE_TIME)
200 now = mbedtls_time(NULL);
201
202 if (now < session->start) {
203 MBEDTLS_SSL_DEBUG_MSG(
204 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
205 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
206 (long long) now, (long long) session->start));
207 goto exit;
208 }
209
210 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800211
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800212 /* RFC 8446 section 4.6.1
213 *
214 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
215 *
216 * RFC 8446 section 4.2.11.1
217 *
218 * Clients MUST NOT attempt to use tickets which have ages greater than
219 * the "ticket_lifetime" value which was provided with the ticket.
220 *
221 * For time being, the age MUST be less than 604800 seconds (7 days).
222 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800224 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100225 3, ("Ticket age exceeds limitation ticket_age=%lu",
226 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800227 goto exit;
228 }
Jerry Yu95699e72022-08-21 19:22:23 +0800229
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800230 /* RFC 8446 section 4.2.10
231 *
232 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
233 * the ticket age for the selected PSK identity (computed by subtracting
234 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
235 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800236 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800237 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
238 * as the age units are different on the server (s) and in the
239 * client (ms) side. Add a -1000 ms tolerance window to take this
240 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800241 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800242 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
244 if (age_diff_in_ms <= -1000 ||
245 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800246 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 3, ("Ticket age outside tolerance window ( diff=%d )",
248 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800249 goto exit;
250 }
251
252 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800253
254#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800255
256exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100257 if (ret != 0) {
258 mbedtls_ssl_session_free(session);
259 }
Jerry Yu95699e72022-08-21 19:22:23 +0800260
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
262 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800263}
264#endif /* MBEDTLS_SSL_SESSION_TICKETS */
265
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800266MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000267static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 mbedtls_ssl_context *ssl,
269 const unsigned char *identity,
270 size_t identity_len,
271 uint32_t obfuscated_ticket_age,
272 int *psk_type,
273 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000274{
Jerry Yu95699e72022-08-21 19:22:23 +0800275 ((void) session);
276 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800277 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800278
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800280 ssl->handshake->resume = 0;
281
Jerry Yu95699e72022-08-21 19:22:23 +0800282#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100283 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800284 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800286 ssl->handshake->resume = 1;
287 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 mbedtls_ssl_set_hs_psk(ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800289 session->resumption_key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 session->resumption_key_len);
291
292 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
293 session->resumption_key,
294 session->resumption_key_len);
295 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
296 (unsigned) obfuscated_ticket_age));
297 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800298 }
299#endif /* MBEDTLS_SSL_SESSION_TICKETS */
300
Jerry Yu1c105562022-07-10 06:32:38 +0000301 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 if (ssl->conf->f_psk != NULL) {
303 if (ssl->conf->f_psk(
304 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
305 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000306 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000308 }
309
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000311 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800313 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 mbedtls_ct_memcmp(ssl->conf->psk_identity,
315 identity, identity_len) == 0) {
316 mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
317 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000318 }
319
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000321}
322
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100324static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
325 const unsigned char *binder,
326 size_t binder_len,
327 int psk_type,
328 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000329{
330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800331
Jerry Yudaf375a2022-07-20 21:31:43 +0800332 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000333 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800334 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800335 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800336 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000337
Jerry Yu1c105562022-07-10 06:32:38 +0000338 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800339 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
341 transcript, sizeof(transcript), &transcript_len);
342 if (ret != 0) {
343 return ret;
344 }
Jerry Yu1c105562022-07-10 06:32:38 +0000345
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
347 if (ret != 0) {
348 return ret;
349 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
352 psk, psk_len, psk_type,
353 transcript,
354 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800355#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800357#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 if (ret != 0) {
359 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
360 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000361 }
362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
364 server_computed_binder, transcript_len);
365 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000366
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
368 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000369 }
370
Gilles Peskine449bd832023-01-11 14:50:10 +0100371 mbedtls_platform_zeroize(server_computed_binder,
372 sizeof(server_computed_binder));
373 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000374}
Jerry Yu96a2e362022-07-21 15:11:34 +0800375
Jerry Yu5725f1c2022-08-21 17:27:16 +0800376MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800377static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100378 mbedtls_ssl_context *ssl,
379 const unsigned char *cipher_suites,
380 const unsigned char *cipher_suites_end,
381 uint16_t *selected_ciphersuite,
382 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800383{
Jerry Yuf35ba382022-08-23 17:58:26 +0800384 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385
Jerry Yu0baf9072022-08-25 11:21:04 +0800386 *selected_ciphersuite = 0;
387 *selected_ciphersuite_info = NULL;
388
Jerry Yuf35ba382022-08-23 17:58:26 +0800389 /* RFC 8446, page 55.
390 *
391 * For externally established PSKs, the Hash algorithm MUST be set when the
392 * PSK is established or default to SHA-256 if no such algorithm is defined.
393 *
394 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800395
Jerry Yu5725f1c2022-08-21 17:27:16 +0800396 /*
397 * Search for a matching ciphersuite
398 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 for (const unsigned char *p = cipher_suites;
400 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800401 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800402 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800403
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
405 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
406 cipher_suite);
407 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800408 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100409 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800410
Jerry Yu5725f1c2022-08-21 17:27:16 +0800411 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
412 * Otherwise, client should reject.
413 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100414 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800415 *selected_ciphersuite = cipher_suite;
416 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100417 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800418 }
419 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
421 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800422}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800423
Jerry Yu82534862022-08-30 10:42:33 +0800424#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800425MBEDTLS_CHECK_RETURN_CRITICAL
426static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 mbedtls_ssl_context *ssl,
428 const unsigned char *cipher_suites,
429 const unsigned char *cipher_suites_end,
430 mbedtls_ssl_session *session,
431 uint16_t *selected_ciphersuite,
432 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800433{
Jerry Yu82534862022-08-30 10:42:33 +0800434
Jerry Yuf35ba382022-08-23 17:58:26 +0800435 *selected_ciphersuite = 0;
436 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
438 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800439 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
440
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800442 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 }
Jerry Yu82534862022-08-30 10:42:33 +0800444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
446 cipher_suite);
447 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800448 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 }
Jerry Yu82534862022-08-30 10:42:33 +0800450
Jerry Yu4746b102022-09-13 11:11:48 +0800451 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800452 *selected_ciphersuite_info = ciphersuite_info;
453
Gilles Peskine449bd832023-01-11 14:50:10 +0100454 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800455 }
456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800458}
Jerry Yuf35ba382022-08-23 17:58:26 +0800459
Jerry Yu82534862022-08-30 10:42:33 +0800460MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100461static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
462 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800463{
Jerry Yu82534862022-08-30 10:42:33 +0800464 dst->ticket_age_add = src->ticket_age_add;
465 dst->ticket_flags = src->ticket_flags;
466 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100467 if (src->resumption_key_len == 0) {
468 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
469 }
470 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800471
Gilles Peskine449bd832023-01-11 14:50:10 +0100472 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800473}
474#endif /* MBEDTLS_SSL_SESSION_TICKETS */
475
Jerry Yu1c105562022-07-10 06:32:38 +0000476/* Parser for pre_shared_key extension in client hello
477 * struct {
478 * opaque identity<1..2^16-1>;
479 * uint32 obfuscated_ticket_age;
480 * } PskIdentity;
481 *
482 * opaque PskBinderEntry<32..255>;
483 *
484 * struct {
485 * PskIdentity identities<7..2^16-1>;
486 * PskBinderEntry binders<33..2^16-1>;
487 * } OfferedPsks;
488 *
489 * struct {
490 * select (Handshake.msg_type) {
491 * case client_hello: OfferedPsks;
492 * ....
493 * };
494 * } PreSharedKeyExtension;
495 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800496MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100497static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
498 const unsigned char *pre_shared_key_ext,
499 const unsigned char *pre_shared_key_ext_end,
500 const unsigned char *ciphersuites,
501 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000502{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800503 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800504 const unsigned char *p_identity_len;
505 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000506 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800507 const unsigned char *binders;
508 const unsigned char *p_binder_len;
509 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000510 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800511 int matched_identity = -1;
512 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
515 pre_shared_key_ext,
516 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000517
Jerry Yu96a2e362022-07-21 15:11:34 +0800518 /* identities_len 2 bytes
519 * identities_data >= 7 bytes
520 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
522 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800523 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
525 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800526 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000527
Jerry Yu96a2e362022-07-21 15:11:34 +0800528 /* binders_len 2 bytes
529 * binders >= 33 bytes
530 */
Jerry Yu568ec252022-07-22 21:27:34 +0800531 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
533 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800534 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800536 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000537
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
539 identities_end - pre_shared_key_ext);
Jerry Yu96a2e362022-07-21 15:11:34 +0800540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000542 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800543 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800544 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800545 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800546 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
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. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 ssl->handshake->update_checksum(ssl,
660 identities_end,
661 (size_t) (binders_end - identities_end));
662 if (matched_identity == -1) {
663 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
664 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000665 }
666
Gilles Peskine449bd832023-01-11 14:50:10 +0100667 ssl->handshake->selected_identity = (uint16_t) matched_identity;
668 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000669
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000671}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672
673/*
674 * struct {
675 * select ( Handshake.msg_type ) {
676 * ....
677 * case server_hello:
678 * uint16 selected_identity;
679 * }
680 * } PreSharedKeyExtension;
681 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100682static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
683 unsigned char *buf,
684 unsigned char *end,
685 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000686{
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000688
689 *olen = 0;
690
David Horstmann21b89762022-10-06 18:34:28 +0100691 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000692#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000696#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698 /* We shouldn't have called this extension writer unless we've
699 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000701 }
702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
704 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
707 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000708
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000710
711 *olen = 6;
712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
714 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000715
Gilles Peskine449bd832023-01-11 14:50:10 +0100716 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800717
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000719}
720
Ronald Cron41a443a2022-10-04 16:38:25 +0200721#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000722
XiaokangQian7807f9f2022-02-15 10:04:37 +0000723/* From RFC 8446:
724 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000725 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000726 * } SupportedVersions;
727 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200728MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100729static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
730 const unsigned char *buf,
731 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000732{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000733 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000734 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000735 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000736 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000737 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738
Gilles Peskine449bd832023-01-11 14:50:10 +0100739 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000740 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000741 p += 1;
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000744 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 while (p < versions_end) {
746 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
747 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000748 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000749
750 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000752 tls13_supported = 1;
753 break;
754 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000755 }
756
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 if (!tls13_supported) {
758 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000759
Gilles Peskine449bd832023-01-11 14:50:10 +0100760 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
761 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
762 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000763 }
764
Gilles Peskine449bd832023-01-11 14:50:10 +0100765 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
766 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000767
Gilles Peskine449bd832023-01-11 14:50:10 +0100768 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000769}
770
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000771#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000772/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773 *
774 * From RFC 8446:
775 * enum {
776 * ... (0xFFFF)
777 * } NamedGroup;
778 * struct {
779 * NamedGroup named_group_list<2..2^16-1>;
780 * } NamedGroupList;
781 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200782MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100783static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
784 const unsigned char *buf,
785 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000786{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000787 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000788 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000789 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
792 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
793 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000794 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000796 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000797 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000798
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000800 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100801 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
802 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000803 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804
Gilles Peskine449bd832023-01-11 14:50:10 +0100805 MBEDTLS_SSL_DEBUG_MSG(2,
806 ("got named group: %s(%04x)",
807 mbedtls_ssl_named_group_to_str(named_group),
808 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
811 !mbedtls_ssl_named_group_is_supported(named_group) ||
812 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000813 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814 }
815
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 MBEDTLS_SSL_DEBUG_MSG(2,
817 ("add named group %s(%04x) into received list.",
818 mbedtls_ssl_named_group_to_str(named_group),
819 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800820
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000821 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000822 }
823
Gilles Peskine449bd832023-01-11 14:50:10 +0100824 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825
826}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000827#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000828
XiaokangQian08037552022-04-20 07:16:41 +0000829#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
830
XiaokangQian88408882022-04-02 10:15:03 +0000831#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000832/*
833 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000834 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000835 *
836 * Possible return values are:
837 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000838 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839 * does not match a group supported by the server. A HelloRetryRequest will
840 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000841 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800842 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200843MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100844static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
845 const unsigned char *buf,
846 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000847{
XiaokangQianb67384d2022-04-19 00:02:38 +0000848 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000850 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800851 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000852
853 /* From RFC 8446:
854 *
855 * struct {
856 * KeyShareEntry client_shares<0..2^16-1>;
857 * } KeyShareClientHello;
858 *
859 */
860
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
862 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000863 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100864 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000865
866 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000867 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000868
869 /* We try to find a suitable key share entry and copy it to the
870 * handshake context. Later, we have to find out whether we can do
871 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000872 * dismiss it and send a HelloRetryRequest message.
873 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000874
Gilles Peskine449bd832023-01-11 14:50:10 +0100875 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000876 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800877 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800878 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000879
880 /*
881 * struct {
882 * NamedGroup group;
883 * opaque key_exchange<1..2^16-1>;
884 * } KeyShareEntry;
885 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100886 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
887 group = MBEDTLS_GET_UINT16_BE(p, 0);
888 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800889 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800890 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800892 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000893
894 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000895 * for input validation purposes.
896 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
898 !mbedtls_ssl_named_group_is_supported(group) ||
899 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000900 continue;
901 }
XiaokangQian060d8672022-04-21 09:24:56 +0000902
XiaokangQian7807f9f2022-02-15 10:04:37 +0000903 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000904 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000905 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100906 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
907 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
908 mbedtls_ssl_named_group_to_str(group),
909 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000910 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 ssl, key_exchange - 2, key_exchange_len + 2);
912 if (ret != 0) {
913 return ret;
914 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000915
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 } else {
917 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
918 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000919 continue;
920 }
921
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000922 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923 }
924
Jerry Yuc1be19f2022-04-23 16:11:39 +0800925
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 if (ssl->handshake->offered_group_id == 0) {
927 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
928 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000929 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000931}
XiaokangQian88408882022-04-02 10:15:03 +0000932#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000933
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200934MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100935static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
936 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937{
Jerry Yu0c354a22022-08-29 15:25:36 +0800938 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940}
941
Jerry Yue5991322022-11-07 14:03:44 +0800942#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200943MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000944static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000946{
Gilles Peskine449bd832023-01-11 14:50:10 +0100947 return ssl_tls13_client_hello_has_exts(
948 ssl,
949 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
950 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
951 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000952}
Jerry Yue5991322022-11-07 14:03:44 +0800953#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000954
Jerry Yue5991322022-11-07 14:03:44 +0800955#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000956MBEDTLS_CHECK_RETURN_CRITICAL
957static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000959{
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 return ssl_tls13_client_hello_has_exts(
961 ssl,
962 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
963 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000964}
Jerry Yue5991322022-11-07 14:03:44 +0800965#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000966
Jerry Yue5991322022-11-07 14:03:44 +0800967#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000968MBEDTLS_CHECK_RETURN_CRITICAL
969static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000971{
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 return ssl_tls13_client_hello_has_exts(
973 ssl,
974 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
975 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
976 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
977 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000978}
Jerry Yue5991322022-11-07 14:03:44 +0800979#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000980
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200981MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100982static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000983{
Jerry Yue5991322022-11-07 14:03:44 +0800984#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
986 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800987#else
988 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800990#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000991}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000992
Jerry Yu77f01482022-07-11 07:03:24 +0000993MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100994static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000995{
Jerry Yue5991322022-11-07 14:03:44 +0800996#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Pengyu Lv0b740bc2023-01-18 17:02:52 +0800997#if defined(MBEDTLS_SSL_SESSION_TICKETS)
998 if (ssl->handshake->resume) {
999 if (!mbedtls_ssl_session_get_ticket_flags(
1000 ssl->session_negotiate,
1001 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK)) {
1002 return 0;
1003 }
1004 }
1005#endif
1006
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1008 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1009 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001010#else
1011 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001012 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001013#endif
1014}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001015
Jerry Yu77f01482022-07-11 07:03:24 +00001016MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001017static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001018{
Jerry Yue5991322022-11-07 14:03:44 +08001019#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Pengyu Lv0b740bc2023-01-18 17:02:52 +08001020#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1021 if (ssl->handshake->resume) {
1022 if (!mbedtls_ssl_session_get_ticket_flags(
1023 ssl->session_negotiate,
1024 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)) {
1025 return 0;
1026 }
1027 }
1028#endif
1029
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1031 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1032 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001033#else
1034 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001036#endif
1037}
1038
Gilles Peskine449bd832023-01-11 14:50:10 +01001039static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001040{
1041 /*
1042 * Determine the key exchange algorithm to use.
1043 * There are three types of key exchanges supported in TLS 1.3:
1044 * - (EC)DH with ECDSA,
1045 * - (EC)DH with PSK,
1046 * - plain PSK.
1047 *
1048 * The PSK-based key exchanges may additionally be used with 0-RTT.
1049 *
1050 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001051 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1052 * 2 ) Certificate Mode ( ephemeral )
1053 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001054 */
1055
1056 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001059 ssl->handshake->key_exchange_mode =
1060 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1062 } else
1063 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001064 ssl->handshake->key_exchange_mode =
1065 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1067 } else
1068 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001069 ssl->handshake->key_exchange_mode =
1070 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1072 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001073 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 1,
1075 ("ClientHello message misses mandatory extensions."));
1076 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1077 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1078 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001079 }
1080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001082
XiaokangQian7807f9f2022-02-15 10:04:37 +00001083}
1084
XiaokangQian81802f42022-06-10 13:25:22 +00001085#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001086 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001087
1088#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001089static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001090{
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001098 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001100 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001102 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001104 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001106 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001108 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001110 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001112 }
1113}
1114#endif /* MBEDTLS_USE_PSA_CRYPTO */
1115
XiaokangQian23c5be62022-06-07 02:04:34 +00001116/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001117 * Pick best ( private key, certificate chain ) pair based on the signature
1118 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001119 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001120MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001121static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001122{
XiaokangQianfb665a82022-06-15 03:57:21 +00001123 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001124 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001125
1126#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001128 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001130#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (key_cert_list == NULL) {
1134 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1135 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001136 }
1137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1139 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001140 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001144 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 for (key_cert = key_cert_list; key_cert != NULL;
1148 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001149#if defined(MBEDTLS_USE_PSA_CRYPTO)
1150 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1151#endif /* MBEDTLS_USE_PSA_CRYPTO */
1152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1154 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001155
1156 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 * This avoids sending the client a cert it'll reject based on
1158 * keyUsage or other extensions.
1159 */
1160 if (mbedtls_x509_crt_check_key_usage(
1161 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001162 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001163 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1165 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1166 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001167 continue;
1168 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 MBEDTLS_SSL_DEBUG_MSG(3,
1171 ("ssl_tls13_pick_key_cert:"
1172 "check signature algorithm %s [%04x]",
1173 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1174 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001175#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001177#endif /* MBEDTLS_USE_PSA_CRYPTO */
1178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1180 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001181#if defined(MBEDTLS_USE_PSA_CRYPTO)
1182 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1184 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001185#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001187 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 MBEDTLS_SSL_DEBUG_MSG(3,
1189 ("ssl_tls13_pick_key_cert:"
1190 "selected signature algorithm"
1191 " %s [%04x]",
1192 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1193 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001194 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 3, "selected certificate (chain)",
1196 ssl->handshake->key_cert->cert);
1197 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001198 }
XiaokangQian81802f42022-06-10 13:25:22 +00001199 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001200 }
1201
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1203 "no suitable certificate found"));
1204 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001205}
XiaokangQian81802f42022-06-10 13:25:22 +00001206#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001207 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001208
XiaokangQian4080a7f2022-04-11 09:55:18 +00001209/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001210 *
1211 * STATE HANDLING: ClientHello
1212 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001213 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001214 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001215 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001216 *
1217 * In this case, the server progresses to sending its ServerHello.
1218 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001219 * 2) The ClientHello was well-formed but didn't match the server's
1220 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001221 *
1222 * For example, the client might not have offered a key share which
1223 * the server supports, or the server might require a cookie.
1224 *
1225 * In this case, the server sends a HelloRetryRequest.
1226 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001227 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001228 *
1229 * In this case, we abort the handshake.
1230 *
1231 */
1232
1233/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001234 * Structure of this message:
1235 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001236 * uint16 ProtocolVersion;
1237 * opaque Random[32];
1238 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001239 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001240 * struct {
1241 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1242 * Random random;
1243 * opaque legacy_session_id<0..32>;
1244 * CipherSuite cipher_suites<2..2^16-2>;
1245 * opaque legacy_compression_methods<1..2^8-1>;
1246 * Extension extensions<8..2^16-1>;
1247 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001248 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001249
1250#define SSL_CLIENT_HELLO_OK 0
1251#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1252
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001253MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001254static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1255 const unsigned char *buf,
1256 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257{
XiaokangQianb67384d2022-04-19 00:02:38 +00001258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1259 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001260 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001261 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001262 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001263 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001264 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001265 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001266 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001267
Ronald Cron41a443a2022-10-04 16:38:25 +02001268#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001269 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001270 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001271 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001272#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001275 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001277 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001278 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001279 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001280 * .. . .. ciphersuite list length ( 2 bytes )
1281 * .. . .. ciphersuite list
1282 * .. . .. compression alg. list length ( 1 byte )
1283 * .. . .. compression alg. list
1284 * .. . .. extensions length ( 2 bytes, optional )
1285 * .. . .. extensions ( optional )
1286 */
1287
XiaokangQianb67384d2022-04-19 00:02:38 +00001288 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001289 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001290 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1291 * read at least up to session id length without worrying.
1292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001294
1295 /* ...
1296 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1297 * ...
1298 * with ProtocolVersion defined as:
1299 * uint16 ProtocolVersion;
1300 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1302 MBEDTLS_SSL_VERSION_TLS1_2) {
1303 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1304 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1305 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1306 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001307 }
1308 p += 2;
1309
1310 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001311 * Only support TLS 1.3 currently, temporarily set the version.
1312 */
XiaokangQiande333912022-04-20 08:49:42 +00001313 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001314
Jerry Yue67bef42022-07-07 07:29:42 +00001315#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1316 /* Store minor version for later use with ticket serialization. */
1317 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001318 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001319#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001320
Jerry Yuc1be19f2022-04-23 16:11:39 +08001321 /* ...
1322 * Random random;
1323 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001324 * with Random defined as:
1325 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1328 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001329
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001331 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001332
Jerry Yuc1be19f2022-04-23 16:11:39 +08001333 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001334 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001335 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001336 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001337 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001338 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001339
Gilles Peskine449bd832023-01-11 14:50:10 +01001340 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1341 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1342 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001343 }
1344
XiaokangQian4080a7f2022-04-11 09:55:18 +00001345 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001346 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1347 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001348 /*
1349 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001350 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001351 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001355 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001358 p += 2;
1359
XiaokangQianb67384d2022-04-19 00:02:38 +00001360 /* Check we have enough data for the ciphersuite list, the legacy
1361 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001362 *
1363 * cipher_suites cipher_suites_len bytes
1364 * legacy_compression_methods 2 bytes
1365 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001366 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001367 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001368
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 /* ...
1370 * CipherSuite cipher_suites<2..2^16-2>;
1371 * ...
1372 * with CipherSuite defined as:
1373 * uint8 CipherSuite[2];
1374 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001375#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001376 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001377#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001378 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1380 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001381
1382 /*
1383 * Search for a matching ciphersuite
1384 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001385 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001386 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001388
Gilles Peskine449bd832023-01-11 14:50:10 +01001389 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001390
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001392 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001393 ssl, cipher_suite);
1394 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001395 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001397
Jerry Yu5725f1c2022-08-21 17:27:16 +08001398 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001399 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1401 cipher_suite,
1402 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001403 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 if (handshake->ciphersuite_info == NULL) {
1406 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1407 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1408 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001409 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001410
XiaokangQian4080a7f2022-04-11 09:55:18 +00001411 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001412 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001413 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001414 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001415 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1416 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1417 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1418 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1419 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001420 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001421 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001422
Jerry Yuc1be19f2022-04-23 16:11:39 +08001423 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001424 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001425 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001426 * with Extension defined as:
1427 * struct {
1428 * ExtensionType extension_type;
1429 * opaque extension_data<0..2^16-1>;
1430 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001431 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001433 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001435 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001436
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001438
Jerry Yu63a459c2022-10-31 13:38:40 +08001439 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001442 unsigned int extension_type;
1443 size_t extension_data_len;
1444 const unsigned char *extension_data_end;
1445
Jerry Yu0c354a22022-08-29 15:25:36 +08001446 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001447 *
1448 * The "pre_shared_key" extension MUST be the last extension in the
1449 * ClientHello (this facilitates implementation as described below).
1450 * Servers MUST check that it is the last extension and otherwise fail
1451 * the handshake with an "illegal_parameter" alert.
1452 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001454 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001456 MBEDTLS_SSL_PEND_FATAL_ALERT(
1457 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1459 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001460 }
1461
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1463 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1464 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001465 p += 4;
1466
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001468 extension_data_end = p + extension_data_len;
1469
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001470 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1472 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1473 if (ret != 0) {
1474 return ret;
1475 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001476
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001478#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1479 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1481 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1482 extension_data_end);
1483 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001484 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001485 1, "mbedtls_ssl_parse_servername_ext", ret);
1486 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001487 }
XiaokangQian40a35232022-05-07 09:02:40 +00001488 break;
1489#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1490
XiaokangQianb67384d2022-04-19 00:02:38 +00001491#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001492 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001494
1495 /* Supported Groups Extension
1496 *
1497 * When sent by the client, the "supported_groups" extension
1498 * indicates the named groups which the client supports,
1499 * ordered from most preferred to least preferred.
1500 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001501 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001502 ssl, p, extension_data_end);
1503 if (ret != 0) {
1504 MBEDTLS_SSL_DEBUG_RET(1,
1505 "mbedtls_ssl_parse_supported_groups_ext", ret);
1506 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001507 }
1508
XiaokangQian7807f9f2022-02-15 10:04:37 +00001509 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001510#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001511
XiaokangQian88408882022-04-02 10:15:03 +00001512#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001514 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001515
1516 /*
1517 * Key Share Extension
1518 *
1519 * When sent by the client, the "key_share" extension
1520 * contains the endpoint's cryptographic parameters for
1521 * ECDHE/DHE key establishment methods.
1522 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001523 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 ssl, p, extension_data_end);
1525 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1526 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001527 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001528 }
1529
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001531 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 1, "ssl_tls13_parse_key_shares_ext", ret);
1533 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001534 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001535
XiaokangQian7807f9f2022-02-15 10:04:37 +00001536 break;
XiaokangQian88408882022-04-02 10:15:03 +00001537#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001538
1539 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001541
1542 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 ssl, p, extension_data_end);
1544 if (ret != 0) {
1545 MBEDTLS_SSL_DEBUG_RET(1,
1546 ("ssl_tls13_parse_supported_versions_ext"), ret);
1547 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001548 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001549 break;
1550
Ronald Cron41a443a2022-10-04 16:38:25 +02001551#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001552 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001554
1555 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 ssl, p, extension_data_end);
1557 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001558 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1560 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001561 }
1562
Jerry Yue19e3b92022-07-08 12:04:51 +00001563 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001564#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001565
Jerry Yu1c105562022-07-10 06:32:38 +00001566 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1568 if ((handshake->received_extensions &
1569 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001570 MBEDTLS_SSL_PEND_FATAL_ALERT(
1571 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001572 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1573 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001574 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001575#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001576 /* Delay processing of the PSK identity once we have
1577 * found out which algorithms to use. We keep a pointer
1578 * to the buffer and the size for later processing.
1579 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001580 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001581 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001582#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001583 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001584
XiaokangQianacb39922022-06-17 10:18:48 +00001585#if defined(MBEDTLS_SSL_ALPN)
1586 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001588
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1590 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001591 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1593 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001594 }
XiaokangQianacb39922022-06-17 10:18:48 +00001595 break;
1596#endif /* MBEDTLS_SSL_ALPN */
1597
Ronald Cron928cbd32022-10-04 16:14:26 +02001598#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001599 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001601
Gabor Mezei078e8032022-04-27 21:17:56 +02001602 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 ssl, p, extension_data_end);
1604 if (ret != 0) {
1605 MBEDTLS_SSL_DEBUG_MSG(1,
1606 (
1607 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1608 ret));
1609 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001610 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001611 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001612#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001613
1614 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001615 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001616 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001618 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001619 }
1620
1621 p += extension_data_len;
1622 }
1623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1625 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001626
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1628 MBEDTLS_SSL_HS_CLIENT_HELLO,
1629 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001630
Ronald Cron41a443a2022-10-04 16:38:25 +02001631#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001632 /* Update checksum with either
1633 * - The entire content of the CH message, if no PSK extension is present
1634 * - The content up to but excluding the PSK extension, if present.
1635 */
Jerry Yu1c105562022-07-10 06:32:38 +00001636 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1638 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1639 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1640 handshake->update_checksum(ssl, buf,
1641 pre_shared_key_ext - buf);
1642 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1643 pre_shared_key_ext,
1644 pre_shared_key_ext_end,
1645 cipher_suites,
1646 cipher_suites_end);
1647 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1648 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1649 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001650 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1652 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001653 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001655#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001656 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001658 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1661 if (ret < 0) {
1662 return ret;
1663 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001664
Gilles Peskine449bd832023-01-11 14:50:10 +01001665 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001666
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001668}
1669
1670/* Update the handshake state machine */
1671
Ronald Cronce7d76e2022-07-08 18:56:49 +02001672MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001673static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001674{
1675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1676
XiaokangQian7807f9f2022-02-15 10:04:37 +00001677 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001678 * Server certificate selection
1679 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1681 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1682 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001683 }
1684#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1685 ssl->handshake->sni_name = NULL;
1686 ssl->handshake->sni_name_len = 0;
1687#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001688
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1690 if (ret != 0) {
1691 MBEDTLS_SSL_DEBUG_RET(1,
1692 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1693 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001694 }
1695
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001697
1698}
1699
1700/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001701 * Main entry point from the state machine; orchestrates the otherfunctions.
1702 */
1703
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001704MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001705static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001706{
1707
XiaokangQian08037552022-04-20 07:16:41 +00001708 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001709 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001710 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001711 int parse_client_hello_ret;
1712
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001714
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1716 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1717 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001718
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1720 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001721 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1722 * only SSL_CLIENT_HELLO_OK or
1723 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1724 * stage as negative error codes are handled
1725 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001728
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1730 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1731 } else {
1732 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1733 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001734
1735cleanup:
1736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1738 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001739}
1740
1741/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001742 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001743 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001744MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001745static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001746{
Jerry Yu637a3f12022-04-20 21:37:58 +08001747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1748 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1750 if (ssl->conf->f_rng == NULL) {
1751 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1752 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001753 }
1754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1756 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1757 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1758 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001759 }
1760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1762 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001763
1764#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001766#endif /* MBEDTLS_HAVE_TIME */
1767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001769}
1770
Jerry Yu3bf2c642022-03-30 22:02:12 +08001771/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001772 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001773 *
1774 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001775 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001776 * } SupportedVersions;
1777 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001778MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001779static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001780 mbedtls_ssl_context *ssl,
1781 unsigned char *buf,
1782 unsigned char *end,
1783 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001784{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001785 *out_len = 0;
1786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001788
1789 /* Check if we have space to write the extension:
1790 * - extension_type (2 bytes)
1791 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001792 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001793 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001795
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001797
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001799
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 mbedtls_ssl_write_version(buf + 4,
1801 ssl->conf->transport,
1802 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1805 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001806
Jerry Yu349a6132022-04-14 20:52:56 +08001807 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001808
Jerry Yub95dd362022-11-08 21:19:34 +08001809 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001810 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001811
Gilles Peskine449bd832023-01-11 14:50:10 +01001812 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001813}
1814
Jerry Yud9436a12022-04-20 22:28:09 +08001815
Jerry Yu3bf2c642022-03-30 22:02:12 +08001816
1817/* Generate and export a single key share. For hybrid KEMs, this can
1818 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001819MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001820static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1821 uint16_t named_group,
1822 unsigned char *buf,
1823 unsigned char *end,
1824 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001825{
1826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001827
1828 *out_len = 0;
1829
Jerry Yu89e103c2022-03-30 22:43:29 +08001830#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001832 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 ssl, named_group, buf, end, out_len);
1834 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001835 MBEDTLS_SSL_DEBUG_RET(
1836 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 ret);
1838 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001840 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001841#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 if (0 /* Other kinds of KEMs */) {
1843 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001844 ((void) ssl);
1845 ((void) named_group);
1846 ((void) buf);
1847 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001848 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1849 }
1850
Gilles Peskine449bd832023-01-11 14:50:10 +01001851 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001852}
1853
1854/*
1855 * ssl_tls13_write_key_share_ext
1856 *
1857 * Structure of key_share extension in ServerHello:
1858 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001859 * struct {
1860 * NamedGroup group;
1861 * opaque key_exchange<1..2^16-1>;
1862 * } KeyShareEntry;
1863 * struct {
1864 * KeyShareEntry server_share;
1865 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001866 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001867MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001868static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1869 unsigned char *buf,
1870 unsigned char *end,
1871 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001872{
Jerry Yu955ddd72022-04-22 22:27:33 +08001873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001874 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001875 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001876 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001877 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001878
1879 *out_len = 0;
1880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882
Gilles Peskine449bd832023-01-11 14:50:10 +01001883 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1884 mbedtls_ssl_named_group_to_str(group),
1885 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001886
Jerry Yu3bf2c642022-03-30 22:02:12 +08001887 /* Check if we have space for header and length fields:
1888 * - extension_type (2 bytes)
1889 * - extension_data_length (2 bytes)
1890 * - group (2 bytes)
1891 * - key_exchange_length (2 bytes)
1892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001893 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1894 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1895 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001896 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001897
Jerry Yu3bf2c642022-03-30 22:02:12 +08001898 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1899 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001900 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 ssl, group, server_share + 4, end, &key_exchange_length);
1902 if (ret != 0) {
1903 return ret;
1904 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001905 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001906
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001910
Jerry Yu57d48412022-04-20 21:50:42 +08001911 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001912
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001914
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001916}
Jerry Yud9436a12022-04-20 22:28:09 +08001917
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001918MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001919static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1920 unsigned char *buf,
1921 unsigned char *end,
1922 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001923{
1924 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1925 /* key_share Extension
1926 *
1927 * struct {
1928 * select (Handshake.msg_type) {
1929 * ...
1930 * case hello_retry_request:
1931 * NamedGroup selected_group;
1932 * ...
1933 * };
1934 * } KeyShare;
1935 */
1936
1937 *out_len = 0;
1938
Jerry Yub0ac10b2022-05-05 11:10:08 +08001939 /*
1940 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1941 * of the HRR is then to transmit a cookie to force the client to demonstrate
1942 * reachability at their apparent network address (primarily useful for DTLS).
1943 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1945 return 0;
1946 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001947
1948 /* We should only send the key_share extension if the client's initial
1949 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001950 if (ssl->handshake->offered_group_id != 0) {
1951 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1952 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001953 }
1954
Gilles Peskine449bd832023-01-11 14:50:10 +01001955 if (selected_group == 0) {
1956 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1957 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001958 }
1959
Jerry Yub0ac10b2022-05-05 11:10:08 +08001960 /* Check if we have enough space:
1961 * - extension_type (2 bytes)
1962 * - extension_data_length (2 bytes)
1963 * - selected_group (2 bytes)
1964 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1968 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1969 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001970
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 MBEDTLS_SSL_DEBUG_MSG(3,
1972 ("HRR selected_group: %s (%x)",
1973 mbedtls_ssl_named_group_to_str(selected_group),
1974 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001975
1976 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001979
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001981}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001982
1983/*
1984 * Structure of ServerHello message:
1985 *
1986 * struct {
1987 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1988 * Random random;
1989 * opaque legacy_session_id_echo<0..32>;
1990 * CipherSuite cipher_suite;
1991 * uint8 legacy_compression_method = 0;
1992 * Extension extensions<6..2^16-1>;
1993 * } ServerHello;
1994 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001995MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001996static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1997 unsigned char *buf,
1998 unsigned char *end,
1999 size_t *out_len,
2000 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002001{
Jerry Yu955ddd72022-04-22 22:27:33 +08002002 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002003 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002004 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002005 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002006
2007 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002008 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002009
Jerry Yucfc04b32022-04-21 09:31:58 +08002010 /* ...
2011 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2012 * ...
2013 * with ProtocolVersion defined as:
2014 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002015 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002016 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2017 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002018 p += 2;
2019
Jerry Yu1c3e6882022-04-20 21:23:40 +08002020 /* ...
2021 * Random random;
2022 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002023 * with Random defined as:
2024 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002025 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2027 if (is_hrr) {
2028 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2029 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2030 } else {
2031 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2032 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002033 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2035 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002036 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2037
Jerry Yucfc04b32022-04-21 09:31:58 +08002038 /* ...
2039 * opaque legacy_session_id_echo<0..32>;
2040 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002041 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2043 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2044 if (ssl->session_negotiate->id_len > 0) {
2045 memcpy(p, &ssl->session_negotiate->id[0],
2046 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002047 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002048
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2050 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051 }
2052
Jerry Yucfc04b32022-04-21 09:31:58 +08002053 /* ...
2054 * CipherSuite cipher_suite;
2055 * ...
2056 * with CipherSuite defined as:
2057 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2060 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002061 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002062 MBEDTLS_SSL_DEBUG_MSG(3,
2063 ("server hello, chosen ciphersuite: %s ( id=%d )",
2064 mbedtls_ssl_get_ciphersuite_name(
2065 ssl->session_negotiate->ciphersuite),
2066 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067
Jerry Yucfc04b32022-04-21 09:31:58 +08002068 /* ...
2069 * uint8 legacy_compression_method = 0;
2070 * ...
2071 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002073 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002074
Jerry Yucfc04b32022-04-21 09:31:58 +08002075 /* ...
2076 * Extension extensions<6..2^16-1>;
2077 * ...
2078 * struct {
2079 * ExtensionType extension_type; (2 bytes)
2080 * opaque extension_data<0..2^16-1>;
2081 * } Extension;
2082 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002084 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002085 p += 2;
2086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2088 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002089 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2091 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 }
2093 p += output_len;
2094
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2096 if (is_hrr) {
2097 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2098 } else {
2099 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2100 }
2101 if (ret != 0) {
2102 return ret;
2103 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002104 p += output_len;
2105 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002106
Ronald Cron41a443a2022-10-04 16:38:25 +02002107#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2109 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2110 if (ret != 0) {
2111 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2112 ret);
2113 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002114 }
2115 p += output_len;
2116 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002117#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002118
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2122 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002123
Jerry Yud9436a12022-04-20 22:28:09 +08002124 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002127
Jerry Yu7de2ff02022-11-08 21:43:46 +08002128 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002129 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 MBEDTLS_SSL_HS_SERVER_HELLO,
2131 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002132
Gilles Peskine449bd832023-01-11 14:50:10 +01002133 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002134}
2135
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002136MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002137static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002138{
2139 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2141 if (ret != 0) {
2142 MBEDTLS_SSL_DEBUG_RET(1,
2143 "mbedtls_ssl_tls13_compute_handshake_transform",
2144 ret);
2145 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002146 }
2147
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002149}
2150
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002151MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002152static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002153{
Jerry Yu637a3f12022-04-20 21:37:58 +08002154 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002155 unsigned char *buf;
2156 size_t buf_len, msg_len;
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002159
Gilles Peskine449bd832023-01-11 14:50:10 +01002160 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002161
Gilles Peskine449bd832023-01-11 14:50:10 +01002162 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2163 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2164 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002165
Gilles Peskine449bd832023-01-11 14:50:10 +01002166 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2167 buf + buf_len,
2168 &msg_len,
2169 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002170
Jerry Yu3bf2c642022-03-30 22:02:12 +08002171 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002173
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2175 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002176
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002178
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002179#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2180 /* The server sends a dummy change_cipher_spec record immediately
2181 * after its first handshake message. This may either be after
2182 * a ServerHello or a HelloRetryRequest.
2183 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002184 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002186#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002188#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002189
Jerry Yuf4b27e42022-03-30 17:32:21 +08002190cleanup:
2191
Gilles Peskine449bd832023-01-11 14:50:10 +01002192 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2193 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002194}
2195
Jerry Yu23d1a252022-05-12 18:08:59 +08002196
2197/*
2198 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2199 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002200MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002201static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002202{
2203 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 if (ssl->handshake->hello_retry_request_count > 0) {
2205 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2206 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2207 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2208 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002209 }
2210
2211 /*
2212 * Create stateless transcript hash for HRR
2213 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2215 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2216 if (ret != 0) {
2217 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2218 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002219 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002223}
2224
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002225MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002226static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002227{
2228 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2229 unsigned char *buf;
2230 size_t buf_len, msg_len;
2231
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002233
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002235
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2237 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2238 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2241 buf + buf_len,
2242 &msg_len,
2243 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002244 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002246
2247
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2249 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002250
2251 ssl->handshake->hello_retry_request_count++;
2252
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002253#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2254 /* The server sends a dummy change_cipher_spec record immediately
2255 * after its first handshake message. This may either be after
2256 * a ServerHello or a HelloRetryRequest.
2257 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002258 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002260#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002261 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002262#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002263
2264cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2266 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002267}
2268
Jerry Yu5b64ae92022-03-30 17:15:02 +08002269/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002270 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2271 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002272
2273/*
2274 * struct {
2275 * Extension extensions<0..2 ^ 16 - 1>;
2276 * } EncryptedExtensions;
2277 *
2278 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002279MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002280static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2281 unsigned char *buf,
2282 unsigned char *end,
2283 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002284{
XiaokangQianacb39922022-06-17 10:18:48 +00002285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002286 unsigned char *p = buf;
2287 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002288 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002289 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002290
Jerry Yu4d3841a2022-04-16 12:37:19 +08002291 *out_len = 0;
2292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002294 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002295 p += 2;
2296
Jerry Yu8937eb42022-05-03 12:12:14 +08002297 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002298 ((void) ret);
2299 ((void) output_len);
2300
2301#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2303 if (ret != 0) {
2304 return ret;
2305 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002306 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002307#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002308
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 extensions_len = (p - p_extensions_len) - 2;
2310 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002311
2312 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002313
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002315
Jerry Yu7de2ff02022-11-08 21:43:46 +08002316 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002317 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002318
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002320}
2321
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002322MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002323static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002324{
2325 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2326 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002327 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002328
Gilles Peskine449bd832023-01-11 14:50:10 +01002329 mbedtls_ssl_set_outbound_transform(ssl,
2330 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002331 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002335
Gilles Peskine449bd832023-01-11 14:50:10 +01002336 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2337 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2338 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2341 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002342
2343 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002344 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2347 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002348
Ronald Cron928cbd32022-10-04 16:14:26 +02002349#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2351 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2352 } else {
2353 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2354 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002355#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002357#endif
2358
Jerry Yu4d3841a2022-04-16 12:37:19 +08002359cleanup:
2360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2362 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002363}
2364
Ronald Cron928cbd32022-10-04 16:14:26 +02002365#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002366#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2367#define SSL_CERTIFICATE_REQUEST_SKIP 1
2368/* Coordination:
2369 * Check whether a CertificateRequest message should be written.
2370 * Returns a negative code on failure, or
2371 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2372 * - SSL_CERTIFICATE_REQUEST_SKIP
2373 * indicating if the writing of the CertificateRequest
2374 * should be skipped or not.
2375 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002376MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002377static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002378{
2379 int authmode;
2380
XiaokangQian40a35232022-05-07 09:02:40 +00002381#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002383 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002384 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002385#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002386 authmode = ssl->conf->authmode;
2387
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002389 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002390 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002391 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002392
XiaokangQianc3017f62022-05-13 05:55:41 +00002393 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002396}
2397
XiaokangQiancec9ae62022-05-06 07:28:50 +00002398/*
2399 * struct {
2400 * opaque certificate_request_context<0..2^8-1>;
2401 * Extension extensions<2..2^16-1>;
2402 * } CertificateRequest;
2403 *
2404 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002405MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002406static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2407 unsigned char *buf,
2408 const unsigned char *end,
2409 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002410{
2411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2412 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002413 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002414 unsigned char *p_extensions_len;
2415
2416 *out_len = 0;
2417
2418 /* Check if we have enough space:
2419 * - certificate_request_context (1 byte)
2420 * - extensions length (2 bytes)
2421 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002423
2424 /*
2425 * Write certificate_request_context
2426 */
2427 /*
2428 * We use a zero length context for the normal handshake
2429 * messages. For post-authentication handshake messages
2430 * this request context would be set to a non-zero value.
2431 */
2432 *p++ = 0x0;
2433
2434 /*
2435 * Write extensions
2436 */
2437 /* The extensions must contain the signature_algorithms. */
2438 p_extensions_len = p;
2439 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2441 if (ret != 0) {
2442 return ret;
2443 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002444
XiaokangQianec6efb92022-05-06 09:53:10 +00002445 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002446 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002447
2448 *out_len = p - buf;
2449
Jerry Yu7de2ff02022-11-08 21:43:46 +08002450 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002451 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002454}
2455
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002456MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002457static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002458{
2459 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2460
Gilles Peskine449bd832023-01-11 14:50:10 +01002461 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002462
Gilles Peskine449bd832023-01-11 14:50:10 +01002463 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002466 unsigned char *buf;
2467 size_t buf_len, msg_len;
2468
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2470 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2471 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002472
Gilles Peskine449bd832023-01-11 14:50:10 +01002473 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2474 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002475
2476 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2480 ssl, buf_len, msg_len));
2481 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2482 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002483 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 } else {
2485 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002486 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2487 goto cleanup;
2488 }
2489
Gilles Peskine449bd832023-01-11 14:50:10 +01002490 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002491cleanup:
2492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2494 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002495}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002496
Jerry Yu4d3841a2022-04-16 12:37:19 +08002497/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002498 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002499 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002500MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002501static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002502{
Jerry Yu5a26f302022-05-10 20:46:40 +08002503 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002504
2505#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2507 mbedtls_ssl_own_cert(ssl) == NULL) {
2508 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2509 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2510 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2511 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002512 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002513#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2516 if (ret != 0) {
2517 return ret;
2518 }
2519 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2520 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002521}
2522
2523/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002524 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002525 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002526MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002527static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002528{
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2530 if (ret != 0) {
2531 return ret;
2532 }
2533 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2534 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002535}
Ronald Cron928cbd32022-10-04 16:14:26 +02002536#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002537
2538/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002539 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002540 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002541MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002542static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002543{
Jerry Yud6e253d2022-05-18 13:59:24 +08002544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2547 if (ret != 0) {
2548 return ret;
2549 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2552 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002553 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002554 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2555 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2556 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002557 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002558
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2560 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002561
Gilles Peskine449bd832023-01-11 14:50:10 +01002562 if (ssl->handshake->certificate_request_sent) {
2563 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2564 } else {
2565 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2566 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2567 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002568 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002571}
2572
2573/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002574 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002575 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002576MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002577static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002578{
Jerry Yud6e253d2022-05-18 13:59:24 +08002579 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2582 if (ret != 0) {
2583 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002584 }
2585
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2587 if (ret != 0) {
2588 MBEDTLS_SSL_DEBUG_RET(1,
2589 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2590 }
2591
2592 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2593 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002594}
2595
2596/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002597 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002598 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002599MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002600static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002601{
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002603
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002605
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002606#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2607 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002608/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2609 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2610 * expected to be resolved with issue#6395.
2611 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002612 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002613 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2614 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002615 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002616#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002617 {
2618 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2619 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002620 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002621}
2622
2623/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002624 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002625 */
2626#define SSL_NEW_SESSION_TICKET_SKIP 0
2627#define SSL_NEW_SESSION_TICKET_WRITE 1
2628MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002629static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002630{
2631 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002632 if (ssl->conf->f_ticket_write == NULL) {
2633 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2634 " callback is not set"));
2635 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002636 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if (ssl->conf->new_session_tickets_count == 0) {
2638 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2639 " configured count is zero"));
2640 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002641 }
2642
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 if (ssl->handshake->new_session_tickets_count == 0) {
2644 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2645 "been sent."));
2646 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002647 }
2648
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002650}
2651
2652#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2653MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002654static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2655 unsigned char *ticket_nonce,
2656 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002657{
2658 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2659 mbedtls_ssl_session *session = ssl->session;
2660 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2661 psa_algorithm_t psa_hash_alg;
2662 int hash_length;
2663
Gilles Peskine449bd832023-01-11 14:50:10 +01002664 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002665
2666#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002668#endif
2669
Pengyu Lv9f926952022-11-17 15:22:33 +08002670 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002671 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002672 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002673#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002674 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002675 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002676#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002677 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002678
Jerry Yue67bef42022-07-07 07:29:42 +00002679 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002680 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2681 (unsigned char *) &session->ticket_age_add,
2682 sizeof(session->ticket_age_add)) != 0)) {
2683 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2684 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002685 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2687 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002688
2689 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2691 if (ret != 0) {
2692 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2693 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002694 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002695 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2696 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002697
2698 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2700 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2701 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2702 if (hash_length == -1 ||
2703 (size_t) hash_length > sizeof(session->resumption_key)) {
2704 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002705 }
2706
Jerry Yue67bef42022-07-07 07:29:42 +00002707 /* In this code the psk key length equals the length of the hash */
2708 session->resumption_key_len = hash_length;
2709 session->ciphersuite = ciphersuite_info->id;
2710
2711 /* Compute resumption key
2712 *
2713 * HKDF-Expand-Label( resumption_master_secret,
2714 * "resumption", ticket_nonce, Hash.length )
2715 */
2716 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 psa_hash_alg,
2718 session->app_secrets.resumption_master_secret,
2719 hash_length,
2720 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2721 ticket_nonce,
2722 ticket_nonce_size,
2723 session->resumption_key,
2724 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002725
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 if (ret != 0) {
2727 MBEDTLS_SSL_DEBUG_RET(2,
2728 "Creating the ticket-resumed PSK failed",
2729 ret);
2730 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2733 session->resumption_key,
2734 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002735
Gilles Peskine449bd832023-01-11 14:50:10 +01002736 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2737 session->app_secrets.resumption_master_secret,
2738 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002739
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002741}
2742
2743/* This function creates a NewSessionTicket message in the following format:
2744 *
2745 * struct {
2746 * uint32 ticket_lifetime;
2747 * uint32 ticket_age_add;
2748 * opaque ticket_nonce<0..255>;
2749 * opaque ticket<1..2^16-1>;
2750 * Extension extensions<0..2^16-2>;
2751 * } NewSessionTicket;
2752 *
2753 * The ticket inside the NewSessionTicket message is an encrypted container
2754 * carrying the necessary information so that the server is later able to
2755 * re-start the communication.
2756 *
2757 * The following fields are placed inside the ticket by the
2758 * f_ticket_write() function:
2759 *
2760 * - creation time (start)
2761 * - flags (flags)
2762 * - age add (ticket_age_add)
2763 * - key (key)
2764 * - key length (key_len)
2765 * - ciphersuite (ciphersuite)
2766 */
2767MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002768static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2769 unsigned char *buf,
2770 unsigned char *end,
2771 size_t *out_len,
2772 unsigned char *ticket_nonce,
2773 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002774{
2775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2776 unsigned char *p = buf;
2777 mbedtls_ssl_session *session = ssl->session;
2778 size_t ticket_len;
2779 uint32_t ticket_lifetime;
2780
2781 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002783
2784 /*
2785 * ticket_lifetime 4 bytes
2786 * ticket_age_add 4 bytes
2787 * ticket_nonce 1 + ticket_nonce_size bytes
2788 * ticket >=2 bytes
2789 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002791
2792 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2794 session,
2795 p + 9 + ticket_nonce_size + 2,
2796 end,
2797 &ticket_len,
2798 &ticket_lifetime);
2799 if (ret != 0) {
2800 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2801 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002802 }
2803 /* RFC 8446 4.6.1
2804 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2805 * unsigned integer in network byte order from the time of ticket
2806 * issuance. Servers MUST NOT use any value greater than
2807 * 604800 seconds (7 days). The value of zero indicates that the
2808 * ticket should be discarded immediately. Clients MUST NOT cache
2809 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2810 * and MAY delete tickets earlier based on local policy. A server
2811 * MAY treat a ticket as valid for a shorter period of time than what
2812 * is stated in the ticket_lifetime.
2813 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002815 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 }
2817 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2818 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2819 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002820
2821 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2823 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2824 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002825
2826 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 p[8] = (unsigned char) ticket_nonce_size;
2828 if (ticket_nonce_size > 0) {
2829 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002830 }
2831 p += 9 + ticket_nonce_size;
2832
2833 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002835 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002837 p += ticket_len;
2838
2839 /* Ticket Extensions
2840 *
2841 * Note: We currently don't have any extensions.
2842 * Set length to zero.
2843 */
Jerry Yuedab6372022-10-31 14:37:31 +08002844 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2845
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2847 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002848 p += 2;
2849
2850 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2852 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002853
Jerry Yu7de2ff02022-11-08 21:43:46 +08002854 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002855 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002858}
2859
2860/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002861 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002862 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002863static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002864{
2865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2866
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002868
Gilles Peskine449bd832023-01-11 14:50:10 +01002869 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002870 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2871 unsigned char *buf;
2872 size_t buf_len, msg_len;
2873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2875 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2878 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2879 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2882 ssl, buf, buf + buf_len, &msg_len,
2883 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2886 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002887
Jerry Yu359e65f2022-09-22 23:47:43 +08002888 /* Limit session tickets count to one when resumption connection.
2889 *
2890 * See document of mbedtls_ssl_conf_new_session_tickets.
2891 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002892 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002893 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002895 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002896 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002897
Jerry Yua8d3c502022-10-30 14:51:23 +08002898 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2900 } else {
2901 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002902 }
2903
Jerry Yue67bef42022-07-07 07:29:42 +00002904cleanup:
2905
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002907}
2908#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2909
2910/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002911 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002912 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002913int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002914{
XiaokangQian08037552022-04-20 07:16:41 +00002915 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002916
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2918 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2919 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2922 mbedtls_ssl_states_str(ssl->state),
2923 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002926 /* start state */
2927 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002928 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002929 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002930 break;
2931
XiaokangQian7807f9f2022-02-15 10:04:37 +00002932 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 ret = ssl_tls13_process_client_hello(ssl);
2934 if (ret != 0) {
2935 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2936 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002937 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002938
Jerry Yuf41553b2022-05-09 22:20:30 +08002939 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 ret = ssl_tls13_write_hello_retry_request(ssl);
2941 if (ret != 0) {
2942 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2943 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002944 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002945 break;
2946
Jerry Yu5b64ae92022-03-30 17:15:02 +08002947 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002949 break;
2950
Xiaofei Baicba64af2022-02-15 10:00:56 +00002951 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 ret = ssl_tls13_write_encrypted_extensions(ssl);
2953 if (ret != 0) {
2954 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2955 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002956 }
Jerry Yu48330562022-05-06 21:35:44 +08002957 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002958
Ronald Cron928cbd32022-10-04 16:14:26 +02002959#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002960 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002962 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002963
Jerry Yu83da34e2022-04-16 13:59:52 +08002964 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002966 break;
2967
2968 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002970 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002971#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002972
Gilles Peskine449bd832023-01-11 14:50:10 +01002973 /*
2974 * Injection of dummy-CCS's for middlebox compatibility
2975 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002976#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002977 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2979 if (ret == 0) {
2980 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2981 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002982 break;
2983
2984 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2986 if (ret == 0) {
2987 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2988 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002989 break;
2990#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2991
Jerry Yu69dd8d42022-04-16 12:51:26 +08002992 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002994 break;
2995
2996 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002998 break;
2999
Jerry Yu69dd8d42022-04-16 12:51:26 +08003000 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003002 break;
3003
Ronald Cron766c0cd2022-10-18 12:17:11 +02003004#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003005 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3007 if (ret == 0) {
3008 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003009 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3011 } else {
3012 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003013 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003015 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003016 }
3017 break;
3018
3019 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3021 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003022 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003024 }
3025 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003026#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003027
Jerry Yue67bef42022-07-07 07:29:42 +00003028#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003029 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003030 ret = ssl_tls13_write_new_session_ticket(ssl);
3031 if (ret != 0) {
3032 MBEDTLS_SSL_DEBUG_RET(1,
3033 "ssl_tls13_write_new_session_ticket ",
3034 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003035 }
3036 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003037 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003038 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003039 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003040 * as part of ssl_prepare_handshake_step.
3041 */
3042 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 if (ssl->handshake->new_session_tickets_count == 0) {
3045 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3046 } else {
3047 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3048 }
Jerry Yue67bef42022-07-07 07:29:42 +00003049 break;
3050
3051#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3052
XiaokangQian7807f9f2022-02-15 10:04:37 +00003053 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3055 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003056 }
3057
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003059}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003060
Jerry Yufb4b6472022-01-27 15:03:26 +08003061#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */