blob: 6f8973e7305180fec632d7b97109de1e035f6a9c [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800164 /* RFC 8446 section 4.2.9
165 *
166 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
167 * compatible with the advertised modes; however, if a server does so,
168 * the impact will just be that the client's attempts at resumption fail.
169 *
170 * We regard the ticket with incompatible key exchange modes as not match.
171 */
Pengyu Lv76679682023-02-02 15:04:27 +0800172 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
173 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
174 session->ticket_flags);
175 if (mbedtls_ssl_tls13_check_kex_modes(
176 ssl,
177 mbedtls_ssl_session_get_ticket_flags(
178 session,
179 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800180 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
181 goto exit;
182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
185#if defined(MBEDTLS_HAVE_TIME)
186 now = mbedtls_time(NULL);
187
188 if (now < session->start) {
189 MBEDTLS_SSL_DEBUG_MSG(
190 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
191 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
192 (long long) now, (long long) session->start));
193 goto exit;
194 }
195
196 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800197
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800198 /* RFC 8446 section 4.6.1
199 *
200 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
201 *
202 * RFC 8446 section 4.2.11.1
203 *
204 * Clients MUST NOT attempt to use tickets which have ages greater than
205 * the "ticket_lifetime" value which was provided with the ticket.
206 *
207 * For time being, the age MUST be less than 604800 seconds (7 days).
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 3, ("Ticket age exceeds limitation ticket_age=%lu",
212 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800213 goto exit;
214 }
Jerry Yu95699e72022-08-21 19:22:23 +0800215
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800216 /* RFC 8446 section 4.2.10
217 *
218 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
219 * the ticket age for the selected PSK identity (computed by subtracting
220 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
221 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800223 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
224 * as the age units are different on the server (s) and in the
225 * client (ms) side. Add a -1000 ms tolerance window to take this
226 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800227 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800228 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
230 if (age_diff_in_ms <= -1000 ||
231 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800232 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 3, ("Ticket age outside tolerance window ( diff=%d )",
234 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800235 goto exit;
236 }
237
238 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800239
240#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800241
242exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (ret != 0) {
244 mbedtls_ssl_session_free(session);
245 }
Jerry Yu95699e72022-08-21 19:22:23 +0800246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
248 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800249}
250#endif /* MBEDTLS_SSL_SESSION_TICKETS */
251
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800252MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000253static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 mbedtls_ssl_context *ssl,
255 const unsigned char *identity,
256 size_t identity_len,
257 uint32_t obfuscated_ticket_age,
258 int *psk_type,
259 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000260{
Jerry Yu95699e72022-08-21 19:22:23 +0800261 ((void) session);
262 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800263 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800264
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800266 ssl->handshake->resume = 0;
267
Jerry Yu95699e72022-08-21 19:22:23 +0800268#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800270 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800272 ssl->handshake->resume = 1;
273 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 mbedtls_ssl_set_hs_psk(ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800275 session->resumption_key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 session->resumption_key_len);
277
278 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
279 session->resumption_key,
280 session->resumption_key_len);
281 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
282 (unsigned) obfuscated_ticket_age));
283 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800284 }
285#endif /* MBEDTLS_SSL_SESSION_TICKETS */
286
Jerry Yu1c105562022-07-10 06:32:38 +0000287 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 if (ssl->conf->f_psk != NULL) {
289 if (ssl->conf->f_psk(
290 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
291 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000292 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000294 }
295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000297 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800299 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 mbedtls_ct_memcmp(ssl->conf->psk_identity,
301 identity, identity_len) == 0) {
302 mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
303 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000304 }
305
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000307}
308
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800309MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100310static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
311 const unsigned char *binder,
312 size_t binder_len,
313 int psk_type,
314 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000315{
316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800317
Jerry Yudaf375a2022-07-20 21:31:43 +0800318 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000319 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800320 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800321 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800322 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000323
Jerry Yu1c105562022-07-10 06:32:38 +0000324 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800325 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
327 transcript, sizeof(transcript), &transcript_len);
328 if (ret != 0) {
329 return ret;
330 }
Jerry Yu1c105562022-07-10 06:32:38 +0000331
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
333 if (ret != 0) {
334 return ret;
335 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
338 psk, psk_len, psk_type,
339 transcript,
340 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800341#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800343#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ret != 0) {
345 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
346 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000347 }
348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
350 server_computed_binder, transcript_len);
351 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
354 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000355 }
356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 mbedtls_platform_zeroize(server_computed_binder,
358 sizeof(server_computed_binder));
359 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000360}
Jerry Yu96a2e362022-07-21 15:11:34 +0800361
Jerry Yu5725f1c2022-08-21 17:27:16 +0800362MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800363static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 mbedtls_ssl_context *ssl,
365 const unsigned char *cipher_suites,
366 const unsigned char *cipher_suites_end,
367 uint16_t *selected_ciphersuite,
368 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800369{
Jerry Yuf35ba382022-08-23 17:58:26 +0800370 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800371
Jerry Yu0baf9072022-08-25 11:21:04 +0800372 *selected_ciphersuite = 0;
373 *selected_ciphersuite_info = NULL;
374
Jerry Yuf35ba382022-08-23 17:58:26 +0800375 /* RFC 8446, page 55.
376 *
377 * For externally established PSKs, the Hash algorithm MUST be set when the
378 * PSK is established or default to SHA-256 if no such algorithm is defined.
379 *
380 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800381
Jerry Yu5725f1c2022-08-21 17:27:16 +0800382 /*
383 * Search for a matching ciphersuite
384 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 for (const unsigned char *p = cipher_suites;
386 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800387 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800388 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
391 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
392 cipher_suite);
393 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800394 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800396
Jerry Yu5725f1c2022-08-21 17:27:16 +0800397 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
398 * Otherwise, client should reject.
399 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800401 *selected_ciphersuite = cipher_suite;
402 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800404 }
405 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
407 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800408}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800409
Jerry Yu82534862022-08-30 10:42:33 +0800410#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800411MBEDTLS_CHECK_RETURN_CRITICAL
412static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 mbedtls_ssl_context *ssl,
414 const unsigned char *cipher_suites,
415 const unsigned char *cipher_suites_end,
416 mbedtls_ssl_session *session,
417 uint16_t *selected_ciphersuite,
418 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800419{
Jerry Yu82534862022-08-30 10:42:33 +0800420
Jerry Yuf35ba382022-08-23 17:58:26 +0800421 *selected_ciphersuite = 0;
422 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
424 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800425 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
426
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800428 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 }
Jerry Yu82534862022-08-30 10:42:33 +0800430
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
432 cipher_suite);
433 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800434 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 }
Jerry Yu82534862022-08-30 10:42:33 +0800436
Jerry Yu4746b102022-09-13 11:11:48 +0800437 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800438 *selected_ciphersuite_info = ciphersuite_info;
439
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800441 }
442
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800444}
Jerry Yuf35ba382022-08-23 17:58:26 +0800445
Jerry Yu82534862022-08-30 10:42:33 +0800446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100447static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
448 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800449{
Jerry Yu82534862022-08-30 10:42:33 +0800450 dst->ticket_age_add = src->ticket_age_add;
451 dst->ticket_flags = src->ticket_flags;
452 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 if (src->resumption_key_len == 0) {
454 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
455 }
456 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800459}
460#endif /* MBEDTLS_SSL_SESSION_TICKETS */
461
Jerry Yu1c105562022-07-10 06:32:38 +0000462/* Parser for pre_shared_key extension in client hello
463 * struct {
464 * opaque identity<1..2^16-1>;
465 * uint32 obfuscated_ticket_age;
466 * } PskIdentity;
467 *
468 * opaque PskBinderEntry<32..255>;
469 *
470 * struct {
471 * PskIdentity identities<7..2^16-1>;
472 * PskBinderEntry binders<33..2^16-1>;
473 * } OfferedPsks;
474 *
475 * struct {
476 * select (Handshake.msg_type) {
477 * case client_hello: OfferedPsks;
478 * ....
479 * };
480 * } PreSharedKeyExtension;
481 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
484 const unsigned char *pre_shared_key_ext,
485 const unsigned char *pre_shared_key_ext_end,
486 const unsigned char *ciphersuites,
487 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000488{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800489 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800490 const unsigned char *p_identity_len;
491 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000492 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800493 const unsigned char *binders;
494 const unsigned char *p_binder_len;
495 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000496 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800497 int matched_identity = -1;
498 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
501 pre_shared_key_ext,
502 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000503
Jerry Yu96a2e362022-07-21 15:11:34 +0800504 /* identities_len 2 bytes
505 * identities_data >= 7 bytes
506 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
508 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800509 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
511 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800512 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000513
Jerry Yu96a2e362022-07-21 15:11:34 +0800514 /* binders_len 2 bytes
515 * binders >= 33 bytes
516 */
Jerry Yu568ec252022-07-22 21:27:34 +0800517 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
519 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800520 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800522 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
525 identities_end - pre_shared_key_ext);
Jerry Yu96a2e362022-07-21 15:11:34 +0800526
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000528 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800529 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800530 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800531 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800532 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800534 int psk_type;
535 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800536 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800537#if defined(MBEDTLS_SSL_SESSION_TICKETS)
538 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800540#endif
Jerry Yubb852022022-07-20 21:10:44 +0800541
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
543 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800544 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
546 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800547 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800550 binder_len = *p_binder_len;
551 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800553 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800554
Jerry Yu96a2e362022-07-21 15:11:34 +0800555 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000557 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 }
Jerry Yu1c105562022-07-10 06:32:38 +0000559
Jerry Yu96a2e362022-07-21 15:11:34 +0800560 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 ssl, identity, identity_len, obfuscated_ticket_age,
562 &psk_type, &session);
563 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800564 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800566
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
568 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800569 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
570 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 ssl, ciphersuites, ciphersuites_end,
572 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800573 break;
574 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800575#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800576 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 ssl, ciphersuites, ciphersuites_end, &session,
578 &cipher_suite, &ciphersuite_info);
579 if (ret != 0) {
580 mbedtls_ssl_session_free(&session);
581 }
Jerry Yu82534862022-08-30 10:42:33 +0800582#else
583 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
584#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800585 break;
586 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800588 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800590 /* See below, no cipher_suite available, abort handshake */
591 MBEDTLS_SSL_PEND_FATAL_ALERT(
592 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800594 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 2, "ssl_tls13_select_ciphersuite", ret);
596 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800597 }
598
Jerry Yu96a2e362022-07-21 15:11:34 +0800599 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 ssl, binder, binder_len, psk_type,
601 mbedtls_psa_translate_md(ciphersuite_info->mac));
602 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800603 /* For security reasons, the handshake should be aborted when we
604 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
605 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800606#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800608#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
610 MBEDTLS_SSL_DEBUG_RET(1,
611 "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800612 MBEDTLS_SSL_PEND_FATAL_ALERT(
613 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
615 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800616 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800617
618 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800619
620 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800621 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800622 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
624 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800625#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
627 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
628 &session);
629 mbedtls_ssl_session_free(&session);
630 if (ret != 0) {
631 return ret;
632 }
Jerry Yu82534862022-08-30 10:42:33 +0800633 }
634#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000635 }
636
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 if (p_identity_len != identities_end || p_binder_len != binders_end) {
638 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
639 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
640 MBEDTLS_ERR_SSL_DECODE_ERROR);
641 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000642 }
643
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800644 /* Update the handshake transcript with the binder list. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 ssl->handshake->update_checksum(ssl,
646 identities_end,
647 (size_t) (binders_end - identities_end));
648 if (matched_identity == -1) {
649 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
650 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000651 }
652
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 ssl->handshake->selected_identity = (uint16_t) matched_identity;
654 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000655
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000657}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000658
659/*
660 * struct {
661 * select ( Handshake.msg_type ) {
662 * ....
663 * case server_hello:
664 * uint16 selected_identity;
665 * }
666 * } PreSharedKeyExtension;
667 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
669 unsigned char *buf,
670 unsigned char *end,
671 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000674
675 *olen = 0;
676
David Horstmann21b89762022-10-06 18:34:28 +0100677 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000680#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000682#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684 /* We shouldn't have called this extension writer unless we've
685 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000687 }
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
690 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
693 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000696
697 *olen = 6;
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
700 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000701
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705}
706
Ronald Cron41a443a2022-10-04 16:38:25 +0200707#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000708
XiaokangQian7807f9f2022-02-15 10:04:37 +0000709/* From RFC 8446:
710 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000711 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000712 * } SupportedVersions;
713 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200714MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100715static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
716 const unsigned char *buf,
717 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000719 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000720 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000721 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000722 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000723 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000726 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000727 p += 1;
728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000730 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 while (p < versions_end) {
732 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
733 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000734 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735
736 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 tls13_supported = 1;
739 break;
740 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000741 }
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 if (!tls13_supported) {
744 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
747 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
748 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000749 }
750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
752 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000755}
756
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000757#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000758/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000759 *
760 * From RFC 8446:
761 * enum {
762 * ... (0xFFFF)
763 * } NamedGroup;
764 * struct {
765 * NamedGroup named_group_list<2..2^16-1>;
766 * } NamedGroupList;
767 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200768MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100769static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
770 const unsigned char *buf,
771 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000774 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000775 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
778 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
779 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000782 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000783 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000786 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
788 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000789 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 MBEDTLS_SSL_DEBUG_MSG(2,
792 ("got named group: %s(%04x)",
793 mbedtls_ssl_named_group_to_str(named_group),
794 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000795
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
797 !mbedtls_ssl_named_group_is_supported(named_group) ||
798 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000799 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000800 }
801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 MBEDTLS_SSL_DEBUG_MSG(2,
803 ("add named group %s(%04x) into received list.",
804 mbedtls_ssl_named_group_to_str(named_group),
805 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800806
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000807 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808 }
809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000811
812}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000813#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814
XiaokangQian08037552022-04-20 07:16:41 +0000815#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
816
XiaokangQian88408882022-04-02 10:15:03 +0000817#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818/*
819 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000820 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000821 *
822 * Possible return values are:
823 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000824 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825 * does not match a group supported by the server. A HelloRetryRequest will
826 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000827 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800828 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100830static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
831 const unsigned char *buf,
832 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000833{
XiaokangQianb67384d2022-04-19 00:02:38 +0000834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000835 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000836 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800837 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000838
839 /* From RFC 8446:
840 *
841 * struct {
842 * KeyShareEntry client_shares<0..2^16-1>;
843 * } KeyShareClientHello;
844 *
845 */
846
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
848 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000851
852 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000853 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000854
855 /* We try to find a suitable key share entry and copy it to the
856 * handshake context. Later, we have to find out whether we can do
857 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000858 * dismiss it and send a HelloRetryRequest message.
859 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000860
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000862 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800863 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800864 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000865
866 /*
867 * struct {
868 * NamedGroup group;
869 * opaque key_exchange<1..2^16-1>;
870 * } KeyShareEntry;
871 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
873 group = MBEDTLS_GET_UINT16_BE(p, 0);
874 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800875 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800876 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100877 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800878 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000879
880 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000881 * for input validation purposes.
882 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100883 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
884 !mbedtls_ssl_named_group_is_supported(group) ||
885 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000886 continue;
887 }
XiaokangQian060d8672022-04-21 09:24:56 +0000888
XiaokangQian7807f9f2022-02-15 10:04:37 +0000889 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000890 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000891 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
893 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
894 mbedtls_ssl_named_group_to_str(group),
895 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000896 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 ssl, key_exchange - 2, key_exchange_len + 2);
898 if (ret != 0) {
899 return ret;
900 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000901
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 } else {
903 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
904 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000905 continue;
906 }
907
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000908 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000909 }
910
Jerry Yuc1be19f2022-04-23 16:11:39 +0800911
Gilles Peskine449bd832023-01-11 14:50:10 +0100912 if (ssl->handshake->offered_group_id == 0) {
913 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
914 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917}
XiaokangQian88408882022-04-02 10:15:03 +0000918#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000919
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200920MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100921static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
922 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923{
Jerry Yu0c354a22022-08-29 15:25:36 +0800924 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000926}
927
Jerry Yue5991322022-11-07 14:03:44 +0800928#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200929MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000930static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932{
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 return ssl_tls13_client_hello_has_exts(
934 ssl,
935 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
936 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
937 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000938}
Jerry Yue5991322022-11-07 14:03:44 +0800939#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940
Jerry Yue5991322022-11-07 14:03:44 +0800941#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000942MBEDTLS_CHECK_RETURN_CRITICAL
943static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000945{
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 return ssl_tls13_client_hello_has_exts(
947 ssl,
948 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
949 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000950}
Jerry Yue5991322022-11-07 14:03:44 +0800951#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000952
Jerry Yue5991322022-11-07 14:03:44 +0800953#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000954MBEDTLS_CHECK_RETURN_CRITICAL
955static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000957{
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return ssl_tls13_client_hello_has_exts(
959 ssl,
960 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
961 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
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_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000966
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200967MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100968static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000969{
Jerry Yue5991322022-11-07 14:03:44 +0800970#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Pengyu Lvdadeb202023-01-18 17:32:34 +0800971 return !ssl->handshake->resume &&
972 mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800974#else
975 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800977#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000978}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000979
Jerry Yu77f01482022-07-11 07:03:24 +0000980MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100981static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000982{
Jerry Yue5991322022-11-07 14:03:44 +0800983#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Pengyu Lv0b740bc2023-01-18 17:02:52 +0800984#if defined(MBEDTLS_SSL_SESSION_TICKETS)
985 if (ssl->handshake->resume) {
986 if (!mbedtls_ssl_session_get_ticket_flags(
987 ssl->session_negotiate,
988 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK)) {
989 return 0;
990 }
991 }
992#endif
993
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
995 mbedtls_ssl_tls13_psk_enabled(ssl) &&
996 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000997#else
998 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001000#endif
1001}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001002
Jerry Yu77f01482022-07-11 07:03:24 +00001003MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001004static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001005{
Jerry Yue5991322022-11-07 14:03:44 +08001006#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Pengyu Lv0b740bc2023-01-18 17:02:52 +08001007#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1008 if (ssl->handshake->resume) {
1009 if (!mbedtls_ssl_session_get_ticket_flags(
1010 ssl->session_negotiate,
1011 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL)) {
1012 return 0;
1013 }
1014 }
1015#endif
1016
Gilles Peskine449bd832023-01-11 14:50:10 +01001017 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1018 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1019 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001020#else
1021 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001023#endif
1024}
1025
Gilles Peskine449bd832023-01-11 14:50:10 +01001026static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001027{
1028 /*
1029 * Determine the key exchange algorithm to use.
1030 * There are three types of key exchanges supported in TLS 1.3:
1031 * - (EC)DH with ECDSA,
1032 * - (EC)DH with PSK,
1033 * - plain PSK.
1034 *
1035 * The PSK-based key exchanges may additionally be used with 0-RTT.
1036 *
1037 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001038 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1039 * 2 ) Certificate Mode ( ephemeral )
1040 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001041 */
1042
1043 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1044
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001046 ssl->handshake->key_exchange_mode =
1047 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001048 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1049 } else
1050 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001051 ssl->handshake->key_exchange_mode =
1052 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1054 } else
1055 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001056 ssl->handshake->key_exchange_mode =
1057 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1059 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001060 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 1,
1062 ("ClientHello message misses mandatory extensions."));
1063 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1064 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1065 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001066 }
1067
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001069
XiaokangQian7807f9f2022-02-15 10:04:37 +00001070}
1071
XiaokangQian81802f42022-06-10 13:25:22 +00001072#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001073 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001074
1075#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001076static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001077{
Gilles Peskine449bd832023-01-11 14:50:10 +01001078 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001079 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001081 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001083 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001085 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001087 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001089 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001097 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001099 }
1100}
1101#endif /* MBEDTLS_USE_PSA_CRYPTO */
1102
XiaokangQian23c5be62022-06-07 02:04:34 +00001103/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001104 * Pick best ( private key, certificate chain ) pair based on the signature
1105 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001106 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001107MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001108static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001109{
XiaokangQianfb665a82022-06-15 03:57:21 +00001110 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001111 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001112
1113#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001114 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001115 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001117#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001119
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 if (key_cert_list == NULL) {
1121 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1122 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001123 }
1124
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1126 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001127 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001129
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001131 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 for (key_cert = key_cert_list; key_cert != NULL;
1135 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001136#if defined(MBEDTLS_USE_PSA_CRYPTO)
1137 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1138#endif /* MBEDTLS_USE_PSA_CRYPTO */
1139
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1141 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001142
1143 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 * This avoids sending the client a cert it'll reject based on
1145 * keyUsage or other extensions.
1146 */
1147 if (mbedtls_x509_crt_check_key_usage(
1148 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001149 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001150 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1152 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1153 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001154 continue;
1155 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001156
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 MBEDTLS_SSL_DEBUG_MSG(3,
1158 ("ssl_tls13_pick_key_cert:"
1159 "check signature algorithm %s [%04x]",
1160 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1161 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001162#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001164#endif /* MBEDTLS_USE_PSA_CRYPTO */
1165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1167 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001168#if defined(MBEDTLS_USE_PSA_CRYPTO)
1169 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1171 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001172#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001174 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 MBEDTLS_SSL_DEBUG_MSG(3,
1176 ("ssl_tls13_pick_key_cert:"
1177 "selected signature algorithm"
1178 " %s [%04x]",
1179 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1180 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001181 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 3, "selected certificate (chain)",
1183 ssl->handshake->key_cert->cert);
1184 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001185 }
XiaokangQian81802f42022-06-10 13:25:22 +00001186 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001187 }
1188
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1190 "no suitable certificate found"));
1191 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001192}
XiaokangQian81802f42022-06-10 13:25:22 +00001193#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001194 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001195
XiaokangQian4080a7f2022-04-11 09:55:18 +00001196/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001197 *
1198 * STATE HANDLING: ClientHello
1199 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001200 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001201 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001202 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001203 *
1204 * In this case, the server progresses to sending its ServerHello.
1205 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001206 * 2) The ClientHello was well-formed but didn't match the server's
1207 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001208 *
1209 * For example, the client might not have offered a key share which
1210 * the server supports, or the server might require a cookie.
1211 *
1212 * In this case, the server sends a HelloRetryRequest.
1213 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001214 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001215 *
1216 * In this case, we abort the handshake.
1217 *
1218 */
1219
1220/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001221 * Structure of this message:
1222 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001223 * uint16 ProtocolVersion;
1224 * opaque Random[32];
1225 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001226 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001227 * struct {
1228 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1229 * Random random;
1230 * opaque legacy_session_id<0..32>;
1231 * CipherSuite cipher_suites<2..2^16-2>;
1232 * opaque legacy_compression_methods<1..2^8-1>;
1233 * Extension extensions<8..2^16-1>;
1234 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001235 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001236
1237#define SSL_CLIENT_HELLO_OK 0
1238#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1239
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001240MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001241static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1242 const unsigned char *buf,
1243 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001244{
XiaokangQianb67384d2022-04-19 00:02:38 +00001245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1246 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001247 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001248 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001249 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001250 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001251 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001252 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001253 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001254
Ronald Cron41a443a2022-10-04 16:38:25 +02001255#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001256 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001257 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001258 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001259#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001260
XiaokangQian7807f9f2022-02-15 10:04:37 +00001261 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001262 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001263 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001264 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001265 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001266 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001267 * .. . .. ciphersuite list length ( 2 bytes )
1268 * .. . .. ciphersuite list
1269 * .. . .. compression alg. list length ( 1 byte )
1270 * .. . .. compression alg. list
1271 * .. . .. extensions length ( 2 bytes, optional )
1272 * .. . .. extensions ( optional )
1273 */
1274
XiaokangQianb67384d2022-04-19 00:02:38 +00001275 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001276 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001277 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1278 * read at least up to session id length without worrying.
1279 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001280 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001281
1282 /* ...
1283 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1284 * ...
1285 * with ProtocolVersion defined as:
1286 * uint16 ProtocolVersion;
1287 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001288 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1289 MBEDTLS_SSL_VERSION_TLS1_2) {
1290 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1291 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1292 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1293 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001294 }
1295 p += 2;
1296
1297 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001298 * Only support TLS 1.3 currently, temporarily set the version.
1299 */
XiaokangQiande333912022-04-20 08:49:42 +00001300 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001301
Jerry Yue67bef42022-07-07 07:29:42 +00001302#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1303 /* Store minor version for later use with ticket serialization. */
1304 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001305 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001306#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001307
Jerry Yuc1be19f2022-04-23 16:11:39 +08001308 /* ...
1309 * Random random;
1310 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001311 * with Random defined as:
1312 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001314 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1315 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001318 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319
Jerry Yuc1be19f2022-04-23 16:11:39 +08001320 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001321 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001322 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001324 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001325 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001326
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1328 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1329 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330 }
1331
XiaokangQian4080a7f2022-04-11 09:55:18 +00001332 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1334 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001335 /*
1336 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001337 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001340
Gilles Peskine449bd832023-01-11 14:50:10 +01001341 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001342 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001343
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001345 p += 2;
1346
XiaokangQianb67384d2022-04-19 00:02:38 +00001347 /* Check we have enough data for the ciphersuite list, the legacy
1348 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001349 *
1350 * cipher_suites cipher_suites_len bytes
1351 * legacy_compression_methods 2 bytes
1352 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001353 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001355
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 /* ...
1357 * CipherSuite cipher_suites<2..2^16-2>;
1358 * ...
1359 * with CipherSuite defined as:
1360 * uint8 CipherSuite[2];
1361 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001362#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001363 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001364#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001365 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1367 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001368
1369 /*
1370 * Search for a matching ciphersuite
1371 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001372 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001373 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001374 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001375
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001377
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001379 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 ssl, cipher_suite);
1381 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001382 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001383 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001384
Jerry Yu5725f1c2022-08-21 17:27:16 +08001385 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001386 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1388 cipher_suite,
1389 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001390 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001391
Gilles Peskine449bd832023-01-11 14:50:10 +01001392 if (handshake->ciphersuite_info == NULL) {
1393 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1394 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1395 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001396 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001397
XiaokangQian4080a7f2022-04-11 09:55:18 +00001398 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001399 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001400 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001401 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1403 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1404 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1405 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1406 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001407 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001408 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001409
Jerry Yuc1be19f2022-04-23 16:11:39 +08001410 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001411 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001412 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001413 * with Extension defined as:
1414 * struct {
1415 * ExtensionType extension_type;
1416 * opaque extension_data<0..2^16-1>;
1417 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001420 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001422 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001423
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001425
Jerry Yu63a459c2022-10-31 13:38:40 +08001426 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001429 unsigned int extension_type;
1430 size_t extension_data_len;
1431 const unsigned char *extension_data_end;
1432
Jerry Yu0c354a22022-08-29 15:25:36 +08001433 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001434 *
1435 * The "pre_shared_key" extension MUST be the last extension in the
1436 * ClientHello (this facilitates implementation as described below).
1437 * Servers MUST check that it is the last extension and otherwise fail
1438 * the handshake with an "illegal_parameter" alert.
1439 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001441 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001443 MBEDTLS_SSL_PEND_FATAL_ALERT(
1444 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1446 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001447 }
1448
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1450 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1451 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001452 p += 4;
1453
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001455 extension_data_end = p + extension_data_len;
1456
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001457 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1459 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1460 if (ret != 0) {
1461 return ret;
1462 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001463
Gilles Peskine449bd832023-01-11 14:50:10 +01001464 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001465#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1466 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1468 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1469 extension_data_end);
1470 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001471 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001472 1, "mbedtls_ssl_parse_servername_ext", ret);
1473 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001474 }
XiaokangQian40a35232022-05-07 09:02:40 +00001475 break;
1476#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1477
XiaokangQianb67384d2022-04-19 00:02:38 +00001478#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001479 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001481
1482 /* Supported Groups Extension
1483 *
1484 * When sent by the client, the "supported_groups" extension
1485 * indicates the named groups which the client supports,
1486 * ordered from most preferred to least preferred.
1487 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001488 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 ssl, p, extension_data_end);
1490 if (ret != 0) {
1491 MBEDTLS_SSL_DEBUG_RET(1,
1492 "mbedtls_ssl_parse_supported_groups_ext", ret);
1493 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001494 }
1495
XiaokangQian7807f9f2022-02-15 10:04:37 +00001496 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001497#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001498
XiaokangQian88408882022-04-02 10:15:03 +00001499#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001502
1503 /*
1504 * Key Share Extension
1505 *
1506 * When sent by the client, the "key_share" extension
1507 * contains the endpoint's cryptographic parameters for
1508 * ECDHE/DHE key establishment methods.
1509 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001510 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001511 ssl, p, extension_data_end);
1512 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1513 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001514 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001515 }
1516
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001518 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 1, "ssl_tls13_parse_key_shares_ext", ret);
1520 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001521 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001522
XiaokangQian7807f9f2022-02-15 10:04:37 +00001523 break;
XiaokangQian88408882022-04-02 10:15:03 +00001524#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001525
1526 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001527 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001528
1529 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 ssl, p, extension_data_end);
1531 if (ret != 0) {
1532 MBEDTLS_SSL_DEBUG_RET(1,
1533 ("ssl_tls13_parse_supported_versions_ext"), ret);
1534 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001535 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001536 break;
1537
Ronald Cron41a443a2022-10-04 16:38:25 +02001538#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001539 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001541
1542 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 ssl, p, extension_data_end);
1544 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001545 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001546 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1547 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001548 }
1549
Jerry Yue19e3b92022-07-08 12:04:51 +00001550 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001551#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001552
Jerry Yu1c105562022-07-10 06:32:38 +00001553 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1555 if ((handshake->received_extensions &
1556 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001557 MBEDTLS_SSL_PEND_FATAL_ALERT(
1558 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1560 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001561 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001562#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001563 /* Delay processing of the PSK identity once we have
1564 * found out which algorithms to use. We keep a pointer
1565 * to the buffer and the size for later processing.
1566 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001567 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001568 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001569#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001570 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001571
XiaokangQianacb39922022-06-17 10:18:48 +00001572#if defined(MBEDTLS_SSL_ALPN)
1573 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001574 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001575
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1577 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001578 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001579 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1580 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001581 }
XiaokangQianacb39922022-06-17 10:18:48 +00001582 break;
1583#endif /* MBEDTLS_SSL_ALPN */
1584
Ronald Cron928cbd32022-10-04 16:14:26 +02001585#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001586 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001588
Gabor Mezei078e8032022-04-27 21:17:56 +02001589 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 ssl, p, extension_data_end);
1591 if (ret != 0) {
1592 MBEDTLS_SSL_DEBUG_MSG(1,
1593 (
1594 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1595 ret));
1596 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001597 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001599#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001600
1601 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001602 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001603 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001604 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001605 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001606 }
1607
1608 p += extension_data_len;
1609 }
1610
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1612 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001613
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1615 MBEDTLS_SSL_HS_CLIENT_HELLO,
1616 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001617
Ronald Cron41a443a2022-10-04 16:38:25 +02001618#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001619 /* Update checksum with either
1620 * - The entire content of the CH message, if no PSK extension is present
1621 * - The content up to but excluding the PSK extension, if present.
1622 */
Jerry Yu1c105562022-07-10 06:32:38 +00001623 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1625 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1626 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1627 handshake->update_checksum(ssl, buf,
1628 pre_shared_key_ext - buf);
1629 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1630 pre_shared_key_ext,
1631 pre_shared_key_ext_end,
1632 cipher_suites,
1633 cipher_suites_end);
1634 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1635 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1636 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001637 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001638 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1639 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001640 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001641 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001642#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001643 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001645 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001646
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1648 if (ret < 0) {
1649 return ret;
1650 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001653
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001655}
1656
1657/* Update the handshake state machine */
1658
Ronald Cronce7d76e2022-07-08 18:56:49 +02001659MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001660static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001661{
1662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1663
XiaokangQian7807f9f2022-02-15 10:04:37 +00001664 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001665 * Server certificate selection
1666 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001667 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1668 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1669 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001670 }
1671#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1672 ssl->handshake->sni_name = NULL;
1673 ssl->handshake->sni_name_len = 0;
1674#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1677 if (ret != 0) {
1678 MBEDTLS_SSL_DEBUG_RET(1,
1679 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1680 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001681 }
1682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001684
1685}
1686
1687/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001688 * Main entry point from the state machine; orchestrates the otherfunctions.
1689 */
1690
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001691MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001692static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001693{
1694
XiaokangQian08037552022-04-20 07:16:41 +00001695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001696 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001697 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001698 int parse_client_hello_ret;
1699
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001701
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1703 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1704 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1707 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001708 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1709 * only SSL_CLIENT_HELLO_OK or
1710 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1711 * stage as negative error codes are handled
1712 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001713
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001715
Gilles Peskine449bd832023-01-11 14:50:10 +01001716 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1717 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1718 } else {
1719 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1720 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001721
1722cleanup:
1723
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1725 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001726}
1727
1728/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001729 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001730 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001731MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001732static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001733{
Jerry Yu637a3f12022-04-20 21:37:58 +08001734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1735 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001736 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1737 if (ssl->conf->f_rng == NULL) {
1738 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1739 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001740 }
1741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1743 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1744 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1745 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001746 }
1747
Gilles Peskine449bd832023-01-11 14:50:10 +01001748 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1749 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001750
1751#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001753#endif /* MBEDTLS_HAVE_TIME */
1754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001756}
1757
Jerry Yu3bf2c642022-03-30 22:02:12 +08001758/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001759 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001760 *
1761 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001762 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001763 * } SupportedVersions;
1764 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001765MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001766static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 mbedtls_ssl_context *ssl,
1768 unsigned char *buf,
1769 unsigned char *end,
1770 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001771{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001772 *out_len = 0;
1773
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001775
1776 /* Check if we have space to write the extension:
1777 * - extension_type (2 bytes)
1778 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001779 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001782
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001784
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 mbedtls_ssl_write_version(buf + 4,
1788 ssl->conf->transport,
1789 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1792 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001793
Jerry Yu349a6132022-04-14 20:52:56 +08001794 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001795
Jerry Yub95dd362022-11-08 21:19:34 +08001796 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001798
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001800}
1801
Jerry Yud9436a12022-04-20 22:28:09 +08001802
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803
1804/* Generate and export a single key share. For hybrid KEMs, this can
1805 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001806MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001807static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1808 uint16_t named_group,
1809 unsigned char *buf,
1810 unsigned char *end,
1811 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001812{
1813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001814
1815 *out_len = 0;
1816
Jerry Yu89e103c2022-03-30 22:43:29 +08001817#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001818 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001819 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001820 ssl, named_group, buf, end, out_len);
1821 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001822 MBEDTLS_SSL_DEBUG_RET(
1823 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 ret);
1825 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001826 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001827 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001828#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001829 if (0 /* Other kinds of KEMs */) {
1830 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001831 ((void) ssl);
1832 ((void) named_group);
1833 ((void) buf);
1834 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001835 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1836 }
1837
Gilles Peskine449bd832023-01-11 14:50:10 +01001838 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839}
1840
1841/*
1842 * ssl_tls13_write_key_share_ext
1843 *
1844 * Structure of key_share extension in ServerHello:
1845 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001846 * struct {
1847 * NamedGroup group;
1848 * opaque key_exchange<1..2^16-1>;
1849 * } KeyShareEntry;
1850 * struct {
1851 * KeyShareEntry server_share;
1852 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001854MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001855static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1856 unsigned char *buf,
1857 unsigned char *end,
1858 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001859{
Jerry Yu955ddd72022-04-22 22:27:33 +08001860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001861 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001862 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001863 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001864 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001865
1866 *out_len = 0;
1867
Gilles Peskine449bd832023-01-11 14:50:10 +01001868 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1871 mbedtls_ssl_named_group_to_str(group),
1872 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001873
Jerry Yu3bf2c642022-03-30 22:02:12 +08001874 /* Check if we have space for header and length fields:
1875 * - extension_type (2 bytes)
1876 * - extension_data_length (2 bytes)
1877 * - group (2 bytes)
1878 * - key_exchange_length (2 bytes)
1879 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1881 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1882 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001884
Jerry Yu3bf2c642022-03-30 22:02:12 +08001885 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1886 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001887 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001888 ssl, group, server_share + 4, end, &key_exchange_length);
1889 if (ret != 0) {
1890 return ret;
1891 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001892 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001893
Gilles Peskine449bd832023-01-11 14:50:10 +01001894 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001895
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001897
Jerry Yu57d48412022-04-20 21:50:42 +08001898 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001901
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001903}
Jerry Yud9436a12022-04-20 22:28:09 +08001904
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001905MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001906static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1907 unsigned char *buf,
1908 unsigned char *end,
1909 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001910{
1911 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1912 /* key_share Extension
1913 *
1914 * struct {
1915 * select (Handshake.msg_type) {
1916 * ...
1917 * case hello_retry_request:
1918 * NamedGroup selected_group;
1919 * ...
1920 * };
1921 * } KeyShare;
1922 */
1923
1924 *out_len = 0;
1925
Jerry Yub0ac10b2022-05-05 11:10:08 +08001926 /*
1927 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1928 * of the HRR is then to transmit a cookie to force the client to demonstrate
1929 * reachability at their apparent network address (primarily useful for DTLS).
1930 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1932 return 0;
1933 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001934
1935 /* We should only send the key_share extension if the client's initial
1936 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 if (ssl->handshake->offered_group_id != 0) {
1938 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1939 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001940 }
1941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 if (selected_group == 0) {
1943 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1944 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001945 }
1946
Jerry Yub0ac10b2022-05-05 11:10:08 +08001947 /* Check if we have enough space:
1948 * - extension_type (2 bytes)
1949 * - extension_data_length (2 bytes)
1950 * - selected_group (2 bytes)
1951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001953
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1955 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1956 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 MBEDTLS_SSL_DEBUG_MSG(3,
1959 ("HRR selected_group: %s (%x)",
1960 mbedtls_ssl_named_group_to_str(selected_group),
1961 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001962
1963 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001964
Gilles Peskine449bd832023-01-11 14:50:10 +01001965 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001966
Gilles Peskine449bd832023-01-11 14:50:10 +01001967 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001968}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969
1970/*
1971 * Structure of ServerHello message:
1972 *
1973 * struct {
1974 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1975 * Random random;
1976 * opaque legacy_session_id_echo<0..32>;
1977 * CipherSuite cipher_suite;
1978 * uint8 legacy_compression_method = 0;
1979 * Extension extensions<6..2^16-1>;
1980 * } ServerHello;
1981 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001982MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001983static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1984 unsigned char *buf,
1985 unsigned char *end,
1986 size_t *out_len,
1987 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08001988{
Jerry Yu955ddd72022-04-22 22:27:33 +08001989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001990 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001991 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001992 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001993
1994 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08001995 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001996
Jerry Yucfc04b32022-04-21 09:31:58 +08001997 /* ...
1998 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1999 * ...
2000 * with ProtocolVersion defined as:
2001 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002002 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002003 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2004 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002005 p += 2;
2006
Jerry Yu1c3e6882022-04-20 21:23:40 +08002007 /* ...
2008 * Random random;
2009 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002010 * with Random defined as:
2011 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2014 if (is_hrr) {
2015 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2016 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2017 } else {
2018 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2019 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002020 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002021 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2022 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002023 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2024
Jerry Yucfc04b32022-04-21 09:31:58 +08002025 /* ...
2026 * opaque legacy_session_id_echo<0..32>;
2027 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002028 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002029 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2030 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2031 if (ssl->session_negotiate->id_len > 0) {
2032 memcpy(p, &ssl->session_negotiate->id[0],
2033 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002034 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002035
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2037 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002038 }
2039
Jerry Yucfc04b32022-04-21 09:31:58 +08002040 /* ...
2041 * CipherSuite cipher_suite;
2042 * ...
2043 * with CipherSuite defined as:
2044 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002045 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2047 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002048 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 MBEDTLS_SSL_DEBUG_MSG(3,
2050 ("server hello, chosen ciphersuite: %s ( id=%d )",
2051 mbedtls_ssl_get_ciphersuite_name(
2052 ssl->session_negotiate->ciphersuite),
2053 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002054
Jerry Yucfc04b32022-04-21 09:31:58 +08002055 /* ...
2056 * uint8 legacy_compression_method = 0;
2057 * ...
2058 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002060 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002061
Jerry Yucfc04b32022-04-21 09:31:58 +08002062 /* ...
2063 * Extension extensions<6..2^16-1>;
2064 * ...
2065 * struct {
2066 * ExtensionType extension_type; (2 bytes)
2067 * opaque extension_data<0..2^16-1>;
2068 * } Extension;
2069 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002070 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002071 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002072 p += 2;
2073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2075 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002076 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002077 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2078 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002079 }
2080 p += output_len;
2081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2083 if (is_hrr) {
2084 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2085 } else {
2086 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2087 }
2088 if (ret != 0) {
2089 return ret;
2090 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002091 p += output_len;
2092 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002093
Ronald Cron41a443a2022-10-04 16:38:25 +02002094#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2096 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2097 if (ret != 0) {
2098 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2099 ret);
2100 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002101 }
2102 p += output_len;
2103 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002104#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002105
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002107
Gilles Peskine449bd832023-01-11 14:50:10 +01002108 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2109 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002110
Jerry Yud9436a12022-04-20 22:28:09 +08002111 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002114
Jerry Yu7de2ff02022-11-08 21:43:46 +08002115 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002116 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 MBEDTLS_SSL_HS_SERVER_HELLO,
2118 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002119
Gilles Peskine449bd832023-01-11 14:50:10 +01002120 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002121}
2122
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002123MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002124static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002125{
2126 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2128 if (ret != 0) {
2129 MBEDTLS_SSL_DEBUG_RET(1,
2130 "mbedtls_ssl_tls13_compute_handshake_transform",
2131 ret);
2132 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002133 }
2134
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002136}
2137
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002138MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002139static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002140{
Jerry Yu637a3f12022-04-20 21:37:58 +08002141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002142 unsigned char *buf;
2143 size_t buf_len, msg_len;
2144
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002146
Gilles Peskine449bd832023-01-11 14:50:10 +01002147 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2150 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2151 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2154 buf + buf_len,
2155 &msg_len,
2156 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002157
Jerry Yu3bf2c642022-03-30 22:02:12 +08002158 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002160
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2162 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002163
Gilles Peskine449bd832023-01-11 14:50:10 +01002164 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002165
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002166#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2167 /* The server sends a dummy change_cipher_spec record immediately
2168 * after its first handshake message. This may either be after
2169 * a ServerHello or a HelloRetryRequest.
2170 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002171 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002172 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002173#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002175#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002176
Jerry Yuf4b27e42022-03-30 17:32:21 +08002177cleanup:
2178
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2180 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002181}
2182
Jerry Yu23d1a252022-05-12 18:08:59 +08002183
2184/*
2185 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2186 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002187MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002188static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002189{
2190 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 if (ssl->handshake->hello_retry_request_count > 0) {
2192 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2193 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2194 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2195 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002196 }
2197
2198 /*
2199 * Create stateless transcript hash for HRR
2200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2202 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2203 if (ret != 0) {
2204 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2205 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002206 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002208
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002210}
2211
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002212MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002213static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002214{
2215 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2216 unsigned char *buf;
2217 size_t buf_len, msg_len;
2218
Gilles Peskine449bd832023-01-11 14:50:10 +01002219 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002220
Gilles Peskine449bd832023-01-11 14:50:10 +01002221 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2224 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2225 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2228 buf + buf_len,
2229 &msg_len,
2230 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002231 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002233
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2236 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002237
2238 ssl->handshake->hello_retry_request_count++;
2239
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002240#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2241 /* The server sends a dummy change_cipher_spec record immediately
2242 * after its first handshake message. This may either be after
2243 * a ServerHello or a HelloRetryRequest.
2244 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002245 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002246 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002247#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002248 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002249#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002250
2251cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2253 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002254}
2255
Jerry Yu5b64ae92022-03-30 17:15:02 +08002256/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002257 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2258 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002259
2260/*
2261 * struct {
2262 * Extension extensions<0..2 ^ 16 - 1>;
2263 * } EncryptedExtensions;
2264 *
2265 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002266MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002267static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2268 unsigned char *buf,
2269 unsigned char *end,
2270 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002271{
XiaokangQianacb39922022-06-17 10:18:48 +00002272 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002273 unsigned char *p = buf;
2274 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002275 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002276 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002277
Jerry Yu4d3841a2022-04-16 12:37:19 +08002278 *out_len = 0;
2279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002281 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002282 p += 2;
2283
Jerry Yu8937eb42022-05-03 12:12:14 +08002284 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002285 ((void) ret);
2286 ((void) output_len);
2287
2288#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002289 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2290 if (ret != 0) {
2291 return ret;
2292 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002293 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002294#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 extensions_len = (p - p_extensions_len) - 2;
2297 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002298
2299 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002302
Jerry Yu7de2ff02022-11-08 21:43:46 +08002303 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002307}
2308
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002309MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002310static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002311{
2312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2313 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002314 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002315
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 mbedtls_ssl_set_outbound_transform(ssl,
2317 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002318 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2324 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2325 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2328 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002329
2330 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002332
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2334 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002335
Ronald Cron928cbd32022-10-04 16:14:26 +02002336#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2338 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2339 } else {
2340 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2341 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002342#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002343 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002344#endif
2345
Jerry Yu4d3841a2022-04-16 12:37:19 +08002346cleanup:
2347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2349 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002350}
2351
Ronald Cron928cbd32022-10-04 16:14:26 +02002352#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002353#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2354#define SSL_CERTIFICATE_REQUEST_SKIP 1
2355/* Coordination:
2356 * Check whether a CertificateRequest message should be written.
2357 * Returns a negative code on failure, or
2358 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2359 * - SSL_CERTIFICATE_REQUEST_SKIP
2360 * indicating if the writing of the CertificateRequest
2361 * should be skipped or not.
2362 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002363MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002364static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002365{
2366 int authmode;
2367
XiaokangQian40a35232022-05-07 09:02:40 +00002368#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002369 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002370 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002371 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002372#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002373 authmode = ssl->conf->authmode;
2374
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002376 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002378 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002379
XiaokangQianc3017f62022-05-13 05:55:41 +00002380 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002381
Gilles Peskine449bd832023-01-11 14:50:10 +01002382 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002383}
2384
XiaokangQiancec9ae62022-05-06 07:28:50 +00002385/*
2386 * struct {
2387 * opaque certificate_request_context<0..2^8-1>;
2388 * Extension extensions<2..2^16-1>;
2389 * } CertificateRequest;
2390 *
2391 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002392MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002393static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2394 unsigned char *buf,
2395 const unsigned char *end,
2396 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002397{
2398 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2399 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002400 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002401 unsigned char *p_extensions_len;
2402
2403 *out_len = 0;
2404
2405 /* Check if we have enough space:
2406 * - certificate_request_context (1 byte)
2407 * - extensions length (2 bytes)
2408 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002410
2411 /*
2412 * Write certificate_request_context
2413 */
2414 /*
2415 * We use a zero length context for the normal handshake
2416 * messages. For post-authentication handshake messages
2417 * this request context would be set to a non-zero value.
2418 */
2419 *p++ = 0x0;
2420
2421 /*
2422 * Write extensions
2423 */
2424 /* The extensions must contain the signature_algorithms. */
2425 p_extensions_len = p;
2426 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2428 if (ret != 0) {
2429 return ret;
2430 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002431
XiaokangQianec6efb92022-05-06 09:53:10 +00002432 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002434
2435 *out_len = p - buf;
2436
Jerry Yu7de2ff02022-11-08 21:43:46 +08002437 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002439
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002441}
2442
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002444static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002445{
2446 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002449
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002453 unsigned char *buf;
2454 size_t buf_len, msg_len;
2455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2457 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2458 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2461 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002462
2463 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002465
Gilles Peskine449bd832023-01-11 14:50:10 +01002466 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2467 ssl, buf_len, msg_len));
2468 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2469 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002470 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 } else {
2472 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002473 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2474 goto cleanup;
2475 }
2476
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002478cleanup:
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2481 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002482}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002483
Jerry Yu4d3841a2022-04-16 12:37:19 +08002484/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002485 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002486 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002487MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002488static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002489{
Jerry Yu5a26f302022-05-10 20:46:40 +08002490 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002491
2492#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2494 mbedtls_ssl_own_cert(ssl) == NULL) {
2495 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2496 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2497 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2498 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002499 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002500#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002501
Gilles Peskine449bd832023-01-11 14:50:10 +01002502 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2503 if (ret != 0) {
2504 return ret;
2505 }
2506 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2507 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002508}
2509
2510/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002511 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002512 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002513MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002514static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002515{
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2517 if (ret != 0) {
2518 return ret;
2519 }
2520 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2521 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002522}
Ronald Cron928cbd32022-10-04 16:14:26 +02002523#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002524
2525/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002526 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002527 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002528MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002529static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002530{
Jerry Yud6e253d2022-05-18 13:59:24 +08002531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2534 if (ret != 0) {
2535 return ret;
2536 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002537
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2539 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002540 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2542 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2543 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002544 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2547 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 if (ssl->handshake->certificate_request_sent) {
2550 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2551 } else {
2552 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2553 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2554 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002555 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002556
Gilles Peskine449bd832023-01-11 14:50:10 +01002557 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002558}
2559
2560/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002561 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002564static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002565{
Jerry Yud6e253d2022-05-18 13:59:24 +08002566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2569 if (ret != 0) {
2570 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002571 }
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2574 if (ret != 0) {
2575 MBEDTLS_SSL_DEBUG_RET(1,
2576 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2577 }
2578
2579 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2580 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002581}
2582
2583/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002584 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002585 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002586MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002587static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002588{
Gilles Peskine449bd832023-01-11 14:50:10 +01002589 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002590
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002592
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002593#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2594 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002595/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2596 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2597 * expected to be resolved with issue#6395.
2598 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002599 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002600 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2601 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002602 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002603#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002604 {
2605 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2606 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002608}
2609
2610/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002611 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002612 */
2613#define SSL_NEW_SESSION_TICKET_SKIP 0
2614#define SSL_NEW_SESSION_TICKET_WRITE 1
2615MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002616static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002617{
2618 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002619 if (ssl->conf->f_ticket_write == NULL) {
2620 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2621 " callback is not set"));
2622 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002623 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 if (ssl->conf->new_session_tickets_count == 0) {
2625 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2626 " configured count is zero"));
2627 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002628 }
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 if (ssl->handshake->new_session_tickets_count == 0) {
2631 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2632 "been sent."));
2633 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002634 }
2635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002637}
2638
2639#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2640MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002641static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2642 unsigned char *ticket_nonce,
2643 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002644{
2645 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2646 mbedtls_ssl_session *session = ssl->session;
2647 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2648 psa_algorithm_t psa_hash_alg;
2649 int hash_length;
2650
Gilles Peskine449bd832023-01-11 14:50:10 +01002651 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002652
2653#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002654 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002655#endif
2656
Pengyu Lv9f926952022-11-17 15:22:33 +08002657 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002658 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002659 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002660#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002661 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002662 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002663#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002664 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002665
Jerry Yue67bef42022-07-07 07:29:42 +00002666 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002667 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2668 (unsigned char *) &session->ticket_age_add,
2669 sizeof(session->ticket_age_add)) != 0)) {
2670 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2671 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002672 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002673 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2674 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002675
2676 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2678 if (ret != 0) {
2679 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2680 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002681 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2683 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002684
2685 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2687 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2688 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2689 if (hash_length == -1 ||
2690 (size_t) hash_length > sizeof(session->resumption_key)) {
2691 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002692 }
2693
Jerry Yue67bef42022-07-07 07:29:42 +00002694 /* In this code the psk key length equals the length of the hash */
2695 session->resumption_key_len = hash_length;
2696 session->ciphersuite = ciphersuite_info->id;
2697
2698 /* Compute resumption key
2699 *
2700 * HKDF-Expand-Label( resumption_master_secret,
2701 * "resumption", ticket_nonce, Hash.length )
2702 */
2703 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002704 psa_hash_alg,
2705 session->app_secrets.resumption_master_secret,
2706 hash_length,
2707 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2708 ticket_nonce,
2709 ticket_nonce_size,
2710 session->resumption_key,
2711 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002712
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 if (ret != 0) {
2714 MBEDTLS_SSL_DEBUG_RET(2,
2715 "Creating the ticket-resumed PSK failed",
2716 ret);
2717 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002718 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002719 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2720 session->resumption_key,
2721 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002722
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2724 session->app_secrets.resumption_master_secret,
2725 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002728}
2729
2730/* This function creates a NewSessionTicket message in the following format:
2731 *
2732 * struct {
2733 * uint32 ticket_lifetime;
2734 * uint32 ticket_age_add;
2735 * opaque ticket_nonce<0..255>;
2736 * opaque ticket<1..2^16-1>;
2737 * Extension extensions<0..2^16-2>;
2738 * } NewSessionTicket;
2739 *
2740 * The ticket inside the NewSessionTicket message is an encrypted container
2741 * carrying the necessary information so that the server is later able to
2742 * re-start the communication.
2743 *
2744 * The following fields are placed inside the ticket by the
2745 * f_ticket_write() function:
2746 *
2747 * - creation time (start)
2748 * - flags (flags)
2749 * - age add (ticket_age_add)
2750 * - key (key)
2751 * - key length (key_len)
2752 * - ciphersuite (ciphersuite)
2753 */
2754MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002755static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2756 unsigned char *buf,
2757 unsigned char *end,
2758 size_t *out_len,
2759 unsigned char *ticket_nonce,
2760 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002761{
2762 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2763 unsigned char *p = buf;
2764 mbedtls_ssl_session *session = ssl->session;
2765 size_t ticket_len;
2766 uint32_t ticket_lifetime;
2767
2768 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002770
2771 /*
2772 * ticket_lifetime 4 bytes
2773 * ticket_age_add 4 bytes
2774 * ticket_nonce 1 + ticket_nonce_size bytes
2775 * ticket >=2 bytes
2776 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002777 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002778
2779 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2781 session,
2782 p + 9 + ticket_nonce_size + 2,
2783 end,
2784 &ticket_len,
2785 &ticket_lifetime);
2786 if (ret != 0) {
2787 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2788 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002789 }
2790 /* RFC 8446 4.6.1
2791 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2792 * unsigned integer in network byte order from the time of ticket
2793 * issuance. Servers MUST NOT use any value greater than
2794 * 604800 seconds (7 days). The value of zero indicates that the
2795 * ticket should be discarded immediately. Clients MUST NOT cache
2796 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2797 * and MAY delete tickets earlier based on local policy. A server
2798 * MAY treat a ticket as valid for a shorter period of time than what
2799 * is stated in the ticket_lifetime.
2800 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002802 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 }
2804 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2805 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2806 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002807
2808 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002809 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2810 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2811 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002812
2813 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 p[8] = (unsigned char) ticket_nonce_size;
2815 if (ticket_nonce_size > 0) {
2816 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002817 }
2818 p += 9 + ticket_nonce_size;
2819
2820 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002822 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002824 p += ticket_len;
2825
2826 /* Ticket Extensions
2827 *
2828 * Note: We currently don't have any extensions.
2829 * Set length to zero.
2830 */
Jerry Yuedab6372022-10-31 14:37:31 +08002831 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2834 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002835 p += 2;
2836
2837 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2839 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002840
Jerry Yu7de2ff02022-11-08 21:43:46 +08002841 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002843
Gilles Peskine449bd832023-01-11 14:50:10 +01002844 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002845}
2846
2847/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002848 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002849 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002850static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002851{
2852 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2853
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002855
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002857 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2858 unsigned char *buf;
2859 size_t buf_len, msg_len;
2860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2862 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002863
Gilles Peskine449bd832023-01-11 14:50:10 +01002864 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2865 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2866 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2869 ssl, buf, buf + buf_len, &msg_len,
2870 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2873 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002874
Jerry Yu359e65f2022-09-22 23:47:43 +08002875 /* Limit session tickets count to one when resumption connection.
2876 *
2877 * See document of mbedtls_ssl_conf_new_session_tickets.
2878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002880 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002882 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002884
Jerry Yua8d3c502022-10-30 14:51:23 +08002885 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2887 } else {
2888 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002889 }
2890
Jerry Yue67bef42022-07-07 07:29:42 +00002891cleanup:
2892
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002894}
2895#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2896
2897/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002898 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002899 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002900int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002901{
XiaokangQian08037552022-04-20 07:16:41 +00002902 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002903
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2905 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2906 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2909 mbedtls_ssl_states_str(ssl->state),
2910 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002913 /* start state */
2914 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002915 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002916 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002917 break;
2918
XiaokangQian7807f9f2022-02-15 10:04:37 +00002919 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002920 ret = ssl_tls13_process_client_hello(ssl);
2921 if (ret != 0) {
2922 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2923 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002924 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002925
Jerry Yuf41553b2022-05-09 22:20:30 +08002926 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 ret = ssl_tls13_write_hello_retry_request(ssl);
2928 if (ret != 0) {
2929 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2930 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002931 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002932 break;
2933
Jerry Yu5b64ae92022-03-30 17:15:02 +08002934 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002936 break;
2937
Xiaofei Baicba64af2022-02-15 10:00:56 +00002938 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 ret = ssl_tls13_write_encrypted_extensions(ssl);
2940 if (ret != 0) {
2941 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2942 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002943 }
Jerry Yu48330562022-05-06 21:35:44 +08002944 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002945
Ronald Cron928cbd32022-10-04 16:14:26 +02002946#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002947 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002949 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002950
Jerry Yu83da34e2022-04-16 13:59:52 +08002951 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002953 break;
2954
2955 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002957 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002958#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002959
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 /*
2961 * Injection of dummy-CCS's for middlebox compatibility
2962 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002963#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002964 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002965 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2966 if (ret == 0) {
2967 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2968 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002969 break;
2970
2971 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2973 if (ret == 0) {
2974 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2975 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002976 break;
2977#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2978
Jerry Yu69dd8d42022-04-16 12:51:26 +08002979 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002981 break;
2982
2983 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002985 break;
2986
Jerry Yu69dd8d42022-04-16 12:51:26 +08002987 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002989 break;
2990
Ronald Cron766c0cd2022-10-18 12:17:11 +02002991#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00002992 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002993 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2994 if (ret == 0) {
2995 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02002996 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2998 } else {
2999 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003000 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003002 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003003 }
3004 break;
3005
3006 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3008 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003009 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003011 }
3012 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003013#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003014
Jerry Yue67bef42022-07-07 07:29:42 +00003015#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003016 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 ret = ssl_tls13_write_new_session_ticket(ssl);
3018 if (ret != 0) {
3019 MBEDTLS_SSL_DEBUG_RET(1,
3020 "ssl_tls13_write_new_session_ticket ",
3021 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003022 }
3023 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003024 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003025 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003026 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003027 * as part of ssl_prepare_handshake_step.
3028 */
3029 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 if (ssl->handshake->new_session_tickets_count == 0) {
3032 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3033 } else {
3034 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3035 }
Jerry Yue67bef42022-07-07 07:29:42 +00003036 break;
3037
3038#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3039
XiaokangQian7807f9f2022-02-15 10:04:37 +00003040 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3042 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003043 }
3044
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003046}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003047
Jerry Yufb4b6472022-01-27 15:03:26 +08003048#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */