blob: 196d09a72582c48359c9ad95586c07a131d52dd0 [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"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020028#include "md_psa.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080029
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000030#include "ssl_misc.h"
31#include "ssl_tls13_keys.h"
32#include "ssl_debug_helpers.h"
33
Jerry Yuf35ba382022-08-23 17:58:26 +080034
Jerry Yuc5a23a02022-08-25 10:51:44 +080035static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010036 mbedtls_ssl_context *ssl,
37 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080038{
39 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010040 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
41 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080042 }
Gilles Peskine449bd832023-01-11 14:50:10 +010043
44 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
45 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
46 ssl->tls_version,
47 ssl->tls_version) != 0)) {
48 return NULL;
49 }
50 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080051}
52
Ronald Cron41a443a2022-10-04 16:38:25 +020053#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000054/* From RFC 8446:
55 *
56 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
57 * struct {
58 * PskKeyExchangeMode ke_modes<1..255>;
59 * } PskKeyExchangeModes;
60 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080061MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010062static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
63 const unsigned char *buf,
64 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000065{
Jerry Yu299e31f2022-07-13 23:06:36 +080066 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000067 size_t ke_modes_len;
68 int ke_modes = 0;
69
Jerry Yu854dd9e2022-07-15 14:28:27 +080070 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010071 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080072 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000073 /* Currently, there are only two PSK modes, so even without looking
74 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010075 if (ke_modes_len > 2) {
76 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
77 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
78 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080079 }
Jerry Yue19e3b92022-07-08 12:04:51 +000080
Gilles Peskine449bd832023-01-11 14:50:10 +010081 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000082
Gilles Peskine449bd832023-01-11 14:50:10 +010083 while (ke_modes_len-- != 0) {
84 switch (*p++) {
85 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
86 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
87 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
88 break;
89 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
90 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
91 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
92 break;
93 default:
94 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
95 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
96 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000097 }
98 }
99
100 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100101 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000102}
Jerry Yu1c105562022-07-10 06:32:38 +0000103
Jerry Yue9d4fc02022-08-20 19:21:15 +0800104#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
105#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800106
107#if defined(MBEDTLS_SSL_SESSION_TICKETS)
108
109MBEDTLS_CHECK_RETURN_CRITICAL
110static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100111 mbedtls_ssl_context *ssl,
112 const unsigned char *identity,
113 size_t identity_len,
114 uint32_t obfuscated_ticket_age,
115 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800116{
Jerry Yufd310eb2022-09-06 09:16:35 +0800117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800118 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800119#if defined(MBEDTLS_HAVE_TIME)
120 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800121 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800122 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800123#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800124
125 ((void) obfuscated_ticket_age);
126
Gilles Peskine449bd832023-01-11 14:50:10 +0100127 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800128
Jerry Yufd310eb2022-09-06 09:16:35 +0800129 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100130 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
131 return 0;
132 }
Jerry Yu95699e72022-08-21 19:22:23 +0800133
Jerry Yu4746b102022-09-13 11:11:48 +0800134 /* We create a copy of the encrypted ticket since the ticket parsing
135 * function is allowed to use its input buffer as an output buffer
136 * (in-place decryption). We do, however, need the original buffer for
137 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800138 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139 ticket_buffer = mbedtls_calloc(1, identity_len);
140 if (ticket_buffer == NULL) {
141 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
142 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800143 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100144 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800145
Gilles Peskine449bd832023-01-11 14:50:10 +0100146 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
147 session,
148 ticket_buffer, identity_len)) != 0) {
149 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
150 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
151 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
152 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
153 } else {
154 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
155 }
Jerry Yu95699e72022-08-21 19:22:23 +0800156 }
157
158 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100159 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800160
Gilles Peskine449bd832023-01-11 14:50:10 +0100161 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800162 goto exit;
163 }
Jerry Yu95699e72022-08-21 19:22:23 +0800164
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800165 /* RFC 8446 section 4.2.9
166 *
167 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
168 * compatible with the advertised modes; however, if a server does so,
169 * the impact will just be that the client's attempts at resumption fail.
170 *
171 * We regard the ticket with incompatible key exchange modes as not match.
172 */
Pengyu Lv18946532023-01-12 12:28:09 +0800173 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv4938a562023-01-16 11:28:49 +0800174 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
Pengyu Lv80270b22023-01-12 11:54:04 +0800175 session->ticket_flags);
Pengyu Lve2f1dbf2023-01-16 12:28:27 +0800176 if (mbedtls_ssl_tls13_check_kex_modes(
177 ssl,
178 mbedtls_ssl_session_get_ticket_flags(
179 session,
180 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800181 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
182 goto exit;
183 }
184
Gilles Peskine449bd832023-01-11 14:50:10 +0100185 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
186#if defined(MBEDTLS_HAVE_TIME)
187 now = mbedtls_time(NULL);
188
189 if (now < session->start) {
190 MBEDTLS_SSL_DEBUG_MSG(
191 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
192 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
193 (long long) now, (long long) session->start));
194 goto exit;
195 }
196
197 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800198
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800199 /* RFC 8446 section 4.6.1
200 *
201 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
202 *
203 * RFC 8446 section 4.2.11.1
204 *
205 * Clients MUST NOT attempt to use tickets which have ages greater than
206 * the "ticket_lifetime" value which was provided with the ticket.
207 *
208 * For time being, the age MUST be less than 604800 seconds (7 days).
209 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800211 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100212 3, ("Ticket age exceeds limitation ticket_age=%lu",
213 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800214 goto exit;
215 }
Jerry Yu95699e72022-08-21 19:22:23 +0800216
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800217 /* RFC 8446 section 4.2.10
218 *
219 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
220 * the ticket age for the selected PSK identity (computed by subtracting
221 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
222 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800223 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800224 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
225 * as the age units are different on the server (s) and in the
226 * client (ms) side. Add a -1000 ms tolerance window to take this
227 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800228 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800229 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
231 if (age_diff_in_ms <= -1000 ||
232 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800233 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 3, ("Ticket age outside tolerance window ( diff=%d )",
235 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800236 goto exit;
237 }
238
239 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800240
241#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800242
243exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 if (ret != 0) {
245 mbedtls_ssl_session_free(session);
246 }
Jerry Yu95699e72022-08-21 19:22:23 +0800247
Gilles Peskine449bd832023-01-11 14:50:10 +0100248 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
249 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800250}
251#endif /* MBEDTLS_SSL_SESSION_TICKETS */
252
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800253MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000254static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 mbedtls_ssl_context *ssl,
256 const unsigned char *identity,
257 size_t identity_len,
258 uint32_t obfuscated_ticket_age,
259 int *psk_type,
260 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000261{
Ronald Cron606671e2023-02-17 11:36:33 +0100262 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
263
Jerry Yu95699e72022-08-21 19:22:23 +0800264 ((void) session);
265 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800266 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800267
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800269 ssl->handshake->resume = 0;
270
Jerry Yu95699e72022-08-21 19:22:23 +0800271#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800273 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800275 ssl->handshake->resume = 1;
276 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100277 ret = mbedtls_ssl_set_hs_psk(ssl,
278 session->resumption_key,
279 session->resumption_key_len);
280 if (ret != 0) {
281 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
282 return ret;
283 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100284
285 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
286 session->resumption_key,
287 session->resumption_key_len);
288 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
289 (unsigned) obfuscated_ticket_age));
290 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800291 }
292#endif /* MBEDTLS_SSL_SESSION_TICKETS */
293
Jerry Yu1c105562022-07-10 06:32:38 +0000294 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 if (ssl->conf->f_psk != NULL) {
296 if (ssl->conf->f_psk(
297 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
298 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000299 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000301 }
302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000304 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800306 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 mbedtls_ct_memcmp(ssl->conf->psk_identity,
308 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100309 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
310 if (ret != 0) {
311 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
312 return ret;
313 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000315 }
316
Gilles Peskine449bd832023-01-11 14:50:10 +0100317 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000318}
319
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800320MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000321static int ssl_tls13_offered_psks_check_binder_match(
322 mbedtls_ssl_context *ssl,
323 const unsigned char *binder, size_t binder_len,
324 int psk_type, psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000325{
326 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800327
Jerry Yudaf375a2022-07-20 21:31:43 +0800328 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000329 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800330 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800331 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800332 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000333
Jerry Yu1c105562022-07-10 06:32:38 +0000334 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800335 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200336 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 transcript, sizeof(transcript), &transcript_len);
338 if (ret != 0) {
339 return ret;
340 }
Jerry Yu1c105562022-07-10 06:32:38 +0000341
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
343 if (ret != 0) {
344 return ret;
345 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800346
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
348 psk, psk_len, psk_type,
349 transcript,
350 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800351#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800353#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 if (ret != 0) {
355 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
356 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000357 }
358
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
360 server_computed_binder, transcript_len);
361 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000362
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
364 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000365 }
366
Gilles Peskine449bd832023-01-11 14:50:10 +0100367 mbedtls_platform_zeroize(server_computed_binder,
368 sizeof(server_computed_binder));
369 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000370}
Jerry Yu96a2e362022-07-21 15:11:34 +0800371
Jerry Yu5725f1c2022-08-21 17:27:16 +0800372MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800373static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 mbedtls_ssl_context *ssl,
375 const unsigned char *cipher_suites,
376 const unsigned char *cipher_suites_end,
377 uint16_t *selected_ciphersuite,
378 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379{
Jerry Yuf35ba382022-08-23 17:58:26 +0800380 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800381
Jerry Yu0baf9072022-08-25 11:21:04 +0800382 *selected_ciphersuite = 0;
383 *selected_ciphersuite_info = NULL;
384
Jerry Yuf35ba382022-08-23 17:58:26 +0800385 /* RFC 8446, page 55.
386 *
387 * For externally established PSKs, the Hash algorithm MUST be set when the
388 * PSK is established or default to SHA-256 if no such algorithm is defined.
389 *
390 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800391
Jerry Yu5725f1c2022-08-21 17:27:16 +0800392 /*
393 * Search for a matching ciphersuite
394 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 for (const unsigned char *p = cipher_suites;
396 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800397 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800399
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
401 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
402 cipher_suite);
403 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800404 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800406
Jerry Yu5725f1c2022-08-21 17:27:16 +0800407 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
408 * Otherwise, client should reject.
409 */
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +0200410 if (psk_hash_alg == mbedtls_md_psa_alg_from_type(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800411 *selected_ciphersuite = cipher_suite;
412 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800414 }
415 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100416 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
417 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800418}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800419
Jerry Yu82534862022-08-30 10:42:33 +0800420#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800421MBEDTLS_CHECK_RETURN_CRITICAL
422static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 mbedtls_ssl_context *ssl,
424 const unsigned char *cipher_suites,
425 const unsigned char *cipher_suites_end,
426 mbedtls_ssl_session *session,
427 uint16_t *selected_ciphersuite,
428 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800429{
Jerry Yu82534862022-08-30 10:42:33 +0800430
Jerry Yuf35ba382022-08-23 17:58:26 +0800431 *selected_ciphersuite = 0;
432 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
434 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800435 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
436
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800438 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 }
Jerry Yu82534862022-08-30 10:42:33 +0800440
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
442 cipher_suite);
443 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800444 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 }
Jerry Yu82534862022-08-30 10:42:33 +0800446
Jerry Yu4746b102022-09-13 11:11:48 +0800447 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800448 *selected_ciphersuite_info = ciphersuite_info;
449
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800451 }
452
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800454}
Jerry Yuf35ba382022-08-23 17:58:26 +0800455
Jerry Yu82534862022-08-30 10:42:33 +0800456MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100457static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
458 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800459{
Jerry Yu82534862022-08-30 10:42:33 +0800460 dst->ticket_age_add = src->ticket_age_add;
461 dst->ticket_flags = src->ticket_flags;
462 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100463 if (src->resumption_key_len == 0) {
464 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
465 }
466 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800467
Gilles Peskine449bd832023-01-11 14:50:10 +0100468 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800469}
470#endif /* MBEDTLS_SSL_SESSION_TICKETS */
471
Jerry Yu1c105562022-07-10 06:32:38 +0000472/* Parser for pre_shared_key extension in client hello
473 * struct {
474 * opaque identity<1..2^16-1>;
475 * uint32 obfuscated_ticket_age;
476 * } PskIdentity;
477 *
478 * opaque PskBinderEntry<32..255>;
479 *
480 * struct {
481 * PskIdentity identities<7..2^16-1>;
482 * PskBinderEntry binders<33..2^16-1>;
483 * } OfferedPsks;
484 *
485 * struct {
486 * select (Handshake.msg_type) {
487 * case client_hello: OfferedPsks;
488 * ....
489 * };
490 * } PreSharedKeyExtension;
491 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800492MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000493static int ssl_tls13_parse_pre_shared_key_ext(
494 mbedtls_ssl_context *ssl,
495 const unsigned char *pre_shared_key_ext,
496 const unsigned char *pre_shared_key_ext_end,
497 const unsigned char *ciphersuites,
498 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000499{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100500 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800501 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800502 const unsigned char *p_identity_len;
503 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000504 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800505 const unsigned char *binders;
506 const unsigned char *p_binder_len;
507 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000508 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800509 int matched_identity = -1;
510 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000511
Gilles Peskine449bd832023-01-11 14:50:10 +0100512 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
513 pre_shared_key_ext,
514 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000515
Jerry Yu96a2e362022-07-21 15:11:34 +0800516 /* identities_len 2 bytes
517 * identities_data >= 7 bytes
518 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
520 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800521 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
523 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800524 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000525
Jerry Yu96a2e362022-07-21 15:11:34 +0800526 /* binders_len 2 bytes
527 * binders >= 33 bytes
528 */
Jerry Yu568ec252022-07-22 21:27:34 +0800529 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
531 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800532 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100533 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800534 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000535
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100536 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
537 identities_end - pre_shared_key_ext);
538 if (0 != ret) {
539 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
540 return ret;
541 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800542
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000544 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800545 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800546 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800547 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800548 size_t binder_len;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800549 int psk_type;
550 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800551 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800552#if defined(MBEDTLS_SSL_SESSION_TICKETS)
553 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800555#endif
Jerry Yubb852022022-07-20 21:10:44 +0800556
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
558 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800559 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
561 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800562 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800565 binder_len = *p_binder_len;
566 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800568 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800569
Jerry Yu96a2e362022-07-21 15:11:34 +0800570 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000572 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 }
Jerry Yu1c105562022-07-10 06:32:38 +0000574
Jerry Yu96a2e362022-07-21 15:11:34 +0800575 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 ssl, identity, identity_len, obfuscated_ticket_age,
577 &psk_type, &session);
578 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800579 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800581
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
583 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800584 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
585 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 ssl, ciphersuites, ciphersuites_end,
587 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800588 break;
589 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800590#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800591 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 ssl, ciphersuites, ciphersuites_end, &session,
593 &cipher_suite, &ciphersuite_info);
594 if (ret != 0) {
595 mbedtls_ssl_session_free(&session);
596 }
Jerry Yu82534862022-08-30 10:42:33 +0800597#else
598 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
599#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800600 break;
601 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100602 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800603 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800605 /* See below, no cipher_suite available, abort handshake */
606 MBEDTLS_SSL_PEND_FATAL_ALERT(
607 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800609 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 2, "ssl_tls13_select_ciphersuite", ret);
611 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800612 }
613
Jerry Yu96a2e362022-07-21 15:11:34 +0800614 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 ssl, binder, binder_len, psk_type,
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +0200616 mbedtls_md_psa_alg_from_type(ciphersuite_info->mac));
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800618 /* For security reasons, the handshake should be aborted when we
619 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
620 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800621#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800623#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000625 MBEDTLS_SSL_DEBUG_RET(
626 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800627 MBEDTLS_SSL_PEND_FATAL_ALERT(
628 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
630 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800631 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800632
633 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800634
635 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800636 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800637 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100638 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
639 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800640#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100641 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
642 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
643 &session);
644 mbedtls_ssl_session_free(&session);
645 if (ret != 0) {
646 return ret;
647 }
Jerry Yu82534862022-08-30 10:42:33 +0800648 }
649#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000650 }
651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 if (p_identity_len != identities_end || p_binder_len != binders_end) {
653 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
654 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
655 MBEDTLS_ERR_SSL_DECODE_ERROR);
656 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000657 }
658
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800659 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000660 ret = ssl->handshake->update_checksum(
661 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100662 if (0 != ret) {
663 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
664 return ret;
665 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100666 if (matched_identity == -1) {
667 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
668 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000669 }
670
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 ssl->handshake->selected_identity = (uint16_t) matched_identity;
672 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000673
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000675}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000676
677/*
678 * struct {
679 * select ( Handshake.msg_type ) {
680 * ....
681 * case server_hello:
682 * uint16 selected_identity;
683 * }
684 * } PreSharedKeyExtension;
685 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
687 unsigned char *buf,
688 unsigned char *end,
689 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000690{
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000692
693 *olen = 0;
694
David Horstmann21b89762022-10-06 18:34:28 +0100695 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000696#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000700#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702 /* We shouldn't have called this extension writer unless we've
703 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705 }
706
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
708 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000709
Gilles Peskine449bd832023-01-11 14:50:10 +0100710 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
711 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000712
Gilles Peskine449bd832023-01-11 14:50:10 +0100713 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000714
715 *olen = 6;
716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
718 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000719
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000723}
724
Ronald Cron41a443a2022-10-04 16:38:25 +0200725#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000726
XiaokangQian7807f9f2022-02-15 10:04:37 +0000727/* From RFC 8446:
728 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000729 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000730 * } SupportedVersions;
731 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200732MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100733static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
734 const unsigned char *buf,
735 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000736{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000738 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000739 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000740 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100741 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000744 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745 p += 1;
746
Gilles Peskine449bd832023-01-11 14:50:10 +0100747 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000748 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 while (p < versions_end) {
750 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
751 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000752 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753
Ronald Cron3bd2b022023-04-03 16:45:39 +0200754 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100755 found_supported_version = 1;
756 break;
757 }
758
Ronald Cron3bd2b022023-04-03 16:45:39 +0200759 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
760 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100761 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000762 break;
763 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000764 }
765
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100766 if (!found_supported_version) {
767 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000768
Gilles Peskine449bd832023-01-11 14:50:10 +0100769 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
770 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
771 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772 }
773
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100774 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100777 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778}
779
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200780#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000781/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000782 *
783 * From RFC 8446:
784 * enum {
785 * ... (0xFFFF)
786 * } NamedGroup;
787 * struct {
788 * NamedGroup named_group_list<2..2^16-1>;
789 * } NamedGroupList;
790 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200791MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100792static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
793 const unsigned char *buf,
794 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000795{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000796 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000797 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000798 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000799
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
801 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
802 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000803 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100804 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000805 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000806 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000807
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000809 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
811 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000812 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000813
Gilles Peskine449bd832023-01-11 14:50:10 +0100814 MBEDTLS_SSL_DEBUG_MSG(2,
815 ("got named group: %s(%04x)",
816 mbedtls_ssl_named_group_to_str(named_group),
817 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000818
Gilles Peskine449bd832023-01-11 14:50:10 +0100819 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
820 !mbedtls_ssl_named_group_is_supported(named_group) ||
821 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000822 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000823 }
824
Gilles Peskine449bd832023-01-11 14:50:10 +0100825 MBEDTLS_SSL_DEBUG_MSG(2,
826 ("add named group %s(%04x) into received list.",
827 mbedtls_ssl_named_group_to_str(named_group),
828 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800829
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000830 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831 }
832
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000834
835}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200836#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000837
XiaokangQian08037552022-04-20 07:16:41 +0000838#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
839
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200840#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000841/*
842 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000843 * extension is correct and stores the first acceptable key share and its
844 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000845 *
846 * Possible return values are:
847 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000848 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
849 * the client does not match a group supported by the server. A
850 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000851 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800852 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200853MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100854static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
855 const unsigned char *buf,
856 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000857{
XiaokangQianb67384d2022-04-19 00:02:38 +0000858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000859 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000860 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800861 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000862
863 /* From RFC 8446:
864 *
865 * struct {
866 * KeyShareEntry client_shares<0..2^16-1>;
867 * } KeyShareClientHello;
868 *
869 */
870
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
872 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000873 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100874 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000875
876 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000877 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000878
879 /* We try to find a suitable key share entry and copy it to the
880 * handshake context. Later, we have to find out whether we can do
881 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000882 * dismiss it and send a HelloRetryRequest message.
883 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000884
Gilles Peskine449bd832023-01-11 14:50:10 +0100885 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000886 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800887 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800888 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000889
890 /*
891 * struct {
892 * NamedGroup group;
893 * opaque key_exchange<1..2^16-1>;
894 * } KeyShareEntry;
895 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
897 group = MBEDTLS_GET_UINT16_BE(p, 0);
898 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800899 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800900 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800902 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000903
904 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000905 * for input validation purposes.
906 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100907 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
908 !mbedtls_ssl_named_group_is_supported(group) ||
909 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000910 continue;
911 }
XiaokangQian060d8672022-04-21 09:24:56 +0000912
XiaokangQian7807f9f2022-02-15 10:04:37 +0000913 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200914 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200916 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200917 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200918 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100919 mbedtls_ssl_named_group_to_str(group),
920 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200921 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 ssl, key_exchange - 2, key_exchange_len + 2);
923 if (ret != 0) {
924 return ret;
925 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000926
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 } else {
928 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
929 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000930 continue;
931 }
932
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000933 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000934 }
935
Jerry Yuc1be19f2022-04-23 16:11:39 +0800936
Gilles Peskine449bd832023-01-11 14:50:10 +0100937 if (ssl->handshake->offered_group_id == 0) {
938 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
939 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000942}
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200943#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000944
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200945MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100946static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
947 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000948{
Jerry Yu0c354a22022-08-29 15:25:36 +0800949 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100950 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000951}
952
Jerry Yue5991322022-11-07 14:03:44 +0800953#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200954MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000955static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +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(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000963}
Jerry Yue5991322022-11-07 14:03:44 +0800964#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000965
Jerry Yue5991322022-11-07 14:03:44 +0800966#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000967MBEDTLS_CHECK_RETURN_CRITICAL
968static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000970{
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 return ssl_tls13_client_hello_has_exts(
972 ssl,
973 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
974 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000975}
Jerry Yue5991322022-11-07 14:03:44 +0800976#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000977
Jerry Yue5991322022-11-07 14:03:44 +0800978#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000979MBEDTLS_CHECK_RETURN_CRITICAL
980static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000982{
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 return ssl_tls13_client_hello_has_exts(
984 ssl,
985 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
986 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
987 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
988 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000989}
Jerry Yue5991322022-11-07 14:03:44 +0800990#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000991
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200992MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100993static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000994{
Jerry Yue5991322022-11-07 14:03:44 +0800995#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
997 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800998#else
999 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 return 0;
Jerry Yue5991322022-11-07 14:03:44 +08001001#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001002}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001003
Jerry Yu77f01482022-07-11 07:03:24 +00001004MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001005static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001006{
Jerry Yue5991322022-11-07 14:03:44 +08001007#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1009 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1010 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001011#else
1012 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001013 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001014#endif
1015}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001016
Jerry Yu77f01482022-07-11 07:03:24 +00001017MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001018static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001019{
Jerry Yue5991322022-11-07 14:03:44 +08001020#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1022 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1023 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001024#else
1025 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001027#endif
1028}
1029
Gilles Peskine449bd832023-01-11 14:50:10 +01001030static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001031{
1032 /*
1033 * Determine the key exchange algorithm to use.
1034 * There are three types of key exchanges supported in TLS 1.3:
1035 * - (EC)DH with ECDSA,
1036 * - (EC)DH with PSK,
1037 * - plain PSK.
1038 *
1039 * The PSK-based key exchanges may additionally be used with 0-RTT.
1040 *
1041 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001042 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1043 * 2 ) Certificate Mode ( ephemeral )
1044 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001045 */
1046
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001047 ssl->handshake->key_exchange_mode =
1048 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
Jerry Yu77f01482022-07-11 07:03:24 +00001049
Gilles Peskine449bd832023-01-11 14:50:10 +01001050 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001051 ssl->handshake->key_exchange_mode =
1052 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001053 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1054 } else
1055 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001056 ssl->handshake->key_exchange_mode =
1057 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1059 } else
1060 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001061 ssl->handshake->key_exchange_mode =
1062 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1064 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001065 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 1,
1067 ("ClientHello message misses mandatory extensions."));
1068 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1069 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1070 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001071 }
1072
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001074
XiaokangQian7807f9f2022-02-15 10:04:37 +00001075}
1076
XiaokangQian81802f42022-06-10 13:25:22 +00001077#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001078 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001079
1080#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001081static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001082{
Gilles Peskine449bd832023-01-11 14:50:10 +01001083 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001084 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001086 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001088 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001090 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001098 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001100 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001102 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001104 }
1105}
1106#endif /* MBEDTLS_USE_PSA_CRYPTO */
1107
XiaokangQian23c5be62022-06-07 02:04:34 +00001108/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001109 * Pick best ( private key, certificate chain ) pair based on the signature
1110 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001111 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001112MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001113static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001114{
XiaokangQianfb665a82022-06-15 03:57:21 +00001115 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001116 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001117
1118#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001119 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001120 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001122#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001124
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 if (key_cert_list == NULL) {
1126 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1127 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001128 }
1129
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1131 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001132 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001136 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001138
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 for (key_cert = key_cert_list; key_cert != NULL;
1140 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001141#if defined(MBEDTLS_USE_PSA_CRYPTO)
1142 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1143#endif /* MBEDTLS_USE_PSA_CRYPTO */
1144
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1146 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001147
1148 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 * This avoids sending the client a cert it'll reject based on
1150 * keyUsage or other extensions.
1151 */
1152 if (mbedtls_x509_crt_check_key_usage(
1153 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001154 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001155 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1157 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1158 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001159 continue;
1160 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001161
Gilles Peskine449bd832023-01-11 14:50:10 +01001162 MBEDTLS_SSL_DEBUG_MSG(3,
1163 ("ssl_tls13_pick_key_cert:"
1164 "check signature algorithm %s [%04x]",
1165 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1166 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001167#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001168 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001169#endif /* MBEDTLS_USE_PSA_CRYPTO */
1170
Gilles Peskine449bd832023-01-11 14:50:10 +01001171 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1172 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001173#if defined(MBEDTLS_USE_PSA_CRYPTO)
1174 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1176 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001177#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001179 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 MBEDTLS_SSL_DEBUG_MSG(3,
1181 ("ssl_tls13_pick_key_cert:"
1182 "selected signature algorithm"
1183 " %s [%04x]",
1184 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1185 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001186 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 3, "selected certificate (chain)",
1188 ssl->handshake->key_cert->cert);
1189 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001190 }
XiaokangQian81802f42022-06-10 13:25:22 +00001191 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001192 }
1193
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1195 "no suitable certificate found"));
1196 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001197}
XiaokangQian81802f42022-06-10 13:25:22 +00001198#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001199 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001200
XiaokangQian4080a7f2022-04-11 09:55:18 +00001201/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001202 *
1203 * STATE HANDLING: ClientHello
1204 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001205 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001206 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001207 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001208 *
1209 * In this case, the server progresses to sending its ServerHello.
1210 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001211 * 2) The ClientHello was well-formed but didn't match the server's
1212 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001213 *
1214 * For example, the client might not have offered a key share which
1215 * the server supports, or the server might require a cookie.
1216 *
1217 * In this case, the server sends a HelloRetryRequest.
1218 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001219 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001220 *
1221 * In this case, we abort the handshake.
1222 *
1223 */
1224
1225/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001226 * Structure of this message:
1227 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001228 * uint16 ProtocolVersion;
1229 * opaque Random[32];
1230 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001231 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001232 * struct {
1233 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1234 * Random random;
1235 * opaque legacy_session_id<0..32>;
1236 * CipherSuite cipher_suites<2..2^16-2>;
1237 * opaque legacy_compression_methods<1..2^8-1>;
1238 * Extension extensions<8..2^16-1>;
1239 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001240 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001241
1242#define SSL_CLIENT_HELLO_OK 0
1243#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001244#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001245
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001246MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001247static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1248 const unsigned char *buf,
1249 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001250{
XiaokangQianb67384d2022-04-19 00:02:38 +00001251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1252 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001253 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001254 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001255 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001256 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001257 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001258 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001259 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001260 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001261 const unsigned char *supported_versions_data;
1262 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001263 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001264 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001265
Ronald Cron41a443a2022-10-04 16:38:25 +02001266#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu29d9faa2022-08-23 17:52:45 +08001267 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001268 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001269#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001270
XiaokangQian7807f9f2022-02-15 10:04:37 +00001271 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001272 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001274 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001275 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001277 * .. . .. ciphersuite list length ( 2 bytes )
1278 * .. . .. ciphersuite list
1279 * .. . .. compression alg. list length ( 1 byte )
1280 * .. . .. compression alg. list
1281 * .. . .. extensions length ( 2 bytes, optional )
1282 * .. . .. extensions ( optional )
1283 */
1284
XiaokangQianb67384d2022-04-19 00:02:38 +00001285 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001286 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001287 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1288 * read at least up to session id length without worrying.
1289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291
1292 /* ...
1293 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1294 * ...
1295 * with ProtocolVersion defined as:
1296 * uint16 ProtocolVersion;
1297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1299 MBEDTLS_SSL_VERSION_TLS1_2) {
1300 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1301 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1302 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1303 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001304 }
1305 p += 2;
1306
Jerry Yuc1be19f2022-04-23 16:11:39 +08001307 /* ...
1308 * Random random;
1309 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001310 * with Random defined as:
1311 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001312 */
Ronald Crond540d992023-03-07 09:41:48 +01001313 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001314 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001315
Jerry Yuc1be19f2022-04-23 16:11:39 +08001316 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001317 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001318 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319 */
Ronald Croncada4102023-03-07 09:51:39 +01001320 legacy_session_id_len = *(p++);
1321 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322
XiaokangQianb67384d2022-04-19 00:02:38 +00001323 /*
1324 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001325 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001326 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001327 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001328 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001329
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001330 /* ...
1331 * CipherSuite cipher_suites<2..2^16-2>;
1332 * ...
1333 * with CipherSuite defined as:
1334 * uint8 CipherSuite[2];
1335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001338 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001339
Ronald Cronfc7ae872023-02-16 15:32:19 +01001340 /*
1341 * The length of the ciphersuite list has to be even.
1342 */
1343 if (cipher_suites_len & 1) {
1344 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1345 MBEDTLS_ERR_SSL_DECODE_ERROR);
1346 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1347 }
1348
XiaokangQianb67384d2022-04-19 00:02:38 +00001349 /* Check we have enough data for the ciphersuite list, the legacy
1350 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001351 *
1352 * cipher_suites cipher_suites_len bytes
1353 * legacy_compression_methods 2 bytes
1354 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001355 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001357 p += cipher_suites_len;
1358 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001359
1360 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001361 * Search for the supported versions extension and parse it to determine
1362 * if the client supports TLS 1.3.
1363 */
1364 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1365 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001366 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001367 if (ret < 0) {
1368 MBEDTLS_SSL_DEBUG_RET(1,
1369 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1370 return ret;
1371 }
1372
1373 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001374 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001375 }
1376
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001377 if (ret == 1) {
1378 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001379 supported_versions_data,
1380 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001381 if (ret < 0) {
1382 MBEDTLS_SSL_DEBUG_RET(1,
1383 ("ssl_tls13_parse_supported_versions_ext"), ret);
1384 return ret;
1385 }
1386
Ronald Cronb828c7d2023-04-03 16:37:22 +02001387 /*
1388 * The supported versions extension was parsed successfully as the
1389 * value returned by ssl_tls13_parse_supported_versions_ext() is
1390 * positive. The return value is then equal to
1391 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1392 * the TLS version to negotiate.
1393 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001394 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1395 return SSL_CLIENT_HELLO_TLS1_2;
1396 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001397 }
1398
1399 /*
1400 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001401 */
1402 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1403
1404#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1405 /* Store minor version for later use with ticket serialization. */
1406 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1407 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1408#endif
1409
1410 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001411 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001412 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001413 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001414 */
1415 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1416 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1417 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1418
Ronald Croncada4102023-03-07 09:51:39 +01001419 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1420 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1421 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1422 }
1423 ssl->session_negotiate->id_len = legacy_session_id_len;
1424 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1425 legacy_session_id, legacy_session_id_len);
1426 memcpy(&ssl->session_negotiate->id[0],
1427 legacy_session_id, legacy_session_id_len);
1428
Ronald Crond540d992023-03-07 09:41:48 +01001429 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001430 * Search for a matching ciphersuite
1431 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001432 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1433 cipher_suites, cipher_suites_len);
Ronald Crone45afd72023-04-04 15:10:06 +02001434 for (const unsigned char *cipher_suites_p = cipher_suites;
1435 cipher_suites_p < cipher_suites_end; cipher_suites_p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001436 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001437 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001438
Ronald Crond89360b2023-02-21 08:53:33 +01001439 /*
Ronald Crone45afd72023-04-04 15:10:06 +02001440 * "cipher_suites_end - cipher_suites_p is even" is an invariant of the
1441 * loop. As cipher_suites_end - cipher_suites_p > 0, we have
1442 * cipher_suites_end - cipher_suites_p >= 2 and it is thus safe to read
1443 * two bytes.
Ronald Crond89360b2023-02-21 08:53:33 +01001444 */
Ronald Crone45afd72023-04-04 15:10:06 +02001445 cipher_suite = MBEDTLS_GET_UINT16_BE(cipher_suites_p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001446 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001447 ssl, cipher_suite);
1448 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001449 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001451
Jerry Yu5725f1c2022-08-21 17:27:16 +08001452 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001453 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001454 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1455 cipher_suite,
1456 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001457 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001458 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001459
Gilles Peskine449bd832023-01-11 14:50:10 +01001460 if (handshake->ciphersuite_info == NULL) {
1461 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1462 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1463 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001464 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001465
XiaokangQian4080a7f2022-04-11 09:55:18 +00001466 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001467 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001468 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001469 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001470 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1471 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1472 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1473 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1474 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001475 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001476 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001477
Jerry Yuc1be19f2022-04-23 16:11:39 +08001478 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001479 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001480 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001481 * with Extension defined as:
1482 * struct {
1483 * ExtensionType extension_type;
1484 * opaque extension_data<0..2^16-1>;
1485 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001486 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001488 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001490 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001491
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001493 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001496 unsigned int extension_type;
1497 size_t extension_data_len;
1498 const unsigned char *extension_data_end;
1499
Jerry Yu0c354a22022-08-29 15:25:36 +08001500 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001501 *
1502 * The "pre_shared_key" extension MUST be the last extension in the
1503 * ClientHello (this facilitates implementation as described below).
1504 * Servers MUST check that it is the last extension and otherwise fail
1505 * the handshake with an "illegal_parameter" alert.
1506 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001508 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001509 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001510 MBEDTLS_SSL_PEND_FATAL_ALERT(
1511 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1513 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001514 }
1515
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1517 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1518 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001519 p += 4;
1520
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001522 extension_data_end = p + extension_data_len;
1523
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001524 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1526 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1527 if (ret != 0) {
1528 return ret;
1529 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001530
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001532#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1533 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1535 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1536 extension_data_end);
1537 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001538 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 1, "mbedtls_ssl_parse_servername_ext", ret);
1540 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001541 }
XiaokangQian40a35232022-05-07 09:02:40 +00001542 break;
1543#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1544
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001545#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001546 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001548
1549 /* Supported Groups Extension
1550 *
1551 * When sent by the client, the "supported_groups" extension
1552 * indicates the named groups which the client supports,
1553 * ordered from most preferred to least preferred.
1554 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001555 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 ssl, p, extension_data_end);
1557 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001558 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001559 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001560 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001561 }
1562
XiaokangQian7807f9f2022-02-15 10:04:37 +00001563 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001564#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001565
Przemek Stekiel63706622023-05-23 16:31:56 +02001566#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001567 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001569
1570 /*
1571 * Key Share Extension
1572 *
1573 * When sent by the client, the "key_share" extension
1574 * contains the endpoint's cryptographic parameters for
1575 * ECDHE/DHE key establishment methods.
1576 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001577 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 ssl, p, extension_data_end);
1579 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1580 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001581 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001582 }
1583
Gilles Peskine449bd832023-01-11 14:50:10 +01001584 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001585 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 1, "ssl_tls13_parse_key_shares_ext", ret);
1587 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001588 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001589
XiaokangQian7807f9f2022-02-15 10:04:37 +00001590 break;
Przemek Stekiel63706622023-05-23 16:31:56 +02001591#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001592
1593 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001594 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001595 break;
1596
Ronald Cron41a443a2022-10-04 16:38:25 +02001597#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001598 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001599 MBEDTLS_SSL_DEBUG_MSG(
1600 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001601
1602 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001603 ssl, p, extension_data_end);
1604 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001605 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1607 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001608 }
1609
Jerry Yue19e3b92022-07-08 12:04:51 +00001610 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001611#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001612
Jerry Yu1c105562022-07-10 06:32:38 +00001613 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1615 if ((handshake->received_extensions &
1616 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001617 MBEDTLS_SSL_PEND_FATAL_ALERT(
1618 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1620 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001621 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001622#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001623 /* Delay processing of the PSK identity once we have
1624 * found out which algorithms to use. We keep a pointer
1625 * to the buffer and the size for later processing.
1626 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001627 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001628 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001629#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001630 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001631
XiaokangQianacb39922022-06-17 10:18:48 +00001632#if defined(MBEDTLS_SSL_ALPN)
1633 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001634 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001635
Gilles Peskine449bd832023-01-11 14:50:10 +01001636 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1637 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001638 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1640 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001641 }
XiaokangQianacb39922022-06-17 10:18:48 +00001642 break;
1643#endif /* MBEDTLS_SSL_ALPN */
1644
Ronald Cron928cbd32022-10-04 16:14:26 +02001645#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001646 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001648
Gabor Mezei078e8032022-04-27 21:17:56 +02001649 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 ssl, p, extension_data_end);
1651 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001652 MBEDTLS_SSL_DEBUG_RET(
1653 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001655 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001656 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001657#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001658
Jan Bruckner151f6422023-02-10 12:45:19 +01001659#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1660 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1661 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1662
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001663 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1664 ssl, p, extension_data_end);
Jan Bruckner151f6422023-02-10 12:45:19 +01001665
Xiaokang Qian09c3ccc2023-04-04 10:18:38 +00001666 /*
1667 * TODO: Return unconditionally here until we handle the record
1668 * size limit correctly.
1669 * Once handled correctly, only return in case of errors.
1670 */
Jan Bruckner151f6422023-02-10 12:45:19 +01001671 return ret;
1672
1673 break;
1674#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1675
XiaokangQian7807f9f2022-02-15 10:04:37 +00001676 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001677 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001678 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001680 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001681 }
1682
1683 p += extension_data_len;
1684 }
1685
Gilles Peskine449bd832023-01-11 14:50:10 +01001686 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1687 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001688
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001689 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1690 MBEDTLS_SSL_HS_CLIENT_HELLO,
1691 p - buf);
1692 if (0 != ret) {
1693 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1694 return ret;
1695 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001696
Ronald Cron41a443a2022-10-04 16:38:25 +02001697#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001698 /* Update checksum with either
1699 * - The entire content of the CH message, if no PSK extension is present
1700 * - The content up to but excluding the PSK extension, if present.
1701 */
Jerry Yu1c105562022-07-10 06:32:38 +00001702 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001703 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1704 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1705 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001706 ret = handshake->update_checksum(ssl, buf,
1707 pre_shared_key_ext - buf);
1708 if (0 != ret) {
1709 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1710 return ret;
1711 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1713 pre_shared_key_ext,
1714 pre_shared_key_ext_end,
1715 cipher_suites,
1716 cipher_suites_end);
1717 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1718 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1719 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001720 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1722 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001723 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001725#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001726 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001727 ret = handshake->update_checksum(ssl, buf, p - buf);
1728 if (0 != ret) {
1729 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1730 return ret;
1731 }
Jerry Yu1c105562022-07-10 06:32:38 +00001732 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001733
Gilles Peskine449bd832023-01-11 14:50:10 +01001734 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1735 if (ret < 0) {
1736 return ret;
1737 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001738
Gilles Peskine449bd832023-01-11 14:50:10 +01001739 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001740
Gilles Peskine449bd832023-01-11 14:50:10 +01001741 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001742}
1743
1744/* Update the handshake state machine */
1745
Ronald Cronce7d76e2022-07-08 18:56:49 +02001746MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001747static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001748{
1749 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1750
XiaokangQian7807f9f2022-02-15 10:04:37 +00001751 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001752 * Server certificate selection
1753 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1755 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1756 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001757 }
1758#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1759 ssl->handshake->sni_name = NULL;
1760 ssl->handshake->sni_name_len = 0;
1761#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001762
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1764 if (ret != 0) {
1765 MBEDTLS_SSL_DEBUG_RET(1,
1766 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1767 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001768 }
1769
Gilles Peskine449bd832023-01-11 14:50:10 +01001770 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001771
1772}
1773
1774/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001775 * Main entry point from the state machine; orchestrates the otherfunctions.
1776 */
1777
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001778MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001779static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001780{
1781
XiaokangQian08037552022-04-20 07:16:41 +00001782 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001783 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001784 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001785 int parse_client_hello_ret;
1786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1790 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1791 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001792
Gilles Peskine449bd832023-01-11 14:50:10 +01001793 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1794 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001795 parse_client_hello_ret = ret; /* Store positive return value of
1796 * parse_client_hello,
1797 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001798 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001799
Ronald Cronb828c7d2023-04-03 16:37:22 +02001800 /*
1801 * Version 1.2 of the protocol has been chosen, set the
1802 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1803 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1804 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1805 * will dispatch to the TLS 1.2 state machine.
1806 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001807 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
1808 ssl->keep_current_message = 1;
1809 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1810 return 0;
1811 }
1812
Gilles Peskine449bd832023-01-11 14:50:10 +01001813 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001814
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001815 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1817 } else {
1818 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1819 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001820
1821cleanup:
1822
Gilles Peskine449bd832023-01-11 14:50:10 +01001823 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1824 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001825}
1826
1827/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001828 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001829 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001831static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001832{
Jerry Yu637a3f12022-04-20 21:37:58 +08001833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1834 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1836 if (ssl->conf->f_rng == NULL) {
1837 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1838 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001839 }
1840
Gilles Peskine449bd832023-01-11 14:50:10 +01001841 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1842 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1843 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1844 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001845 }
1846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1848 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001849
1850#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001851 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001852#endif /* MBEDTLS_HAVE_TIME */
1853
Gilles Peskine449bd832023-01-11 14:50:10 +01001854 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001855}
1856
Jerry Yu3bf2c642022-03-30 22:02:12 +08001857/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001858 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001859 *
1860 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001861 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001862 * } SupportedVersions;
1863 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001864MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001865static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 mbedtls_ssl_context *ssl,
1867 unsigned char *buf,
1868 unsigned char *end,
1869 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001870{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001871 *out_len = 0;
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001874
1875 /* Check if we have space to write the extension:
1876 * - extension_type (2 bytes)
1877 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001878 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001879 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001881
Gilles Peskine449bd832023-01-11 14:50:10 +01001882 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 mbedtls_ssl_write_version(buf + 4,
1887 ssl->conf->transport,
1888 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001889
Gilles Peskine449bd832023-01-11 14:50:10 +01001890 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1891 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001892
Jerry Yu349a6132022-04-14 20:52:56 +08001893 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001894
Jerry Yub95dd362022-11-08 21:19:34 +08001895 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001896 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001899}
1900
Jerry Yud9436a12022-04-20 22:28:09 +08001901
Jerry Yu3bf2c642022-03-30 22:02:12 +08001902
1903/* Generate and export a single key share. For hybrid KEMs, this can
1904 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001905MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001906static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1907 uint16_t named_group,
1908 unsigned char *buf,
1909 unsigned char *end,
1910 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001911{
1912 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001913
1914 *out_len = 0;
1915
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001916#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
1917 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02001918 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02001919 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 ssl, named_group, buf, end, out_len);
1921 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001922 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02001923 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001924 ret);
1925 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001926 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 } else
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001928#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if (0 /* Other kinds of KEMs */) {
1930 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001931 ((void) ssl);
1932 ((void) named_group);
1933 ((void) buf);
1934 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001935 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1936 }
1937
Gilles Peskine449bd832023-01-11 14:50:10 +01001938 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001939}
1940
1941/*
1942 * ssl_tls13_write_key_share_ext
1943 *
1944 * Structure of key_share extension in ServerHello:
1945 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001946 * struct {
1947 * NamedGroup group;
1948 * opaque key_exchange<1..2^16-1>;
1949 * } KeyShareEntry;
1950 * struct {
1951 * KeyShareEntry server_share;
1952 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001953 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001954MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001955static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1956 unsigned char *buf,
1957 unsigned char *end,
1958 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001959{
Jerry Yu955ddd72022-04-22 22:27:33 +08001960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001961 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001962 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001963 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001964 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001965
1966 *out_len = 0;
1967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1971 mbedtls_ssl_named_group_to_str(group),
1972 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001973
Jerry Yu3bf2c642022-03-30 22:02:12 +08001974 /* Check if we have space for header and length fields:
1975 * - extension_type (2 bytes)
1976 * - extension_data_length (2 bytes)
1977 * - group (2 bytes)
1978 * - key_exchange_length (2 bytes)
1979 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1981 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1982 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001983 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001984
Jerry Yu3bf2c642022-03-30 22:02:12 +08001985 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1986 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001987 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001988 ssl, group, server_share + 4, end, &key_exchange_length);
1989 if (ret != 0) {
1990 return ret;
1991 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001992 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001993
Gilles Peskine449bd832023-01-11 14:50:10 +01001994 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001995
Gilles Peskine449bd832023-01-11 14:50:10 +01001996 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001997
Jerry Yu57d48412022-04-20 21:50:42 +08001998 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002003}
Jerry Yud9436a12022-04-20 22:28:09 +08002004
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002005MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002006static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2007 unsigned char *buf,
2008 unsigned char *end,
2009 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002010{
2011 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2012 /* key_share Extension
2013 *
2014 * struct {
2015 * select (Handshake.msg_type) {
2016 * ...
2017 * case hello_retry_request:
2018 * NamedGroup selected_group;
2019 * ...
2020 * };
2021 * } KeyShare;
2022 */
2023
2024 *out_len = 0;
2025
Jerry Yub0ac10b2022-05-05 11:10:08 +08002026 /*
2027 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2028 * of the HRR is then to transmit a cookie to force the client to demonstrate
2029 * reachability at their apparent network address (primarily useful for DTLS).
2030 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002031 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2032 return 0;
2033 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002034
2035 /* We should only send the key_share extension if the client's initial
2036 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 if (ssl->handshake->offered_group_id != 0) {
2038 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2039 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002040 }
2041
Gilles Peskine449bd832023-01-11 14:50:10 +01002042 if (selected_group == 0) {
2043 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2044 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002045 }
2046
Jerry Yub0ac10b2022-05-05 11:10:08 +08002047 /* Check if we have enough space:
2048 * - extension_type (2 bytes)
2049 * - extension_data_length (2 bytes)
2050 * - selected_group (2 bytes)
2051 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2055 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2056 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 MBEDTLS_SSL_DEBUG_MSG(3,
2059 ("HRR selected_group: %s (%x)",
2060 mbedtls_ssl_named_group_to_str(selected_group),
2061 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002062
2063 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002064
Gilles Peskine449bd832023-01-11 14:50:10 +01002065 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002066
Gilles Peskine449bd832023-01-11 14:50:10 +01002067 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002068}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002069
2070/*
2071 * Structure of ServerHello message:
2072 *
2073 * struct {
2074 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2075 * Random random;
2076 * opaque legacy_session_id_echo<0..32>;
2077 * CipherSuite cipher_suite;
2078 * uint8 legacy_compression_method = 0;
2079 * Extension extensions<6..2^16-1>;
2080 * } ServerHello;
2081 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002082MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002083static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2084 unsigned char *buf,
2085 unsigned char *end,
2086 size_t *out_len,
2087 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002088{
Jerry Yu955ddd72022-04-22 22:27:33 +08002089 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002090 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002091 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002092 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002093
2094 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002095 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002096
Jerry Yucfc04b32022-04-21 09:31:58 +08002097 /* ...
2098 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2099 * ...
2100 * with ProtocolVersion defined as:
2101 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002102 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2104 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002105 p += 2;
2106
Jerry Yu1c3e6882022-04-20 21:23:40 +08002107 /* ...
2108 * Random random;
2109 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002110 * with Random defined as:
2111 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002112 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2114 if (is_hrr) {
2115 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2116 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2117 } else {
2118 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2119 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002120 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2122 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002123 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2124
Jerry Yucfc04b32022-04-21 09:31:58 +08002125 /* ...
2126 * opaque legacy_session_id_echo<0..32>;
2127 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002128 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2130 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2131 if (ssl->session_negotiate->id_len > 0) {
2132 memcpy(p, &ssl->session_negotiate->id[0],
2133 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002134 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002135
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2137 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002138 }
2139
Jerry Yucfc04b32022-04-21 09:31:58 +08002140 /* ...
2141 * CipherSuite cipher_suite;
2142 * ...
2143 * with CipherSuite defined as:
2144 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002145 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2147 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002148 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 MBEDTLS_SSL_DEBUG_MSG(3,
2150 ("server hello, chosen ciphersuite: %s ( id=%d )",
2151 mbedtls_ssl_get_ciphersuite_name(
2152 ssl->session_negotiate->ciphersuite),
2153 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002154
Jerry Yucfc04b32022-04-21 09:31:58 +08002155 /* ...
2156 * uint8 legacy_compression_method = 0;
2157 * ...
2158 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002159 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002160 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002161
Jerry Yucfc04b32022-04-21 09:31:58 +08002162 /* ...
2163 * Extension extensions<6..2^16-1>;
2164 * ...
2165 * struct {
2166 * ExtensionType extension_type; (2 bytes)
2167 * opaque extension_data<0..2^16-1>;
2168 * } Extension;
2169 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002170 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002171 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002172 p += 2;
2173
Gilles Peskine449bd832023-01-11 14:50:10 +01002174 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2175 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002176 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2178 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002179 }
2180 p += output_len;
2181
Gilles Peskine449bd832023-01-11 14:50:10 +01002182 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2183 if (is_hrr) {
2184 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2185 } else {
2186 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2187 }
2188 if (ret != 0) {
2189 return ret;
2190 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002191 p += output_len;
2192 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002193
Ronald Cron41a443a2022-10-04 16:38:25 +02002194#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2196 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2197 if (ret != 0) {
2198 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2199 ret);
2200 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002201 }
2202 p += output_len;
2203 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002204#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002207
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2209 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002210
Jerry Yud9436a12022-04-20 22:28:09 +08002211 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002214
Jerry Yu7de2ff02022-11-08 21:43:46 +08002215 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002216 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 MBEDTLS_SSL_HS_SERVER_HELLO,
2218 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002219
Gilles Peskine449bd832023-01-11 14:50:10 +01002220 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002221}
2222
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002223MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002224static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002225{
2226 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2228 if (ret != 0) {
2229 MBEDTLS_SSL_DEBUG_RET(1,
2230 "mbedtls_ssl_tls13_compute_handshake_transform",
2231 ret);
2232 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002233 }
2234
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002236}
2237
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002238MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002239static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002240{
Jerry Yu637a3f12022-04-20 21:37:58 +08002241 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002242 unsigned char *buf;
2243 size_t buf_len, msg_len;
2244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002246
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002248
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002249 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2250 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2253 buf + buf_len,
2254 &msg_len,
2255 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002256
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002257 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002258 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2261 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002262
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002263 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002264
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002265#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2266 /* The server sends a dummy change_cipher_spec record immediately
2267 * after its first handshake message. This may either be after
2268 * a ServerHello or a HelloRetryRequest.
2269 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002270 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002271 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002272#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002274#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002275
Jerry Yuf4b27e42022-03-30 17:32:21 +08002276cleanup:
2277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2279 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002280}
2281
Jerry Yu23d1a252022-05-12 18:08:59 +08002282
2283/*
2284 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2285 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002286MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002287static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002288{
2289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002290 if (ssl->handshake->hello_retry_request_count > 0) {
2291 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2292 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2293 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2294 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002295 }
2296
2297 /*
2298 * Create stateless transcript hash for HRR
2299 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2301 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2302 if (ret != 0) {
2303 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2304 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002305 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002309}
2310
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002311MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002312static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002313{
2314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2315 unsigned char *buf;
2316 size_t buf_len, msg_len;
2317
Gilles Peskine449bd832023-01-11 14:50:10 +01002318 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002321
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2323 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2324 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2327 buf + buf_len,
2328 &msg_len,
2329 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002330 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002331 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002332
2333
Gilles Peskine449bd832023-01-11 14:50:10 +01002334 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2335 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002336
2337 ssl->handshake->hello_retry_request_count++;
2338
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002339#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2340 /* The server sends a dummy change_cipher_spec record immediately
2341 * after its first handshake message. This may either be after
2342 * a ServerHello or a HelloRetryRequest.
2343 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002344 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002346#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002348#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002349
2350cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2352 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002353}
2354
Jerry Yu5b64ae92022-03-30 17:15:02 +08002355/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002356 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2357 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002358
2359/*
2360 * struct {
2361 * Extension extensions<0..2 ^ 16 - 1>;
2362 * } EncryptedExtensions;
2363 *
2364 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002365MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002366static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2367 unsigned char *buf,
2368 unsigned char *end,
2369 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002370{
XiaokangQianacb39922022-06-17 10:18:48 +00002371 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002372 unsigned char *p = buf;
2373 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002374 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002375 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002376
Jerry Yu4d3841a2022-04-16 12:37:19 +08002377 *out_len = 0;
2378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002380 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002381 p += 2;
2382
Jerry Yu8937eb42022-05-03 12:12:14 +08002383 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002384 ((void) ret);
2385 ((void) output_len);
2386
2387#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2389 if (ret != 0) {
2390 return ret;
2391 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002392 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002393#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002394
Gilles Peskine449bd832023-01-11 14:50:10 +01002395 extensions_len = (p - p_extensions_len) - 2;
2396 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002397
2398 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002399
Gilles Peskine449bd832023-01-11 14:50:10 +01002400 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002401
Jerry Yu7de2ff02022-11-08 21:43:46 +08002402 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002404
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002406}
2407
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002408MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002409static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002410{
2411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2412 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002413 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002414
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 mbedtls_ssl_set_outbound_transform(ssl,
2416 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002417 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002421
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002422 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2423 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2424 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2427 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002428
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002429 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002430 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2431 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2434 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002435
Ronald Cron928cbd32022-10-04 16:14:26 +02002436#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2438 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2439 } else {
2440 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2441 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002442#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002444#endif
2445
Jerry Yu4d3841a2022-04-16 12:37:19 +08002446cleanup:
2447
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2449 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002450}
2451
Ronald Cron928cbd32022-10-04 16:14:26 +02002452#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002453#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2454#define SSL_CERTIFICATE_REQUEST_SKIP 1
2455/* Coordination:
2456 * Check whether a CertificateRequest message should be written.
2457 * Returns a negative code on failure, or
2458 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2459 * - SSL_CERTIFICATE_REQUEST_SKIP
2460 * indicating if the writing of the CertificateRequest
2461 * should be skipped or not.
2462 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002464static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002465{
2466 int authmode;
2467
XiaokangQian40a35232022-05-07 09:02:40 +00002468#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002470 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002472#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002473 authmode = ssl->conf->authmode;
2474
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002476 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002477 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002478 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002479
XiaokangQianc3017f62022-05-13 05:55:41 +00002480 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002481
Gilles Peskine449bd832023-01-11 14:50:10 +01002482 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002483}
2484
XiaokangQiancec9ae62022-05-06 07:28:50 +00002485/*
2486 * struct {
2487 * opaque certificate_request_context<0..2^8-1>;
2488 * Extension extensions<2..2^16-1>;
2489 * } CertificateRequest;
2490 *
2491 */
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_request_body(mbedtls_ssl_context *ssl,
2494 unsigned char *buf,
2495 const unsigned char *end,
2496 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002497{
2498 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2499 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002500 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002501 unsigned char *p_extensions_len;
2502
2503 *out_len = 0;
2504
2505 /* Check if we have enough space:
2506 * - certificate_request_context (1 byte)
2507 * - extensions length (2 bytes)
2508 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002510
2511 /*
2512 * Write certificate_request_context
2513 */
2514 /*
2515 * We use a zero length context for the normal handshake
2516 * messages. For post-authentication handshake messages
2517 * this request context would be set to a non-zero value.
2518 */
2519 *p++ = 0x0;
2520
2521 /*
2522 * Write extensions
2523 */
2524 /* The extensions must contain the signature_algorithms. */
2525 p_extensions_len = p;
2526 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2528 if (ret != 0) {
2529 return ret;
2530 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002531
XiaokangQianec6efb92022-05-06 09:53:10 +00002532 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002534
2535 *out_len = p - buf;
2536
Jerry Yu7de2ff02022-11-08 21:43:46 +08002537 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002538 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002539
Gilles Peskine449bd832023-01-11 14:50:10 +01002540 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002541}
2542
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002543MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002544static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002545{
2546 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2547
Gilles Peskine449bd832023-01-11 14:50:10 +01002548 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002551
Gilles Peskine449bd832023-01-11 14:50:10 +01002552 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002553 unsigned char *buf;
2554 size_t buf_len, msg_len;
2555
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002556 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2557 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2558 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002559
Gilles Peskine449bd832023-01-11 14:50:10 +01002560 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2561 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002562
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002563 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002564 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2565 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2568 ssl, buf_len, msg_len));
2569 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2570 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002571 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 } else {
2573 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002574 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2575 goto cleanup;
2576 }
2577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002579cleanup:
2580
Gilles Peskine449bd832023-01-11 14:50:10 +01002581 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2582 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002583}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002584
Jerry Yu4d3841a2022-04-16 12:37:19 +08002585/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002586 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002587 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002590{
Jerry Yu5a26f302022-05-10 20:46:40 +08002591 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002592
2593#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002594 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2595 mbedtls_ssl_own_cert(ssl) == NULL) {
2596 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2597 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2598 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2599 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002600 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002601#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2604 if (ret != 0) {
2605 return ret;
2606 }
2607 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2608 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002609}
2610
2611/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002612 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002613 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002614MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002615static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002616{
Gilles Peskine449bd832023-01-11 14:50:10 +01002617 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2618 if (ret != 0) {
2619 return ret;
2620 }
2621 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2622 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002623}
Ronald Cron928cbd32022-10-04 16:14:26 +02002624#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002625
2626/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002627 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002628 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002629MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002630static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002631{
Jerry Yud6e253d2022-05-18 13:59:24 +08002632 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2635 if (ret != 0) {
2636 return ret;
2637 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002638
Gilles Peskine449bd832023-01-11 14:50:10 +01002639 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2640 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002641 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002642 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2643 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2644 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002645 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002646
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2648 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (ssl->handshake->certificate_request_sent) {
2651 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2652 } else {
2653 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2654 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2655 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002656 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002659}
2660
2661/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002662 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002663 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002664MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002665static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002666{
Jerry Yud6e253d2022-05-18 13:59:24 +08002667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2668
Gilles Peskine449bd832023-01-11 14:50:10 +01002669 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2670 if (ret != 0) {
2671 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002672 }
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2675 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002676 MBEDTLS_SSL_DEBUG_RET(
2677 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002678 }
2679
2680 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2681 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002682}
2683
2684/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002685 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002686 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002687MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002688static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002689{
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002693
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002694#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2695 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002696/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2697 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2698 * expected to be resolved with issue#6395.
2699 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002700 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002701 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002702 mbedtls_ssl_handshake_set_state(
2703 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002704 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002705#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002706 {
2707 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2708 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002709 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002710}
2711
2712/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002713 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002714 */
2715#define SSL_NEW_SESSION_TICKET_SKIP 0
2716#define SSL_NEW_SESSION_TICKET_WRITE 1
2717MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002718static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002719{
2720 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002721 if (ssl->conf->f_ticket_write == NULL) {
2722 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2723 " callback is not set"));
2724 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002725 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002726 if (ssl->conf->new_session_tickets_count == 0) {
2727 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2728 " configured count is zero"));
2729 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002730 }
2731
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 if (ssl->handshake->new_session_tickets_count == 0) {
2733 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2734 "been sent."));
2735 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002736 }
2737
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002739}
2740
2741#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2742MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002743static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2744 unsigned char *ticket_nonce,
2745 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002746{
2747 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2748 mbedtls_ssl_session *session = ssl->session;
2749 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2750 psa_algorithm_t psa_hash_alg;
2751 int hash_length;
2752
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002754
2755#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002757#endif
2758
Pengyu Lv9f926952022-11-17 15:22:33 +08002759 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002760 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002761 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002762#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002763 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002764 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002765#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002766 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002767
Jerry Yue67bef42022-07-07 07:29:42 +00002768 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002769 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2770 (unsigned char *) &session->ticket_age_add,
2771 sizeof(session->ticket_age_add)) != 0)) {
2772 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2773 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002774 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002775 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2776 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002777
2778 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2780 if (ret != 0) {
2781 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2782 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002783 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2785 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002786
2787 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Manuel Pégourié-Gonnard1f2a5872023-03-28 11:46:17 +02002789 psa_hash_alg = mbedtls_md_psa_alg_from_type(ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2791 if (hash_length == -1 ||
2792 (size_t) hash_length > sizeof(session->resumption_key)) {
2793 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002794 }
2795
Jerry Yue67bef42022-07-07 07:29:42 +00002796 /* In this code the psk key length equals the length of the hash */
2797 session->resumption_key_len = hash_length;
2798 session->ciphersuite = ciphersuite_info->id;
2799
2800 /* Compute resumption key
2801 *
2802 * HKDF-Expand-Label( resumption_master_secret,
2803 * "resumption", ticket_nonce, Hash.length )
2804 */
2805 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 psa_hash_alg,
2807 session->app_secrets.resumption_master_secret,
2808 hash_length,
2809 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2810 ticket_nonce,
2811 ticket_nonce_size,
2812 session->resumption_key,
2813 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002814
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 if (ret != 0) {
2816 MBEDTLS_SSL_DEBUG_RET(2,
2817 "Creating the ticket-resumed PSK failed",
2818 ret);
2819 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002820 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2822 session->resumption_key,
2823 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002824
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2826 session->app_secrets.resumption_master_secret,
2827 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002830}
2831
2832/* This function creates a NewSessionTicket message in the following format:
2833 *
2834 * struct {
2835 * uint32 ticket_lifetime;
2836 * uint32 ticket_age_add;
2837 * opaque ticket_nonce<0..255>;
2838 * opaque ticket<1..2^16-1>;
2839 * Extension extensions<0..2^16-2>;
2840 * } NewSessionTicket;
2841 *
2842 * The ticket inside the NewSessionTicket message is an encrypted container
2843 * carrying the necessary information so that the server is later able to
2844 * re-start the communication.
2845 *
2846 * The following fields are placed inside the ticket by the
2847 * f_ticket_write() function:
2848 *
2849 * - creation time (start)
2850 * - flags (flags)
2851 * - age add (ticket_age_add)
2852 * - key (key)
2853 * - key length (key_len)
2854 * - ciphersuite (ciphersuite)
2855 */
2856MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002857static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2858 unsigned char *buf,
2859 unsigned char *end,
2860 size_t *out_len,
2861 unsigned char *ticket_nonce,
2862 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002863{
2864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2865 unsigned char *p = buf;
2866 mbedtls_ssl_session *session = ssl->session;
2867 size_t ticket_len;
2868 uint32_t ticket_lifetime;
2869
2870 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002872
2873 /*
2874 * ticket_lifetime 4 bytes
2875 * ticket_age_add 4 bytes
2876 * ticket_nonce 1 + ticket_nonce_size bytes
2877 * ticket >=2 bytes
2878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002880
2881 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2883 session,
2884 p + 9 + ticket_nonce_size + 2,
2885 end,
2886 &ticket_len,
2887 &ticket_lifetime);
2888 if (ret != 0) {
2889 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2890 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002891 }
2892 /* RFC 8446 4.6.1
2893 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2894 * unsigned integer in network byte order from the time of ticket
2895 * issuance. Servers MUST NOT use any value greater than
2896 * 604800 seconds (7 days). The value of zero indicates that the
2897 * ticket should be discarded immediately. Clients MUST NOT cache
2898 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2899 * and MAY delete tickets earlier based on local policy. A server
2900 * MAY treat a ticket as valid for a shorter period of time than what
2901 * is stated in the ticket_lifetime.
2902 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002904 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 }
2906 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2907 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2908 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002909
2910 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2912 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2913 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002914
2915 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 p[8] = (unsigned char) ticket_nonce_size;
2917 if (ticket_nonce_size > 0) {
2918 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002919 }
2920 p += 9 + ticket_nonce_size;
2921
2922 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002924 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002926 p += ticket_len;
2927
2928 /* Ticket Extensions
2929 *
2930 * Note: We currently don't have any extensions.
2931 * Set length to zero.
2932 */
Jerry Yuedab6372022-10-31 14:37:31 +08002933 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2934
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2936 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002937 p += 2;
2938
2939 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002940 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2941 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002942
Jerry Yu7de2ff02022-11-08 21:43:46 +08002943 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002945
Gilles Peskine449bd832023-01-11 14:50:10 +01002946 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002947}
2948
2949/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002950 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002951 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002952static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002953{
2954 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2955
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002957
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002959 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2960 unsigned char *buf;
2961 size_t buf_len, msg_len;
2962
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2964 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002965
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002966 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2967 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2968 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002969
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2971 ssl, buf, buf + buf_len, &msg_len,
2972 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002973
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2975 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002976
Jerry Yu359e65f2022-09-22 23:47:43 +08002977 /* Limit session tickets count to one when resumption connection.
2978 *
2979 * See document of mbedtls_ssl_conf_new_session_tickets.
2980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002981 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002982 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002984 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002985 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002986
Jerry Yua8d3c502022-10-30 14:51:23 +08002987 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2989 } else {
2990 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002991 }
2992
Jerry Yue67bef42022-07-07 07:29:42 +00002993cleanup:
2994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002996}
2997#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2998
2999/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003000 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003001 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003002int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003003{
XiaokangQian08037552022-04-20 07:16:41 +00003004 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003005
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3007 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3008 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
3011 mbedtls_ssl_states_str(ssl->state),
3012 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003013
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003015 /* start state */
3016 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003018 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003019 break;
3020
XiaokangQian7807f9f2022-02-15 10:04:37 +00003021 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003022 ret = ssl_tls13_process_client_hello(ssl);
3023 if (ret != 0) {
3024 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3025 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003026 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003027
Jerry Yuf41553b2022-05-09 22:20:30 +08003028 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003029 ret = ssl_tls13_write_hello_retry_request(ssl);
3030 if (ret != 0) {
3031 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3032 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003033 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003034 break;
3035
Jerry Yu5b64ae92022-03-30 17:15:02 +08003036 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003037 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003038 break;
3039
Xiaofei Baicba64af2022-02-15 10:00:56 +00003040 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003041 ret = ssl_tls13_write_encrypted_extensions(ssl);
3042 if (ret != 0) {
3043 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3044 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003045 }
Jerry Yu48330562022-05-06 21:35:44 +08003046 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003047
Ronald Cron928cbd32022-10-04 16:14:26 +02003048#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003049 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003050 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003051 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003052
Jerry Yu83da34e2022-04-16 13:59:52 +08003053 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003055 break;
3056
3057 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003058 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003059 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003060#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003061
Gilles Peskine449bd832023-01-11 14:50:10 +01003062 /*
3063 * Injection of dummy-CCS's for middlebox compatibility
3064 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003065#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003066 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003067 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3068 if (ret == 0) {
3069 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3070 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003071 break;
3072
3073 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003074 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3075 if (ret == 0) {
3076 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3077 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003078 break;
3079#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3080
Jerry Yu69dd8d42022-04-16 12:51:26 +08003081 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003083 break;
3084
3085 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003087 break;
3088
Jerry Yu69dd8d42022-04-16 12:51:26 +08003089 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003091 break;
3092
Ronald Cron766c0cd2022-10-18 12:17:11 +02003093#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003094 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003095 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3096 if (ret == 0) {
3097 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003098 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3100 } else {
3101 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003102 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003103 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003104 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003105 }
3106 break;
3107
3108 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003109 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3110 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003111 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003113 }
3114 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003115#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003116
Jerry Yue67bef42022-07-07 07:29:42 +00003117#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003118 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003119 ret = ssl_tls13_write_new_session_ticket(ssl);
3120 if (ret != 0) {
3121 MBEDTLS_SSL_DEBUG_RET(1,
3122 "ssl_tls13_write_new_session_ticket ",
3123 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003124 }
3125 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003126 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003127 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003128 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003129 * as part of ssl_prepare_handshake_step.
3130 */
3131 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003132
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 if (ssl->handshake->new_session_tickets_count == 0) {
3134 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3135 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003136 mbedtls_ssl_handshake_set_state(
3137 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003138 }
Jerry Yue67bef42022-07-07 07:29:42 +00003139 break;
3140
3141#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3142
XiaokangQian7807f9f2022-02-15 10:04:37 +00003143 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3145 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003146 }
3147
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003149}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003150
Jerry Yufb4b6472022-01-27 15:03:26 +08003151#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */