blob: 2d2ad610b44a7e089bde244bed6a9663e2a8e9e2 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Gilles Peskine449bd832023-01-11 14:50:10 +0100164 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
165#if defined(MBEDTLS_HAVE_TIME)
166 now = mbedtls_time(NULL);
167
168 if (now < session->start) {
169 MBEDTLS_SSL_DEBUG_MSG(
170 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
171 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
172 (long long) now, (long long) session->start));
173 goto exit;
174 }
175
176 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800177
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800178 /* RFC 8446 section 4.6.1
179 *
180 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
181 *
182 * RFC 8446 section 4.2.11.1
183 *
184 * Clients MUST NOT attempt to use tickets which have ages greater than
185 * the "ticket_lifetime" value which was provided with the ticket.
186 *
187 * For time being, the age MUST be less than 604800 seconds (7 days).
188 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100189 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800190 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 3, ("Ticket age exceeds limitation ticket_age=%lu",
192 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800193 goto exit;
194 }
Jerry Yu95699e72022-08-21 19:22:23 +0800195
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800196 /* RFC 8446 section 4.2.10
197 *
198 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
199 * the ticket age for the selected PSK identity (computed by subtracting
200 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
201 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800202 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800203 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
204 * as the age units are different on the server (s) and in the
205 * client (ms) side. Add a -1000 ms tolerance window to take this
206 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800207 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800208 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
210 if (age_diff_in_ms <= -1000 ||
211 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800212 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100213 3, ("Ticket age outside tolerance window ( diff=%d )",
214 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800215 goto exit;
216 }
217
218 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800219
220#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800221
222exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100223 if (ret != 0) {
224 mbedtls_ssl_session_free(session);
225 }
Jerry Yu95699e72022-08-21 19:22:23 +0800226
Gilles Peskine449bd832023-01-11 14:50:10 +0100227 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
228 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800229}
230#endif /* MBEDTLS_SSL_SESSION_TICKETS */
231
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800232MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000233static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100234 mbedtls_ssl_context *ssl,
235 const unsigned char *identity,
236 size_t identity_len,
237 uint32_t obfuscated_ticket_age,
238 int *psk_type,
239 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000240{
Jerry Yu95699e72022-08-21 19:22:23 +0800241 ((void) session);
242 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800243 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800244
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800246 ssl->handshake->resume = 0;
247
Jerry Yu95699e72022-08-21 19:22:23 +0800248#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800250 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Pengyu Lvc55eeb62022-11-17 15:26:20 +0800252 /* RFC 8446 section 4.2.9
253 *
254 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
255 * compatible with the advertised modes; however, if a server does so,
256 * the impact will just be that the client's attempts at resumption fail.
257 *
258 * We regard the ticket with incompatible key exchange modes as not match.
259 */
260 MBEDTLS_SSL_DEBUG_TICKET_FLAGS(4,
261 session->ticket_flags);
262 if (mbedtls_ssl_tls13_check_kex_modes(ssl,
263 mbedtls_ssl_tls13_session_get_ticket_flags(session,
264 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL)))
265 {
266 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
267 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
268 }
269
Jerry Yu95699e72022-08-21 19:22:23 +0800270 ssl->handshake->resume = 1;
271 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Gilles Peskine449bd832023-01-11 14:50:10 +0100272 mbedtls_ssl_set_hs_psk(ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800273 session->resumption_key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 session->resumption_key_len);
275
276 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
277 session->resumption_key,
278 session->resumption_key_len);
279 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
280 (unsigned) obfuscated_ticket_age));
281 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800282 }
283#endif /* MBEDTLS_SSL_SESSION_TICKETS */
284
Jerry Yu1c105562022-07-10 06:32:38 +0000285 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100286 if (ssl->conf->f_psk != NULL) {
287 if (ssl->conf->f_psk(
288 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
289 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000290 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100291 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000292 }
293
Gilles Peskine449bd832023-01-11 14:50:10 +0100294 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000295 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800297 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 mbedtls_ct_memcmp(ssl->conf->psk_identity,
299 identity, identity_len) == 0) {
300 mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
301 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000302 }
303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000305}
306
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800307MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100308static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
309 const unsigned char *binder,
310 size_t binder_len,
311 int psk_type,
312 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000313{
314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800315
Jerry Yudaf375a2022-07-20 21:31:43 +0800316 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000317 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800318 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800319 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800320 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000321
Jerry Yu1c105562022-07-10 06:32:38 +0000322 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800323 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
325 transcript, sizeof(transcript), &transcript_len);
326 if (ret != 0) {
327 return ret;
328 }
Jerry Yu1c105562022-07-10 06:32:38 +0000329
Gilles Peskine449bd832023-01-11 14:50:10 +0100330 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
331 if (ret != 0) {
332 return ret;
333 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800334
Gilles Peskine449bd832023-01-11 14:50:10 +0100335 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
336 psk, psk_len, psk_type,
337 transcript,
338 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800339#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100340 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800341#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 if (ret != 0) {
343 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
344 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000345 }
346
Gilles Peskine449bd832023-01-11 14:50:10 +0100347 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
348 server_computed_binder, transcript_len);
349 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000350
Gilles Peskine449bd832023-01-11 14:50:10 +0100351 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
352 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000353 }
354
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 mbedtls_platform_zeroize(server_computed_binder,
356 sizeof(server_computed_binder));
357 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000358}
Jerry Yu96a2e362022-07-21 15:11:34 +0800359
Jerry Yu5725f1c2022-08-21 17:27:16 +0800360MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800361static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100362 mbedtls_ssl_context *ssl,
363 const unsigned char *cipher_suites,
364 const unsigned char *cipher_suites_end,
365 uint16_t *selected_ciphersuite,
366 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800367{
Jerry Yuf35ba382022-08-23 17:58:26 +0800368 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800369
Jerry Yu0baf9072022-08-25 11:21:04 +0800370 *selected_ciphersuite = 0;
371 *selected_ciphersuite_info = NULL;
372
Jerry Yuf35ba382022-08-23 17:58:26 +0800373 /* RFC 8446, page 55.
374 *
375 * For externally established PSKs, the Hash algorithm MUST be set when the
376 * PSK is established or default to SHA-256 if no such algorithm is defined.
377 *
378 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379
Jerry Yu5725f1c2022-08-21 17:27:16 +0800380 /*
381 * Search for a matching ciphersuite
382 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100383 for (const unsigned char *p = cipher_suites;
384 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800386 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800387
Gilles Peskine449bd832023-01-11 14:50:10 +0100388 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
389 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
390 cipher_suite);
391 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800392 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100393 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800394
Jerry Yu5725f1c2022-08-21 17:27:16 +0800395 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
396 * Otherwise, client should reject.
397 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100398 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800399 *selected_ciphersuite = cipher_suite;
400 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100401 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800402 }
403 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100404 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
405 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800406}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800407
Jerry Yu82534862022-08-30 10:42:33 +0800408#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800409MBEDTLS_CHECK_RETURN_CRITICAL
410static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 mbedtls_ssl_context *ssl,
412 const unsigned char *cipher_suites,
413 const unsigned char *cipher_suites_end,
414 mbedtls_ssl_session *session,
415 uint16_t *selected_ciphersuite,
416 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800417{
Jerry Yu82534862022-08-30 10:42:33 +0800418
Jerry Yuf35ba382022-08-23 17:58:26 +0800419 *selected_ciphersuite = 0;
420 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
422 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800423 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
424
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800426 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 }
Jerry Yu82534862022-08-30 10:42:33 +0800428
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
430 cipher_suite);
431 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800432 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100433 }
Jerry Yu82534862022-08-30 10:42:33 +0800434
Jerry Yu4746b102022-09-13 11:11:48 +0800435 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800436 *selected_ciphersuite_info = ciphersuite_info;
437
Gilles Peskine449bd832023-01-11 14:50:10 +0100438 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800439 }
440
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800442}
Jerry Yuf35ba382022-08-23 17:58:26 +0800443
Jerry Yu82534862022-08-30 10:42:33 +0800444MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100445static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
446 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800447{
Jerry Yu82534862022-08-30 10:42:33 +0800448 dst->ticket_age_add = src->ticket_age_add;
449 dst->ticket_flags = src->ticket_flags;
450 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100451 if (src->resumption_key_len == 0) {
452 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
453 }
454 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800455
Gilles Peskine449bd832023-01-11 14:50:10 +0100456 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800457}
458#endif /* MBEDTLS_SSL_SESSION_TICKETS */
459
Jerry Yu1c105562022-07-10 06:32:38 +0000460/* Parser for pre_shared_key extension in client hello
461 * struct {
462 * opaque identity<1..2^16-1>;
463 * uint32 obfuscated_ticket_age;
464 * } PskIdentity;
465 *
466 * opaque PskBinderEntry<32..255>;
467 *
468 * struct {
469 * PskIdentity identities<7..2^16-1>;
470 * PskBinderEntry binders<33..2^16-1>;
471 * } OfferedPsks;
472 *
473 * struct {
474 * select (Handshake.msg_type) {
475 * case client_hello: OfferedPsks;
476 * ....
477 * };
478 * } PreSharedKeyExtension;
479 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800480MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100481static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
482 const unsigned char *pre_shared_key_ext,
483 const unsigned char *pre_shared_key_ext_end,
484 const unsigned char *ciphersuites,
485 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000486{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800487 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800488 const unsigned char *p_identity_len;
489 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000490 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800491 const unsigned char *binders;
492 const unsigned char *p_binder_len;
493 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000494 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800495 int matched_identity = -1;
496 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000497
Gilles Peskine449bd832023-01-11 14:50:10 +0100498 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
499 pre_shared_key_ext,
500 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000501
Jerry Yu96a2e362022-07-21 15:11:34 +0800502 /* identities_len 2 bytes
503 * identities_data >= 7 bytes
504 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100505 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
506 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800507 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100508 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
509 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800510 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000511
Jerry Yu96a2e362022-07-21 15:11:34 +0800512 /* binders_len 2 bytes
513 * binders >= 33 bytes
514 */
Jerry Yu568ec252022-07-22 21:27:34 +0800515 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100516 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
517 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800518 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800520 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000521
Gilles Peskine449bd832023-01-11 14:50:10 +0100522 ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
523 identities_end - pre_shared_key_ext);
Jerry Yu96a2e362022-07-21 15:11:34 +0800524
Gilles Peskine449bd832023-01-11 14:50:10 +0100525 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000526 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800527 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800528 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800529 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800530 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800532 int psk_type;
533 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800534 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800535#if defined(MBEDTLS_SSL_SESSION_TICKETS)
536 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800538#endif
Jerry Yubb852022022-07-20 21:10:44 +0800539
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
541 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800542 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100543 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
544 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800545 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000546
Gilles Peskine449bd832023-01-11 14:50:10 +0100547 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800548 binder_len = *p_binder_len;
549 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800551 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800552
Jerry Yu96a2e362022-07-21 15:11:34 +0800553 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100554 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000555 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 }
Jerry Yu1c105562022-07-10 06:32:38 +0000557
Jerry Yu96a2e362022-07-21 15:11:34 +0800558 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 ssl, identity, identity_len, obfuscated_ticket_age,
560 &psk_type, &session);
561 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800562 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100563 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800564
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
566 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800567 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
568 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 ssl, ciphersuites, ciphersuites_end,
570 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800571 break;
572 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800573#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800574 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 ssl, ciphersuites, ciphersuites_end, &session,
576 &cipher_suite, &ciphersuite_info);
577 if (ret != 0) {
578 mbedtls_ssl_session_free(&session);
579 }
Jerry Yu82534862022-08-30 10:42:33 +0800580#else
581 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
582#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800583 break;
584 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100585 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800586 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800588 /* See below, no cipher_suite available, abort handshake */
589 MBEDTLS_SSL_PEND_FATAL_ALERT(
590 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100591 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800592 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 2, "ssl_tls13_select_ciphersuite", ret);
594 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800595 }
596
Jerry Yu96a2e362022-07-21 15:11:34 +0800597 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100598 ssl, binder, binder_len, psk_type,
599 mbedtls_psa_translate_md(ciphersuite_info->mac));
600 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800601 /* For security reasons, the handshake should be aborted when we
602 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
603 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800604#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100605 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800606#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
608 MBEDTLS_SSL_DEBUG_RET(1,
609 "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800610 MBEDTLS_SSL_PEND_FATAL_ALERT(
611 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
613 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800614 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800615
616 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800617
618 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800619 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800620 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100621 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
622 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800623#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
625 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
626 &session);
627 mbedtls_ssl_session_free(&session);
628 if (ret != 0) {
629 return ret;
630 }
Jerry Yu82534862022-08-30 10:42:33 +0800631 }
632#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000633 }
634
Gilles Peskine449bd832023-01-11 14:50:10 +0100635 if (p_identity_len != identities_end || p_binder_len != binders_end) {
636 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
637 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
638 MBEDTLS_ERR_SSL_DECODE_ERROR);
639 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000640 }
641
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800642 /* Update the handshake transcript with the binder list. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 ssl->handshake->update_checksum(ssl,
644 identities_end,
645 (size_t) (binders_end - identities_end));
646 if (matched_identity == -1) {
647 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
648 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000649 }
650
Gilles Peskine449bd832023-01-11 14:50:10 +0100651 ssl->handshake->selected_identity = (uint16_t) matched_identity;
652 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000655}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000656
657/*
658 * struct {
659 * select ( Handshake.msg_type ) {
660 * ....
661 * case server_hello:
662 * uint16 selected_identity;
663 * }
664 * } PreSharedKeyExtension;
665 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100666static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
667 unsigned char *buf,
668 unsigned char *end,
669 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000670{
Gilles Peskine449bd832023-01-11 14:50:10 +0100671 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672
673 *olen = 0;
674
David Horstmann21b89762022-10-06 18:34:28 +0100675 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000676#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100677 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000680#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000682 /* We shouldn't have called this extension writer unless we've
683 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100684 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000685 }
686
Gilles Peskine449bd832023-01-11 14:50:10 +0100687 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
688 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000689
Gilles Peskine449bd832023-01-11 14:50:10 +0100690 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
691 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000692
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694
695 *olen = 6;
696
Gilles Peskine449bd832023-01-11 14:50:10 +0100697 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
698 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000699
Gilles Peskine449bd832023-01-11 14:50:10 +0100700 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800701
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000703}
704
Ronald Cron41a443a2022-10-04 16:38:25 +0200705#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000706
XiaokangQian7807f9f2022-02-15 10:04:37 +0000707/* From RFC 8446:
708 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000709 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000710 * } SupportedVersions;
711 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100713static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
714 const unsigned char *buf,
715 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000716{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000717 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000718 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000719 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000720 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000721 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000722
Gilles Peskine449bd832023-01-11 14:50:10 +0100723 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000724 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000725 p += 1;
726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000728 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 while (p < versions_end) {
730 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
731 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000732 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000733
734 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100735 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000736 tls13_supported = 1;
737 break;
738 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000739 }
740
Gilles Peskine449bd832023-01-11 14:50:10 +0100741 if (!tls13_supported) {
742 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000743
Gilles Peskine449bd832023-01-11 14:50:10 +0100744 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
745 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
746 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000747 }
748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
750 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000751
Gilles Peskine449bd832023-01-11 14:50:10 +0100752 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753}
754
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000755#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000756/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000757 *
758 * From RFC 8446:
759 * enum {
760 * ... (0xFFFF)
761 * } NamedGroup;
762 * struct {
763 * NamedGroup named_group_list<2..2^16-1>;
764 * } NamedGroupList;
765 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200766MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100767static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
768 const unsigned char *buf,
769 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000770{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000771 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000772 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000773 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000774
Gilles Peskine449bd832023-01-11 14:50:10 +0100775 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
776 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
777 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100779 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000780 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000781 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000782
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000784 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
786 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000787 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788
Gilles Peskine449bd832023-01-11 14:50:10 +0100789 MBEDTLS_SSL_DEBUG_MSG(2,
790 ("got named group: %s(%04x)",
791 mbedtls_ssl_named_group_to_str(named_group),
792 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000793
Gilles Peskine449bd832023-01-11 14:50:10 +0100794 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
795 !mbedtls_ssl_named_group_is_supported(named_group) ||
796 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000797 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000798 }
799
Gilles Peskine449bd832023-01-11 14:50:10 +0100800 MBEDTLS_SSL_DEBUG_MSG(2,
801 ("add named group %s(%04x) into received list.",
802 mbedtls_ssl_named_group_to_str(named_group),
803 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800804
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000805 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000806 }
807
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000809
810}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000811#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000812
XiaokangQian08037552022-04-20 07:16:41 +0000813#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
814
XiaokangQian88408882022-04-02 10:15:03 +0000815#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000816/*
817 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000818 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000819 *
820 * Possible return values are:
821 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000822 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000823 * does not match a group supported by the server. A HelloRetryRequest will
824 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000825 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800826 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200827MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100828static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
829 const unsigned char *buf,
830 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831{
XiaokangQianb67384d2022-04-19 00:02:38 +0000832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000833 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000834 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800835 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000836
837 /* From RFC 8446:
838 *
839 * struct {
840 * KeyShareEntry client_shares<0..2^16-1>;
841 * } KeyShareClientHello;
842 *
843 */
844
Gilles Peskine449bd832023-01-11 14:50:10 +0100845 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
846 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000847 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100848 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849
850 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000851 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000852
853 /* We try to find a suitable key share entry and copy it to the
854 * handshake context. Later, we have to find out whether we can do
855 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000856 * dismiss it and send a HelloRetryRequest message.
857 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000858
Gilles Peskine449bd832023-01-11 14:50:10 +0100859 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000860 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800861 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800862 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000863
864 /*
865 * struct {
866 * NamedGroup group;
867 * opaque key_exchange<1..2^16-1>;
868 * } KeyShareEntry;
869 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100870 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
871 group = MBEDTLS_GET_UINT16_BE(p, 0);
872 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800873 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800874 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100875 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800876 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000877
878 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000879 * for input validation purposes.
880 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
882 !mbedtls_ssl_named_group_is_supported(group) ||
883 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000884 continue;
885 }
XiaokangQian060d8672022-04-21 09:24:56 +0000886
XiaokangQian7807f9f2022-02-15 10:04:37 +0000887 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000888 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000889 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100890 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
891 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
892 mbedtls_ssl_named_group_to_str(group),
893 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000894 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100895 ssl, key_exchange - 2, key_exchange_len + 2);
896 if (ret != 0) {
897 return ret;
898 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000899
Gilles Peskine449bd832023-01-11 14:50:10 +0100900 } else {
901 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
902 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000903 continue;
904 }
905
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000906 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000907 }
908
Jerry Yuc1be19f2022-04-23 16:11:39 +0800909
Gilles Peskine449bd832023-01-11 14:50:10 +0100910 if (ssl->handshake->offered_group_id == 0) {
911 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
912 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000913 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915}
XiaokangQian88408882022-04-02 10:15:03 +0000916#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200918MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100919static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
920 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000921{
Jerry Yu0c354a22022-08-29 15:25:36 +0800922 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100923 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000924}
925
Jerry Yue5991322022-11-07 14:03:44 +0800926#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200927MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000928static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000930{
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 return ssl_tls13_client_hello_has_exts(
932 ssl,
933 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
934 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
935 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000936}
Jerry Yue5991322022-11-07 14:03:44 +0800937#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000938
Jerry Yue5991322022-11-07 14:03:44 +0800939#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000940MBEDTLS_CHECK_RETURN_CRITICAL
941static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100942 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000943{
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 return ssl_tls13_client_hello_has_exts(
945 ssl,
946 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
947 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000948}
Jerry Yue5991322022-11-07 14:03:44 +0800949#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000950
Jerry Yue5991322022-11-07 14:03:44 +0800951#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000952MBEDTLS_CHECK_RETURN_CRITICAL
953static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100954 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000955{
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 return ssl_tls13_client_hello_has_exts(
957 ssl,
958 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
959 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
960 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
961 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000962}
Jerry Yue5991322022-11-07 14:03:44 +0800963#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000964
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200965MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100966static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000967{
Jerry Yue5991322022-11-07 14:03:44 +0800968#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100969 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
970 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800971#else
972 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800974#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000975}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000976
Jerry Yu77f01482022-07-11 07:03:24 +0000977MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100978static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000979{
Jerry Yue5991322022-11-07 14:03:44 +0800980#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100981 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
982 mbedtls_ssl_tls13_psk_enabled(ssl) &&
983 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000984#else
985 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100986 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +0000987#endif
988}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000989
Jerry Yu77f01482022-07-11 07:03:24 +0000990MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100991static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000992{
Jerry Yue5991322022-11-07 14:03:44 +0800993#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100994 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
995 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
996 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000997#else
998 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100999 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001000#endif
1001}
1002
Gilles Peskine449bd832023-01-11 14:50:10 +01001003static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001004{
1005 /*
1006 * Determine the key exchange algorithm to use.
1007 * There are three types of key exchanges supported in TLS 1.3:
1008 * - (EC)DH with ECDSA,
1009 * - (EC)DH with PSK,
1010 * - plain PSK.
1011 *
1012 * The PSK-based key exchanges may additionally be used with 0-RTT.
1013 *
1014 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001015 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1016 * 2 ) Certificate Mode ( ephemeral )
1017 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001018 */
1019
1020 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1021
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001023 ssl->handshake->key_exchange_mode =
1024 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001025 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1026 } else
1027 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001028 ssl->handshake->key_exchange_mode =
1029 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001030 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1031 } else
1032 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001033 ssl->handshake->key_exchange_mode =
1034 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001035 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1036 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001037 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001038 1,
1039 ("ClientHello message misses mandatory extensions."));
1040 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1041 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1042 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001043 }
1044
Gilles Peskine449bd832023-01-11 14:50:10 +01001045 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001046
XiaokangQian7807f9f2022-02-15 10:04:37 +00001047}
1048
XiaokangQian81802f42022-06-10 13:25:22 +00001049#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001050 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001051
1052#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001053static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001054{
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001056 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001058 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001059 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001060 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001062 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001063 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001064 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001066 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001067 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001068 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001069 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001070 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001072 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001074 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001076 }
1077}
1078#endif /* MBEDTLS_USE_PSA_CRYPTO */
1079
XiaokangQian23c5be62022-06-07 02:04:34 +00001080/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001081 * Pick best ( private key, certificate chain ) pair based on the signature
1082 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001083 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001084MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001085static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001086{
XiaokangQianfb665a82022-06-15 03:57:21 +00001087 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001088 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001089
1090#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001092 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001094#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001096
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 if (key_cert_list == NULL) {
1098 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1099 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001100 }
1101
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1103 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001104 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001106
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001108 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001110
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 for (key_cert = key_cert_list; key_cert != NULL;
1112 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001113#if defined(MBEDTLS_USE_PSA_CRYPTO)
1114 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1115#endif /* MBEDTLS_USE_PSA_CRYPTO */
1116
Gilles Peskine449bd832023-01-11 14:50:10 +01001117 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1118 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001119
1120 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 * This avoids sending the client a cert it'll reject based on
1122 * keyUsage or other extensions.
1123 */
1124 if (mbedtls_x509_crt_check_key_usage(
1125 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001126 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001127 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1129 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1130 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001131 continue;
1132 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 MBEDTLS_SSL_DEBUG_MSG(3,
1135 ("ssl_tls13_pick_key_cert:"
1136 "check signature algorithm %s [%04x]",
1137 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1138 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001139#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001141#endif /* MBEDTLS_USE_PSA_CRYPTO */
1142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1144 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001145#if defined(MBEDTLS_USE_PSA_CRYPTO)
1146 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1148 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001149#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001150 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001151 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 MBEDTLS_SSL_DEBUG_MSG(3,
1153 ("ssl_tls13_pick_key_cert:"
1154 "selected signature algorithm"
1155 " %s [%04x]",
1156 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1157 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001158 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001159 3, "selected certificate (chain)",
1160 ssl->handshake->key_cert->cert);
1161 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001162 }
XiaokangQian81802f42022-06-10 13:25:22 +00001163 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001164 }
1165
Gilles Peskine449bd832023-01-11 14:50:10 +01001166 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1167 "no suitable certificate found"));
1168 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001169}
XiaokangQian81802f42022-06-10 13:25:22 +00001170#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001171 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001172
XiaokangQian4080a7f2022-04-11 09:55:18 +00001173/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001174 *
1175 * STATE HANDLING: ClientHello
1176 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001177 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001178 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001179 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001180 *
1181 * In this case, the server progresses to sending its ServerHello.
1182 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001183 * 2) The ClientHello was well-formed but didn't match the server's
1184 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001185 *
1186 * For example, the client might not have offered a key share which
1187 * the server supports, or the server might require a cookie.
1188 *
1189 * In this case, the server sends a HelloRetryRequest.
1190 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001191 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001192 *
1193 * In this case, we abort the handshake.
1194 *
1195 */
1196
1197/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001198 * Structure of this message:
1199 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001200 * uint16 ProtocolVersion;
1201 * opaque Random[32];
1202 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001203 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001204 * struct {
1205 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1206 * Random random;
1207 * opaque legacy_session_id<0..32>;
1208 * CipherSuite cipher_suites<2..2^16-2>;
1209 * opaque legacy_compression_methods<1..2^8-1>;
1210 * Extension extensions<8..2^16-1>;
1211 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001212 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001213
1214#define SSL_CLIENT_HELLO_OK 0
1215#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1216
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001217MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001218static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1219 const unsigned char *buf,
1220 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001221{
XiaokangQianb67384d2022-04-19 00:02:38 +00001222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1223 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001224 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001225 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001226 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001227 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001228 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001229 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001230 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001231
Ronald Cron41a443a2022-10-04 16:38:25 +02001232#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001233 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001234 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001235 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001236#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001237
XiaokangQian7807f9f2022-02-15 10:04:37 +00001238 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001239 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001240 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001241 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001242 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001243 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001244 * .. . .. ciphersuite list length ( 2 bytes )
1245 * .. . .. ciphersuite list
1246 * .. . .. compression alg. list length ( 1 byte )
1247 * .. . .. compression alg. list
1248 * .. . .. extensions length ( 2 bytes, optional )
1249 * .. . .. extensions ( optional )
1250 */
1251
XiaokangQianb67384d2022-04-19 00:02:38 +00001252 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001253 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001254 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1255 * read at least up to session id length without worrying.
1256 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001257 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258
1259 /* ...
1260 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1261 * ...
1262 * with ProtocolVersion defined as:
1263 * uint16 ProtocolVersion;
1264 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001265 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1266 MBEDTLS_SSL_VERSION_TLS1_2) {
1267 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1268 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1269 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1270 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001271 }
1272 p += 2;
1273
1274 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001275 * Only support TLS 1.3 currently, temporarily set the version.
1276 */
XiaokangQiande333912022-04-20 08:49:42 +00001277 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001278
Jerry Yue67bef42022-07-07 07:29:42 +00001279#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1280 /* Store minor version for later use with ticket serialization. */
1281 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001282 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001283#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001284
Jerry Yuc1be19f2022-04-23 16:11:39 +08001285 /* ...
1286 * Random random;
1287 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001288 * with Random defined as:
1289 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001290 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001291 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1292 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001293
Gilles Peskine449bd832023-01-11 14:50:10 +01001294 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001295 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001296
Jerry Yuc1be19f2022-04-23 16:11:39 +08001297 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001298 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001299 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001300 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001301 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001302 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001303
Gilles Peskine449bd832023-01-11 14:50:10 +01001304 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1305 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1306 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001307 }
1308
XiaokangQian4080a7f2022-04-11 09:55:18 +00001309 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001310 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1311 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001312 /*
1313 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001314 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001315 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001316 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001317
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001319 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322 p += 2;
1323
XiaokangQianb67384d2022-04-19 00:02:38 +00001324 /* Check we have enough data for the ciphersuite list, the legacy
1325 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001326 *
1327 * cipher_suites cipher_suites_len bytes
1328 * legacy_compression_methods 2 bytes
1329 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001330 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001332
Gilles Peskine449bd832023-01-11 14:50:10 +01001333 /* ...
1334 * CipherSuite cipher_suites<2..2^16-2>;
1335 * ...
1336 * with CipherSuite defined as:
1337 * uint8 CipherSuite[2];
1338 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001339#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001340 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001341#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001342 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1344 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001345
1346 /*
1347 * Search for a matching ciphersuite
1348 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001349 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001350 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001351 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001352
Gilles Peskine449bd832023-01-11 14:50:10 +01001353 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001354
Gilles Peskine449bd832023-01-11 14:50:10 +01001355 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001356 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001357 ssl, cipher_suite);
1358 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001359 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001361
Jerry Yu5725f1c2022-08-21 17:27:16 +08001362 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001363 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1365 cipher_suite,
1366 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001367 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001368
Gilles Peskine449bd832023-01-11 14:50:10 +01001369 if (handshake->ciphersuite_info == NULL) {
1370 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1371 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1372 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001373 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001374
XiaokangQian4080a7f2022-04-11 09:55:18 +00001375 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001376 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001377 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001378 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001379 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1380 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1381 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1382 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1383 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001384 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001385 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001386
Jerry Yuc1be19f2022-04-23 16:11:39 +08001387 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001388 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001389 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001390 * with Extension defined as:
1391 * struct {
1392 * ExtensionType extension_type;
1393 * opaque extension_data<0..2^16-1>;
1394 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001395 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001397 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001398 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001399 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001400
Gilles Peskine449bd832023-01-11 14:50:10 +01001401 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001402
Jerry Yu63a459c2022-10-31 13:38:40 +08001403 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001404
Gilles Peskine449bd832023-01-11 14:50:10 +01001405 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001406 unsigned int extension_type;
1407 size_t extension_data_len;
1408 const unsigned char *extension_data_end;
1409
Jerry Yu0c354a22022-08-29 15:25:36 +08001410 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001411 *
1412 * The "pre_shared_key" extension MUST be the last extension in the
1413 * ClientHello (this facilitates implementation as described below).
1414 * Servers MUST check that it is the last extension and otherwise fail
1415 * the handshake with an "illegal_parameter" alert.
1416 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001417 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001418 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001419 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001420 MBEDTLS_SSL_PEND_FATAL_ALERT(
1421 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001422 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1423 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001424 }
1425
Gilles Peskine449bd832023-01-11 14:50:10 +01001426 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1427 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1428 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001429 p += 4;
1430
Gilles Peskine449bd832023-01-11 14:50:10 +01001431 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001432 extension_data_end = p + extension_data_len;
1433
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001434 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001435 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1436 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1437 if (ret != 0) {
1438 return ret;
1439 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001440
Gilles Peskine449bd832023-01-11 14:50:10 +01001441 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001442#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1443 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1445 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1446 extension_data_end);
1447 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001448 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 1, "mbedtls_ssl_parse_servername_ext", ret);
1450 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001451 }
XiaokangQian40a35232022-05-07 09:02:40 +00001452 break;
1453#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1454
XiaokangQianb67384d2022-04-19 00:02:38 +00001455#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001456 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001458
1459 /* Supported Groups Extension
1460 *
1461 * When sent by the client, the "supported_groups" extension
1462 * indicates the named groups which the client supports,
1463 * ordered from most preferred to least preferred.
1464 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001465 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001466 ssl, p, extension_data_end);
1467 if (ret != 0) {
1468 MBEDTLS_SSL_DEBUG_RET(1,
1469 "mbedtls_ssl_parse_supported_groups_ext", ret);
1470 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001471 }
1472
XiaokangQian7807f9f2022-02-15 10:04:37 +00001473 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001474#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001475
XiaokangQian88408882022-04-02 10:15:03 +00001476#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001477 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001479
1480 /*
1481 * Key Share Extension
1482 *
1483 * When sent by the client, the "key_share" extension
1484 * contains the endpoint's cryptographic parameters for
1485 * ECDHE/DHE key establishment methods.
1486 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001487 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001488 ssl, p, extension_data_end);
1489 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1490 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001491 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001492 }
1493
Gilles Peskine449bd832023-01-11 14:50:10 +01001494 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001495 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 1, "ssl_tls13_parse_key_shares_ext", ret);
1497 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001498 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001499
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500 break;
XiaokangQian88408882022-04-02 10:15:03 +00001501#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001502
1503 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001505
1506 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001507 ssl, p, extension_data_end);
1508 if (ret != 0) {
1509 MBEDTLS_SSL_DEBUG_RET(1,
1510 ("ssl_tls13_parse_supported_versions_ext"), ret);
1511 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001512 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513 break;
1514
Ronald Cron41a443a2022-10-04 16:38:25 +02001515#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001516 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001518
1519 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 ssl, p, extension_data_end);
1521 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001522 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1524 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001525 }
1526
Jerry Yue19e3b92022-07-08 12:04:51 +00001527 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001528#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001529
Jerry Yu1c105562022-07-10 06:32:38 +00001530 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1532 if ((handshake->received_extensions &
1533 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001534 MBEDTLS_SSL_PEND_FATAL_ALERT(
1535 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001536 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1537 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001538 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001539#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001540 /* Delay processing of the PSK identity once we have
1541 * found out which algorithms to use. We keep a pointer
1542 * to the buffer and the size for later processing.
1543 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001544 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001545 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001546#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001547 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001548
XiaokangQianacb39922022-06-17 10:18:48 +00001549#if defined(MBEDTLS_SSL_ALPN)
1550 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001551 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001552
Gilles Peskine449bd832023-01-11 14:50:10 +01001553 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1554 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001555 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1557 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001558 }
XiaokangQianacb39922022-06-17 10:18:48 +00001559 break;
1560#endif /* MBEDTLS_SSL_ALPN */
1561
Ronald Cron928cbd32022-10-04 16:14:26 +02001562#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001563 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001565
Gabor Mezei078e8032022-04-27 21:17:56 +02001566 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001567 ssl, p, extension_data_end);
1568 if (ret != 0) {
1569 MBEDTLS_SSL_DEBUG_MSG(1,
1570 (
1571 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1572 ret));
1573 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001574 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001575 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001576#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001577
1578 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001579 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001580 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001582 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001583 }
1584
1585 p += extension_data_len;
1586 }
1587
Gilles Peskine449bd832023-01-11 14:50:10 +01001588 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1589 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001590
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1592 MBEDTLS_SSL_HS_CLIENT_HELLO,
1593 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001594
Ronald Cron41a443a2022-10-04 16:38:25 +02001595#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001596 /* Update checksum with either
1597 * - The entire content of the CH message, if no PSK extension is present
1598 * - The content up to but excluding the PSK extension, if present.
1599 */
Jerry Yu1c105562022-07-10 06:32:38 +00001600 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001601 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1602 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1603 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1604 handshake->update_checksum(ssl, buf,
1605 pre_shared_key_ext - buf);
1606 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1607 pre_shared_key_ext,
1608 pre_shared_key_ext_end,
1609 cipher_suites,
1610 cipher_suites_end);
1611 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1612 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1613 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001614 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1616 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001617 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001619#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001620 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001621 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001622 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001623
Gilles Peskine449bd832023-01-11 14:50:10 +01001624 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1625 if (ret < 0) {
1626 return ret;
1627 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001628
Gilles Peskine449bd832023-01-11 14:50:10 +01001629 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001630
Gilles Peskine449bd832023-01-11 14:50:10 +01001631 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001632}
1633
1634/* Update the handshake state machine */
1635
Ronald Cronce7d76e2022-07-08 18:56:49 +02001636MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001637static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001638{
1639 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1640
XiaokangQian7807f9f2022-02-15 10:04:37 +00001641 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001642 * Server certificate selection
1643 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1645 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1646 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001647 }
1648#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1649 ssl->handshake->sni_name = NULL;
1650 ssl->handshake->sni_name_len = 0;
1651#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001652
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1654 if (ret != 0) {
1655 MBEDTLS_SSL_DEBUG_RET(1,
1656 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1657 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001658 }
1659
Gilles Peskine449bd832023-01-11 14:50:10 +01001660 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001661
1662}
1663
1664/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001665 * Main entry point from the state machine; orchestrates the otherfunctions.
1666 */
1667
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001668MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001669static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001670{
1671
XiaokangQian08037552022-04-20 07:16:41 +00001672 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001673 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001674 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001675 int parse_client_hello_ret;
1676
Gilles Peskine449bd832023-01-11 14:50:10 +01001677 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001678
Gilles Peskine449bd832023-01-11 14:50:10 +01001679 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1680 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1681 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001682
Gilles Peskine449bd832023-01-11 14:50:10 +01001683 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1684 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001685 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1686 * only SSL_CLIENT_HELLO_OK or
1687 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1688 * stage as negative error codes are handled
1689 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001690
Gilles Peskine449bd832023-01-11 14:50:10 +01001691 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001692
Gilles Peskine449bd832023-01-11 14:50:10 +01001693 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1694 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1695 } else {
1696 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1697 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001698
1699cleanup:
1700
Gilles Peskine449bd832023-01-11 14:50:10 +01001701 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1702 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001703}
1704
1705/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001706 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001707 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001708MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001709static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001710{
Jerry Yu637a3f12022-04-20 21:37:58 +08001711 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1712 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001713 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1714 if (ssl->conf->f_rng == NULL) {
1715 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1716 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001717 }
1718
Gilles Peskine449bd832023-01-11 14:50:10 +01001719 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1720 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1721 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1722 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001723 }
1724
Gilles Peskine449bd832023-01-11 14:50:10 +01001725 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1726 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001727
1728#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001730#endif /* MBEDTLS_HAVE_TIME */
1731
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001733}
1734
Jerry Yu3bf2c642022-03-30 22:02:12 +08001735/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001736 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001737 *
1738 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001739 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001740 * } SupportedVersions;
1741 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001742MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001743static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001744 mbedtls_ssl_context *ssl,
1745 unsigned char *buf,
1746 unsigned char *end,
1747 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001748{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001749 *out_len = 0;
1750
Gilles Peskine449bd832023-01-11 14:50:10 +01001751 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001752
1753 /* Check if we have space to write the extension:
1754 * - extension_type (2 bytes)
1755 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001756 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001757 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001758 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001759
Gilles Peskine449bd832023-01-11 14:50:10 +01001760 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001761
Gilles Peskine449bd832023-01-11 14:50:10 +01001762 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001763
Gilles Peskine449bd832023-01-11 14:50:10 +01001764 mbedtls_ssl_write_version(buf + 4,
1765 ssl->conf->transport,
1766 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001767
Gilles Peskine449bd832023-01-11 14:50:10 +01001768 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1769 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001770
Jerry Yu349a6132022-04-14 20:52:56 +08001771 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001772
Jerry Yub95dd362022-11-08 21:19:34 +08001773 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001774 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001775
Gilles Peskine449bd832023-01-11 14:50:10 +01001776 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001777}
1778
Jerry Yud9436a12022-04-20 22:28:09 +08001779
Jerry Yu3bf2c642022-03-30 22:02:12 +08001780
1781/* Generate and export a single key share. For hybrid KEMs, this can
1782 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001783MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001784static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1785 uint16_t named_group,
1786 unsigned char *buf,
1787 unsigned char *end,
1788 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001789{
1790 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001791
1792 *out_len = 0;
1793
Jerry Yu89e103c2022-03-30 22:43:29 +08001794#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001796 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001797 ssl, named_group, buf, end, out_len);
1798 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001799 MBEDTLS_SSL_DEBUG_RET(
1800 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 ret);
1802 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001804 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001805#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001806 if (0 /* Other kinds of KEMs */) {
1807 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001808 ((void) ssl);
1809 ((void) named_group);
1810 ((void) buf);
1811 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001812 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1813 }
1814
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001816}
1817
1818/*
1819 * ssl_tls13_write_key_share_ext
1820 *
1821 * Structure of key_share extension in ServerHello:
1822 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001823 * struct {
1824 * NamedGroup group;
1825 * opaque key_exchange<1..2^16-1>;
1826 * } KeyShareEntry;
1827 * struct {
1828 * KeyShareEntry server_share;
1829 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001830 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001831MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001832static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1833 unsigned char *buf,
1834 unsigned char *end,
1835 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001836{
Jerry Yu955ddd72022-04-22 22:27:33 +08001837 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001838 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001839 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001840 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001841 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001842
1843 *out_len = 0;
1844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001846
Gilles Peskine449bd832023-01-11 14:50:10 +01001847 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1848 mbedtls_ssl_named_group_to_str(group),
1849 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001850
Jerry Yu3bf2c642022-03-30 22:02:12 +08001851 /* Check if we have space for header and length fields:
1852 * - extension_type (2 bytes)
1853 * - extension_data_length (2 bytes)
1854 * - group (2 bytes)
1855 * - key_exchange_length (2 bytes)
1856 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001857 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1858 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1859 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001860 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001861
Jerry Yu3bf2c642022-03-30 22:02:12 +08001862 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1863 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001864 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001865 ssl, group, server_share + 4, end, &key_exchange_length);
1866 if (ret != 0) {
1867 return ret;
1868 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001869 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001870
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001874
Jerry Yu57d48412022-04-20 21:50:42 +08001875 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001880}
Jerry Yud9436a12022-04-20 22:28:09 +08001881
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001882MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001883static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1884 unsigned char *buf,
1885 unsigned char *end,
1886 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001887{
1888 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1889 /* key_share Extension
1890 *
1891 * struct {
1892 * select (Handshake.msg_type) {
1893 * ...
1894 * case hello_retry_request:
1895 * NamedGroup selected_group;
1896 * ...
1897 * };
1898 * } KeyShare;
1899 */
1900
1901 *out_len = 0;
1902
Jerry Yub0ac10b2022-05-05 11:10:08 +08001903 /*
1904 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1905 * of the HRR is then to transmit a cookie to force the client to demonstrate
1906 * reachability at their apparent network address (primarily useful for DTLS).
1907 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001908 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1909 return 0;
1910 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001911
1912 /* We should only send the key_share extension if the client's initial
1913 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 if (ssl->handshake->offered_group_id != 0) {
1915 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1916 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001917 }
1918
Gilles Peskine449bd832023-01-11 14:50:10 +01001919 if (selected_group == 0) {
1920 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1921 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001922 }
1923
Jerry Yub0ac10b2022-05-05 11:10:08 +08001924 /* Check if we have enough space:
1925 * - extension_type (2 bytes)
1926 * - extension_data_length (2 bytes)
1927 * - selected_group (2 bytes)
1928 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001930
Gilles Peskine449bd832023-01-11 14:50:10 +01001931 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1932 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1933 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 MBEDTLS_SSL_DEBUG_MSG(3,
1936 ("HRR selected_group: %s (%x)",
1937 mbedtls_ssl_named_group_to_str(selected_group),
1938 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001939
1940 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001943
Gilles Peskine449bd832023-01-11 14:50:10 +01001944 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001945}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001946
1947/*
1948 * Structure of ServerHello message:
1949 *
1950 * struct {
1951 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1952 * Random random;
1953 * opaque legacy_session_id_echo<0..32>;
1954 * CipherSuite cipher_suite;
1955 * uint8 legacy_compression_method = 0;
1956 * Extension extensions<6..2^16-1>;
1957 * } ServerHello;
1958 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001959MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001960static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1961 unsigned char *buf,
1962 unsigned char *end,
1963 size_t *out_len,
1964 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08001965{
Jerry Yu955ddd72022-04-22 22:27:33 +08001966 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001967 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001968 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001969 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001970
1971 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08001972 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001973
Jerry Yucfc04b32022-04-21 09:31:58 +08001974 /* ...
1975 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1976 * ...
1977 * with ProtocolVersion defined as:
1978 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001979 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001980 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
1981 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001982 p += 2;
1983
Jerry Yu1c3e6882022-04-20 21:23:40 +08001984 /* ...
1985 * Random random;
1986 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001987 * with Random defined as:
1988 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001989 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001990 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1991 if (is_hrr) {
1992 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
1993 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1994 } else {
1995 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
1996 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001997 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001998 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1999 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002000 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2001
Jerry Yucfc04b32022-04-21 09:31:58 +08002002 /* ...
2003 * opaque legacy_session_id_echo<0..32>;
2004 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002005 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2007 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2008 if (ssl->session_negotiate->id_len > 0) {
2009 memcpy(p, &ssl->session_negotiate->id[0],
2010 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002011 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002012
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2014 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002015 }
2016
Jerry Yucfc04b32022-04-21 09:31:58 +08002017 /* ...
2018 * CipherSuite cipher_suite;
2019 * ...
2020 * with CipherSuite defined as:
2021 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002022 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002023 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2024 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002025 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 MBEDTLS_SSL_DEBUG_MSG(3,
2027 ("server hello, chosen ciphersuite: %s ( id=%d )",
2028 mbedtls_ssl_get_ciphersuite_name(
2029 ssl->session_negotiate->ciphersuite),
2030 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002031
Jerry Yucfc04b32022-04-21 09:31:58 +08002032 /* ...
2033 * uint8 legacy_compression_method = 0;
2034 * ...
2035 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002036 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002037 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002038
Jerry Yucfc04b32022-04-21 09:31:58 +08002039 /* ...
2040 * Extension extensions<6..2^16-1>;
2041 * ...
2042 * struct {
2043 * ExtensionType extension_type; (2 bytes)
2044 * opaque extension_data<0..2^16-1>;
2045 * } Extension;
2046 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002047 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002048 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 p += 2;
2050
Gilles Peskine449bd832023-01-11 14:50:10 +01002051 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2052 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002053 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2055 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002056 }
2057 p += output_len;
2058
Gilles Peskine449bd832023-01-11 14:50:10 +01002059 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2060 if (is_hrr) {
2061 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2062 } else {
2063 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2064 }
2065 if (ret != 0) {
2066 return ret;
2067 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002068 p += output_len;
2069 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002070
Ronald Cron41a443a2022-10-04 16:38:25 +02002071#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002072 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2073 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2074 if (ret != 0) {
2075 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2076 ret);
2077 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002078 }
2079 p += output_len;
2080 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002081#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002082
Gilles Peskine449bd832023-01-11 14:50:10 +01002083 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002084
Gilles Peskine449bd832023-01-11 14:50:10 +01002085 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2086 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002087
Jerry Yud9436a12022-04-20 22:28:09 +08002088 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002091
Jerry Yu7de2ff02022-11-08 21:43:46 +08002092 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002093 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002094 MBEDTLS_SSL_HS_SERVER_HELLO,
2095 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002098}
2099
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002100MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002101static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002102{
2103 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002104 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2105 if (ret != 0) {
2106 MBEDTLS_SSL_DEBUG_RET(1,
2107 "mbedtls_ssl_tls13_compute_handshake_transform",
2108 ret);
2109 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002110 }
2111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002113}
2114
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002115MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002116static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002117{
Jerry Yu637a3f12022-04-20 21:37:58 +08002118 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002119 unsigned char *buf;
2120 size_t buf_len, msg_len;
2121
Gilles Peskine449bd832023-01-11 14:50:10 +01002122 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002125
Gilles Peskine449bd832023-01-11 14:50:10 +01002126 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2127 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2128 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2131 buf + buf_len,
2132 &msg_len,
2133 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002134
Jerry Yu3bf2c642022-03-30 22:02:12 +08002135 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002136 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002137
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2139 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002140
Gilles Peskine449bd832023-01-11 14:50:10 +01002141 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002142
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002143#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2144 /* The server sends a dummy change_cipher_spec record immediately
2145 * after its first handshake message. This may either be after
2146 * a ServerHello or a HelloRetryRequest.
2147 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002148 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002150#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002152#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002153
Jerry Yuf4b27e42022-03-30 17:32:21 +08002154cleanup:
2155
Gilles Peskine449bd832023-01-11 14:50:10 +01002156 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2157 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002158}
2159
Jerry Yu23d1a252022-05-12 18:08:59 +08002160
2161/*
2162 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2163 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002164MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002165static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002166{
2167 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 if (ssl->handshake->hello_retry_request_count > 0) {
2169 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2170 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2171 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2172 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002173 }
2174
2175 /*
2176 * Create stateless transcript hash for HRR
2177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2179 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2180 if (ret != 0) {
2181 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2182 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002183 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002184 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002185
Gilles Peskine449bd832023-01-11 14:50:10 +01002186 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002187}
2188
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002189MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002190static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002191{
2192 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2193 unsigned char *buf;
2194 size_t buf_len, msg_len;
2195
Gilles Peskine449bd832023-01-11 14:50:10 +01002196 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002197
Gilles Peskine449bd832023-01-11 14:50:10 +01002198 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002199
Gilles Peskine449bd832023-01-11 14:50:10 +01002200 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2201 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2202 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002203
Gilles Peskine449bd832023-01-11 14:50:10 +01002204 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2205 buf + buf_len,
2206 &msg_len,
2207 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002208 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002210
2211
Gilles Peskine449bd832023-01-11 14:50:10 +01002212 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2213 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002214
2215 ssl->handshake->hello_retry_request_count++;
2216
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002217#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2218 /* The server sends a dummy change_cipher_spec record immediately
2219 * after its first handshake message. This may either be after
2220 * a ServerHello or a HelloRetryRequest.
2221 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002222 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002224#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002226#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002227
2228cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002229 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2230 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002231}
2232
Jerry Yu5b64ae92022-03-30 17:15:02 +08002233/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002234 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2235 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002236
2237/*
2238 * struct {
2239 * Extension extensions<0..2 ^ 16 - 1>;
2240 * } EncryptedExtensions;
2241 *
2242 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002243MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002244static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2245 unsigned char *buf,
2246 unsigned char *end,
2247 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002248{
XiaokangQianacb39922022-06-17 10:18:48 +00002249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002250 unsigned char *p = buf;
2251 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002252 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002253 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002254
Jerry Yu4d3841a2022-04-16 12:37:19 +08002255 *out_len = 0;
2256
Gilles Peskine449bd832023-01-11 14:50:10 +01002257 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002258 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002259 p += 2;
2260
Jerry Yu8937eb42022-05-03 12:12:14 +08002261 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002262 ((void) ret);
2263 ((void) output_len);
2264
2265#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002266 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2267 if (ret != 0) {
2268 return ret;
2269 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002270 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002271#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002272
Gilles Peskine449bd832023-01-11 14:50:10 +01002273 extensions_len = (p - p_extensions_len) - 2;
2274 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002275
2276 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002277
Gilles Peskine449bd832023-01-11 14:50:10 +01002278 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002279
Jerry Yu7de2ff02022-11-08 21:43:46 +08002280 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002282
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002284}
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_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002288{
2289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2290 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002291 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002292
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 mbedtls_ssl_set_outbound_transform(ssl,
2294 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002295 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002297
Gilles Peskine449bd832023-01-11 14:50:10 +01002298 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2301 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2302 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002303
Gilles Peskine449bd832023-01-11 14:50:10 +01002304 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2305 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002306
2307 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2311 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002312
Ronald Cron928cbd32022-10-04 16:14:26 +02002313#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002314 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2315 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2316 } else {
2317 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2318 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002319#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002321#endif
2322
Jerry Yu4d3841a2022-04-16 12:37:19 +08002323cleanup:
2324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2326 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002327}
2328
Ronald Cron928cbd32022-10-04 16:14:26 +02002329#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002330#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2331#define SSL_CERTIFICATE_REQUEST_SKIP 1
2332/* Coordination:
2333 * Check whether a CertificateRequest message should be written.
2334 * Returns a negative code on failure, or
2335 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2336 * - SSL_CERTIFICATE_REQUEST_SKIP
2337 * indicating if the writing of the CertificateRequest
2338 * should be skipped or not.
2339 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002340MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002341static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002342{
2343 int authmode;
2344
XiaokangQian40a35232022-05-07 09:02:40 +00002345#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002347 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002349#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002350 authmode = ssl->conf->authmode;
2351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002353 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002355 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002356
XiaokangQianc3017f62022-05-13 05:55:41 +00002357 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002358
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002360}
2361
XiaokangQiancec9ae62022-05-06 07:28:50 +00002362/*
2363 * struct {
2364 * opaque certificate_request_context<0..2^8-1>;
2365 * Extension extensions<2..2^16-1>;
2366 * } CertificateRequest;
2367 *
2368 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002369MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002370static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2371 unsigned char *buf,
2372 const unsigned char *end,
2373 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002374{
2375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2376 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002377 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002378 unsigned char *p_extensions_len;
2379
2380 *out_len = 0;
2381
2382 /* Check if we have enough space:
2383 * - certificate_request_context (1 byte)
2384 * - extensions length (2 bytes)
2385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002387
2388 /*
2389 * Write certificate_request_context
2390 */
2391 /*
2392 * We use a zero length context for the normal handshake
2393 * messages. For post-authentication handshake messages
2394 * this request context would be set to a non-zero value.
2395 */
2396 *p++ = 0x0;
2397
2398 /*
2399 * Write extensions
2400 */
2401 /* The extensions must contain the signature_algorithms. */
2402 p_extensions_len = p;
2403 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2405 if (ret != 0) {
2406 return ret;
2407 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002408
XiaokangQianec6efb92022-05-06 09:53:10 +00002409 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002411
2412 *out_len = p - buf;
2413
Jerry Yu7de2ff02022-11-08 21:43:46 +08002414 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002415 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002416
Gilles Peskine449bd832023-01-11 14:50:10 +01002417 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002418}
2419
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002420MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002421static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002422{
2423 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2424
Gilles Peskine449bd832023-01-11 14:50:10 +01002425 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002428
Gilles Peskine449bd832023-01-11 14:50:10 +01002429 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002430 unsigned char *buf;
2431 size_t buf_len, msg_len;
2432
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2434 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2435 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2438 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002439
2440 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002441 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002442
Gilles Peskine449bd832023-01-11 14:50:10 +01002443 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2444 ssl, buf_len, msg_len));
2445 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2446 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002447 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002448 } else {
2449 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002450 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2451 goto cleanup;
2452 }
2453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002455cleanup:
2456
Gilles Peskine449bd832023-01-11 14:50:10 +01002457 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2458 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002459}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002460
Jerry Yu4d3841a2022-04-16 12:37:19 +08002461/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002462 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002463 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002465static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002466{
Jerry Yu5a26f302022-05-10 20:46:40 +08002467 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002468
2469#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2471 mbedtls_ssl_own_cert(ssl) == NULL) {
2472 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2473 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2474 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2475 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002476 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002477#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002478
Gilles Peskine449bd832023-01-11 14:50:10 +01002479 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2480 if (ret != 0) {
2481 return ret;
2482 }
2483 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2484 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002485}
2486
2487/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002488 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002489 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002490MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002491static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002492{
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2494 if (ret != 0) {
2495 return ret;
2496 }
2497 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2498 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002499}
Ronald Cron928cbd32022-10-04 16:14:26 +02002500#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002501
2502/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002503 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002504 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002505MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002506static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002507{
Jerry Yud6e253d2022-05-18 13:59:24 +08002508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002509
Gilles Peskine449bd832023-01-11 14:50:10 +01002510 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2511 if (ret != 0) {
2512 return ret;
2513 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002514
Gilles Peskine449bd832023-01-11 14:50:10 +01002515 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2516 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002517 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2519 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2520 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002521 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002522
Gilles Peskine449bd832023-01-11 14:50:10 +01002523 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2524 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002525
Gilles Peskine449bd832023-01-11 14:50:10 +01002526 if (ssl->handshake->certificate_request_sent) {
2527 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2528 } else {
2529 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2530 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2531 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002532 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002533
Gilles Peskine449bd832023-01-11 14:50:10 +01002534 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002535}
2536
2537/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002538 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002539 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002540MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002541static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002542{
Jerry Yud6e253d2022-05-18 13:59:24 +08002543 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2544
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2546 if (ret != 0) {
2547 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002548 }
2549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2551 if (ret != 0) {
2552 MBEDTLS_SSL_DEBUG_RET(1,
2553 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2554 }
2555
2556 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2557 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002558}
2559
2560/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002561 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002563MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002564static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002565{
Gilles Peskine449bd832023-01-11 14:50:10 +01002566 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002567
Gilles Peskine449bd832023-01-11 14:50:10 +01002568 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002569
2570#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002571 /* Sent NewSessionTicket message only when client supports PSK */
2572 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2573 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
2574 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002575#endif
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002576 {
2577 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2578 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002579 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002580}
2581
2582/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002583 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002584 */
2585#define SSL_NEW_SESSION_TICKET_SKIP 0
2586#define SSL_NEW_SESSION_TICKET_WRITE 1
2587MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002588static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002589{
2590 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002591 if (ssl->conf->f_ticket_write == NULL) {
2592 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2593 " callback is not set"));
2594 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002595 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002596 if (ssl->conf->new_session_tickets_count == 0) {
2597 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2598 " configured count is zero"));
2599 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002600 }
2601
Gilles Peskine449bd832023-01-11 14:50:10 +01002602 if (ssl->handshake->new_session_tickets_count == 0) {
2603 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2604 "been sent."));
2605 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002606 }
2607
Gilles Peskine449bd832023-01-11 14:50:10 +01002608 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002609}
2610
2611#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2612MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002613static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2614 unsigned char *ticket_nonce,
2615 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002616{
2617 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2618 mbedtls_ssl_session *session = ssl->session;
2619 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2620 psa_algorithm_t psa_hash_alg;
2621 int hash_length;
2622
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002624
2625#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002627#endif
2628
Pengyu Lv9f926952022-11-17 15:22:33 +08002629 /* Set ticket_flags depends on the advertised psk key exchange mode */
2630 mbedtls_ssl_tls13_session_clear_ticket_flags(session,
2631 MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
2632 mbedtls_ssl_tls13_session_set_ticket_flags(session,
2633 ssl->handshake->tls13_kex_modes);
2634 MBEDTLS_SSL_DEBUG_TICKET_FLAGS(4, session->ticket_flags);
2635
Jerry Yue67bef42022-07-07 07:29:42 +00002636 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002637 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2638 (unsigned char *) &session->ticket_age_add,
2639 sizeof(session->ticket_age_add)) != 0)) {
2640 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2641 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002642 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002643 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2644 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002645
2646 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002647 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2648 if (ret != 0) {
2649 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2650 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002651 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2653 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002654
2655 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2657 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2658 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2659 if (hash_length == -1 ||
2660 (size_t) hash_length > sizeof(session->resumption_key)) {
2661 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002662 }
2663
Jerry Yue67bef42022-07-07 07:29:42 +00002664 /* In this code the psk key length equals the length of the hash */
2665 session->resumption_key_len = hash_length;
2666 session->ciphersuite = ciphersuite_info->id;
2667
2668 /* Compute resumption key
2669 *
2670 * HKDF-Expand-Label( resumption_master_secret,
2671 * "resumption", ticket_nonce, Hash.length )
2672 */
2673 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 psa_hash_alg,
2675 session->app_secrets.resumption_master_secret,
2676 hash_length,
2677 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2678 ticket_nonce,
2679 ticket_nonce_size,
2680 session->resumption_key,
2681 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002682
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 if (ret != 0) {
2684 MBEDTLS_SSL_DEBUG_RET(2,
2685 "Creating the ticket-resumed PSK failed",
2686 ret);
2687 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002688 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002689 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2690 session->resumption_key,
2691 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002692
Gilles Peskine449bd832023-01-11 14:50:10 +01002693 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2694 session->app_secrets.resumption_master_secret,
2695 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002696
Gilles Peskine449bd832023-01-11 14:50:10 +01002697 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002698}
2699
2700/* This function creates a NewSessionTicket message in the following format:
2701 *
2702 * struct {
2703 * uint32 ticket_lifetime;
2704 * uint32 ticket_age_add;
2705 * opaque ticket_nonce<0..255>;
2706 * opaque ticket<1..2^16-1>;
2707 * Extension extensions<0..2^16-2>;
2708 * } NewSessionTicket;
2709 *
2710 * The ticket inside the NewSessionTicket message is an encrypted container
2711 * carrying the necessary information so that the server is later able to
2712 * re-start the communication.
2713 *
2714 * The following fields are placed inside the ticket by the
2715 * f_ticket_write() function:
2716 *
2717 * - creation time (start)
2718 * - flags (flags)
2719 * - age add (ticket_age_add)
2720 * - key (key)
2721 * - key length (key_len)
2722 * - ciphersuite (ciphersuite)
2723 */
2724MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002725static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2726 unsigned char *buf,
2727 unsigned char *end,
2728 size_t *out_len,
2729 unsigned char *ticket_nonce,
2730 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002731{
2732 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2733 unsigned char *p = buf;
2734 mbedtls_ssl_session *session = ssl->session;
2735 size_t ticket_len;
2736 uint32_t ticket_lifetime;
2737
2738 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002739 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002740
2741 /*
2742 * ticket_lifetime 4 bytes
2743 * ticket_age_add 4 bytes
2744 * ticket_nonce 1 + ticket_nonce_size bytes
2745 * ticket >=2 bytes
2746 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002747 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002748
2749 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2751 session,
2752 p + 9 + ticket_nonce_size + 2,
2753 end,
2754 &ticket_len,
2755 &ticket_lifetime);
2756 if (ret != 0) {
2757 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2758 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002759 }
2760 /* RFC 8446 4.6.1
2761 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2762 * unsigned integer in network byte order from the time of ticket
2763 * issuance. Servers MUST NOT use any value greater than
2764 * 604800 seconds (7 days). The value of zero indicates that the
2765 * ticket should be discarded immediately. Clients MUST NOT cache
2766 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2767 * and MAY delete tickets earlier based on local policy. A server
2768 * MAY treat a ticket as valid for a shorter period of time than what
2769 * is stated in the ticket_lifetime.
2770 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002771 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002772 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 }
2774 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2775 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2776 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002777
2778 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002779 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2780 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2781 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002782
2783 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 p[8] = (unsigned char) ticket_nonce_size;
2785 if (ticket_nonce_size > 0) {
2786 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002787 }
2788 p += 9 + ticket_nonce_size;
2789
2790 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002791 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002792 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002794 p += ticket_len;
2795
2796 /* Ticket Extensions
2797 *
2798 * Note: We currently don't have any extensions.
2799 * Set length to zero.
2800 */
Jerry Yuedab6372022-10-31 14:37:31 +08002801 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2802
Gilles Peskine449bd832023-01-11 14:50:10 +01002803 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2804 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002805 p += 2;
2806
2807 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002808 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2809 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002810
Jerry Yu7de2ff02022-11-08 21:43:46 +08002811 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002813
Gilles Peskine449bd832023-01-11 14:50:10 +01002814 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002815}
2816
2817/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002818 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002819 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002820static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002821{
2822 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2823
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002825
Gilles Peskine449bd832023-01-11 14:50:10 +01002826 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002827 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2828 unsigned char *buf;
2829 size_t buf_len, msg_len;
2830
Gilles Peskine449bd832023-01-11 14:50:10 +01002831 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2832 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2835 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2836 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002837
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2839 ssl, buf, buf + buf_len, &msg_len,
2840 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002841
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2843 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002844
Jerry Yu359e65f2022-09-22 23:47:43 +08002845 /* Limit session tickets count to one when resumption connection.
2846 *
2847 * See document of mbedtls_ssl_conf_new_session_tickets.
2848 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002850 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002852 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002854
Jerry Yua8d3c502022-10-30 14:51:23 +08002855 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2857 } else {
2858 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002859 }
2860
Jerry Yue67bef42022-07-07 07:29:42 +00002861cleanup:
2862
Gilles Peskine449bd832023-01-11 14:50:10 +01002863 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002864}
2865#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2866
2867/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002868 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002869 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002870int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002871{
XiaokangQian08037552022-04-20 07:16:41 +00002872 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002873
Gilles Peskine449bd832023-01-11 14:50:10 +01002874 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2875 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2876 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002877
Gilles Peskine449bd832023-01-11 14:50:10 +01002878 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2879 mbedtls_ssl_states_str(ssl->state),
2880 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002881
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002883 /* start state */
2884 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002886 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002887 break;
2888
XiaokangQian7807f9f2022-02-15 10:04:37 +00002889 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 ret = ssl_tls13_process_client_hello(ssl);
2891 if (ret != 0) {
2892 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2893 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002894 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002895
Jerry Yuf41553b2022-05-09 22:20:30 +08002896 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 ret = ssl_tls13_write_hello_retry_request(ssl);
2898 if (ret != 0) {
2899 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2900 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002901 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002902 break;
2903
Jerry Yu5b64ae92022-03-30 17:15:02 +08002904 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002905 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002906 break;
2907
Xiaofei Baicba64af2022-02-15 10:00:56 +00002908 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002909 ret = ssl_tls13_write_encrypted_extensions(ssl);
2910 if (ret != 0) {
2911 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2912 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002913 }
Jerry Yu48330562022-05-06 21:35:44 +08002914 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002915
Ronald Cron928cbd32022-10-04 16:14:26 +02002916#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002917 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002919 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002920
Jerry Yu83da34e2022-04-16 13:59:52 +08002921 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002922 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002923 break;
2924
2925 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002926 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002927 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002928#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002929
Gilles Peskine449bd832023-01-11 14:50:10 +01002930 /*
2931 * Injection of dummy-CCS's for middlebox compatibility
2932 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002933#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002934 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2936 if (ret == 0) {
2937 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2938 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002939 break;
2940
2941 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002942 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2943 if (ret == 0) {
2944 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2945 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002946 break;
2947#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2948
Jerry Yu69dd8d42022-04-16 12:51:26 +08002949 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002950 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002951 break;
2952
2953 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002954 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002955 break;
2956
Jerry Yu69dd8d42022-04-16 12:51:26 +08002957 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002958 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002959 break;
2960
Ronald Cron766c0cd2022-10-18 12:17:11 +02002961#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00002962 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2964 if (ret == 0) {
2965 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02002966 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2968 } else {
2969 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02002970 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002971 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002972 }
XiaokangQian6b916b12022-04-25 07:29:34 +00002973 }
2974 break;
2975
2976 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2978 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00002979 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00002981 }
2982 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02002983#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00002984
Jerry Yue67bef42022-07-07 07:29:42 +00002985#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08002986 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01002987 ret = ssl_tls13_write_new_session_ticket(ssl);
2988 if (ret != 0) {
2989 MBEDTLS_SSL_DEBUG_RET(1,
2990 "ssl_tls13_write_new_session_ticket ",
2991 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00002992 }
2993 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08002994 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00002995 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08002996 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002997 * as part of ssl_prepare_handshake_step.
2998 */
2999 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003000
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (ssl->handshake->new_session_tickets_count == 0) {
3002 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3003 } else {
3004 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3005 }
Jerry Yue67bef42022-07-07 07:29:42 +00003006 break;
3007
3008#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3009
XiaokangQian7807f9f2022-02-15 10:04:37 +00003010 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3012 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003013 }
3014
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003016}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003017
Jerry Yufb4b6472022-01-27 15:03:26 +08003018#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */