blob: 90869d6c3ae55df886ea1daa8f06415628a3cf9f [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)
Pengyu Lvdadeb202023-01-18 17:32:34 +0800985 return !ssl->handshake->resume &&
986 mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800988#else
989 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800991#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000992}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000993
Jerry Yu77f01482022-07-11 07:03:24 +0000994MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100995static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000996{
Jerry Yue5991322022-11-07 14:03:44 +0800997#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Pengyu Lv0b740bc2023-01-18 17:02:52 +0800998#if defined(MBEDTLS_SSL_SESSION_TICKETS)
999 if (ssl->handshake->resume) {
1000 if (!mbedtls_ssl_session_get_ticket_flags(
1001 ssl->session_negotiate,
1002 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK)) {
1003 return 0;
1004 }
1005 }
1006#endif
1007
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1009 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1010 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001011#else
1012 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001014#endif
1015}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001016
Jerry Yu77f01482022-07-11 07:03:24 +00001017MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001018static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001019{
Jerry Yue5991322022-11-07 14:03:44 +08001020#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Pengyu Lv0b740bc2023-01-18 17:02:52 +08001021#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1022 if (ssl->handshake->resume) {
1023 if (!mbedtls_ssl_session_get_ticket_flags(
1024 ssl->session_negotiate,
1025 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)) {
1026 return 0;
1027 }
1028 }
1029#endif
1030
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1032 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1033 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001034#else
1035 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001037#endif
1038}
1039
Gilles Peskine449bd832023-01-11 14:50:10 +01001040static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001041{
1042 /*
1043 * Determine the key exchange algorithm to use.
1044 * There are three types of key exchanges supported in TLS 1.3:
1045 * - (EC)DH with ECDSA,
1046 * - (EC)DH with PSK,
1047 * - plain PSK.
1048 *
1049 * The PSK-based key exchanges may additionally be used with 0-RTT.
1050 *
1051 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001052 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1053 * 2 ) Certificate Mode ( ephemeral )
1054 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001055 */
1056
1057 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1058
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001060 ssl->handshake->key_exchange_mode =
1061 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1063 } else
1064 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001065 ssl->handshake->key_exchange_mode =
1066 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1068 } else
1069 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001070 ssl->handshake->key_exchange_mode =
1071 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1073 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001074 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 1,
1076 ("ClientHello message misses mandatory extensions."));
1077 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1078 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1079 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001080 }
1081
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001083
XiaokangQian7807f9f2022-02-15 10:04:37 +00001084}
1085
XiaokangQian81802f42022-06-10 13:25:22 +00001086#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001087 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001088
1089#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001091{
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001097 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001099 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001101 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001103 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001105 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001107 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001109 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001111 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001113 }
1114}
1115#endif /* MBEDTLS_USE_PSA_CRYPTO */
1116
XiaokangQian23c5be62022-06-07 02:04:34 +00001117/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001118 * Pick best ( private key, certificate chain ) pair based on the signature
1119 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001120 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001121MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001122static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001123{
XiaokangQianfb665a82022-06-15 03:57:21 +00001124 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001125 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001126
1127#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001129 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001131#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (key_cert_list == NULL) {
1135 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1136 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001137 }
1138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1140 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001141 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001145 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001147
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 for (key_cert = key_cert_list; key_cert != NULL;
1149 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001150#if defined(MBEDTLS_USE_PSA_CRYPTO)
1151 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1152#endif /* MBEDTLS_USE_PSA_CRYPTO */
1153
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1155 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001156
1157 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 * This avoids sending the client a cert it'll reject based on
1159 * keyUsage or other extensions.
1160 */
1161 if (mbedtls_x509_crt_check_key_usage(
1162 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001163 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001164 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1166 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1167 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001168 continue;
1169 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 MBEDTLS_SSL_DEBUG_MSG(3,
1172 ("ssl_tls13_pick_key_cert:"
1173 "check signature algorithm %s [%04x]",
1174 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1175 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001176#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001178#endif /* MBEDTLS_USE_PSA_CRYPTO */
1179
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1181 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001182#if defined(MBEDTLS_USE_PSA_CRYPTO)
1183 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001184 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1185 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001186#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001188 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 MBEDTLS_SSL_DEBUG_MSG(3,
1190 ("ssl_tls13_pick_key_cert:"
1191 "selected signature algorithm"
1192 " %s [%04x]",
1193 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1194 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001195 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 3, "selected certificate (chain)",
1197 ssl->handshake->key_cert->cert);
1198 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001199 }
XiaokangQian81802f42022-06-10 13:25:22 +00001200 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001201 }
1202
Gilles Peskine449bd832023-01-11 14:50:10 +01001203 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1204 "no suitable certificate found"));
1205 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001206}
XiaokangQian81802f42022-06-10 13:25:22 +00001207#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001208 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001209
XiaokangQian4080a7f2022-04-11 09:55:18 +00001210/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001211 *
1212 * STATE HANDLING: ClientHello
1213 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001214 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001215 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001216 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001217 *
1218 * In this case, the server progresses to sending its ServerHello.
1219 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001220 * 2) The ClientHello was well-formed but didn't match the server's
1221 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001222 *
1223 * For example, the client might not have offered a key share which
1224 * the server supports, or the server might require a cookie.
1225 *
1226 * In this case, the server sends a HelloRetryRequest.
1227 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001228 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001229 *
1230 * In this case, we abort the handshake.
1231 *
1232 */
1233
1234/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001235 * Structure of this message:
1236 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001237 * uint16 ProtocolVersion;
1238 * opaque Random[32];
1239 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001240 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001241 * struct {
1242 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1243 * Random random;
1244 * opaque legacy_session_id<0..32>;
1245 * CipherSuite cipher_suites<2..2^16-2>;
1246 * opaque legacy_compression_methods<1..2^8-1>;
1247 * Extension extensions<8..2^16-1>;
1248 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001249 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001250
1251#define SSL_CLIENT_HELLO_OK 0
1252#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1253
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001254MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001255static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1256 const unsigned char *buf,
1257 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258{
XiaokangQianb67384d2022-04-19 00:02:38 +00001259 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1260 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001261 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001262 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001263 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001264 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001265 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001266 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001267 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001268
Ronald Cron41a443a2022-10-04 16:38:25 +02001269#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001270 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001271 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001272 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001273#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274
XiaokangQian7807f9f2022-02-15 10:04:37 +00001275 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001276 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001277 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001278 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001279 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001280 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001281 * .. . .. ciphersuite list length ( 2 bytes )
1282 * .. . .. ciphersuite list
1283 * .. . .. compression alg. list length ( 1 byte )
1284 * .. . .. compression alg. list
1285 * .. . .. extensions length ( 2 bytes, optional )
1286 * .. . .. extensions ( optional )
1287 */
1288
XiaokangQianb67384d2022-04-19 00:02:38 +00001289 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001290 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1292 * read at least up to session id length without worrying.
1293 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001295
1296 /* ...
1297 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1298 * ...
1299 * with ProtocolVersion defined as:
1300 * uint16 ProtocolVersion;
1301 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001302 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1303 MBEDTLS_SSL_VERSION_TLS1_2) {
1304 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1305 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1306 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1307 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308 }
1309 p += 2;
1310
1311 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001312 * Only support TLS 1.3 currently, temporarily set the version.
1313 */
XiaokangQiande333912022-04-20 08:49:42 +00001314 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001315
Jerry Yue67bef42022-07-07 07:29:42 +00001316#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1317 /* Store minor version for later use with ticket serialization. */
1318 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001319 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001320#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001321
Jerry Yuc1be19f2022-04-23 16:11:39 +08001322 /* ...
1323 * Random random;
1324 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001325 * with Random defined as:
1326 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001327 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001328 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1329 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001332 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001333
Jerry Yuc1be19f2022-04-23 16:11:39 +08001334 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001335 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001336 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001338 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001339 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1342 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1343 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001344 }
1345
XiaokangQian4080a7f2022-04-11 09:55:18 +00001346 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001347 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1348 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001349 /*
1350 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001351 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001352 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001356 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001357
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001359 p += 2;
1360
XiaokangQianb67384d2022-04-19 00:02:38 +00001361 /* Check we have enough data for the ciphersuite list, the legacy
1362 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001363 *
1364 * cipher_suites cipher_suites_len bytes
1365 * legacy_compression_methods 2 bytes
1366 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001367 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001369
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 /* ...
1371 * CipherSuite cipher_suites<2..2^16-2>;
1372 * ...
1373 * with CipherSuite defined as:
1374 * uint8 CipherSuite[2];
1375 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001376#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001377 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001378#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001379 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1381 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001382
1383 /*
1384 * Search for a matching ciphersuite
1385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001386 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001387 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001388 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001389
Gilles Peskine449bd832023-01-11 14:50:10 +01001390 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001391
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001393 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001394 ssl, cipher_suite);
1395 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001396 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001398
Jerry Yu5725f1c2022-08-21 17:27:16 +08001399 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001400 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1402 cipher_suite,
1403 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001404 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 if (handshake->ciphersuite_info == NULL) {
1407 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1408 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1409 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001410 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001411
XiaokangQian4080a7f2022-04-11 09:55:18 +00001412 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001413 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001414 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001415 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1417 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1418 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1419 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1420 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001421 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001422 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001423
Jerry Yuc1be19f2022-04-23 16:11:39 +08001424 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001425 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001426 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001427 * with Extension defined as:
1428 * struct {
1429 * ExtensionType extension_type;
1430 * opaque extension_data<0..2^16-1>;
1431 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001432 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001434 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001436 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001437
Gilles Peskine449bd832023-01-11 14:50:10 +01001438 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001439
Jerry Yu63a459c2022-10-31 13:38:40 +08001440 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001441
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001443 unsigned int extension_type;
1444 size_t extension_data_len;
1445 const unsigned char *extension_data_end;
1446
Jerry Yu0c354a22022-08-29 15:25:36 +08001447 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001448 *
1449 * The "pre_shared_key" extension MUST be the last extension in the
1450 * ClientHello (this facilitates implementation as described below).
1451 * Servers MUST check that it is the last extension and otherwise fail
1452 * the handshake with an "illegal_parameter" alert.
1453 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001455 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001457 MBEDTLS_SSL_PEND_FATAL_ALERT(
1458 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1460 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001461 }
1462
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1464 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1465 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001466 p += 4;
1467
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001469 extension_data_end = p + extension_data_len;
1470
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001471 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1473 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1474 if (ret != 0) {
1475 return ret;
1476 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001477
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001479#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1480 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001481 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1482 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1483 extension_data_end);
1484 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001485 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001486 1, "mbedtls_ssl_parse_servername_ext", ret);
1487 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001488 }
XiaokangQian40a35232022-05-07 09:02:40 +00001489 break;
1490#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1491
XiaokangQianb67384d2022-04-19 00:02:38 +00001492#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001493 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001495
1496 /* Supported Groups Extension
1497 *
1498 * When sent by the client, the "supported_groups" extension
1499 * indicates the named groups which the client supports,
1500 * ordered from most preferred to least preferred.
1501 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001502 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 ssl, p, extension_data_end);
1504 if (ret != 0) {
1505 MBEDTLS_SSL_DEBUG_RET(1,
1506 "mbedtls_ssl_parse_supported_groups_ext", ret);
1507 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001508 }
1509
XiaokangQian7807f9f2022-02-15 10:04:37 +00001510 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001511#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001512
XiaokangQian88408882022-04-02 10:15:03 +00001513#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001514 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001516
1517 /*
1518 * Key Share Extension
1519 *
1520 * When sent by the client, the "key_share" extension
1521 * contains the endpoint's cryptographic parameters for
1522 * ECDHE/DHE key establishment methods.
1523 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001524 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 ssl, p, extension_data_end);
1526 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1527 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001528 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001529 }
1530
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001532 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 1, "ssl_tls13_parse_key_shares_ext", ret);
1534 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001535 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001536
XiaokangQian7807f9f2022-02-15 10:04:37 +00001537 break;
XiaokangQian88408882022-04-02 10:15:03 +00001538#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001539
1540 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001541 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001542
1543 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 ssl, p, extension_data_end);
1545 if (ret != 0) {
1546 MBEDTLS_SSL_DEBUG_RET(1,
1547 ("ssl_tls13_parse_supported_versions_ext"), ret);
1548 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001549 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001550 break;
1551
Ronald Cron41a443a2022-10-04 16:38:25 +02001552#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001553 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001555
1556 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 ssl, p, extension_data_end);
1558 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001559 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1561 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001562 }
1563
Jerry Yue19e3b92022-07-08 12:04:51 +00001564 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001565#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001566
Jerry Yu1c105562022-07-10 06:32:38 +00001567 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1569 if ((handshake->received_extensions &
1570 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001571 MBEDTLS_SSL_PEND_FATAL_ALERT(
1572 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001573 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1574 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001575 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001576#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001577 /* Delay processing of the PSK identity once we have
1578 * found out which algorithms to use. We keep a pointer
1579 * to the buffer and the size for later processing.
1580 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001581 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001582 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001583#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001584 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001585
XiaokangQianacb39922022-06-17 10:18:48 +00001586#if defined(MBEDTLS_SSL_ALPN)
1587 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1591 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001592 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1594 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001595 }
XiaokangQianacb39922022-06-17 10:18:48 +00001596 break;
1597#endif /* MBEDTLS_SSL_ALPN */
1598
Ronald Cron928cbd32022-10-04 16:14:26 +02001599#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001600 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001602
Gabor Mezei078e8032022-04-27 21:17:56 +02001603 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 ssl, p, extension_data_end);
1605 if (ret != 0) {
1606 MBEDTLS_SSL_DEBUG_MSG(1,
1607 (
1608 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1609 ret));
1610 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001611 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001612 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001613#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001614
1615 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001616 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001617 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001619 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001620 }
1621
1622 p += extension_data_len;
1623 }
1624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1626 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1629 MBEDTLS_SSL_HS_CLIENT_HELLO,
1630 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001631
Ronald Cron41a443a2022-10-04 16:38:25 +02001632#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001633 /* Update checksum with either
1634 * - The entire content of the CH message, if no PSK extension is present
1635 * - The content up to but excluding the PSK extension, if present.
1636 */
Jerry Yu1c105562022-07-10 06:32:38 +00001637 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1639 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1640 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1641 handshake->update_checksum(ssl, buf,
1642 pre_shared_key_ext - buf);
1643 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1644 pre_shared_key_ext,
1645 pre_shared_key_ext_end,
1646 cipher_suites,
1647 cipher_suites_end);
1648 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1649 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1650 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001651 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1653 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001654 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001656#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001657 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001659 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1662 if (ret < 0) {
1663 return ret;
1664 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001665
Gilles Peskine449bd832023-01-11 14:50:10 +01001666 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001667
Gilles Peskine449bd832023-01-11 14:50:10 +01001668 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001669}
1670
1671/* Update the handshake state machine */
1672
Ronald Cronce7d76e2022-07-08 18:56:49 +02001673MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001674static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001675{
1676 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1677
XiaokangQian7807f9f2022-02-15 10:04:37 +00001678 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001679 * Server certificate selection
1680 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1682 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1683 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001684 }
1685#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1686 ssl->handshake->sni_name = NULL;
1687 ssl->handshake->sni_name_len = 0;
1688#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1691 if (ret != 0) {
1692 MBEDTLS_SSL_DEBUG_RET(1,
1693 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1694 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001695 }
1696
Gilles Peskine449bd832023-01-11 14:50:10 +01001697 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001698
1699}
1700
1701/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001702 * Main entry point from the state machine; orchestrates the otherfunctions.
1703 */
1704
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001705MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001706static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001707{
1708
XiaokangQian08037552022-04-20 07:16:41 +00001709 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001711 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001712 int parse_client_hello_ret;
1713
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001715
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1717 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1718 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1721 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001722 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1723 * only SSL_CLIENT_HELLO_OK or
1724 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1725 * stage as negative error codes are handled
1726 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001729
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1731 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1732 } else {
1733 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1734 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001735
1736cleanup:
1737
Gilles Peskine449bd832023-01-11 14:50:10 +01001738 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1739 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001740}
1741
1742/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001743 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001744 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001745MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001746static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001747{
Jerry Yu637a3f12022-04-20 21:37:58 +08001748 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1749 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1751 if (ssl->conf->f_rng == NULL) {
1752 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1753 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001754 }
1755
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1757 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1758 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1759 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001760 }
1761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1763 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001764
1765#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001767#endif /* MBEDTLS_HAVE_TIME */
1768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001770}
1771
Jerry Yu3bf2c642022-03-30 22:02:12 +08001772/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001773 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001774 *
1775 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001776 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001777 * } SupportedVersions;
1778 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001779MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001780static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 mbedtls_ssl_context *ssl,
1782 unsigned char *buf,
1783 unsigned char *end,
1784 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001785{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001786 *out_len = 0;
1787
Gilles Peskine449bd832023-01-11 14:50:10 +01001788 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001789
1790 /* Check if we have space to write the extension:
1791 * - extension_type (2 bytes)
1792 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001793 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001794 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001796
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001800
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 mbedtls_ssl_write_version(buf + 4,
1802 ssl->conf->transport,
1803 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001804
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1806 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001807
Jerry Yu349a6132022-04-14 20:52:56 +08001808 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001809
Jerry Yub95dd362022-11-08 21:19:34 +08001810 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001811 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001814}
1815
Jerry Yud9436a12022-04-20 22:28:09 +08001816
Jerry Yu3bf2c642022-03-30 22:02:12 +08001817
1818/* Generate and export a single key share. For hybrid KEMs, this can
1819 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001820MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001821static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1822 uint16_t named_group,
1823 unsigned char *buf,
1824 unsigned char *end,
1825 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001826{
1827 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001828
1829 *out_len = 0;
1830
Jerry Yu89e103c2022-03-30 22:43:29 +08001831#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001832 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001833 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001834 ssl, named_group, buf, end, out_len);
1835 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001836 MBEDTLS_SSL_DEBUG_RET(
1837 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 ret);
1839 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001840 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001842#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001843 if (0 /* Other kinds of KEMs */) {
1844 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001845 ((void) ssl);
1846 ((void) named_group);
1847 ((void) buf);
1848 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1850 }
1851
Gilles Peskine449bd832023-01-11 14:50:10 +01001852 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853}
1854
1855/*
1856 * ssl_tls13_write_key_share_ext
1857 *
1858 * Structure of key_share extension in ServerHello:
1859 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001860 * struct {
1861 * NamedGroup group;
1862 * opaque key_exchange<1..2^16-1>;
1863 * } KeyShareEntry;
1864 * struct {
1865 * KeyShareEntry server_share;
1866 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001867 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001868MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001869static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1870 unsigned char *buf,
1871 unsigned char *end,
1872 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001873{
Jerry Yu955ddd72022-04-22 22:27:33 +08001874 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001875 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001876 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001877 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001878 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001879
1880 *out_len = 0;
1881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1885 mbedtls_ssl_named_group_to_str(group),
1886 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001887
Jerry Yu3bf2c642022-03-30 22:02:12 +08001888 /* Check if we have space for header and length fields:
1889 * - extension_type (2 bytes)
1890 * - extension_data_length (2 bytes)
1891 * - group (2 bytes)
1892 * - key_exchange_length (2 bytes)
1893 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1895 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1896 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001897 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001898
Jerry Yu3bf2c642022-03-30 22:02:12 +08001899 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1900 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001901 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 ssl, group, server_share + 4, end, &key_exchange_length);
1903 if (ret != 0) {
1904 return ret;
1905 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001906 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001907
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001909
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001911
Jerry Yu57d48412022-04-20 21:50:42 +08001912 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001917}
Jerry Yud9436a12022-04-20 22:28:09 +08001918
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001919MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001920static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1921 unsigned char *buf,
1922 unsigned char *end,
1923 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001924{
1925 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1926 /* key_share Extension
1927 *
1928 * struct {
1929 * select (Handshake.msg_type) {
1930 * ...
1931 * case hello_retry_request:
1932 * NamedGroup selected_group;
1933 * ...
1934 * };
1935 * } KeyShare;
1936 */
1937
1938 *out_len = 0;
1939
Jerry Yub0ac10b2022-05-05 11:10:08 +08001940 /*
1941 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1942 * of the HRR is then to transmit a cookie to force the client to demonstrate
1943 * reachability at their apparent network address (primarily useful for DTLS).
1944 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1946 return 0;
1947 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001948
1949 /* We should only send the key_share extension if the client's initial
1950 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001951 if (ssl->handshake->offered_group_id != 0) {
1952 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1953 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001954 }
1955
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 if (selected_group == 0) {
1957 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1958 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001959 }
1960
Jerry Yub0ac10b2022-05-05 11:10:08 +08001961 /* Check if we have enough space:
1962 * - extension_type (2 bytes)
1963 * - extension_data_length (2 bytes)
1964 * - selected_group (2 bytes)
1965 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1969 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1970 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 MBEDTLS_SSL_DEBUG_MSG(3,
1973 ("HRR selected_group: %s (%x)",
1974 mbedtls_ssl_named_group_to_str(selected_group),
1975 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001976
1977 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001978
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001980
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001982}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001983
1984/*
1985 * Structure of ServerHello message:
1986 *
1987 * struct {
1988 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1989 * Random random;
1990 * opaque legacy_session_id_echo<0..32>;
1991 * CipherSuite cipher_suite;
1992 * uint8 legacy_compression_method = 0;
1993 * Extension extensions<6..2^16-1>;
1994 * } ServerHello;
1995 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001996MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001997static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1998 unsigned char *buf,
1999 unsigned char *end,
2000 size_t *out_len,
2001 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002002{
Jerry Yu955ddd72022-04-22 22:27:33 +08002003 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002004 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002005 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002006 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002007
2008 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002009 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002010
Jerry Yucfc04b32022-04-21 09:31:58 +08002011 /* ...
2012 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2013 * ...
2014 * with ProtocolVersion defined as:
2015 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2018 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002019 p += 2;
2020
Jerry Yu1c3e6882022-04-20 21:23:40 +08002021 /* ...
2022 * Random random;
2023 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002024 * with Random defined as:
2025 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002026 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2028 if (is_hrr) {
2029 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2030 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2031 } else {
2032 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2033 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002034 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2036 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002037 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2038
Jerry Yucfc04b32022-04-21 09:31:58 +08002039 /* ...
2040 * opaque legacy_session_id_echo<0..32>;
2041 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002042 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002043 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2044 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2045 if (ssl->session_negotiate->id_len > 0) {
2046 memcpy(p, &ssl->session_negotiate->id[0],
2047 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002048 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2051 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002052 }
2053
Jerry Yucfc04b32022-04-21 09:31:58 +08002054 /* ...
2055 * CipherSuite cipher_suite;
2056 * ...
2057 * with CipherSuite defined as:
2058 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002059 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2061 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002062 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 MBEDTLS_SSL_DEBUG_MSG(3,
2064 ("server hello, chosen ciphersuite: %s ( id=%d )",
2065 mbedtls_ssl_get_ciphersuite_name(
2066 ssl->session_negotiate->ciphersuite),
2067 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002068
Jerry Yucfc04b32022-04-21 09:31:58 +08002069 /* ...
2070 * uint8 legacy_compression_method = 0;
2071 * ...
2072 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002074 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002075
Jerry Yucfc04b32022-04-21 09:31:58 +08002076 /* ...
2077 * Extension extensions<6..2^16-1>;
2078 * ...
2079 * struct {
2080 * ExtensionType extension_type; (2 bytes)
2081 * opaque extension_data<0..2^16-1>;
2082 * } Extension;
2083 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002085 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002086 p += 2;
2087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2089 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002090 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2092 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002093 }
2094 p += output_len;
2095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2097 if (is_hrr) {
2098 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2099 } else {
2100 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2101 }
2102 if (ret != 0) {
2103 return ret;
2104 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002105 p += output_len;
2106 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002107
Ronald Cron41a443a2022-10-04 16:38:25 +02002108#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002109 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2110 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2111 if (ret != 0) {
2112 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2113 ret);
2114 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002115 }
2116 p += output_len;
2117 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002118#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2123 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002124
Jerry Yud9436a12022-04-20 22:28:09 +08002125 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002128
Jerry Yu7de2ff02022-11-08 21:43:46 +08002129 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002130 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 MBEDTLS_SSL_HS_SERVER_HELLO,
2132 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002133
Gilles Peskine449bd832023-01-11 14:50:10 +01002134 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002135}
2136
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002137MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002138static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002139{
2140 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2142 if (ret != 0) {
2143 MBEDTLS_SSL_DEBUG_RET(1,
2144 "mbedtls_ssl_tls13_compute_handshake_transform",
2145 ret);
2146 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002147 }
2148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002150}
2151
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002152MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002153static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002154{
Jerry Yu637a3f12022-04-20 21:37:58 +08002155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002156 unsigned char *buf;
2157 size_t buf_len, msg_len;
2158
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002162
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2164 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2165 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002166
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2168 buf + buf_len,
2169 &msg_len,
2170 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002171
Jerry Yu3bf2c642022-03-30 22:02:12 +08002172 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002173 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002174
Gilles Peskine449bd832023-01-11 14:50:10 +01002175 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2176 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002177
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002179
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002180#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2181 /* The server sends a dummy change_cipher_spec record immediately
2182 * after its first handshake message. This may either be after
2183 * a ServerHello or a HelloRetryRequest.
2184 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002185 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002187#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002189#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002190
Jerry Yuf4b27e42022-03-30 17:32:21 +08002191cleanup:
2192
Gilles Peskine449bd832023-01-11 14:50:10 +01002193 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2194 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002195}
2196
Jerry Yu23d1a252022-05-12 18:08:59 +08002197
2198/*
2199 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2200 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002201MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002202static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002203{
2204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 if (ssl->handshake->hello_retry_request_count > 0) {
2206 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2207 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2208 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2209 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002210 }
2211
2212 /*
2213 * Create stateless transcript hash for HRR
2214 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2216 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2217 if (ret != 0) {
2218 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2219 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002220 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002224}
2225
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002226MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002227static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002228{
2229 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2230 unsigned char *buf;
2231 size_t buf_len, msg_len;
2232
Gilles Peskine449bd832023-01-11 14:50:10 +01002233 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002236
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2238 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2239 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002240
Gilles Peskine449bd832023-01-11 14:50:10 +01002241 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2242 buf + buf_len,
2243 &msg_len,
2244 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002245 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002247
2248
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2250 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002251
2252 ssl->handshake->hello_retry_request_count++;
2253
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002254#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2255 /* The server sends a dummy change_cipher_spec record immediately
2256 * after its first handshake message. This may either be after
2257 * a ServerHello or a HelloRetryRequest.
2258 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002259 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002261#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002263#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002264
2265cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2267 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002268}
2269
Jerry Yu5b64ae92022-03-30 17:15:02 +08002270/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002271 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2272 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002273
2274/*
2275 * struct {
2276 * Extension extensions<0..2 ^ 16 - 1>;
2277 * } EncryptedExtensions;
2278 *
2279 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002280MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002281static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2282 unsigned char *buf,
2283 unsigned char *end,
2284 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002285{
XiaokangQianacb39922022-06-17 10:18:48 +00002286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002287 unsigned char *p = buf;
2288 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002289 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002290 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002291
Jerry Yu4d3841a2022-04-16 12:37:19 +08002292 *out_len = 0;
2293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002295 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002296 p += 2;
2297
Jerry Yu8937eb42022-05-03 12:12:14 +08002298 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002299 ((void) ret);
2300 ((void) output_len);
2301
2302#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2304 if (ret != 0) {
2305 return ret;
2306 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002307 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002308#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 extensions_len = (p - p_extensions_len) - 2;
2311 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002312
2313 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002314
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002316
Jerry Yu7de2ff02022-11-08 21:43:46 +08002317 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002321}
2322
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002323MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002324static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002325{
2326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2327 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002328 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002329
Gilles Peskine449bd832023-01-11 14:50:10 +01002330 mbedtls_ssl_set_outbound_transform(ssl,
2331 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002332 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2338 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2339 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002340
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2342 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002343
2344 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002346
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2348 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002349
Ronald Cron928cbd32022-10-04 16:14:26 +02002350#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2352 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2353 } else {
2354 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2355 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002356#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002358#endif
2359
Jerry Yu4d3841a2022-04-16 12:37:19 +08002360cleanup:
2361
Gilles Peskine449bd832023-01-11 14:50:10 +01002362 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2363 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002364}
2365
Ronald Cron928cbd32022-10-04 16:14:26 +02002366#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002367#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2368#define SSL_CERTIFICATE_REQUEST_SKIP 1
2369/* Coordination:
2370 * Check whether a CertificateRequest message should be written.
2371 * Returns a negative code on failure, or
2372 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2373 * - SSL_CERTIFICATE_REQUEST_SKIP
2374 * indicating if the writing of the CertificateRequest
2375 * should be skipped or not.
2376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002377MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002378static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002379{
2380 int authmode;
2381
XiaokangQian40a35232022-05-07 09:02:40 +00002382#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002384 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002386#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002387 authmode = ssl->conf->authmode;
2388
Gilles Peskine449bd832023-01-11 14:50:10 +01002389 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002390 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002391 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002392 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002393
XiaokangQianc3017f62022-05-13 05:55:41 +00002394 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002395
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002397}
2398
XiaokangQiancec9ae62022-05-06 07:28:50 +00002399/*
2400 * struct {
2401 * opaque certificate_request_context<0..2^8-1>;
2402 * Extension extensions<2..2^16-1>;
2403 * } CertificateRequest;
2404 *
2405 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002406MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002407static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2408 unsigned char *buf,
2409 const unsigned char *end,
2410 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002411{
2412 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2413 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002414 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002415 unsigned char *p_extensions_len;
2416
2417 *out_len = 0;
2418
2419 /* Check if we have enough space:
2420 * - certificate_request_context (1 byte)
2421 * - extensions length (2 bytes)
2422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002423 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002424
2425 /*
2426 * Write certificate_request_context
2427 */
2428 /*
2429 * We use a zero length context for the normal handshake
2430 * messages. For post-authentication handshake messages
2431 * this request context would be set to a non-zero value.
2432 */
2433 *p++ = 0x0;
2434
2435 /*
2436 * Write extensions
2437 */
2438 /* The extensions must contain the signature_algorithms. */
2439 p_extensions_len = p;
2440 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2442 if (ret != 0) {
2443 return ret;
2444 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002445
XiaokangQianec6efb92022-05-06 09:53:10 +00002446 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002448
2449 *out_len = p - buf;
2450
Jerry Yu7de2ff02022-11-08 21:43:46 +08002451 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002455}
2456
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002457MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002458static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002459{
2460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2461
Gilles Peskine449bd832023-01-11 14:50:10 +01002462 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002467 unsigned char *buf;
2468 size_t buf_len, msg_len;
2469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2471 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2472 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002473
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2475 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002476
2477 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2481 ssl, buf_len, msg_len));
2482 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2483 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002484 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002485 } else {
2486 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002487 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2488 goto cleanup;
2489 }
2490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002492cleanup:
2493
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2495 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002496}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002497
Jerry Yu4d3841a2022-04-16 12:37:19 +08002498/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002499 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002500 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002501MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002502static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002503{
Jerry Yu5a26f302022-05-10 20:46:40 +08002504 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002505
2506#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2508 mbedtls_ssl_own_cert(ssl) == NULL) {
2509 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2510 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2511 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2512 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002513 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002514#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2517 if (ret != 0) {
2518 return ret;
2519 }
2520 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2521 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002522}
2523
2524/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002525 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002526 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002527MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002528static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002529{
Gilles Peskine449bd832023-01-11 14:50:10 +01002530 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2531 if (ret != 0) {
2532 return ret;
2533 }
2534 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2535 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002536}
Ronald Cron928cbd32022-10-04 16:14:26 +02002537#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002538
2539/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002540 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002541 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002542MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002543static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002544{
Jerry Yud6e253d2022-05-18 13:59:24 +08002545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2548 if (ret != 0) {
2549 return ret;
2550 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2553 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002554 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002555 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2556 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2557 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002558 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2561 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002562
Gilles Peskine449bd832023-01-11 14:50:10 +01002563 if (ssl->handshake->certificate_request_sent) {
2564 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2565 } else {
2566 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2567 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2568 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002569 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002572}
2573
2574/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002575 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002576 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002577MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002578static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002579{
Jerry Yud6e253d2022-05-18 13:59:24 +08002580 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2583 if (ret != 0) {
2584 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002585 }
2586
Gilles Peskine449bd832023-01-11 14:50:10 +01002587 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2588 if (ret != 0) {
2589 MBEDTLS_SSL_DEBUG_RET(1,
2590 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2591 }
2592
2593 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2594 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002595}
2596
2597/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002598 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002599 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002600MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002601static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002602{
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002604
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002606
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002607#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2608 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002609/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2610 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2611 * expected to be resolved with issue#6395.
2612 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002613 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002614 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2615 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002616 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002617#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002618 {
2619 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2620 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002621 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002622}
2623
2624/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002625 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002626 */
2627#define SSL_NEW_SESSION_TICKET_SKIP 0
2628#define SSL_NEW_SESSION_TICKET_WRITE 1
2629MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002630static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002631{
2632 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 if (ssl->conf->f_ticket_write == NULL) {
2634 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2635 " callback is not set"));
2636 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002637 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 if (ssl->conf->new_session_tickets_count == 0) {
2639 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2640 " configured count is zero"));
2641 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002642 }
2643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 if (ssl->handshake->new_session_tickets_count == 0) {
2645 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2646 "been sent."));
2647 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002648 }
2649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002651}
2652
2653#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2654MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002655static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2656 unsigned char *ticket_nonce,
2657 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002658{
2659 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2660 mbedtls_ssl_session *session = ssl->session;
2661 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2662 psa_algorithm_t psa_hash_alg;
2663 int hash_length;
2664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002666
2667#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002669#endif
2670
Pengyu Lv9f926952022-11-17 15:22:33 +08002671 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002672 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002673 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002674#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002675 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002676 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002677#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002678 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002679
Jerry Yue67bef42022-07-07 07:29:42 +00002680 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2682 (unsigned char *) &session->ticket_age_add,
2683 sizeof(session->ticket_age_add)) != 0)) {
2684 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2685 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002686 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002687 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2688 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002689
2690 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002691 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2692 if (ret != 0) {
2693 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2694 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002695 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2697 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002698
2699 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2701 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2702 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2703 if (hash_length == -1 ||
2704 (size_t) hash_length > sizeof(session->resumption_key)) {
2705 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002706 }
2707
Jerry Yue67bef42022-07-07 07:29:42 +00002708 /* In this code the psk key length equals the length of the hash */
2709 session->resumption_key_len = hash_length;
2710 session->ciphersuite = ciphersuite_info->id;
2711
2712 /* Compute resumption key
2713 *
2714 * HKDF-Expand-Label( resumption_master_secret,
2715 * "resumption", ticket_nonce, Hash.length )
2716 */
2717 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002718 psa_hash_alg,
2719 session->app_secrets.resumption_master_secret,
2720 hash_length,
2721 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2722 ticket_nonce,
2723 ticket_nonce_size,
2724 session->resumption_key,
2725 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 if (ret != 0) {
2728 MBEDTLS_SSL_DEBUG_RET(2,
2729 "Creating the ticket-resumed PSK failed",
2730 ret);
2731 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002732 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002733 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2734 session->resumption_key,
2735 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2738 session->app_secrets.resumption_master_secret,
2739 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002740
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002742}
2743
2744/* This function creates a NewSessionTicket message in the following format:
2745 *
2746 * struct {
2747 * uint32 ticket_lifetime;
2748 * uint32 ticket_age_add;
2749 * opaque ticket_nonce<0..255>;
2750 * opaque ticket<1..2^16-1>;
2751 * Extension extensions<0..2^16-2>;
2752 * } NewSessionTicket;
2753 *
2754 * The ticket inside the NewSessionTicket message is an encrypted container
2755 * carrying the necessary information so that the server is later able to
2756 * re-start the communication.
2757 *
2758 * The following fields are placed inside the ticket by the
2759 * f_ticket_write() function:
2760 *
2761 * - creation time (start)
2762 * - flags (flags)
2763 * - age add (ticket_age_add)
2764 * - key (key)
2765 * - key length (key_len)
2766 * - ciphersuite (ciphersuite)
2767 */
2768MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002769static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2770 unsigned char *buf,
2771 unsigned char *end,
2772 size_t *out_len,
2773 unsigned char *ticket_nonce,
2774 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002775{
2776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2777 unsigned char *p = buf;
2778 mbedtls_ssl_session *session = ssl->session;
2779 size_t ticket_len;
2780 uint32_t ticket_lifetime;
2781
2782 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002783 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002784
2785 /*
2786 * ticket_lifetime 4 bytes
2787 * ticket_age_add 4 bytes
2788 * ticket_nonce 1 + ticket_nonce_size bytes
2789 * ticket >=2 bytes
2790 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002792
2793 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2795 session,
2796 p + 9 + ticket_nonce_size + 2,
2797 end,
2798 &ticket_len,
2799 &ticket_lifetime);
2800 if (ret != 0) {
2801 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2802 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002803 }
2804 /* RFC 8446 4.6.1
2805 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2806 * unsigned integer in network byte order from the time of ticket
2807 * issuance. Servers MUST NOT use any value greater than
2808 * 604800 seconds (7 days). The value of zero indicates that the
2809 * ticket should be discarded immediately. Clients MUST NOT cache
2810 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2811 * and MAY delete tickets earlier based on local policy. A server
2812 * MAY treat a ticket as valid for a shorter period of time than what
2813 * is stated in the ticket_lifetime.
2814 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002816 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 }
2818 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2819 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2820 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002821
2822 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2824 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2825 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002826
2827 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 p[8] = (unsigned char) ticket_nonce_size;
2829 if (ticket_nonce_size > 0) {
2830 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002831 }
2832 p += 9 + ticket_nonce_size;
2833
2834 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002836 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002838 p += ticket_len;
2839
2840 /* Ticket Extensions
2841 *
2842 * Note: We currently don't have any extensions.
2843 * Set length to zero.
2844 */
Jerry Yuedab6372022-10-31 14:37:31 +08002845 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2848 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002849 p += 2;
2850
2851 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2853 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002854
Jerry Yu7de2ff02022-11-08 21:43:46 +08002855 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002859}
2860
2861/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002862 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002863 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002864static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002865{
2866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002869
Gilles Peskine449bd832023-01-11 14:50:10 +01002870 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002871 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2872 unsigned char *buf;
2873 size_t buf_len, msg_len;
2874
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2876 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2879 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2880 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2883 ssl, buf, buf + buf_len, &msg_len,
2884 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002885
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2887 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002888
Jerry Yu359e65f2022-09-22 23:47:43 +08002889 /* Limit session tickets count to one when resumption connection.
2890 *
2891 * See document of mbedtls_ssl_conf_new_session_tickets.
2892 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002894 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002895 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002896 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002898
Jerry Yua8d3c502022-10-30 14:51:23 +08002899 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2901 } else {
2902 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002903 }
2904
Jerry Yue67bef42022-07-07 07:29:42 +00002905cleanup:
2906
Gilles Peskine449bd832023-01-11 14:50:10 +01002907 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002908}
2909#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2910
2911/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002912 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002913 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002914int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002915{
XiaokangQian08037552022-04-20 07:16:41 +00002916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002917
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2919 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2920 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002921
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2923 mbedtls_ssl_states_str(ssl->state),
2924 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002925
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002927 /* start state */
2928 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002930 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002931 break;
2932
XiaokangQian7807f9f2022-02-15 10:04:37 +00002933 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002934 ret = ssl_tls13_process_client_hello(ssl);
2935 if (ret != 0) {
2936 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2937 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002938 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002939
Jerry Yuf41553b2022-05-09 22:20:30 +08002940 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002941 ret = ssl_tls13_write_hello_retry_request(ssl);
2942 if (ret != 0) {
2943 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2944 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002945 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002946 break;
2947
Jerry Yu5b64ae92022-03-30 17:15:02 +08002948 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002949 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002950 break;
2951
Xiaofei Baicba64af2022-02-15 10:00:56 +00002952 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 ret = ssl_tls13_write_encrypted_extensions(ssl);
2954 if (ret != 0) {
2955 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2956 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002957 }
Jerry Yu48330562022-05-06 21:35:44 +08002958 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002959
Ronald Cron928cbd32022-10-04 16:14:26 +02002960#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002961 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002962 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002963 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002964
Jerry Yu83da34e2022-04-16 13:59:52 +08002965 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002967 break;
2968
2969 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002971 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002972#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 /*
2975 * Injection of dummy-CCS's for middlebox compatibility
2976 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002977#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002978 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002979 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2980 if (ret == 0) {
2981 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2982 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002983 break;
2984
2985 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2987 if (ret == 0) {
2988 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2989 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002990 break;
2991#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2992
Jerry Yu69dd8d42022-04-16 12:51:26 +08002993 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002994 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002995 break;
2996
2997 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002998 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002999 break;
3000
Jerry Yu69dd8d42022-04-16 12:51:26 +08003001 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003003 break;
3004
Ronald Cron766c0cd2022-10-18 12:17:11 +02003005#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003006 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3008 if (ret == 0) {
3009 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003010 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3012 } else {
3013 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003014 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003016 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003017 }
3018 break;
3019
3020 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3022 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003023 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003025 }
3026 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003027#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003028
Jerry Yue67bef42022-07-07 07:29:42 +00003029#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003030 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 ret = ssl_tls13_write_new_session_ticket(ssl);
3032 if (ret != 0) {
3033 MBEDTLS_SSL_DEBUG_RET(1,
3034 "ssl_tls13_write_new_session_ticket ",
3035 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003036 }
3037 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003038 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003039 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003040 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003041 * as part of ssl_prepare_handshake_step.
3042 */
3043 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 if (ssl->handshake->new_session_tickets_count == 0) {
3046 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3047 } else {
3048 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3049 }
Jerry Yue67bef42022-07-07 07:29:42 +00003050 break;
3051
3052#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3053
XiaokangQian7807f9f2022-02-15 10:04:37 +00003054 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003055 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3056 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003057 }
3058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003060}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003061
Jerry Yufb4b6472022-01-27 15:03:26 +08003062#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */