blob: ef90f69a2c5c1209b908acb2baad351523929049 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800164 /* RFC 8446 section 4.2.9
165 *
166 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
167 * compatible with the advertised modes; however, if a server does so,
168 * the impact will just be that the client's attempts at resumption fail.
169 *
170 * We regard the ticket with incompatible key exchange modes as not match.
171 */
Pengyu Lv18946532023-01-12 12:28:09 +0800172 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv4938a562023-01-16 11:28:49 +0800173 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
Pengyu Lv80270b22023-01-12 11:54:04 +0800174 session->ticket_flags);
Pengyu Lve2f1dbf2023-01-16 12:28:27 +0800175 if (mbedtls_ssl_tls13_check_kex_modes(
176 ssl,
177 mbedtls_ssl_session_get_ticket_flags(
178 session,
179 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800180 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
181 goto exit;
182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
185#if defined(MBEDTLS_HAVE_TIME)
186 now = mbedtls_time(NULL);
187
188 if (now < session->start) {
189 MBEDTLS_SSL_DEBUG_MSG(
190 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
191 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
192 (long long) now, (long long) session->start));
193 goto exit;
194 }
195
196 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800197
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800198 /* RFC 8446 section 4.6.1
199 *
200 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
201 *
202 * RFC 8446 section 4.2.11.1
203 *
204 * Clients MUST NOT attempt to use tickets which have ages greater than
205 * the "ticket_lifetime" value which was provided with the ticket.
206 *
207 * For time being, the age MUST be less than 604800 seconds (7 days).
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 3, ("Ticket age exceeds limitation ticket_age=%lu",
212 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800213 goto exit;
214 }
Jerry Yu95699e72022-08-21 19:22:23 +0800215
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800216 /* RFC 8446 section 4.2.10
217 *
218 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
219 * the ticket age for the selected PSK identity (computed by subtracting
220 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
221 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800223 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
224 * as the age units are different on the server (s) and in the
225 * client (ms) side. Add a -1000 ms tolerance window to take this
226 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800227 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800228 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
230 if (age_diff_in_ms <= -1000 ||
231 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800232 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 3, ("Ticket age outside tolerance window ( diff=%d )",
234 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800235 goto exit;
236 }
237
238 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800239
240#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800241
242exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (ret != 0) {
244 mbedtls_ssl_session_free(session);
245 }
Jerry Yu95699e72022-08-21 19:22:23 +0800246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
248 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800249}
250#endif /* MBEDTLS_SSL_SESSION_TICKETS */
251
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800252MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000253static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 mbedtls_ssl_context *ssl,
255 const unsigned char *identity,
256 size_t identity_len,
257 uint32_t obfuscated_ticket_age,
258 int *psk_type,
259 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000260{
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)
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
972 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800973#else
974 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100975 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800976#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000977}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000978
Jerry Yu77f01482022-07-11 07:03:24 +0000979MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100980static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000981{
Jerry Yue5991322022-11-07 14:03:44 +0800982#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
984 mbedtls_ssl_tls13_psk_enabled(ssl) &&
985 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000986#else
987 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +0000989#endif
990}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000991
Jerry Yu77f01482022-07-11 07:03:24 +0000992MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100993static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000994{
Jerry Yue5991322022-11-07 14:03:44 +0800995#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
997 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
998 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000999#else
1000 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001001 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001002#endif
1003}
1004
Gilles Peskine449bd832023-01-11 14:50:10 +01001005static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001006{
1007 /*
1008 * Determine the key exchange algorithm to use.
1009 * There are three types of key exchanges supported in TLS 1.3:
1010 * - (EC)DH with ECDSA,
1011 * - (EC)DH with PSK,
1012 * - plain PSK.
1013 *
1014 * The PSK-based key exchanges may additionally be used with 0-RTT.
1015 *
1016 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001017 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1018 * 2 ) Certificate Mode ( ephemeral )
1019 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001020 */
1021
1022 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1023
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001025 ssl->handshake->key_exchange_mode =
1026 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001027 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1028 } else
1029 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001030 ssl->handshake->key_exchange_mode =
1031 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001032 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1033 } else
1034 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001035 ssl->handshake->key_exchange_mode =
1036 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1038 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001039 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001040 1,
1041 ("ClientHello message misses mandatory extensions."));
1042 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1043 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1044 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001045 }
1046
Gilles Peskine449bd832023-01-11 14:50:10 +01001047 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001048
XiaokangQian7807f9f2022-02-15 10:04:37 +00001049}
1050
XiaokangQian81802f42022-06-10 13:25:22 +00001051#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001052 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001053
1054#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001055static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001056{
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001058 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001060 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001062 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001064 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001066 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001068 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001070 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001072 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001074 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001076 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001077 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001078 }
1079}
1080#endif /* MBEDTLS_USE_PSA_CRYPTO */
1081
XiaokangQian23c5be62022-06-07 02:04:34 +00001082/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001083 * Pick best ( private key, certificate chain ) pair based on the signature
1084 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001085 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001086MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001087static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001088{
XiaokangQianfb665a82022-06-15 03:57:21 +00001089 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001090 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001091
1092#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001094 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001096#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001098
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 if (key_cert_list == NULL) {
1100 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1101 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001102 }
1103
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1105 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001106 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001108
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001110 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001112
Gilles Peskine449bd832023-01-11 14:50:10 +01001113 for (key_cert = key_cert_list; key_cert != NULL;
1114 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001115#if defined(MBEDTLS_USE_PSA_CRYPTO)
1116 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1117#endif /* MBEDTLS_USE_PSA_CRYPTO */
1118
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1120 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001121
1122 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 * This avoids sending the client a cert it'll reject based on
1124 * keyUsage or other extensions.
1125 */
1126 if (mbedtls_x509_crt_check_key_usage(
1127 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001128 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001129 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1131 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1132 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001133 continue;
1134 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001135
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 MBEDTLS_SSL_DEBUG_MSG(3,
1137 ("ssl_tls13_pick_key_cert:"
1138 "check signature algorithm %s [%04x]",
1139 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1140 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001141#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001143#endif /* MBEDTLS_USE_PSA_CRYPTO */
1144
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1146 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001147#if defined(MBEDTLS_USE_PSA_CRYPTO)
1148 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1150 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001151#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001153 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001154 MBEDTLS_SSL_DEBUG_MSG(3,
1155 ("ssl_tls13_pick_key_cert:"
1156 "selected signature algorithm"
1157 " %s [%04x]",
1158 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1159 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001160 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 3, "selected certificate (chain)",
1162 ssl->handshake->key_cert->cert);
1163 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001164 }
XiaokangQian81802f42022-06-10 13:25:22 +00001165 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001166 }
1167
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1169 "no suitable certificate found"));
1170 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001171}
XiaokangQian81802f42022-06-10 13:25:22 +00001172#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001173 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001174
XiaokangQian4080a7f2022-04-11 09:55:18 +00001175/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001176 *
1177 * STATE HANDLING: ClientHello
1178 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001179 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001180 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001181 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001182 *
1183 * In this case, the server progresses to sending its ServerHello.
1184 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001185 * 2) The ClientHello was well-formed but didn't match the server's
1186 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001187 *
1188 * For example, the client might not have offered a key share which
1189 * the server supports, or the server might require a cookie.
1190 *
1191 * In this case, the server sends a HelloRetryRequest.
1192 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001193 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001194 *
1195 * In this case, we abort the handshake.
1196 *
1197 */
1198
1199/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001200 * Structure of this message:
1201 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001202 * uint16 ProtocolVersion;
1203 * opaque Random[32];
1204 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001205 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001206 * struct {
1207 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1208 * Random random;
1209 * opaque legacy_session_id<0..32>;
1210 * CipherSuite cipher_suites<2..2^16-2>;
1211 * opaque legacy_compression_methods<1..2^8-1>;
1212 * Extension extensions<8..2^16-1>;
1213 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001214 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001215
1216#define SSL_CLIENT_HELLO_OK 0
1217#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1218
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001219MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001220static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1221 const unsigned char *buf,
1222 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001223{
XiaokangQianb67384d2022-04-19 00:02:38 +00001224 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1225 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001226 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001227 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001228 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001229 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001230 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001231 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001232 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001233
Ronald Cron41a443a2022-10-04 16:38:25 +02001234#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001235 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001236 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001237 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001238#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001239
XiaokangQian7807f9f2022-02-15 10:04:37 +00001240 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001241 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001242 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001243 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001244 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001245 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001246 * .. . .. ciphersuite list length ( 2 bytes )
1247 * .. . .. ciphersuite list
1248 * .. . .. compression alg. list length ( 1 byte )
1249 * .. . .. compression alg. list
1250 * .. . .. extensions length ( 2 bytes, optional )
1251 * .. . .. extensions ( optional )
1252 */
1253
XiaokangQianb67384d2022-04-19 00:02:38 +00001254 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001255 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001256 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1257 * read at least up to session id length without worrying.
1258 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001259 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001260
1261 /* ...
1262 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1263 * ...
1264 * with ProtocolVersion defined as:
1265 * uint16 ProtocolVersion;
1266 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001267 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1268 MBEDTLS_SSL_VERSION_TLS1_2) {
1269 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1270 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1271 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1272 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273 }
1274 p += 2;
1275
1276 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001277 * Only support TLS 1.3 currently, temporarily set the version.
1278 */
XiaokangQiande333912022-04-20 08:49:42 +00001279 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001280
Jerry Yue67bef42022-07-07 07:29:42 +00001281#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1282 /* Store minor version for later use with ticket serialization. */
1283 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001284 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001285#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001286
Jerry Yuc1be19f2022-04-23 16:11:39 +08001287 /* ...
1288 * Random random;
1289 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001290 * with Random defined as:
1291 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1294 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001295
Gilles Peskine449bd832023-01-11 14:50:10 +01001296 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001297 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001298
Jerry Yuc1be19f2022-04-23 16:11:39 +08001299 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001300 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001301 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001302 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001303 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001304 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001305
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1307 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1308 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001309 }
1310
XiaokangQian4080a7f2022-04-11 09:55:18 +00001311 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001312 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1313 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001314 /*
1315 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001316 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001321 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322
Gilles Peskine449bd832023-01-11 14:50:10 +01001323 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001324 p += 2;
1325
XiaokangQianb67384d2022-04-19 00:02:38 +00001326 /* Check we have enough data for the ciphersuite list, the legacy
1327 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001328 *
1329 * cipher_suites cipher_suites_len bytes
1330 * legacy_compression_methods 2 bytes
1331 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001332 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001334
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 /* ...
1336 * CipherSuite cipher_suites<2..2^16-2>;
1337 * ...
1338 * with CipherSuite defined as:
1339 * uint8 CipherSuite[2];
1340 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001341#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001342 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001343#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001344 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1346 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001347
1348 /*
1349 * Search for a matching ciphersuite
1350 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001352 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001356
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001358 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 ssl, cipher_suite);
1360 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001361 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001362 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001363
Jerry Yu5725f1c2022-08-21 17:27:16 +08001364 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001365 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001366 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1367 cipher_suite,
1368 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001369 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001370
Gilles Peskine449bd832023-01-11 14:50:10 +01001371 if (handshake->ciphersuite_info == NULL) {
1372 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1373 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1374 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001375 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001376
XiaokangQian4080a7f2022-04-11 09:55:18 +00001377 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001378 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001379 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001380 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001381 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1382 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1383 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1384 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1385 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001386 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001387 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001388
Jerry Yuc1be19f2022-04-23 16:11:39 +08001389 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001390 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001391 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001392 * with Extension defined as:
1393 * struct {
1394 * ExtensionType extension_type;
1395 * opaque extension_data<0..2^16-1>;
1396 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001397 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001399 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001401 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001402
Gilles Peskine449bd832023-01-11 14:50:10 +01001403 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001404
Jerry Yu63a459c2022-10-31 13:38:40 +08001405 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001406
Gilles Peskine449bd832023-01-11 14:50:10 +01001407 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001408 unsigned int extension_type;
1409 size_t extension_data_len;
1410 const unsigned char *extension_data_end;
1411
Jerry Yu0c354a22022-08-29 15:25:36 +08001412 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001413 *
1414 * The "pre_shared_key" extension MUST be the last extension in the
1415 * ClientHello (this facilitates implementation as described below).
1416 * Servers MUST check that it is the last extension and otherwise fail
1417 * the handshake with an "illegal_parameter" alert.
1418 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001420 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001422 MBEDTLS_SSL_PEND_FATAL_ALERT(
1423 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001424 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1425 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001426 }
1427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1429 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1430 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001431 p += 4;
1432
Gilles Peskine449bd832023-01-11 14:50:10 +01001433 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001434 extension_data_end = p + extension_data_len;
1435
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001436 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1438 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1439 if (ret != 0) {
1440 return ret;
1441 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001442
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001444#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1445 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1447 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1448 extension_data_end);
1449 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001450 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001451 1, "mbedtls_ssl_parse_servername_ext", ret);
1452 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001453 }
XiaokangQian40a35232022-05-07 09:02:40 +00001454 break;
1455#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1456
XiaokangQianb67384d2022-04-19 00:02:38 +00001457#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001458 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001460
1461 /* Supported Groups Extension
1462 *
1463 * When sent by the client, the "supported_groups" extension
1464 * indicates the named groups which the client supports,
1465 * ordered from most preferred to least preferred.
1466 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001467 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 ssl, p, extension_data_end);
1469 if (ret != 0) {
1470 MBEDTLS_SSL_DEBUG_RET(1,
1471 "mbedtls_ssl_parse_supported_groups_ext", ret);
1472 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001473 }
1474
XiaokangQian7807f9f2022-02-15 10:04:37 +00001475 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001476#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001477
XiaokangQian88408882022-04-02 10:15:03 +00001478#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001479 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001480 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001481
1482 /*
1483 * Key Share Extension
1484 *
1485 * When sent by the client, the "key_share" extension
1486 * contains the endpoint's cryptographic parameters for
1487 * ECDHE/DHE key establishment methods.
1488 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001489 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 ssl, p, extension_data_end);
1491 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1492 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001493 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001494 }
1495
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001497 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 1, "ssl_tls13_parse_key_shares_ext", ret);
1499 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001500 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001501
XiaokangQian7807f9f2022-02-15 10:04:37 +00001502 break;
XiaokangQian88408882022-04-02 10:15:03 +00001503#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001504
1505 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001507
1508 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 ssl, p, extension_data_end);
1510 if (ret != 0) {
1511 MBEDTLS_SSL_DEBUG_RET(1,
1512 ("ssl_tls13_parse_supported_versions_ext"), ret);
1513 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001514 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001515 break;
1516
Ronald Cron41a443a2022-10-04 16:38:25 +02001517#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001518 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001520
1521 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 ssl, p, extension_data_end);
1523 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001524 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1526 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001527 }
1528
Jerry Yue19e3b92022-07-08 12:04:51 +00001529 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001530#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001531
Jerry Yu1c105562022-07-10 06:32:38 +00001532 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1534 if ((handshake->received_extensions &
1535 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001536 MBEDTLS_SSL_PEND_FATAL_ALERT(
1537 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001538 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1539 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001540 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001541#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001542 /* Delay processing of the PSK identity once we have
1543 * found out which algorithms to use. We keep a pointer
1544 * to the buffer and the size for later processing.
1545 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001546 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001547 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001548#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001549 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001550
XiaokangQianacb39922022-06-17 10:18:48 +00001551#if defined(MBEDTLS_SSL_ALPN)
1552 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001554
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1556 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001557 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1559 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001560 }
XiaokangQianacb39922022-06-17 10:18:48 +00001561 break;
1562#endif /* MBEDTLS_SSL_ALPN */
1563
Ronald Cron928cbd32022-10-04 16:14:26 +02001564#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001565 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001567
Gabor Mezei078e8032022-04-27 21:17:56 +02001568 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 ssl, p, extension_data_end);
1570 if (ret != 0) {
1571 MBEDTLS_SSL_DEBUG_MSG(1,
1572 (
1573 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1574 ret));
1575 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001576 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001577 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001578#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001579
1580 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001581 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001582 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001584 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001585 }
1586
1587 p += extension_data_len;
1588 }
1589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1591 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001592
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1594 MBEDTLS_SSL_HS_CLIENT_HELLO,
1595 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001596
Ronald Cron41a443a2022-10-04 16:38:25 +02001597#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598 /* Update checksum with either
1599 * - The entire content of the CH message, if no PSK extension is present
1600 * - The content up to but excluding the PSK extension, if present.
1601 */
Jerry Yu1c105562022-07-10 06:32:38 +00001602 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1604 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1605 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1606 handshake->update_checksum(ssl, buf,
1607 pre_shared_key_ext - buf);
1608 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1609 pre_shared_key_ext,
1610 pre_shared_key_ext_end,
1611 cipher_suites,
1612 cipher_suites_end);
1613 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1614 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1615 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001616 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1618 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001619 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001621#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001622 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001624 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001625
Gilles Peskine449bd832023-01-11 14:50:10 +01001626 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1627 if (ret < 0) {
1628 return ret;
1629 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001632
Gilles Peskine449bd832023-01-11 14:50:10 +01001633 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001634}
1635
1636/* Update the handshake state machine */
1637
Ronald Cronce7d76e2022-07-08 18:56:49 +02001638MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001639static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001640{
1641 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1642
XiaokangQian7807f9f2022-02-15 10:04:37 +00001643 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001644 * Server certificate selection
1645 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001646 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1647 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1648 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001649 }
1650#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1651 ssl->handshake->sni_name = NULL;
1652 ssl->handshake->sni_name_len = 0;
1653#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001654
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1656 if (ret != 0) {
1657 MBEDTLS_SSL_DEBUG_RET(1,
1658 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1659 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001660 }
1661
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001663
1664}
1665
1666/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001667 * Main entry point from the state machine; orchestrates the otherfunctions.
1668 */
1669
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001670MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001671static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001672{
1673
XiaokangQian08037552022-04-20 07:16:41 +00001674 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001675 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001676 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001677 int parse_client_hello_ret;
1678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001680
Gilles Peskine449bd832023-01-11 14:50:10 +01001681 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1682 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1683 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001684
Gilles Peskine449bd832023-01-11 14:50:10 +01001685 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1686 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001687 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1688 * only SSL_CLIENT_HELLO_OK or
1689 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1690 * stage as negative error codes are handled
1691 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1696 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1697 } else {
1698 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1699 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001700
1701cleanup:
1702
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1704 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001705}
1706
1707/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001708 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001709 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001711static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001712{
Jerry Yu637a3f12022-04-20 21:37:58 +08001713 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1714 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1716 if (ssl->conf->f_rng == NULL) {
1717 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1718 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001719 }
1720
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1722 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1723 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1724 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001725 }
1726
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1728 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001729
1730#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001732#endif /* MBEDTLS_HAVE_TIME */
1733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001735}
1736
Jerry Yu3bf2c642022-03-30 22:02:12 +08001737/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001738 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001739 *
1740 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001741 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001742 * } SupportedVersions;
1743 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001744MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001745static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 mbedtls_ssl_context *ssl,
1747 unsigned char *buf,
1748 unsigned char *end,
1749 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001750{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001751 *out_len = 0;
1752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001754
1755 /* Check if we have space to write the extension:
1756 * - extension_type (2 bytes)
1757 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001758 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001759 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001765
Gilles Peskine449bd832023-01-11 14:50:10 +01001766 mbedtls_ssl_write_version(buf + 4,
1767 ssl->conf->transport,
1768 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1771 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001772
Jerry Yu349a6132022-04-14 20:52:56 +08001773 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001774
Jerry Yub95dd362022-11-08 21:19:34 +08001775 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001779}
1780
Jerry Yud9436a12022-04-20 22:28:09 +08001781
Jerry Yu3bf2c642022-03-30 22:02:12 +08001782
1783/* Generate and export a single key share. For hybrid KEMs, this can
1784 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001785MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001786static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1787 uint16_t named_group,
1788 unsigned char *buf,
1789 unsigned char *end,
1790 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001791{
1792 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001793
1794 *out_len = 0;
1795
Jerry Yu89e103c2022-03-30 22:43:29 +08001796#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001798 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001799 ssl, named_group, buf, end, out_len);
1800 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001801 MBEDTLS_SSL_DEBUG_RET(
1802 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 ret);
1804 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001805 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001807#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001808 if (0 /* Other kinds of KEMs */) {
1809 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001810 ((void) ssl);
1811 ((void) named_group);
1812 ((void) buf);
1813 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001814 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1815 }
1816
Gilles Peskine449bd832023-01-11 14:50:10 +01001817 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001818}
1819
1820/*
1821 * ssl_tls13_write_key_share_ext
1822 *
1823 * Structure of key_share extension in ServerHello:
1824 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001825 * struct {
1826 * NamedGroup group;
1827 * opaque key_exchange<1..2^16-1>;
1828 * } KeyShareEntry;
1829 * struct {
1830 * KeyShareEntry server_share;
1831 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001832 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001833MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001834static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1835 unsigned char *buf,
1836 unsigned char *end,
1837 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001838{
Jerry Yu955ddd72022-04-22 22:27:33 +08001839 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001840 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001841 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001842 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001844
1845 *out_len = 0;
1846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001848
Gilles Peskine449bd832023-01-11 14:50:10 +01001849 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1850 mbedtls_ssl_named_group_to_str(group),
1851 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001852
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853 /* Check if we have space for header and length fields:
1854 * - extension_type (2 bytes)
1855 * - extension_data_length (2 bytes)
1856 * - group (2 bytes)
1857 * - key_exchange_length (2 bytes)
1858 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001859 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1860 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1861 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001862 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001863
Jerry Yu3bf2c642022-03-30 22:02:12 +08001864 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1865 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001866 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 ssl, group, server_share + 4, end, &key_exchange_length);
1868 if (ret != 0) {
1869 return ret;
1870 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001871 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001876
Jerry Yu57d48412022-04-20 21:50:42 +08001877 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882}
Jerry Yud9436a12022-04-20 22:28:09 +08001883
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001884MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001885static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1886 unsigned char *buf,
1887 unsigned char *end,
1888 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001889{
1890 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1891 /* key_share Extension
1892 *
1893 * struct {
1894 * select (Handshake.msg_type) {
1895 * ...
1896 * case hello_retry_request:
1897 * NamedGroup selected_group;
1898 * ...
1899 * };
1900 * } KeyShare;
1901 */
1902
1903 *out_len = 0;
1904
Jerry Yub0ac10b2022-05-05 11:10:08 +08001905 /*
1906 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1907 * of the HRR is then to transmit a cookie to force the client to demonstrate
1908 * reachability at their apparent network address (primarily useful for DTLS).
1909 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001910 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1911 return 0;
1912 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001913
1914 /* We should only send the key_share extension if the client's initial
1915 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 if (ssl->handshake->offered_group_id != 0) {
1917 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1918 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001919 }
1920
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 if (selected_group == 0) {
1922 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1923 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001924 }
1925
Jerry Yub0ac10b2022-05-05 11:10:08 +08001926 /* Check if we have enough space:
1927 * - extension_type (2 bytes)
1928 * - extension_data_length (2 bytes)
1929 * - selected_group (2 bytes)
1930 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001932
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1934 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1935 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001936
Gilles Peskine449bd832023-01-11 14:50:10 +01001937 MBEDTLS_SSL_DEBUG_MSG(3,
1938 ("HRR selected_group: %s (%x)",
1939 mbedtls_ssl_named_group_to_str(selected_group),
1940 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001941
1942 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001943
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001947}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001948
1949/*
1950 * Structure of ServerHello message:
1951 *
1952 * struct {
1953 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1954 * Random random;
1955 * opaque legacy_session_id_echo<0..32>;
1956 * CipherSuite cipher_suite;
1957 * uint8 legacy_compression_method = 0;
1958 * Extension extensions<6..2^16-1>;
1959 * } ServerHello;
1960 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001961MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001962static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1963 unsigned char *buf,
1964 unsigned char *end,
1965 size_t *out_len,
1966 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08001967{
Jerry Yu955ddd72022-04-22 22:27:33 +08001968 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001970 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001971 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001972
1973 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08001974 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001975
Jerry Yucfc04b32022-04-21 09:31:58 +08001976 /* ...
1977 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1978 * ...
1979 * with ProtocolVersion defined as:
1980 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001981 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
1983 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001984 p += 2;
1985
Jerry Yu1c3e6882022-04-20 21:23:40 +08001986 /* ...
1987 * Random random;
1988 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001989 * with Random defined as:
1990 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001991 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001992 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1993 if (is_hrr) {
1994 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
1995 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1996 } else {
1997 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
1998 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001999 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2001 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002002 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2003
Jerry Yucfc04b32022-04-21 09:31:58 +08002004 /* ...
2005 * opaque legacy_session_id_echo<0..32>;
2006 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002007 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2009 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2010 if (ssl->session_negotiate->id_len > 0) {
2011 memcpy(p, &ssl->session_negotiate->id[0],
2012 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002013 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002014
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2016 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002017 }
2018
Jerry Yucfc04b32022-04-21 09:31:58 +08002019 /* ...
2020 * CipherSuite cipher_suite;
2021 * ...
2022 * with CipherSuite defined as:
2023 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002024 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2026 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002027 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 MBEDTLS_SSL_DEBUG_MSG(3,
2029 ("server hello, chosen ciphersuite: %s ( id=%d )",
2030 mbedtls_ssl_get_ciphersuite_name(
2031 ssl->session_negotiate->ciphersuite),
2032 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002033
Jerry Yucfc04b32022-04-21 09:31:58 +08002034 /* ...
2035 * uint8 legacy_compression_method = 0;
2036 * ...
2037 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002038 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002039 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002040
Jerry Yucfc04b32022-04-21 09:31:58 +08002041 /* ...
2042 * Extension extensions<6..2^16-1>;
2043 * ...
2044 * struct {
2045 * ExtensionType extension_type; (2 bytes)
2046 * opaque extension_data<0..2^16-1>;
2047 * } Extension;
2048 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002049 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002050 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051 p += 2;
2052
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2054 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002055 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2057 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058 }
2059 p += output_len;
2060
Gilles Peskine449bd832023-01-11 14:50:10 +01002061 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2062 if (is_hrr) {
2063 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2064 } else {
2065 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2066 }
2067 if (ret != 0) {
2068 return ret;
2069 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002070 p += output_len;
2071 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002072
Ronald Cron41a443a2022-10-04 16:38:25 +02002073#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2075 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2076 if (ret != 0) {
2077 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2078 ret);
2079 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002080 }
2081 p += output_len;
2082 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002083#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002086
Gilles Peskine449bd832023-01-11 14:50:10 +01002087 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2088 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002089
Jerry Yud9436a12022-04-20 22:28:09 +08002090 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002091
Gilles Peskine449bd832023-01-11 14:50:10 +01002092 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002093
Jerry Yu7de2ff02022-11-08 21:43:46 +08002094 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002095 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 MBEDTLS_SSL_HS_SERVER_HELLO,
2097 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002100}
2101
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002102MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002103static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002104{
2105 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002106 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2107 if (ret != 0) {
2108 MBEDTLS_SSL_DEBUG_RET(1,
2109 "mbedtls_ssl_tls13_compute_handshake_transform",
2110 ret);
2111 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002112 }
2113
Gilles Peskine449bd832023-01-11 14:50:10 +01002114 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002115}
2116
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002117MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002118static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002119{
Jerry Yu637a3f12022-04-20 21:37:58 +08002120 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002121 unsigned char *buf;
2122 size_t buf_len, msg_len;
2123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2129 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2130 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002131
Gilles Peskine449bd832023-01-11 14:50:10 +01002132 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2133 buf + buf_len,
2134 &msg_len,
2135 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002136
Jerry Yu3bf2c642022-03-30 22:02:12 +08002137 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2141 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002142
Gilles Peskine449bd832023-01-11 14:50:10 +01002143 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002144
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002145#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2146 /* The server sends a dummy change_cipher_spec record immediately
2147 * after its first handshake message. This may either be after
2148 * a ServerHello or a HelloRetryRequest.
2149 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002150 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002152#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002154#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002155
Jerry Yuf4b27e42022-03-30 17:32:21 +08002156cleanup:
2157
Gilles Peskine449bd832023-01-11 14:50:10 +01002158 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2159 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002160}
2161
Jerry Yu23d1a252022-05-12 18:08:59 +08002162
2163/*
2164 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2165 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002166MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002167static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002168{
2169 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 if (ssl->handshake->hello_retry_request_count > 0) {
2171 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2172 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2173 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2174 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002175 }
2176
2177 /*
2178 * Create stateless transcript hash for HRR
2179 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002180 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2181 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2182 if (ret != 0) {
2183 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2184 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002185 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002187
Gilles Peskine449bd832023-01-11 14:50:10 +01002188 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002189}
2190
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002191MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002193{
2194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2195 unsigned char *buf;
2196 size_t buf_len, msg_len;
2197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002201
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2203 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2204 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2207 buf + buf_len,
2208 &msg_len,
2209 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002210 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002212
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2215 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002216
2217 ssl->handshake->hello_retry_request_count++;
2218
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002219#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2220 /* The server sends a dummy change_cipher_spec record immediately
2221 * after its first handshake message. This may either be after
2222 * a ServerHello or a HelloRetryRequest.
2223 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002224 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002226#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002228#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002229
2230cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2232 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002233}
2234
Jerry Yu5b64ae92022-03-30 17:15:02 +08002235/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002236 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2237 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002238
2239/*
2240 * struct {
2241 * Extension extensions<0..2 ^ 16 - 1>;
2242 * } EncryptedExtensions;
2243 *
2244 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002245MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002246static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2247 unsigned char *buf,
2248 unsigned char *end,
2249 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002250{
XiaokangQianacb39922022-06-17 10:18:48 +00002251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002252 unsigned char *p = buf;
2253 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002254 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002255 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002256
Jerry Yu4d3841a2022-04-16 12:37:19 +08002257 *out_len = 0;
2258
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002260 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002261 p += 2;
2262
Jerry Yu8937eb42022-05-03 12:12:14 +08002263 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002264 ((void) ret);
2265 ((void) output_len);
2266
2267#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2269 if (ret != 0) {
2270 return ret;
2271 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002272 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002273#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002274
Gilles Peskine449bd832023-01-11 14:50:10 +01002275 extensions_len = (p - p_extensions_len) - 2;
2276 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002277
2278 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002279
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002281
Jerry Yu7de2ff02022-11-08 21:43:46 +08002282 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002284
Gilles Peskine449bd832023-01-11 14:50:10 +01002285 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002286}
2287
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002288MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002289static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002290{
2291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2292 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002293 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002294
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 mbedtls_ssl_set_outbound_transform(ssl,
2296 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002297 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002301
Gilles Peskine449bd832023-01-11 14:50:10 +01002302 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2303 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2304 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2307 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002308
2309 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002311
Gilles Peskine449bd832023-01-11 14:50:10 +01002312 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2313 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002314
Ronald Cron928cbd32022-10-04 16:14:26 +02002315#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002316 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2317 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2318 } else {
2319 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2320 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002321#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002323#endif
2324
Jerry Yu4d3841a2022-04-16 12:37:19 +08002325cleanup:
2326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2328 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002329}
2330
Ronald Cron928cbd32022-10-04 16:14:26 +02002331#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002332#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2333#define SSL_CERTIFICATE_REQUEST_SKIP 1
2334/* Coordination:
2335 * Check whether a CertificateRequest message should be written.
2336 * Returns a negative code on failure, or
2337 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2338 * - SSL_CERTIFICATE_REQUEST_SKIP
2339 * indicating if the writing of the CertificateRequest
2340 * should be skipped or not.
2341 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002342MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002343static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002344{
2345 int authmode;
2346
XiaokangQian40a35232022-05-07 09:02:40 +00002347#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002349 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002351#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002352 authmode = ssl->conf->authmode;
2353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002355 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002356 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002357 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002358
XiaokangQianc3017f62022-05-13 05:55:41 +00002359 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002360
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002362}
2363
XiaokangQiancec9ae62022-05-06 07:28:50 +00002364/*
2365 * struct {
2366 * opaque certificate_request_context<0..2^8-1>;
2367 * Extension extensions<2..2^16-1>;
2368 * } CertificateRequest;
2369 *
2370 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002371MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002372static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2373 unsigned char *buf,
2374 const unsigned char *end,
2375 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002376{
2377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2378 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002379 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002380 unsigned char *p_extensions_len;
2381
2382 *out_len = 0;
2383
2384 /* Check if we have enough space:
2385 * - certificate_request_context (1 byte)
2386 * - extensions length (2 bytes)
2387 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002389
2390 /*
2391 * Write certificate_request_context
2392 */
2393 /*
2394 * We use a zero length context for the normal handshake
2395 * messages. For post-authentication handshake messages
2396 * this request context would be set to a non-zero value.
2397 */
2398 *p++ = 0x0;
2399
2400 /*
2401 * Write extensions
2402 */
2403 /* The extensions must contain the signature_algorithms. */
2404 p_extensions_len = p;
2405 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2407 if (ret != 0) {
2408 return ret;
2409 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002410
XiaokangQianec6efb92022-05-06 09:53:10 +00002411 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002413
2414 *out_len = p - buf;
2415
Jerry Yu7de2ff02022-11-08 21:43:46 +08002416 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002418
Gilles Peskine449bd832023-01-11 14:50:10 +01002419 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002420}
2421
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002422MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002423static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002424{
2425 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002428
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002430
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002432 unsigned char *buf;
2433 size_t buf_len, msg_len;
2434
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2436 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2437 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002438
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2440 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002441
2442 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002444
Gilles Peskine449bd832023-01-11 14:50:10 +01002445 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2446 ssl, buf_len, msg_len));
2447 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2448 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002449 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 } else {
2451 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002452 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2453 goto cleanup;
2454 }
2455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002457cleanup:
2458
Gilles Peskine449bd832023-01-11 14:50:10 +01002459 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2460 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002461}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002462
Jerry Yu4d3841a2022-04-16 12:37:19 +08002463/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002464 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002465 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002466MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002467static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002468{
Jerry Yu5a26f302022-05-10 20:46:40 +08002469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002470
2471#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002472 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2473 mbedtls_ssl_own_cert(ssl) == NULL) {
2474 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2475 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2476 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2477 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002478 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002479#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2482 if (ret != 0) {
2483 return ret;
2484 }
2485 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2486 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002487}
2488
2489/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002490 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002491 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002492MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002493static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002494{
Gilles Peskine449bd832023-01-11 14:50:10 +01002495 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2496 if (ret != 0) {
2497 return ret;
2498 }
2499 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2500 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002501}
Ronald Cron928cbd32022-10-04 16:14:26 +02002502#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002503
2504/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002505 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002506 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002507MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002508static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002509{
Jerry Yud6e253d2022-05-18 13:59:24 +08002510 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002511
Gilles Peskine449bd832023-01-11 14:50:10 +01002512 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2513 if (ret != 0) {
2514 return ret;
2515 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002516
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2518 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002519 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2521 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2522 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002523 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2526 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002527
Gilles Peskine449bd832023-01-11 14:50:10 +01002528 if (ssl->handshake->certificate_request_sent) {
2529 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2530 } else {
2531 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2532 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2533 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002534 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002535
Gilles Peskine449bd832023-01-11 14:50:10 +01002536 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002537}
2538
2539/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002540 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002541 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002542MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002543static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002544{
Jerry Yud6e253d2022-05-18 13:59:24 +08002545 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2546
Gilles Peskine449bd832023-01-11 14:50:10 +01002547 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2548 if (ret != 0) {
2549 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002550 }
2551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2553 if (ret != 0) {
2554 MBEDTLS_SSL_DEBUG_RET(1,
2555 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2556 }
2557
2558 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2559 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002560}
2561
2562/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002563 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002564 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002565MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002566static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002567{
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002569
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002571
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002572#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2573 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002574/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2575 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2576 * expected to be resolved with issue#6395.
2577 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002578 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002579 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2580 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002581 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002582#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002583 {
2584 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2585 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002587}
2588
2589/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002590 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002591 */
2592#define SSL_NEW_SESSION_TICKET_SKIP 0
2593#define SSL_NEW_SESSION_TICKET_WRITE 1
2594MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002595static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002596{
2597 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (ssl->conf->f_ticket_write == NULL) {
2599 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2600 " callback is not set"));
2601 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002602 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (ssl->conf->new_session_tickets_count == 0) {
2604 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2605 " configured count is zero"));
2606 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002607 }
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (ssl->handshake->new_session_tickets_count == 0) {
2610 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2611 "been sent."));
2612 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002613 }
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002616}
2617
2618#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2619MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002620static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2621 unsigned char *ticket_nonce,
2622 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002623{
2624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2625 mbedtls_ssl_session *session = ssl->session;
2626 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2627 psa_algorithm_t psa_hash_alg;
2628 int hash_length;
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002631
2632#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002634#endif
2635
Pengyu Lv9f926952022-11-17 15:22:33 +08002636 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002637 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002638 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002639#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002640 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002641 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002642#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002643 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002644
Jerry Yue67bef42022-07-07 07:29:42 +00002645 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2647 (unsigned char *) &session->ticket_age_add,
2648 sizeof(session->ticket_age_add)) != 0)) {
2649 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2650 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002651 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2653 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002654
2655 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2657 if (ret != 0) {
2658 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2659 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002660 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2662 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002663
2664 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2666 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2667 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2668 if (hash_length == -1 ||
2669 (size_t) hash_length > sizeof(session->resumption_key)) {
2670 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002671 }
2672
Jerry Yue67bef42022-07-07 07:29:42 +00002673 /* In this code the psk key length equals the length of the hash */
2674 session->resumption_key_len = hash_length;
2675 session->ciphersuite = ciphersuite_info->id;
2676
2677 /* Compute resumption key
2678 *
2679 * HKDF-Expand-Label( resumption_master_secret,
2680 * "resumption", ticket_nonce, Hash.length )
2681 */
2682 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 psa_hash_alg,
2684 session->app_secrets.resumption_master_secret,
2685 hash_length,
2686 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2687 ticket_nonce,
2688 ticket_nonce_size,
2689 session->resumption_key,
2690 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 if (ret != 0) {
2693 MBEDTLS_SSL_DEBUG_RET(2,
2694 "Creating the ticket-resumed PSK failed",
2695 ret);
2696 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002697 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2699 session->resumption_key,
2700 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2703 session->app_secrets.resumption_master_secret,
2704 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002707}
2708
2709/* This function creates a NewSessionTicket message in the following format:
2710 *
2711 * struct {
2712 * uint32 ticket_lifetime;
2713 * uint32 ticket_age_add;
2714 * opaque ticket_nonce<0..255>;
2715 * opaque ticket<1..2^16-1>;
2716 * Extension extensions<0..2^16-2>;
2717 * } NewSessionTicket;
2718 *
2719 * The ticket inside the NewSessionTicket message is an encrypted container
2720 * carrying the necessary information so that the server is later able to
2721 * re-start the communication.
2722 *
2723 * The following fields are placed inside the ticket by the
2724 * f_ticket_write() function:
2725 *
2726 * - creation time (start)
2727 * - flags (flags)
2728 * - age add (ticket_age_add)
2729 * - key (key)
2730 * - key length (key_len)
2731 * - ciphersuite (ciphersuite)
2732 */
2733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002734static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2735 unsigned char *buf,
2736 unsigned char *end,
2737 size_t *out_len,
2738 unsigned char *ticket_nonce,
2739 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002740{
2741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2742 unsigned char *p = buf;
2743 mbedtls_ssl_session *session = ssl->session;
2744 size_t ticket_len;
2745 uint32_t ticket_lifetime;
2746
2747 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002749
2750 /*
2751 * ticket_lifetime 4 bytes
2752 * ticket_age_add 4 bytes
2753 * ticket_nonce 1 + ticket_nonce_size bytes
2754 * ticket >=2 bytes
2755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002757
2758 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2760 session,
2761 p + 9 + ticket_nonce_size + 2,
2762 end,
2763 &ticket_len,
2764 &ticket_lifetime);
2765 if (ret != 0) {
2766 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2767 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002768 }
2769 /* RFC 8446 4.6.1
2770 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2771 * unsigned integer in network byte order from the time of ticket
2772 * issuance. Servers MUST NOT use any value greater than
2773 * 604800 seconds (7 days). The value of zero indicates that the
2774 * ticket should be discarded immediately. Clients MUST NOT cache
2775 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2776 * and MAY delete tickets earlier based on local policy. A server
2777 * MAY treat a ticket as valid for a shorter period of time than what
2778 * is stated in the ticket_lifetime.
2779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002781 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 }
2783 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2784 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2785 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002786
2787 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2789 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2790 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002791
2792 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 p[8] = (unsigned char) ticket_nonce_size;
2794 if (ticket_nonce_size > 0) {
2795 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002796 }
2797 p += 9 + ticket_nonce_size;
2798
2799 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002801 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002803 p += ticket_len;
2804
2805 /* Ticket Extensions
2806 *
2807 * Note: We currently don't have any extensions.
2808 * Set length to zero.
2809 */
Jerry Yuedab6372022-10-31 14:37:31 +08002810 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2813 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002814 p += 2;
2815
2816 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2818 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002819
Jerry Yu7de2ff02022-11-08 21:43:46 +08002820 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002824}
2825
2826/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002827 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002829static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002830{
2831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002836 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2837 unsigned char *buf;
2838 size_t buf_len, msg_len;
2839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2841 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2844 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2845 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2848 ssl, buf, buf + buf_len, &msg_len,
2849 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2852 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002853
Jerry Yu359e65f2022-09-22 23:47:43 +08002854 /* Limit session tickets count to one when resumption connection.
2855 *
2856 * See document of mbedtls_ssl_conf_new_session_tickets.
2857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002859 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002861 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002863
Jerry Yua8d3c502022-10-30 14:51:23 +08002864 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2866 } else {
2867 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002868 }
2869
Jerry Yue67bef42022-07-07 07:29:42 +00002870cleanup:
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002873}
2874#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2875
2876/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002877 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002880{
XiaokangQian08037552022-04-20 07:16:41 +00002881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2885 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2888 mbedtls_ssl_states_str(ssl->state),
2889 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002892 /* start state */
2893 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002895 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002896 break;
2897
XiaokangQian7807f9f2022-02-15 10:04:37 +00002898 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 ret = ssl_tls13_process_client_hello(ssl);
2900 if (ret != 0) {
2901 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2902 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002903 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002904
Jerry Yuf41553b2022-05-09 22:20:30 +08002905 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 ret = ssl_tls13_write_hello_retry_request(ssl);
2907 if (ret != 0) {
2908 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2909 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002910 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002911 break;
2912
Jerry Yu5b64ae92022-03-30 17:15:02 +08002913 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002915 break;
2916
Xiaofei Baicba64af2022-02-15 10:00:56 +00002917 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 ret = ssl_tls13_write_encrypted_extensions(ssl);
2919 if (ret != 0) {
2920 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2921 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002922 }
Jerry Yu48330562022-05-06 21:35:44 +08002923 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002924
Ronald Cron928cbd32022-10-04 16:14:26 +02002925#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002926 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002928 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002929
Jerry Yu83da34e2022-04-16 13:59:52 +08002930 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002932 break;
2933
2934 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002936 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002937#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 /*
2940 * Injection of dummy-CCS's for middlebox compatibility
2941 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002942#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002943 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2945 if (ret == 0) {
2946 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2947 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002948 break;
2949
2950 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2952 if (ret == 0) {
2953 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2954 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002955 break;
2956#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2957
Jerry Yu69dd8d42022-04-16 12:51:26 +08002958 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002960 break;
2961
2962 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002964 break;
2965
Jerry Yu69dd8d42022-04-16 12:51:26 +08002966 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002968 break;
2969
Ronald Cron766c0cd2022-10-18 12:17:11 +02002970#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00002971 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2973 if (ret == 0) {
2974 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02002975 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2977 } else {
2978 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02002979 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002981 }
XiaokangQian6b916b12022-04-25 07:29:34 +00002982 }
2983 break;
2984
2985 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2987 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00002988 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00002990 }
2991 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02002992#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00002993
Jerry Yue67bef42022-07-07 07:29:42 +00002994#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08002995 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = ssl_tls13_write_new_session_ticket(ssl);
2997 if (ret != 0) {
2998 MBEDTLS_SSL_DEBUG_RET(1,
2999 "ssl_tls13_write_new_session_ticket ",
3000 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003001 }
3002 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003003 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003004 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003005 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003006 * as part of ssl_prepare_handshake_step.
3007 */
3008 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 if (ssl->handshake->new_session_tickets_count == 0) {
3011 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3012 } else {
3013 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3014 }
Jerry Yue67bef42022-07-07 07:29:42 +00003015 break;
3016
3017#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3018
XiaokangQian7807f9f2022-02-15 10:04:37 +00003019 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3021 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003022 }
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003025}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003026
Jerry Yufb4b6472022-01-27 15:03:26 +08003027#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */