blob: f8239330332224f81e2727136370d74b39c26d25 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800164 /* RFC 8446 section 4.2.9
165 *
166 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
167 * compatible with the advertised modes; however, if a server does so,
168 * the impact will just be that the client's attempts at resumption fail.
169 *
170 * We regard the ticket with incompatible key exchange modes as not match.
171 */
Pengyu Lv76679682023-02-02 15:04:27 +0800172 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
173 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
174 session->ticket_flags);
175 if (mbedtls_ssl_tls13_check_kex_modes(
176 ssl,
177 mbedtls_ssl_session_get_ticket_flags(
178 session,
179 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800180 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
181 goto exit;
182 }
183
Gilles Peskine449bd832023-01-11 14:50:10 +0100184 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
185#if defined(MBEDTLS_HAVE_TIME)
186 now = mbedtls_time(NULL);
187
188 if (now < session->start) {
189 MBEDTLS_SSL_DEBUG_MSG(
190 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
191 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
192 (long long) now, (long long) session->start));
193 goto exit;
194 }
195
196 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800197
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800198 /* RFC 8446 section 4.6.1
199 *
200 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
201 *
202 * RFC 8446 section 4.2.11.1
203 *
204 * Clients MUST NOT attempt to use tickets which have ages greater than
205 * the "ticket_lifetime" value which was provided with the ticket.
206 *
207 * For time being, the age MUST be less than 604800 seconds (7 days).
208 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100209 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 3, ("Ticket age exceeds limitation ticket_age=%lu",
212 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800213 goto exit;
214 }
Jerry Yu95699e72022-08-21 19:22:23 +0800215
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800216 /* RFC 8446 section 4.2.10
217 *
218 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
219 * the ticket age for the selected PSK identity (computed by subtracting
220 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
221 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800223 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
224 * as the age units are different on the server (s) and in the
225 * client (ms) side. Add a -1000 ms tolerance window to take this
226 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800227 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800228 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100229 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
230 if (age_diff_in_ms <= -1000 ||
231 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800232 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100233 3, ("Ticket age outside tolerance window ( diff=%d )",
234 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800235 goto exit;
236 }
237
238 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800239
240#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800241
242exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100243 if (ret != 0) {
244 mbedtls_ssl_session_free(session);
245 }
Jerry Yu95699e72022-08-21 19:22:23 +0800246
Gilles Peskine449bd832023-01-11 14:50:10 +0100247 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
248 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800249}
250#endif /* MBEDTLS_SSL_SESSION_TICKETS */
251
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800252MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000253static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 mbedtls_ssl_context *ssl,
255 const unsigned char *identity,
256 size_t identity_len,
257 uint32_t obfuscated_ticket_age,
258 int *psk_type,
259 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000260{
Jerry Yu95699e72022-08-21 19:22:23 +0800261 ((void) session);
262 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800263 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800264
Gilles Peskine449bd832023-01-11 14:50:10 +0100265 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800266 ssl->handshake->resume = 0;
267
Jerry Yu95699e72022-08-21 19:22:23 +0800268#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800270 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800272 ssl->handshake->resume = 1;
273 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 mbedtls_ssl_set_hs_psk(ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800275 session->resumption_key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100276 session->resumption_key_len);
277
278 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
279 session->resumption_key,
280 session->resumption_key_len);
281 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
282 (unsigned) obfuscated_ticket_age));
283 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800284 }
285#endif /* MBEDTLS_SSL_SESSION_TICKETS */
286
Jerry Yu1c105562022-07-10 06:32:38 +0000287 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100288 if (ssl->conf->f_psk != NULL) {
289 if (ssl->conf->f_psk(
290 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
291 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000292 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000294 }
295
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000297 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100298 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800299 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100300 mbedtls_ct_memcmp(ssl->conf->psk_identity,
301 identity, identity_len) == 0) {
302 mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
303 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000304 }
305
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000307}
308
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800309MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100310static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
311 const unsigned char *binder,
312 size_t binder_len,
313 int psk_type,
314 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000315{
316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800317
Jerry Yudaf375a2022-07-20 21:31:43 +0800318 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000319 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800320 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800321 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800322 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000323
Jerry Yu1c105562022-07-10 06:32:38 +0000324 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800325 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100326 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
327 transcript, sizeof(transcript), &transcript_len);
328 if (ret != 0) {
329 return ret;
330 }
Jerry Yu1c105562022-07-10 06:32:38 +0000331
Gilles Peskine449bd832023-01-11 14:50:10 +0100332 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
333 if (ret != 0) {
334 return ret;
335 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800336
Gilles Peskine449bd832023-01-11 14:50:10 +0100337 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
338 psk, psk_len, psk_type,
339 transcript,
340 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800341#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100342 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800343#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 if (ret != 0) {
345 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
346 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000347 }
348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
350 server_computed_binder, transcript_len);
351 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
354 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000355 }
356
Gilles Peskine449bd832023-01-11 14:50:10 +0100357 mbedtls_platform_zeroize(server_computed_binder,
358 sizeof(server_computed_binder));
359 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000360}
Jerry Yu96a2e362022-07-21 15:11:34 +0800361
Jerry Yu5725f1c2022-08-21 17:27:16 +0800362MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800363static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 mbedtls_ssl_context *ssl,
365 const unsigned char *cipher_suites,
366 const unsigned char *cipher_suites_end,
367 uint16_t *selected_ciphersuite,
368 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800369{
Jerry Yuf35ba382022-08-23 17:58:26 +0800370 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800371
Jerry Yu0baf9072022-08-25 11:21:04 +0800372 *selected_ciphersuite = 0;
373 *selected_ciphersuite_info = NULL;
374
Jerry Yuf35ba382022-08-23 17:58:26 +0800375 /* RFC 8446, page 55.
376 *
377 * For externally established PSKs, the Hash algorithm MUST be set when the
378 * PSK is established or default to SHA-256 if no such algorithm is defined.
379 *
380 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800381
Jerry Yu5725f1c2022-08-21 17:27:16 +0800382 /*
383 * Search for a matching ciphersuite
384 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100385 for (const unsigned char *p = cipher_suites;
386 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800387 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800388 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800389
Gilles Peskine449bd832023-01-11 14:50:10 +0100390 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
391 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
392 cipher_suite);
393 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800394 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100395 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800396
Jerry Yu5725f1c2022-08-21 17:27:16 +0800397 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
398 * Otherwise, client should reject.
399 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800401 *selected_ciphersuite = cipher_suite;
402 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800404 }
405 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
407 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800408}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800409
Jerry Yu82534862022-08-30 10:42:33 +0800410#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800411MBEDTLS_CHECK_RETURN_CRITICAL
412static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100413 mbedtls_ssl_context *ssl,
414 const unsigned char *cipher_suites,
415 const unsigned char *cipher_suites_end,
416 mbedtls_ssl_session *session,
417 uint16_t *selected_ciphersuite,
418 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800419{
Jerry Yu82534862022-08-30 10:42:33 +0800420
Jerry Yuf35ba382022-08-23 17:58:26 +0800421 *selected_ciphersuite = 0;
422 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
424 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800425 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
426
Gilles Peskine449bd832023-01-11 14:50:10 +0100427 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800428 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100429 }
Jerry Yu82534862022-08-30 10:42:33 +0800430
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
432 cipher_suite);
433 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800434 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 }
Jerry Yu82534862022-08-30 10:42:33 +0800436
Jerry Yu4746b102022-09-13 11:11:48 +0800437 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800438 *selected_ciphersuite_info = ciphersuite_info;
439
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800441 }
442
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800444}
Jerry Yuf35ba382022-08-23 17:58:26 +0800445
Jerry Yu82534862022-08-30 10:42:33 +0800446MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100447static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
448 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800449{
Jerry Yu82534862022-08-30 10:42:33 +0800450 dst->ticket_age_add = src->ticket_age_add;
451 dst->ticket_flags = src->ticket_flags;
452 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 if (src->resumption_key_len == 0) {
454 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
455 }
456 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800459}
460#endif /* MBEDTLS_SSL_SESSION_TICKETS */
461
Jerry Yu1c105562022-07-10 06:32:38 +0000462/* Parser for pre_shared_key extension in client hello
463 * struct {
464 * opaque identity<1..2^16-1>;
465 * uint32 obfuscated_ticket_age;
466 * } PskIdentity;
467 *
468 * opaque PskBinderEntry<32..255>;
469 *
470 * struct {
471 * PskIdentity identities<7..2^16-1>;
472 * PskBinderEntry binders<33..2^16-1>;
473 * } OfferedPsks;
474 *
475 * struct {
476 * select (Handshake.msg_type) {
477 * case client_hello: OfferedPsks;
478 * ....
479 * };
480 * } PreSharedKeyExtension;
481 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800482MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100483static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
484 const unsigned char *pre_shared_key_ext,
485 const unsigned char *pre_shared_key_ext_end,
486 const unsigned char *ciphersuites,
487 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000488{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800489 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800490 const unsigned char *p_identity_len;
491 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000492 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800493 const unsigned char *binders;
494 const unsigned char *p_binder_len;
495 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000496 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800497 int matched_identity = -1;
498 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000499
Gilles Peskine449bd832023-01-11 14:50:10 +0100500 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
501 pre_shared_key_ext,
502 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000503
Jerry Yu96a2e362022-07-21 15:11:34 +0800504 /* identities_len 2 bytes
505 * identities_data >= 7 bytes
506 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
508 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800509 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100510 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
511 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800512 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000513
Jerry Yu96a2e362022-07-21 15:11:34 +0800514 /* binders_len 2 bytes
515 * binders >= 33 bytes
516 */
Jerry Yu568ec252022-07-22 21:27:34 +0800517 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
519 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800520 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800522 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
525 identities_end - pre_shared_key_ext);
Jerry Yu96a2e362022-07-21 15:11:34 +0800526
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000528 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800529 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800530 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800531 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800532 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800533 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800534 int psk_type;
535 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800536 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800537#if defined(MBEDTLS_SSL_SESSION_TICKETS)
538 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800540#endif
Jerry Yubb852022022-07-20 21:10:44 +0800541
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
543 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800544 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
546 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800547 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000548
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800550 binder_len = *p_binder_len;
551 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100552 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800553 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800554
Jerry Yu96a2e362022-07-21 15:11:34 +0800555 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000557 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 }
Jerry Yu1c105562022-07-10 06:32:38 +0000559
Jerry Yu96a2e362022-07-21 15:11:34 +0800560 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 ssl, identity, identity_len, obfuscated_ticket_age,
562 &psk_type, &session);
563 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800564 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800566
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
568 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800569 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
570 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 ssl, ciphersuites, ciphersuites_end,
572 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800573 break;
574 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800575#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800576 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100577 ssl, ciphersuites, ciphersuites_end, &session,
578 &cipher_suite, &ciphersuite_info);
579 if (ret != 0) {
580 mbedtls_ssl_session_free(&session);
581 }
Jerry Yu82534862022-08-30 10:42:33 +0800582#else
583 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
584#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800585 break;
586 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800588 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800590 /* See below, no cipher_suite available, abort handshake */
591 MBEDTLS_SSL_PEND_FATAL_ALERT(
592 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800594 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100595 2, "ssl_tls13_select_ciphersuite", ret);
596 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800597 }
598
Jerry Yu96a2e362022-07-21 15:11:34 +0800599 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 ssl, binder, binder_len, psk_type,
601 mbedtls_psa_translate_md(ciphersuite_info->mac));
602 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800603 /* For security reasons, the handshake should be aborted when we
604 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
605 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800606#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100607 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800608#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
610 MBEDTLS_SSL_DEBUG_RET(1,
611 "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800612 MBEDTLS_SSL_PEND_FATAL_ALERT(
613 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100614 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
615 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800616 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800617
618 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800619
620 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800621 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800622 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
624 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800625#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
627 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
628 &session);
629 mbedtls_ssl_session_free(&session);
630 if (ret != 0) {
631 return ret;
632 }
Jerry Yu82534862022-08-30 10:42:33 +0800633 }
634#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000635 }
636
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 if (p_identity_len != identities_end || p_binder_len != binders_end) {
638 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
639 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
640 MBEDTLS_ERR_SSL_DECODE_ERROR);
641 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000642 }
643
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800644 /* Update the handshake transcript with the binder list. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 ssl->handshake->update_checksum(ssl,
646 identities_end,
647 (size_t) (binders_end - identities_end));
648 if (matched_identity == -1) {
649 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
650 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000651 }
652
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 ssl->handshake->selected_identity = (uint16_t) matched_identity;
654 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000655
Gilles Peskine449bd832023-01-11 14:50:10 +0100656 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000657}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000658
659/*
660 * struct {
661 * select ( Handshake.msg_type ) {
662 * ....
663 * case server_hello:
664 * uint16 selected_identity;
665 * }
666 * } PreSharedKeyExtension;
667 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100668static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
669 unsigned char *buf,
670 unsigned char *end,
671 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672{
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000674
675 *olen = 0;
676
David Horstmann21b89762022-10-06 18:34:28 +0100677 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000680#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000682#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684 /* We shouldn't have called this extension writer unless we've
685 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000687 }
688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
690 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
693 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694
Gilles Peskine449bd832023-01-11 14:50:10 +0100695 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000696
697 *olen = 6;
698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
700 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000701
Gilles Peskine449bd832023-01-11 14:50:10 +0100702 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800703
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705}
706
Ronald Cron41a443a2022-10-04 16:38:25 +0200707#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000708
XiaokangQian7807f9f2022-02-15 10:04:37 +0000709/* From RFC 8446:
710 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000711 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000712 * } SupportedVersions;
713 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200714MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100715static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
716 const unsigned char *buf,
717 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000719 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000720 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000721 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000722 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000723 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000726 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000727 p += 1;
728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000730 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100731 while (p < versions_end) {
732 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
733 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000734 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735
736 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100737 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 tls13_supported = 1;
739 break;
740 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000741 }
742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 if (!tls13_supported) {
744 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745
Gilles Peskine449bd832023-01-11 14:50:10 +0100746 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
747 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
748 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000749 }
750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
752 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000755}
756
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000757#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000758/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000759 *
760 * From RFC 8446:
761 * enum {
762 * ... (0xFFFF)
763 * } NamedGroup;
764 * struct {
765 * NamedGroup named_group_list<2..2^16-1>;
766 * } NamedGroupList;
767 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200768MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100769static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
770 const unsigned char *buf,
771 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000774 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000775 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
778 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
779 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100781 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000782 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000783 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784
Gilles Peskine449bd832023-01-11 14:50:10 +0100785 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000786 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100787 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
788 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000789 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790
Gilles Peskine449bd832023-01-11 14:50:10 +0100791 MBEDTLS_SSL_DEBUG_MSG(2,
792 ("got named group: %s(%04x)",
793 mbedtls_ssl_named_group_to_str(named_group),
794 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000795
Gilles Peskine449bd832023-01-11 14:50:10 +0100796 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
797 !mbedtls_ssl_named_group_is_supported(named_group) ||
798 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000799 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000800 }
801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 MBEDTLS_SSL_DEBUG_MSG(2,
803 ("add named group %s(%04x) into received list.",
804 mbedtls_ssl_named_group_to_str(named_group),
805 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800806
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000807 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808 }
809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000811
812}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000813#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814
XiaokangQian08037552022-04-20 07:16:41 +0000815#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
816
XiaokangQian88408882022-04-02 10:15:03 +0000817#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818/*
819 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000820 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000821 *
822 * Possible return values are:
823 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000824 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825 * does not match a group supported by the server. A HelloRetryRequest will
826 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000827 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800828 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100830static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
831 const unsigned char *buf,
832 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000833{
XiaokangQianb67384d2022-04-19 00:02:38 +0000834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000835 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000836 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800837 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000838
839 /* From RFC 8446:
840 *
841 * struct {
842 * KeyShareEntry client_shares<0..2^16-1>;
843 * } KeyShareClientHello;
844 *
845 */
846
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
848 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100850 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000851
852 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000853 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000854
855 /* We try to find a suitable key share entry and copy it to the
856 * handshake context. Later, we have to find out whether we can do
857 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000858 * dismiss it and send a HelloRetryRequest message.
859 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000860
Gilles Peskine449bd832023-01-11 14:50:10 +0100861 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000862 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800863 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800864 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000865
866 /*
867 * struct {
868 * NamedGroup group;
869 * opaque key_exchange<1..2^16-1>;
870 * } KeyShareEntry;
871 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100872 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
873 group = MBEDTLS_GET_UINT16_BE(p, 0);
874 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800875 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800876 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100877 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800878 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000879
880 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000881 * for input validation purposes.
882 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100883 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
884 !mbedtls_ssl_named_group_is_supported(group) ||
885 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000886 continue;
887 }
XiaokangQian060d8672022-04-21 09:24:56 +0000888
XiaokangQian7807f9f2022-02-15 10:04:37 +0000889 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000890 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000891 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
893 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
894 mbedtls_ssl_named_group_to_str(group),
895 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000896 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100897 ssl, key_exchange - 2, key_exchange_len + 2);
898 if (ret != 0) {
899 return ret;
900 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000901
Gilles Peskine449bd832023-01-11 14:50:10 +0100902 } else {
903 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
904 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000905 continue;
906 }
907
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000908 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000909 }
910
Jerry Yuc1be19f2022-04-23 16:11:39 +0800911
Gilles Peskine449bd832023-01-11 14:50:10 +0100912 if (ssl->handshake->offered_group_id == 0) {
913 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
914 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100916 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917}
XiaokangQian88408882022-04-02 10:15:03 +0000918#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000919
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200920MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100921static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
922 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923{
Jerry Yu0c354a22022-08-29 15:25:36 +0800924 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100925 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000926}
927
Jerry Yue5991322022-11-07 14:03:44 +0800928#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200929MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000930static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100931 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932{
Gilles Peskine449bd832023-01-11 14:50:10 +0100933 return ssl_tls13_client_hello_has_exts(
934 ssl,
935 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
936 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
937 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000938}
Jerry Yue5991322022-11-07 14:03:44 +0800939#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940
Jerry Yue5991322022-11-07 14:03:44 +0800941#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000942MBEDTLS_CHECK_RETURN_CRITICAL
943static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000945{
Gilles Peskine449bd832023-01-11 14:50:10 +0100946 return ssl_tls13_client_hello_has_exts(
947 ssl,
948 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
949 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000950}
Jerry Yue5991322022-11-07 14:03:44 +0800951#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000952
Jerry Yue5991322022-11-07 14:03:44 +0800953#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000954MBEDTLS_CHECK_RETURN_CRITICAL
955static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100956 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000957{
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return ssl_tls13_client_hello_has_exts(
959 ssl,
960 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
961 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
962 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
963 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000964}
Jerry Yue5991322022-11-07 14:03:44 +0800965#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000966
Pengyu Lv306a01d2023-02-02 16:35:47 +0800967#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
968MBEDTLS_CHECK_RETURN_CRITICAL
969static int ssl_tls13_check_psk_mode_allowed_by_ticket(mbedtls_ssl_context *ssl,
970 unsigned int kex_mode)
971{
972#if defined(MBEDTLS_SSL_SESSION_TICKETS)
973 if (ssl->handshake->resume) {
974 if (!mbedtls_ssl_session_get_ticket_flags(
975 ssl->session_negotiate, kex_mode)) {
976 return 0;
977 }
978 }
979#else
980 ((void) ssl);
981 ((void) kex_mode);
982#endif
983 return 1;
984}
985#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
986
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200987MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100988static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000989{
Jerry Yue5991322022-11-07 14:03:44 +0800990#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Pengyu Lvdadeb202023-01-18 17:32:34 +0800991 return !ssl->handshake->resume &&
992 mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800994#else
995 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100996 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800997#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000998}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000999
Jerry Yu77f01482022-07-11 07:03:24 +00001000MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001001static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001002{
Jerry Yue5991322022-11-07 14:03:44 +08001003#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Pengyu Lv306a01d2023-02-02 16:35:47 +08001004 return ssl_tls13_check_psk_mode_allowed_by_ticket(
1005 ssl, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) &&
1006 mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1008 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001009#else
1010 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001011 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001012#endif
1013}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001014
Jerry Yu77f01482022-07-11 07:03:24 +00001015MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001016static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001017{
Jerry Yue5991322022-11-07 14:03:44 +08001018#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Pengyu Lv306a01d2023-02-02 16:35:47 +08001019 return ssl_tls13_check_psk_mode_allowed_by_ticket(
1020 ssl, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL) &&
1021 mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001022 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1023 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001024#else
1025 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001027#endif
1028}
1029
Gilles Peskine449bd832023-01-11 14:50:10 +01001030static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001031{
1032 /*
1033 * Determine the key exchange algorithm to use.
1034 * There are three types of key exchanges supported in TLS 1.3:
1035 * - (EC)DH with ECDSA,
1036 * - (EC)DH with PSK,
1037 * - plain PSK.
1038 *
1039 * The PSK-based key exchanges may additionally be used with 0-RTT.
1040 *
1041 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001042 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1043 * 2 ) Certificate Mode ( ephemeral )
1044 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001045 */
1046
1047 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1048
Gilles Peskine449bd832023-01-11 14:50:10 +01001049 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001050 ssl->handshake->key_exchange_mode =
1051 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1053 } else
1054 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001055 ssl->handshake->key_exchange_mode =
1056 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1058 } else
1059 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001060 ssl->handshake->key_exchange_mode =
1061 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1063 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001064 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 1,
1066 ("ClientHello message misses mandatory extensions."));
1067 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1068 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1069 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001070 }
1071
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001073
XiaokangQian7807f9f2022-02-15 10:04:37 +00001074}
1075
XiaokangQian81802f42022-06-10 13:25:22 +00001076#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001077 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001078
1079#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001080static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001081{
Gilles Peskine449bd832023-01-11 14:50:10 +01001082 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001083 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001084 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001085 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001086 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001087 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001088 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001089 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001097 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001099 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001101 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001103 }
1104}
1105#endif /* MBEDTLS_USE_PSA_CRYPTO */
1106
XiaokangQian23c5be62022-06-07 02:04:34 +00001107/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001108 * Pick best ( private key, certificate chain ) pair based on the signature
1109 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001110 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001111MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001112static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001113{
XiaokangQianfb665a82022-06-15 03:57:21 +00001114 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001115 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001116
1117#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001119 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001121#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001123
Gilles Peskine449bd832023-01-11 14:50:10 +01001124 if (key_cert_list == NULL) {
1125 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1126 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001127 }
1128
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1130 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001131 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001133
Gilles Peskine449bd832023-01-11 14:50:10 +01001134 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001135 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001136 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 for (key_cert = key_cert_list; key_cert != NULL;
1139 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001140#if defined(MBEDTLS_USE_PSA_CRYPTO)
1141 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1142#endif /* MBEDTLS_USE_PSA_CRYPTO */
1143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1145 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001146
1147 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 * This avoids sending the client a cert it'll reject based on
1149 * keyUsage or other extensions.
1150 */
1151 if (mbedtls_x509_crt_check_key_usage(
1152 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001153 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001154 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001155 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1156 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1157 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001158 continue;
1159 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001160
Gilles Peskine449bd832023-01-11 14:50:10 +01001161 MBEDTLS_SSL_DEBUG_MSG(3,
1162 ("ssl_tls13_pick_key_cert:"
1163 "check signature algorithm %s [%04x]",
1164 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1165 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001166#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001168#endif /* MBEDTLS_USE_PSA_CRYPTO */
1169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1171 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001172#if defined(MBEDTLS_USE_PSA_CRYPTO)
1173 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001174 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1175 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001176#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001178 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 MBEDTLS_SSL_DEBUG_MSG(3,
1180 ("ssl_tls13_pick_key_cert:"
1181 "selected signature algorithm"
1182 " %s [%04x]",
1183 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1184 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001185 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 3, "selected certificate (chain)",
1187 ssl->handshake->key_cert->cert);
1188 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001189 }
XiaokangQian81802f42022-06-10 13:25:22 +00001190 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001191 }
1192
Gilles Peskine449bd832023-01-11 14:50:10 +01001193 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1194 "no suitable certificate found"));
1195 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001196}
XiaokangQian81802f42022-06-10 13:25:22 +00001197#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001198 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001199
XiaokangQian4080a7f2022-04-11 09:55:18 +00001200/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001201 *
1202 * STATE HANDLING: ClientHello
1203 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001204 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001206 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001207 *
1208 * In this case, the server progresses to sending its ServerHello.
1209 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001210 * 2) The ClientHello was well-formed but didn't match the server's
1211 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001212 *
1213 * For example, the client might not have offered a key share which
1214 * the server supports, or the server might require a cookie.
1215 *
1216 * In this case, the server sends a HelloRetryRequest.
1217 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001218 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001219 *
1220 * In this case, we abort the handshake.
1221 *
1222 */
1223
1224/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001225 * Structure of this message:
1226 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001227 * uint16 ProtocolVersion;
1228 * opaque Random[32];
1229 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001230 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001231 * struct {
1232 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1233 * Random random;
1234 * opaque legacy_session_id<0..32>;
1235 * CipherSuite cipher_suites<2..2^16-2>;
1236 * opaque legacy_compression_methods<1..2^8-1>;
1237 * Extension extensions<8..2^16-1>;
1238 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001239 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001240
1241#define SSL_CLIENT_HELLO_OK 0
1242#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1243
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001244MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001245static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1246 const unsigned char *buf,
1247 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001248{
XiaokangQianb67384d2022-04-19 00:02:38 +00001249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1250 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001251 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001252 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001253 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001254 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001255 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001256 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001257 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258
Ronald Cron41a443a2022-10-04 16:38:25 +02001259#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001260 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001261 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001262 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001263#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001264
XiaokangQian7807f9f2022-02-15 10:04:37 +00001265 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001266 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001267 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001268 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001269 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001270 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001271 * .. . .. ciphersuite list length ( 2 bytes )
1272 * .. . .. ciphersuite list
1273 * .. . .. compression alg. list length ( 1 byte )
1274 * .. . .. compression alg. list
1275 * .. . .. extensions length ( 2 bytes, optional )
1276 * .. . .. extensions ( optional )
1277 */
1278
XiaokangQianb67384d2022-04-19 00:02:38 +00001279 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001280 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001281 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1282 * read at least up to session id length without worrying.
1283 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001284 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001285
1286 /* ...
1287 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1288 * ...
1289 * with ProtocolVersion defined as:
1290 * uint16 ProtocolVersion;
1291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1293 MBEDTLS_SSL_VERSION_TLS1_2) {
1294 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1295 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1296 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1297 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001298 }
1299 p += 2;
1300
1301 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001302 * Only support TLS 1.3 currently, temporarily set the version.
1303 */
XiaokangQiande333912022-04-20 08:49:42 +00001304 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001305
Jerry Yue67bef42022-07-07 07:29:42 +00001306#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1307 /* Store minor version for later use with ticket serialization. */
1308 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001309 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001310#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001311
Jerry Yuc1be19f2022-04-23 16:11:39 +08001312 /* ...
1313 * Random random;
1314 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001315 * with Random defined as:
1316 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001317 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001318 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1319 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320
Gilles Peskine449bd832023-01-11 14:50:10 +01001321 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001322 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323
Jerry Yuc1be19f2022-04-23 16:11:39 +08001324 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001325 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001326 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001327 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001328 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001329 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330
Gilles Peskine449bd832023-01-11 14:50:10 +01001331 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1332 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1333 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001334 }
1335
XiaokangQian4080a7f2022-04-11 09:55:18 +00001336 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001337 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1338 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001339 /*
1340 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001341 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001342 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001343 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001344
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001346 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001347
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001349 p += 2;
1350
XiaokangQianb67384d2022-04-19 00:02:38 +00001351 /* Check we have enough data for the ciphersuite list, the legacy
1352 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001353 *
1354 * cipher_suites cipher_suites_len bytes
1355 * legacy_compression_methods 2 bytes
1356 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001357 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001359
Gilles Peskine449bd832023-01-11 14:50:10 +01001360 /* ...
1361 * CipherSuite cipher_suites<2..2^16-2>;
1362 * ...
1363 * with CipherSuite defined as:
1364 * uint8 CipherSuite[2];
1365 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001366#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001367 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001368#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001369 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1371 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001372
1373 /*
1374 * Search for a matching ciphersuite
1375 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001376 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001377 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001379
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001381
Gilles Peskine449bd832023-01-11 14:50:10 +01001382 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001383 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001384 ssl, cipher_suite);
1385 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001386 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001387 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001388
Jerry Yu5725f1c2022-08-21 17:27:16 +08001389 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001390 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001391 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1392 cipher_suite,
1393 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001394 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001395
Gilles Peskine449bd832023-01-11 14:50:10 +01001396 if (handshake->ciphersuite_info == NULL) {
1397 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1398 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1399 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001400 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001401
XiaokangQian4080a7f2022-04-11 09:55:18 +00001402 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001403 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001404 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001405 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1407 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1408 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1409 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1410 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001411 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001412 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001413
Jerry Yuc1be19f2022-04-23 16:11:39 +08001414 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001415 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001416 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001417 * with Extension defined as:
1418 * struct {
1419 * ExtensionType extension_type;
1420 * opaque extension_data<0..2^16-1>;
1421 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001422 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001424 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001426 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001427
Gilles Peskine449bd832023-01-11 14:50:10 +01001428 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001429
Jerry Yu63a459c2022-10-31 13:38:40 +08001430 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001431
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001433 unsigned int extension_type;
1434 size_t extension_data_len;
1435 const unsigned char *extension_data_end;
1436
Jerry Yu0c354a22022-08-29 15:25:36 +08001437 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001438 *
1439 * The "pre_shared_key" extension MUST be the last extension in the
1440 * ClientHello (this facilitates implementation as described below).
1441 * Servers MUST check that it is the last extension and otherwise fail
1442 * the handshake with an "illegal_parameter" alert.
1443 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001444 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001445 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001447 MBEDTLS_SSL_PEND_FATAL_ALERT(
1448 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001449 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1450 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001451 }
1452
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1454 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1455 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001456 p += 4;
1457
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001459 extension_data_end = p + extension_data_len;
1460
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001461 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1463 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1464 if (ret != 0) {
1465 return ret;
1466 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001467
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001469#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1470 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001471 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1472 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1473 extension_data_end);
1474 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001475 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001476 1, "mbedtls_ssl_parse_servername_ext", ret);
1477 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001478 }
XiaokangQian40a35232022-05-07 09:02:40 +00001479 break;
1480#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1481
XiaokangQianb67384d2022-04-19 00:02:38 +00001482#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001483 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001484 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001485
1486 /* Supported Groups Extension
1487 *
1488 * When sent by the client, the "supported_groups" extension
1489 * indicates the named groups which the client supports,
1490 * ordered from most preferred to least preferred.
1491 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001492 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 ssl, p, extension_data_end);
1494 if (ret != 0) {
1495 MBEDTLS_SSL_DEBUG_RET(1,
1496 "mbedtls_ssl_parse_supported_groups_ext", ret);
1497 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001498 }
1499
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001501#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001502
XiaokangQian88408882022-04-02 10:15:03 +00001503#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001504 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001506
1507 /*
1508 * Key Share Extension
1509 *
1510 * When sent by the client, the "key_share" extension
1511 * contains the endpoint's cryptographic parameters for
1512 * ECDHE/DHE key establishment methods.
1513 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001514 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 ssl, p, extension_data_end);
1516 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1517 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001518 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001519 }
1520
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001522 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001523 1, "ssl_tls13_parse_key_shares_ext", ret);
1524 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001525 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001526
XiaokangQian7807f9f2022-02-15 10:04:37 +00001527 break;
XiaokangQian88408882022-04-02 10:15:03 +00001528#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001529
1530 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001531 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001532
1533 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 ssl, p, extension_data_end);
1535 if (ret != 0) {
1536 MBEDTLS_SSL_DEBUG_RET(1,
1537 ("ssl_tls13_parse_supported_versions_ext"), ret);
1538 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001539 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001540 break;
1541
Ronald Cron41a443a2022-10-04 16:38:25 +02001542#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001543 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001544 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001545
1546 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 ssl, p, extension_data_end);
1548 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001549 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1551 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001552 }
1553
Jerry Yue19e3b92022-07-08 12:04:51 +00001554 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001555#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001556
Jerry Yu1c105562022-07-10 06:32:38 +00001557 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001558 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1559 if ((handshake->received_extensions &
1560 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001561 MBEDTLS_SSL_PEND_FATAL_ALERT(
1562 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1564 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001565 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001566#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001567 /* Delay processing of the PSK identity once we have
1568 * found out which algorithms to use. We keep a pointer
1569 * to the buffer and the size for later processing.
1570 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001571 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001572 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001573#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001574 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001575
XiaokangQianacb39922022-06-17 10:18:48 +00001576#if defined(MBEDTLS_SSL_ALPN)
1577 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001578 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001579
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1581 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001582 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001583 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1584 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001585 }
XiaokangQianacb39922022-06-17 10:18:48 +00001586 break;
1587#endif /* MBEDTLS_SSL_ALPN */
1588
Ronald Cron928cbd32022-10-04 16:14:26 +02001589#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001590 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001591 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001592
Gabor Mezei078e8032022-04-27 21:17:56 +02001593 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 ssl, p, extension_data_end);
1595 if (ret != 0) {
1596 MBEDTLS_SSL_DEBUG_MSG(1,
1597 (
1598 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1599 ret));
1600 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001601 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001602 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001603#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001604
1605 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001606 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001607 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001608 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001609 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001610 }
1611
1612 p += extension_data_len;
1613 }
1614
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1616 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001617
Gilles Peskine449bd832023-01-11 14:50:10 +01001618 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1619 MBEDTLS_SSL_HS_CLIENT_HELLO,
1620 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001621
Ronald Cron41a443a2022-10-04 16:38:25 +02001622#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001623 /* Update checksum with either
1624 * - The entire content of the CH message, if no PSK extension is present
1625 * - The content up to but excluding the PSK extension, if present.
1626 */
Jerry Yu1c105562022-07-10 06:32:38 +00001627 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1629 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1630 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1631 handshake->update_checksum(ssl, buf,
1632 pre_shared_key_ext - buf);
1633 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1634 pre_shared_key_ext,
1635 pre_shared_key_ext_end,
1636 cipher_suites,
1637 cipher_suites_end);
1638 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1639 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1640 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001641 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1643 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001644 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001646#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001647 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001649 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001650
Gilles Peskine449bd832023-01-11 14:50:10 +01001651 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1652 if (ret < 0) {
1653 return ret;
1654 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001655
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001657
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001659}
1660
1661/* Update the handshake state machine */
1662
Ronald Cronce7d76e2022-07-08 18:56:49 +02001663MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001664static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001665{
1666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1667
XiaokangQian7807f9f2022-02-15 10:04:37 +00001668 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001669 * Server certificate selection
1670 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001671 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1672 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1673 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001674 }
1675#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1676 ssl->handshake->sni_name = NULL;
1677 ssl->handshake->sni_name_len = 0;
1678#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1681 if (ret != 0) {
1682 MBEDTLS_SSL_DEBUG_RET(1,
1683 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1684 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001685 }
1686
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001688
1689}
1690
1691/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001692 * Main entry point from the state machine; orchestrates the otherfunctions.
1693 */
1694
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001695MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001696static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001697{
1698
XiaokangQian08037552022-04-20 07:16:41 +00001699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001701 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001702 int parse_client_hello_ret;
1703
Gilles Peskine449bd832023-01-11 14:50:10 +01001704 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001705
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1707 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1708 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001709
Gilles Peskine449bd832023-01-11 14:50:10 +01001710 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1711 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001712 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1713 * only SSL_CLIENT_HELLO_OK or
1714 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1715 * stage as negative error codes are handled
1716 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001717
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1721 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1722 } else {
1723 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1724 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001725
1726cleanup:
1727
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1729 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001730}
1731
1732/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001733 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001734 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001735MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001736static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001737{
Jerry Yu637a3f12022-04-20 21:37:58 +08001738 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1739 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001740 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1741 if (ssl->conf->f_rng == NULL) {
1742 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1743 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001744 }
1745
Gilles Peskine449bd832023-01-11 14:50:10 +01001746 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1747 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1748 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1749 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001750 }
1751
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1753 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001754
1755#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001756 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001757#endif /* MBEDTLS_HAVE_TIME */
1758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001760}
1761
Jerry Yu3bf2c642022-03-30 22:02:12 +08001762/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001763 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001764 *
1765 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001766 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001767 * } SupportedVersions;
1768 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001769MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001770static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001771 mbedtls_ssl_context *ssl,
1772 unsigned char *buf,
1773 unsigned char *end,
1774 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001775{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001776 *out_len = 0;
1777
Gilles Peskine449bd832023-01-11 14:50:10 +01001778 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001779
1780 /* Check if we have space to write the extension:
1781 * - extension_type (2 bytes)
1782 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001783 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001784 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001785 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001786
Gilles Peskine449bd832023-01-11 14:50:10 +01001787 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001788
Gilles Peskine449bd832023-01-11 14:50:10 +01001789 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001790
Gilles Peskine449bd832023-01-11 14:50:10 +01001791 mbedtls_ssl_write_version(buf + 4,
1792 ssl->conf->transport,
1793 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001794
Gilles Peskine449bd832023-01-11 14:50:10 +01001795 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1796 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001797
Jerry Yu349a6132022-04-14 20:52:56 +08001798 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001799
Jerry Yub95dd362022-11-08 21:19:34 +08001800 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001801 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001802
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001804}
1805
Jerry Yud9436a12022-04-20 22:28:09 +08001806
Jerry Yu3bf2c642022-03-30 22:02:12 +08001807
1808/* Generate and export a single key share. For hybrid KEMs, this can
1809 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001811static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1812 uint16_t named_group,
1813 unsigned char *buf,
1814 unsigned char *end,
1815 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001816{
1817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001818
1819 *out_len = 0;
1820
Jerry Yu89e103c2022-03-30 22:43:29 +08001821#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001822 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001823 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001824 ssl, named_group, buf, end, out_len);
1825 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001826 MBEDTLS_SSL_DEBUG_RET(
1827 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001828 ret);
1829 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001830 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001831 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001832#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001833 if (0 /* Other kinds of KEMs */) {
1834 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001835 ((void) ssl);
1836 ((void) named_group);
1837 ((void) buf);
1838 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1840 }
1841
Gilles Peskine449bd832023-01-11 14:50:10 +01001842 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843}
1844
1845/*
1846 * ssl_tls13_write_key_share_ext
1847 *
1848 * Structure of key_share extension in ServerHello:
1849 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001850 * struct {
1851 * NamedGroup group;
1852 * opaque key_exchange<1..2^16-1>;
1853 * } KeyShareEntry;
1854 * struct {
1855 * KeyShareEntry server_share;
1856 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001857 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001858MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001859static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1860 unsigned char *buf,
1861 unsigned char *end,
1862 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001863{
Jerry Yu955ddd72022-04-22 22:27:33 +08001864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001865 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001866 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001867 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001868 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001869
1870 *out_len = 0;
1871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1875 mbedtls_ssl_named_group_to_str(group),
1876 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001877
Jerry Yu3bf2c642022-03-30 22:02:12 +08001878 /* Check if we have space for header and length fields:
1879 * - extension_type (2 bytes)
1880 * - extension_data_length (2 bytes)
1881 * - group (2 bytes)
1882 * - key_exchange_length (2 bytes)
1883 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001884 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1885 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1886 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001887 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001888
Jerry Yu3bf2c642022-03-30 22:02:12 +08001889 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1890 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001891 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001892 ssl, group, server_share + 4, end, &key_exchange_length);
1893 if (ret != 0) {
1894 return ret;
1895 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001896 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001897
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001899
Gilles Peskine449bd832023-01-11 14:50:10 +01001900 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001901
Jerry Yu57d48412022-04-20 21:50:42 +08001902 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001903
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001905
Gilles Peskine449bd832023-01-11 14:50:10 +01001906 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001907}
Jerry Yud9436a12022-04-20 22:28:09 +08001908
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001909MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001910static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1911 unsigned char *buf,
1912 unsigned char *end,
1913 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001914{
1915 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1916 /* key_share Extension
1917 *
1918 * struct {
1919 * select (Handshake.msg_type) {
1920 * ...
1921 * case hello_retry_request:
1922 * NamedGroup selected_group;
1923 * ...
1924 * };
1925 * } KeyShare;
1926 */
1927
1928 *out_len = 0;
1929
Jerry Yub0ac10b2022-05-05 11:10:08 +08001930 /*
1931 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1932 * of the HRR is then to transmit a cookie to force the client to demonstrate
1933 * reachability at their apparent network address (primarily useful for DTLS).
1934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1936 return 0;
1937 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001938
1939 /* We should only send the key_share extension if the client's initial
1940 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 if (ssl->handshake->offered_group_id != 0) {
1942 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1943 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001944 }
1945
Gilles Peskine449bd832023-01-11 14:50:10 +01001946 if (selected_group == 0) {
1947 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1948 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001949 }
1950
Jerry Yub0ac10b2022-05-05 11:10:08 +08001951 /* Check if we have enough space:
1952 * - extension_type (2 bytes)
1953 * - extension_data_length (2 bytes)
1954 * - selected_group (2 bytes)
1955 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001957
Gilles Peskine449bd832023-01-11 14:50:10 +01001958 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1959 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1960 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001961
Gilles Peskine449bd832023-01-11 14:50:10 +01001962 MBEDTLS_SSL_DEBUG_MSG(3,
1963 ("HRR selected_group: %s (%x)",
1964 mbedtls_ssl_named_group_to_str(selected_group),
1965 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001966
1967 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001968
Gilles Peskine449bd832023-01-11 14:50:10 +01001969 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001970
Gilles Peskine449bd832023-01-11 14:50:10 +01001971 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001972}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001973
1974/*
1975 * Structure of ServerHello message:
1976 *
1977 * struct {
1978 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1979 * Random random;
1980 * opaque legacy_session_id_echo<0..32>;
1981 * CipherSuite cipher_suite;
1982 * uint8 legacy_compression_method = 0;
1983 * Extension extensions<6..2^16-1>;
1984 * } ServerHello;
1985 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001986MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001987static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1988 unsigned char *buf,
1989 unsigned char *end,
1990 size_t *out_len,
1991 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08001992{
Jerry Yu955ddd72022-04-22 22:27:33 +08001993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001994 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001995 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001996 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001997
1998 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08001999 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002000
Jerry Yucfc04b32022-04-21 09:31:58 +08002001 /* ...
2002 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2003 * ...
2004 * with ProtocolVersion defined as:
2005 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2008 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002009 p += 2;
2010
Jerry Yu1c3e6882022-04-20 21:23:40 +08002011 /* ...
2012 * Random random;
2013 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002014 * with Random defined as:
2015 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002016 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2018 if (is_hrr) {
2019 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2020 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2021 } else {
2022 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2023 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002024 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2026 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002027 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2028
Jerry Yucfc04b32022-04-21 09:31:58 +08002029 /* ...
2030 * opaque legacy_session_id_echo<0..32>;
2031 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002032 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002033 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2034 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2035 if (ssl->session_negotiate->id_len > 0) {
2036 memcpy(p, &ssl->session_negotiate->id[0],
2037 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002038 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002039
Gilles Peskine449bd832023-01-11 14:50:10 +01002040 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2041 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002042 }
2043
Jerry Yucfc04b32022-04-21 09:31:58 +08002044 /* ...
2045 * CipherSuite cipher_suite;
2046 * ...
2047 * with CipherSuite defined as:
2048 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2051 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002052 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 MBEDTLS_SSL_DEBUG_MSG(3,
2054 ("server hello, chosen ciphersuite: %s ( id=%d )",
2055 mbedtls_ssl_get_ciphersuite_name(
2056 ssl->session_negotiate->ciphersuite),
2057 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058
Jerry Yucfc04b32022-04-21 09:31:58 +08002059 /* ...
2060 * uint8 legacy_compression_method = 0;
2061 * ...
2062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002064 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002065
Jerry Yucfc04b32022-04-21 09:31:58 +08002066 /* ...
2067 * Extension extensions<6..2^16-1>;
2068 * ...
2069 * struct {
2070 * ExtensionType extension_type; (2 bytes)
2071 * opaque extension_data<0..2^16-1>;
2072 * } Extension;
2073 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002075 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002076 p += 2;
2077
Gilles Peskine449bd832023-01-11 14:50:10 +01002078 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2079 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002080 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002081 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2082 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083 }
2084 p += output_len;
2085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2087 if (is_hrr) {
2088 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2089 } else {
2090 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2091 }
2092 if (ret != 0) {
2093 return ret;
2094 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002095 p += output_len;
2096 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002097
Ronald Cron41a443a2022-10-04 16:38:25 +02002098#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2100 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2101 if (ret != 0) {
2102 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2103 ret);
2104 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002105 }
2106 p += output_len;
2107 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002108#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002109
Gilles Peskine449bd832023-01-11 14:50:10 +01002110 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002111
Gilles Peskine449bd832023-01-11 14:50:10 +01002112 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2113 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002114
Jerry Yud9436a12022-04-20 22:28:09 +08002115 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002116
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002118
Jerry Yu7de2ff02022-11-08 21:43:46 +08002119 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002120 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_HS_SERVER_HELLO,
2122 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002123
Gilles Peskine449bd832023-01-11 14:50:10 +01002124 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002125}
2126
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002127MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002128static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002129{
2130 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2132 if (ret != 0) {
2133 MBEDTLS_SSL_DEBUG_RET(1,
2134 "mbedtls_ssl_tls13_compute_handshake_transform",
2135 ret);
2136 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002137 }
2138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002140}
2141
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002142MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002143static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002144{
Jerry Yu637a3f12022-04-20 21:37:58 +08002145 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002146 unsigned char *buf;
2147 size_t buf_len, msg_len;
2148
Gilles Peskine449bd832023-01-11 14:50:10 +01002149 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002150
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2154 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2155 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2158 buf + buf_len,
2159 &msg_len,
2160 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002161
Jerry Yu3bf2c642022-03-30 22:02:12 +08002162 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002163 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002164
Gilles Peskine449bd832023-01-11 14:50:10 +01002165 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2166 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002169
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002170#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2171 /* The server sends a dummy change_cipher_spec record immediately
2172 * after its first handshake message. This may either be after
2173 * a ServerHello or a HelloRetryRequest.
2174 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002175 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002176 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002177#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002179#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002180
Jerry Yuf4b27e42022-03-30 17:32:21 +08002181cleanup:
2182
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2184 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002185}
2186
Jerry Yu23d1a252022-05-12 18:08:59 +08002187
2188/*
2189 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2190 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002191MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002192static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002193{
2194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 if (ssl->handshake->hello_retry_request_count > 0) {
2196 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2197 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2198 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2199 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002200 }
2201
2202 /*
2203 * Create stateless transcript hash for HRR
2204 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2206 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2207 if (ret != 0) {
2208 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2209 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002210 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002214}
2215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002217static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002218{
2219 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2220 unsigned char *buf;
2221 size_t buf_len, msg_len;
2222
Gilles Peskine449bd832023-01-11 14:50:10 +01002223 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002224
Gilles Peskine449bd832023-01-11 14:50:10 +01002225 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002226
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2228 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2229 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002230
Gilles Peskine449bd832023-01-11 14:50:10 +01002231 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2232 buf + buf_len,
2233 &msg_len,
2234 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002235 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002236 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002237
2238
Gilles Peskine449bd832023-01-11 14:50:10 +01002239 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2240 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002241
2242 ssl->handshake->hello_retry_request_count++;
2243
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002244#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2245 /* The server sends a dummy change_cipher_spec record immediately
2246 * after its first handshake message. This may either be after
2247 * a ServerHello or a HelloRetryRequest.
2248 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002249 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002250 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002251#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002253#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002254
2255cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2257 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002258}
2259
Jerry Yu5b64ae92022-03-30 17:15:02 +08002260/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002261 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2262 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002263
2264/*
2265 * struct {
2266 * Extension extensions<0..2 ^ 16 - 1>;
2267 * } EncryptedExtensions;
2268 *
2269 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002271static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2272 unsigned char *buf,
2273 unsigned char *end,
2274 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002275{
XiaokangQianacb39922022-06-17 10:18:48 +00002276 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002277 unsigned char *p = buf;
2278 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002279 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002280 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002281
Jerry Yu4d3841a2022-04-16 12:37:19 +08002282 *out_len = 0;
2283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002285 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002286 p += 2;
2287
Jerry Yu8937eb42022-05-03 12:12:14 +08002288 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002289 ((void) ret);
2290 ((void) output_len);
2291
2292#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002293 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2294 if (ret != 0) {
2295 return ret;
2296 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002297 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002298#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002299
Gilles Peskine449bd832023-01-11 14:50:10 +01002300 extensions_len = (p - p_extensions_len) - 2;
2301 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002302
2303 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002306
Jerry Yu7de2ff02022-11-08 21:43:46 +08002307 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002311}
2312
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002313MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002314static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002315{
2316 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2317 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002318 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002319
Gilles Peskine449bd832023-01-11 14:50:10 +01002320 mbedtls_ssl_set_outbound_transform(ssl,
2321 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002322 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002324
Gilles Peskine449bd832023-01-11 14:50:10 +01002325 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002326
Gilles Peskine449bd832023-01-11 14:50:10 +01002327 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2328 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2329 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2332 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002333
2334 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002336
Gilles Peskine449bd832023-01-11 14:50:10 +01002337 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2338 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002339
Ronald Cron928cbd32022-10-04 16:14:26 +02002340#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002341 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2342 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2343 } else {
2344 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2345 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002346#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002348#endif
2349
Jerry Yu4d3841a2022-04-16 12:37:19 +08002350cleanup:
2351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2353 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002354}
2355
Ronald Cron928cbd32022-10-04 16:14:26 +02002356#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002357#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2358#define SSL_CERTIFICATE_REQUEST_SKIP 1
2359/* Coordination:
2360 * Check whether a CertificateRequest message should be written.
2361 * Returns a negative code on failure, or
2362 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2363 * - SSL_CERTIFICATE_REQUEST_SKIP
2364 * indicating if the writing of the CertificateRequest
2365 * should be skipped or not.
2366 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002367MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002368static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002369{
2370 int authmode;
2371
XiaokangQian40a35232022-05-07 09:02:40 +00002372#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002373 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002374 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002375 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002376#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002377 authmode = ssl->conf->authmode;
2378
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002380 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002381 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002382 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002383
XiaokangQianc3017f62022-05-13 05:55:41 +00002384 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002385
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002387}
2388
XiaokangQiancec9ae62022-05-06 07:28:50 +00002389/*
2390 * struct {
2391 * opaque certificate_request_context<0..2^8-1>;
2392 * Extension extensions<2..2^16-1>;
2393 * } CertificateRequest;
2394 *
2395 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002396MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002397static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2398 unsigned char *buf,
2399 const unsigned char *end,
2400 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002401{
2402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2403 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002404 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002405 unsigned char *p_extensions_len;
2406
2407 *out_len = 0;
2408
2409 /* Check if we have enough space:
2410 * - certificate_request_context (1 byte)
2411 * - extensions length (2 bytes)
2412 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002413 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002414
2415 /*
2416 * Write certificate_request_context
2417 */
2418 /*
2419 * We use a zero length context for the normal handshake
2420 * messages. For post-authentication handshake messages
2421 * this request context would be set to a non-zero value.
2422 */
2423 *p++ = 0x0;
2424
2425 /*
2426 * Write extensions
2427 */
2428 /* The extensions must contain the signature_algorithms. */
2429 p_extensions_len = p;
2430 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2432 if (ret != 0) {
2433 return ret;
2434 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002435
XiaokangQianec6efb92022-05-06 09:53:10 +00002436 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002438
2439 *out_len = p - buf;
2440
Jerry Yu7de2ff02022-11-08 21:43:46 +08002441 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002445}
2446
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002447MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002448static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002449{
2450 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002453
Gilles Peskine449bd832023-01-11 14:50:10 +01002454 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002457 unsigned char *buf;
2458 size_t buf_len, msg_len;
2459
Gilles Peskine449bd832023-01-11 14:50:10 +01002460 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2461 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2462 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002463
Gilles Peskine449bd832023-01-11 14:50:10 +01002464 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2465 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002466
2467 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002468 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002469
Gilles Peskine449bd832023-01-11 14:50:10 +01002470 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2471 ssl, buf_len, msg_len));
2472 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2473 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002474 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 } else {
2476 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002477 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2478 goto cleanup;
2479 }
2480
Gilles Peskine449bd832023-01-11 14:50:10 +01002481 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002482cleanup:
2483
Gilles Peskine449bd832023-01-11 14:50:10 +01002484 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2485 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002486}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002487
Jerry Yu4d3841a2022-04-16 12:37:19 +08002488/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002489 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002490 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002491MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002492static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002493{
Jerry Yu5a26f302022-05-10 20:46:40 +08002494 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002495
2496#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002497 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2498 mbedtls_ssl_own_cert(ssl) == NULL) {
2499 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2500 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2501 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2502 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002503 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002504#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002505
Gilles Peskine449bd832023-01-11 14:50:10 +01002506 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2507 if (ret != 0) {
2508 return ret;
2509 }
2510 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2511 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002512}
2513
2514/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002515 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002516 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002517MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002518static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002519{
Gilles Peskine449bd832023-01-11 14:50:10 +01002520 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2521 if (ret != 0) {
2522 return ret;
2523 }
2524 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2525 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002526}
Ronald Cron928cbd32022-10-04 16:14:26 +02002527#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002528
2529/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002530 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002531 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002532MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002533static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002534{
Jerry Yud6e253d2022-05-18 13:59:24 +08002535 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002536
Gilles Peskine449bd832023-01-11 14:50:10 +01002537 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2538 if (ret != 0) {
2539 return ret;
2540 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002541
Gilles Peskine449bd832023-01-11 14:50:10 +01002542 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2543 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002544 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002545 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2546 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2547 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002548 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002549
Gilles Peskine449bd832023-01-11 14:50:10 +01002550 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2551 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002552
Gilles Peskine449bd832023-01-11 14:50:10 +01002553 if (ssl->handshake->certificate_request_sent) {
2554 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2555 } else {
2556 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2557 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2558 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002559 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002560
Gilles Peskine449bd832023-01-11 14:50:10 +01002561 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002562}
2563
2564/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002565 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002566 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002567MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002568static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002569{
Jerry Yud6e253d2022-05-18 13:59:24 +08002570 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2573 if (ret != 0) {
2574 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002575 }
2576
Gilles Peskine449bd832023-01-11 14:50:10 +01002577 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2578 if (ret != 0) {
2579 MBEDTLS_SSL_DEBUG_RET(1,
2580 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2581 }
2582
2583 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2584 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002585}
2586
2587/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002588 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002589 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002590MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002591static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002592{
Gilles Peskine449bd832023-01-11 14:50:10 +01002593 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002594
Gilles Peskine449bd832023-01-11 14:50:10 +01002595 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002596
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002597#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2598 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002599/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2600 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2601 * expected to be resolved with issue#6395.
2602 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002603 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002604 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2605 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002606 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002607#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002608 {
2609 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2610 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002611 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002612}
2613
2614/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002615 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002616 */
2617#define SSL_NEW_SESSION_TICKET_SKIP 0
2618#define SSL_NEW_SESSION_TICKET_WRITE 1
2619MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002620static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002621{
2622 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 if (ssl->conf->f_ticket_write == NULL) {
2624 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2625 " callback is not set"));
2626 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002627 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002628 if (ssl->conf->new_session_tickets_count == 0) {
2629 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2630 " configured count is zero"));
2631 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002632 }
2633
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 if (ssl->handshake->new_session_tickets_count == 0) {
2635 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2636 "been sent."));
2637 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002638 }
2639
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002641}
2642
2643#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2644MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002645static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2646 unsigned char *ticket_nonce,
2647 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002648{
2649 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2650 mbedtls_ssl_session *session = ssl->session;
2651 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2652 psa_algorithm_t psa_hash_alg;
2653 int hash_length;
2654
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002656
2657#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002659#endif
2660
Pengyu Lv9f926952022-11-17 15:22:33 +08002661 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002662 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002663 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002664#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002665 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002666 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002667#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002668 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002669
Jerry Yue67bef42022-07-07 07:29:42 +00002670 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2672 (unsigned char *) &session->ticket_age_add,
2673 sizeof(session->ticket_age_add)) != 0)) {
2674 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2675 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002676 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2678 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002679
2680 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002681 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2682 if (ret != 0) {
2683 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2684 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002685 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2687 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002688
2689 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2691 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2692 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2693 if (hash_length == -1 ||
2694 (size_t) hash_length > sizeof(session->resumption_key)) {
2695 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002696 }
2697
Jerry Yue67bef42022-07-07 07:29:42 +00002698 /* In this code the psk key length equals the length of the hash */
2699 session->resumption_key_len = hash_length;
2700 session->ciphersuite = ciphersuite_info->id;
2701
2702 /* Compute resumption key
2703 *
2704 * HKDF-Expand-Label( resumption_master_secret,
2705 * "resumption", ticket_nonce, Hash.length )
2706 */
2707 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002708 psa_hash_alg,
2709 session->app_secrets.resumption_master_secret,
2710 hash_length,
2711 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2712 ticket_nonce,
2713 ticket_nonce_size,
2714 session->resumption_key,
2715 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002716
Gilles Peskine449bd832023-01-11 14:50:10 +01002717 if (ret != 0) {
2718 MBEDTLS_SSL_DEBUG_RET(2,
2719 "Creating the ticket-resumed PSK failed",
2720 ret);
2721 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002722 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002723 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2724 session->resumption_key,
2725 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002726
Gilles Peskine449bd832023-01-11 14:50:10 +01002727 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2728 session->app_secrets.resumption_master_secret,
2729 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002730
Gilles Peskine449bd832023-01-11 14:50:10 +01002731 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002732}
2733
2734/* This function creates a NewSessionTicket message in the following format:
2735 *
2736 * struct {
2737 * uint32 ticket_lifetime;
2738 * uint32 ticket_age_add;
2739 * opaque ticket_nonce<0..255>;
2740 * opaque ticket<1..2^16-1>;
2741 * Extension extensions<0..2^16-2>;
2742 * } NewSessionTicket;
2743 *
2744 * The ticket inside the NewSessionTicket message is an encrypted container
2745 * carrying the necessary information so that the server is later able to
2746 * re-start the communication.
2747 *
2748 * The following fields are placed inside the ticket by the
2749 * f_ticket_write() function:
2750 *
2751 * - creation time (start)
2752 * - flags (flags)
2753 * - age add (ticket_age_add)
2754 * - key (key)
2755 * - key length (key_len)
2756 * - ciphersuite (ciphersuite)
2757 */
2758MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002759static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2760 unsigned char *buf,
2761 unsigned char *end,
2762 size_t *out_len,
2763 unsigned char *ticket_nonce,
2764 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002765{
2766 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2767 unsigned char *p = buf;
2768 mbedtls_ssl_session *session = ssl->session;
2769 size_t ticket_len;
2770 uint32_t ticket_lifetime;
2771
2772 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002773 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002774
2775 /*
2776 * ticket_lifetime 4 bytes
2777 * ticket_age_add 4 bytes
2778 * ticket_nonce 1 + ticket_nonce_size bytes
2779 * ticket >=2 bytes
2780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002781 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002782
2783 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002784 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2785 session,
2786 p + 9 + ticket_nonce_size + 2,
2787 end,
2788 &ticket_len,
2789 &ticket_lifetime);
2790 if (ret != 0) {
2791 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2792 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002793 }
2794 /* RFC 8446 4.6.1
2795 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2796 * unsigned integer in network byte order from the time of ticket
2797 * issuance. Servers MUST NOT use any value greater than
2798 * 604800 seconds (7 days). The value of zero indicates that the
2799 * ticket should be discarded immediately. Clients MUST NOT cache
2800 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2801 * and MAY delete tickets earlier based on local policy. A server
2802 * MAY treat a ticket as valid for a shorter period of time than what
2803 * is stated in the ticket_lifetime.
2804 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002806 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 }
2808 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2809 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2810 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002811
2812 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002813 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2814 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2815 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002816
2817 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002818 p[8] = (unsigned char) ticket_nonce_size;
2819 if (ticket_nonce_size > 0) {
2820 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002821 }
2822 p += 9 + ticket_nonce_size;
2823
2824 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002825 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002826 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002828 p += ticket_len;
2829
2830 /* Ticket Extensions
2831 *
2832 * Note: We currently don't have any extensions.
2833 * Set length to zero.
2834 */
Jerry Yuedab6372022-10-31 14:37:31 +08002835 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2838 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002839 p += 2;
2840
2841 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002842 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2843 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002844
Jerry Yu7de2ff02022-11-08 21:43:46 +08002845 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002846 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002847
Gilles Peskine449bd832023-01-11 14:50:10 +01002848 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002849}
2850
2851/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002852 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002853 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002854static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002855{
2856 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2857
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002859
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002861 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2862 unsigned char *buf;
2863 size_t buf_len, msg_len;
2864
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2866 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002867
Gilles Peskine449bd832023-01-11 14:50:10 +01002868 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2869 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2870 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2873 ssl, buf, buf + buf_len, &msg_len,
2874 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002875
Gilles Peskine449bd832023-01-11 14:50:10 +01002876 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2877 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002878
Jerry Yu359e65f2022-09-22 23:47:43 +08002879 /* Limit session tickets count to one when resumption connection.
2880 *
2881 * See document of mbedtls_ssl_conf_new_session_tickets.
2882 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002884 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002886 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002888
Jerry Yua8d3c502022-10-30 14:51:23 +08002889 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002890 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2891 } else {
2892 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002893 }
2894
Jerry Yue67bef42022-07-07 07:29:42 +00002895cleanup:
2896
Gilles Peskine449bd832023-01-11 14:50:10 +01002897 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002898}
2899#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2900
2901/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002902 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002903 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002904int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002905{
XiaokangQian08037552022-04-20 07:16:41 +00002906 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002907
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2909 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2910 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002911
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2913 mbedtls_ssl_states_str(ssl->state),
2914 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002915
Gilles Peskine449bd832023-01-11 14:50:10 +01002916 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002917 /* start state */
2918 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002920 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002921 break;
2922
XiaokangQian7807f9f2022-02-15 10:04:37 +00002923 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002924 ret = ssl_tls13_process_client_hello(ssl);
2925 if (ret != 0) {
2926 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2927 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002928 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002929
Jerry Yuf41553b2022-05-09 22:20:30 +08002930 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 ret = ssl_tls13_write_hello_retry_request(ssl);
2932 if (ret != 0) {
2933 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2934 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002935 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002936 break;
2937
Jerry Yu5b64ae92022-03-30 17:15:02 +08002938 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002940 break;
2941
Xiaofei Baicba64af2022-02-15 10:00:56 +00002942 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 ret = ssl_tls13_write_encrypted_extensions(ssl);
2944 if (ret != 0) {
2945 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2946 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002947 }
Jerry Yu48330562022-05-06 21:35:44 +08002948 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002949
Ronald Cron928cbd32022-10-04 16:14:26 +02002950#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002951 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002952 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002953 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002954
Jerry Yu83da34e2022-04-16 13:59:52 +08002955 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002956 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002957 break;
2958
2959 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002960 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002961 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002962#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002963
Gilles Peskine449bd832023-01-11 14:50:10 +01002964 /*
2965 * Injection of dummy-CCS's for middlebox compatibility
2966 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002967#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002968 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2970 if (ret == 0) {
2971 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2972 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002973 break;
2974
2975 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2977 if (ret == 0) {
2978 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2979 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002980 break;
2981#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2982
Jerry Yu69dd8d42022-04-16 12:51:26 +08002983 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002984 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002985 break;
2986
2987 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002989 break;
2990
Jerry Yu69dd8d42022-04-16 12:51:26 +08002991 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002992 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002993 break;
2994
Ronald Cron766c0cd2022-10-18 12:17:11 +02002995#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00002996 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002997 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2998 if (ret == 0) {
2999 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003000 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3002 } else {
3003 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003004 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003005 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003006 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003007 }
3008 break;
3009
3010 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003011 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3012 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003013 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003015 }
3016 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003017#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003018
Jerry Yue67bef42022-07-07 07:29:42 +00003019#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003020 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 ret = ssl_tls13_write_new_session_ticket(ssl);
3022 if (ret != 0) {
3023 MBEDTLS_SSL_DEBUG_RET(1,
3024 "ssl_tls13_write_new_session_ticket ",
3025 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003026 }
3027 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003028 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003029 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003030 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003031 * as part of ssl_prepare_handshake_step.
3032 */
3033 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003034
Gilles Peskine449bd832023-01-11 14:50:10 +01003035 if (ssl->handshake->new_session_tickets_count == 0) {
3036 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3037 } else {
3038 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3039 }
Jerry Yue67bef42022-07-07 07:29:42 +00003040 break;
3041
3042#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3043
XiaokangQian7807f9f2022-02-15 10:04:37 +00003044 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003045 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3046 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003047 }
3048
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003050}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003051
Jerry Yufb4b6472022-01-27 15:03:26 +08003052#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */