blob: 16317c07646a1482847df9c7d7c8db7b69178232 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800164 /* RFC 8446 section 4.2.9
165 *
166 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
167 * compatible with the advertised modes; however, if a server does so,
168 * the impact will just be that the client's attempts at resumption fail.
169 *
170 * We regard the ticket with incompatible key exchange modes as not match.
171 */
Pengyu Lv18946532023-01-12 12:28:09 +0800172 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv80270b22023-01-12 11:54:04 +0800173 MBEDTLS_SSL_DEBUG_TICKET_FLAGS(4,
174 session->ticket_flags);
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800175 if (mbedtls_ssl_tls13_check_kex_modes(ssl,
Pengyu Lv80270b22023-01-12 11:54:04 +0800176 mbedtls_ssl_session_get_ticket_flags(
177 session,
178 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800179 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
180 goto exit;
181 }
182
Gilles Peskine449bd832023-01-11 14:50:10 +0100183 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
184#if defined(MBEDTLS_HAVE_TIME)
185 now = mbedtls_time(NULL);
186
187 if (now < session->start) {
188 MBEDTLS_SSL_DEBUG_MSG(
189 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
190 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
191 (long long) now, (long long) session->start));
192 goto exit;
193 }
194
195 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800196
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800197 /* RFC 8446 section 4.6.1
198 *
199 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
200 *
201 * RFC 8446 section 4.2.11.1
202 *
203 * Clients MUST NOT attempt to use tickets which have ages greater than
204 * the "ticket_lifetime" value which was provided with the ticket.
205 *
206 * For time being, the age MUST be less than 604800 seconds (7 days).
207 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800209 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100210 3, ("Ticket age exceeds limitation ticket_age=%lu",
211 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800212 goto exit;
213 }
Jerry Yu95699e72022-08-21 19:22:23 +0800214
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800215 /* RFC 8446 section 4.2.10
216 *
217 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
218 * the ticket age for the selected PSK identity (computed by subtracting
219 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
220 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800221 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800222 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
223 * as the age units are different on the server (s) and in the
224 * client (ms) side. Add a -1000 ms tolerance window to take this
225 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800226 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800227 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100228 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
229 if (age_diff_in_ms <= -1000 ||
230 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800231 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100232 3, ("Ticket age outside tolerance window ( diff=%d )",
233 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800234 goto exit;
235 }
236
237 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800238
239#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800240
241exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100242 if (ret != 0) {
243 mbedtls_ssl_session_free(session);
244 }
Jerry Yu95699e72022-08-21 19:22:23 +0800245
Gilles Peskine449bd832023-01-11 14:50:10 +0100246 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
247 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800248}
249#endif /* MBEDTLS_SSL_SESSION_TICKETS */
250
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800251MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000252static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100253 mbedtls_ssl_context *ssl,
254 const unsigned char *identity,
255 size_t identity_len,
256 uint32_t obfuscated_ticket_age,
257 int *psk_type,
258 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000259{
Jerry Yu95699e72022-08-21 19:22:23 +0800260 ((void) session);
261 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800262 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800263
Gilles Peskine449bd832023-01-11 14:50:10 +0100264 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800265 ssl->handshake->resume = 0;
266
Jerry Yu95699e72022-08-21 19:22:23 +0800267#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800269 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100270 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800271 ssl->handshake->resume = 1;
272 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 mbedtls_ssl_set_hs_psk(ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800274 session->resumption_key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 session->resumption_key_len);
276
277 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
278 session->resumption_key,
279 session->resumption_key_len);
280 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
281 (unsigned) obfuscated_ticket_age));
282 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800283 }
284#endif /* MBEDTLS_SSL_SESSION_TICKETS */
285
Jerry Yu1c105562022-07-10 06:32:38 +0000286 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100287 if (ssl->conf->f_psk != NULL) {
288 if (ssl->conf->f_psk(
289 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
290 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000291 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100292 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000293 }
294
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000296 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800298 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100299 mbedtls_ct_memcmp(ssl->conf->psk_identity,
300 identity, identity_len) == 0) {
301 mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
302 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000303 }
304
Gilles Peskine449bd832023-01-11 14:50:10 +0100305 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000306}
307
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800308MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100309static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
310 const unsigned char *binder,
311 size_t binder_len,
312 int psk_type,
313 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000314{
315 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800316
Jerry Yudaf375a2022-07-20 21:31:43 +0800317 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000318 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800319 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800320 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800321 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000322
Jerry Yu1c105562022-07-10 06:32:38 +0000323 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800324 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100325 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
326 transcript, sizeof(transcript), &transcript_len);
327 if (ret != 0) {
328 return ret;
329 }
Jerry Yu1c105562022-07-10 06:32:38 +0000330
Gilles Peskine449bd832023-01-11 14:50:10 +0100331 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
332 if (ret != 0) {
333 return ret;
334 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800335
Gilles Peskine449bd832023-01-11 14:50:10 +0100336 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
337 psk, psk_len, psk_type,
338 transcript,
339 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800340#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800342#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 if (ret != 0) {
344 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
345 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000346 }
347
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
349 server_computed_binder, transcript_len);
350 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000351
Gilles Peskine449bd832023-01-11 14:50:10 +0100352 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
353 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000354 }
355
Gilles Peskine449bd832023-01-11 14:50:10 +0100356 mbedtls_platform_zeroize(server_computed_binder,
357 sizeof(server_computed_binder));
358 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000359}
Jerry Yu96a2e362022-07-21 15:11:34 +0800360
Jerry Yu5725f1c2022-08-21 17:27:16 +0800361MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800362static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100363 mbedtls_ssl_context *ssl,
364 const unsigned char *cipher_suites,
365 const unsigned char *cipher_suites_end,
366 uint16_t *selected_ciphersuite,
367 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800368{
Jerry Yuf35ba382022-08-23 17:58:26 +0800369 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800370
Jerry Yu0baf9072022-08-25 11:21:04 +0800371 *selected_ciphersuite = 0;
372 *selected_ciphersuite_info = NULL;
373
Jerry Yuf35ba382022-08-23 17:58:26 +0800374 /* RFC 8446, page 55.
375 *
376 * For externally established PSKs, the Hash algorithm MUST be set when the
377 * PSK is established or default to SHA-256 if no such algorithm is defined.
378 *
379 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800380
Jerry Yu5725f1c2022-08-21 17:27:16 +0800381 /*
382 * Search for a matching ciphersuite
383 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100384 for (const unsigned char *p = cipher_suites;
385 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800386 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800387 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800388
Gilles Peskine449bd832023-01-11 14:50:10 +0100389 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
390 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
391 cipher_suite);
392 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800393 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100394 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800395
Jerry Yu5725f1c2022-08-21 17:27:16 +0800396 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
397 * Otherwise, client should reject.
398 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100399 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800400 *selected_ciphersuite = cipher_suite;
401 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800403 }
404 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100405 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
406 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800407}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800408
Jerry Yu82534862022-08-30 10:42:33 +0800409#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800410MBEDTLS_CHECK_RETURN_CRITICAL
411static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 mbedtls_ssl_context *ssl,
413 const unsigned char *cipher_suites,
414 const unsigned char *cipher_suites_end,
415 mbedtls_ssl_session *session,
416 uint16_t *selected_ciphersuite,
417 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800418{
Jerry Yu82534862022-08-30 10:42:33 +0800419
Jerry Yuf35ba382022-08-23 17:58:26 +0800420 *selected_ciphersuite = 0;
421 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100422 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
423 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800424 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
425
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800427 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 }
Jerry Yu82534862022-08-30 10:42:33 +0800429
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
431 cipher_suite);
432 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800433 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100434 }
Jerry Yu82534862022-08-30 10:42:33 +0800435
Jerry Yu4746b102022-09-13 11:11:48 +0800436 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800437 *selected_ciphersuite_info = ciphersuite_info;
438
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800440 }
441
Gilles Peskine449bd832023-01-11 14:50:10 +0100442 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800443}
Jerry Yuf35ba382022-08-23 17:58:26 +0800444
Jerry Yu82534862022-08-30 10:42:33 +0800445MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100446static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
447 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800448{
Jerry Yu82534862022-08-30 10:42:33 +0800449 dst->ticket_age_add = src->ticket_age_add;
450 dst->ticket_flags = src->ticket_flags;
451 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 if (src->resumption_key_len == 0) {
453 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
454 }
455 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800458}
459#endif /* MBEDTLS_SSL_SESSION_TICKETS */
460
Jerry Yu1c105562022-07-10 06:32:38 +0000461/* Parser for pre_shared_key extension in client hello
462 * struct {
463 * opaque identity<1..2^16-1>;
464 * uint32 obfuscated_ticket_age;
465 * } PskIdentity;
466 *
467 * opaque PskBinderEntry<32..255>;
468 *
469 * struct {
470 * PskIdentity identities<7..2^16-1>;
471 * PskBinderEntry binders<33..2^16-1>;
472 * } OfferedPsks;
473 *
474 * struct {
475 * select (Handshake.msg_type) {
476 * case client_hello: OfferedPsks;
477 * ....
478 * };
479 * } PreSharedKeyExtension;
480 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800481MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100482static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
483 const unsigned char *pre_shared_key_ext,
484 const unsigned char *pre_shared_key_ext_end,
485 const unsigned char *ciphersuites,
486 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000487{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800488 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800489 const unsigned char *p_identity_len;
490 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000491 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800492 const unsigned char *binders;
493 const unsigned char *p_binder_len;
494 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000495 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800496 int matched_identity = -1;
497 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000498
Gilles Peskine449bd832023-01-11 14:50:10 +0100499 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
500 pre_shared_key_ext,
501 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000502
Jerry Yu96a2e362022-07-21 15:11:34 +0800503 /* identities_len 2 bytes
504 * identities_data >= 7 bytes
505 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100506 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
507 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800508 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100509 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
510 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800511 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000512
Jerry Yu96a2e362022-07-21 15:11:34 +0800513 /* binders_len 2 bytes
514 * binders >= 33 bytes
515 */
Jerry Yu568ec252022-07-22 21:27:34 +0800516 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100517 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
518 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800519 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800521 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000522
Gilles Peskine449bd832023-01-11 14:50:10 +0100523 ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
524 identities_end - pre_shared_key_ext);
Jerry Yu96a2e362022-07-21 15:11:34 +0800525
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000527 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800528 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800529 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800530 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800531 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800532 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800533 int psk_type;
534 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800535 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800536#if defined(MBEDTLS_SSL_SESSION_TICKETS)
537 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800539#endif
Jerry Yubb852022022-07-20 21:10:44 +0800540
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
542 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800543 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100544 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
545 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800546 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000547
Gilles Peskine449bd832023-01-11 14:50:10 +0100548 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800549 binder_len = *p_binder_len;
550 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800552 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800553
Jerry Yu96a2e362022-07-21 15:11:34 +0800554 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000556 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100557 }
Jerry Yu1c105562022-07-10 06:32:38 +0000558
Jerry Yu96a2e362022-07-21 15:11:34 +0800559 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100560 ssl, identity, identity_len, obfuscated_ticket_age,
561 &psk_type, &session);
562 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800563 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800565
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
567 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800568 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
569 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100570 ssl, ciphersuites, ciphersuites_end,
571 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800572 break;
573 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800574#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800575 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100576 ssl, ciphersuites, ciphersuites_end, &session,
577 &cipher_suite, &ciphersuite_info);
578 if (ret != 0) {
579 mbedtls_ssl_session_free(&session);
580 }
Jerry Yu82534862022-08-30 10:42:33 +0800581#else
582 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
583#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800584 break;
585 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800587 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800589 /* See below, no cipher_suite available, abort handshake */
590 MBEDTLS_SSL_PEND_FATAL_ALERT(
591 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800593 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 2, "ssl_tls13_select_ciphersuite", ret);
595 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800596 }
597
Jerry Yu96a2e362022-07-21 15:11:34 +0800598 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 ssl, binder, binder_len, psk_type,
600 mbedtls_psa_translate_md(ciphersuite_info->mac));
601 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800602 /* For security reasons, the handshake should be aborted when we
603 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
604 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800605#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800607#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100608 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
609 MBEDTLS_SSL_DEBUG_RET(1,
610 "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800611 MBEDTLS_SSL_PEND_FATAL_ALERT(
612 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100613 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
614 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800615 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800616
617 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800618
619 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800620 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800621 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
623 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800624#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
626 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
627 &session);
628 mbedtls_ssl_session_free(&session);
629 if (ret != 0) {
630 return ret;
631 }
Jerry Yu82534862022-08-30 10:42:33 +0800632 }
633#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000634 }
635
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 if (p_identity_len != identities_end || p_binder_len != binders_end) {
637 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
638 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
639 MBEDTLS_ERR_SSL_DECODE_ERROR);
640 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000641 }
642
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800643 /* Update the handshake transcript with the binder list. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100644 ssl->handshake->update_checksum(ssl,
645 identities_end,
646 (size_t) (binders_end - identities_end));
647 if (matched_identity == -1) {
648 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
649 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000650 }
651
Gilles Peskine449bd832023-01-11 14:50:10 +0100652 ssl->handshake->selected_identity = (uint16_t) matched_identity;
653 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000654
Gilles Peskine449bd832023-01-11 14:50:10 +0100655 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000656}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000657
658/*
659 * struct {
660 * select ( Handshake.msg_type ) {
661 * ....
662 * case server_hello:
663 * uint16 selected_identity;
664 * }
665 * } PreSharedKeyExtension;
666 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100667static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
668 unsigned char *buf,
669 unsigned char *end,
670 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000671{
Gilles Peskine449bd832023-01-11 14:50:10 +0100672 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000673
674 *olen = 0;
675
David Horstmann21b89762022-10-06 18:34:28 +0100676 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000677#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000679#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000681#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000683 /* We shouldn't have called this extension writer unless we've
684 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100685 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000686 }
687
Gilles Peskine449bd832023-01-11 14:50:10 +0100688 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
689 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000690
Gilles Peskine449bd832023-01-11 14:50:10 +0100691 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
692 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000693
Gilles Peskine449bd832023-01-11 14:50:10 +0100694 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000695
696 *olen = 6;
697
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
699 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000700
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800702
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000704}
705
Ronald Cron41a443a2022-10-04 16:38:25 +0200706#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000707
XiaokangQian7807f9f2022-02-15 10:04:37 +0000708/* From RFC 8446:
709 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000710 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000711 * } SupportedVersions;
712 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200713MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100714static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
715 const unsigned char *buf,
716 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000717{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000719 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000720 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000721 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000722 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000723
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000725 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000726 p += 1;
727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000729 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 while (p < versions_end) {
731 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
732 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000733 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000734
735 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100736 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737 tls13_supported = 1;
738 break;
739 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000740 }
741
Gilles Peskine449bd832023-01-11 14:50:10 +0100742 if (!tls13_supported) {
743 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
746 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
747 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000748 }
749
Gilles Peskine449bd832023-01-11 14:50:10 +0100750 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
751 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000752
Gilles Peskine449bd832023-01-11 14:50:10 +0100753 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000754}
755
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000756#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000757/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000758 *
759 * From RFC 8446:
760 * enum {
761 * ... (0xFFFF)
762 * } NamedGroup;
763 * struct {
764 * NamedGroup named_group_list<2..2^16-1>;
765 * } NamedGroupList;
766 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200767MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100768static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
769 const unsigned char *buf,
770 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000771{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000773 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000774 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000775
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
777 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
778 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000779 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100780 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000781 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000782 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000783
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000785 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100786 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
787 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000788 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000789
Gilles Peskine449bd832023-01-11 14:50:10 +0100790 MBEDTLS_SSL_DEBUG_MSG(2,
791 ("got named group: %s(%04x)",
792 mbedtls_ssl_named_group_to_str(named_group),
793 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000794
Gilles Peskine449bd832023-01-11 14:50:10 +0100795 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
796 !mbedtls_ssl_named_group_is_supported(named_group) ||
797 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000798 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000799 }
800
Gilles Peskine449bd832023-01-11 14:50:10 +0100801 MBEDTLS_SSL_DEBUG_MSG(2,
802 ("add named group %s(%04x) into received list.",
803 mbedtls_ssl_named_group_to_str(named_group),
804 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800805
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000806 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000807 }
808
Gilles Peskine449bd832023-01-11 14:50:10 +0100809 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000810
811}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000812#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000813
XiaokangQian08037552022-04-20 07:16:41 +0000814#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
815
XiaokangQian88408882022-04-02 10:15:03 +0000816#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000817/*
818 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000819 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000820 *
821 * Possible return values are:
822 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000823 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000824 * does not match a group supported by the server. A HelloRetryRequest will
825 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000826 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800827 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200828MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100829static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
830 const unsigned char *buf,
831 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000832{
XiaokangQianb67384d2022-04-19 00:02:38 +0000833 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000834 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000835 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800836 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000837
838 /* From RFC 8446:
839 *
840 * struct {
841 * KeyShareEntry client_shares<0..2^16-1>;
842 * } KeyShareClientHello;
843 *
844 */
845
Gilles Peskine449bd832023-01-11 14:50:10 +0100846 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
847 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000848 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100849 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000850
851 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000852 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853
854 /* We try to find a suitable key share entry and copy it to the
855 * handshake context. Later, we have to find out whether we can do
856 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000857 * dismiss it and send a HelloRetryRequest message.
858 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000859
Gilles Peskine449bd832023-01-11 14:50:10 +0100860 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000861 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800862 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800863 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864
865 /*
866 * struct {
867 * NamedGroup group;
868 * opaque key_exchange<1..2^16-1>;
869 * } KeyShareEntry;
870 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100871 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
872 group = MBEDTLS_GET_UINT16_BE(p, 0);
873 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800874 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800875 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100876 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800877 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000878
879 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000880 * for input validation purposes.
881 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
883 !mbedtls_ssl_named_group_is_supported(group) ||
884 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000885 continue;
886 }
XiaokangQian060d8672022-04-21 09:24:56 +0000887
XiaokangQian7807f9f2022-02-15 10:04:37 +0000888 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000889 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000890 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100891 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
892 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
893 mbedtls_ssl_named_group_to_str(group),
894 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000895 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100896 ssl, key_exchange - 2, key_exchange_len + 2);
897 if (ret != 0) {
898 return ret;
899 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000900
Gilles Peskine449bd832023-01-11 14:50:10 +0100901 } else {
902 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
903 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000904 continue;
905 }
906
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000907 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000908 }
909
Jerry Yuc1be19f2022-04-23 16:11:39 +0800910
Gilles Peskine449bd832023-01-11 14:50:10 +0100911 if (ssl->handshake->offered_group_id == 0) {
912 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
913 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000914 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000916}
XiaokangQian88408882022-04-02 10:15:03 +0000917#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000918
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200919MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100920static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
921 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000922{
Jerry Yu0c354a22022-08-29 15:25:36 +0800923 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000925}
926
Jerry Yue5991322022-11-07 14:03:44 +0800927#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200928MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000929static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000931{
Gilles Peskine449bd832023-01-11 14:50:10 +0100932 return ssl_tls13_client_hello_has_exts(
933 ssl,
934 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
935 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
936 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937}
Jerry Yue5991322022-11-07 14:03:44 +0800938#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000939
Jerry Yue5991322022-11-07 14:03:44 +0800940#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000941MBEDTLS_CHECK_RETURN_CRITICAL
942static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000944{
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 return ssl_tls13_client_hello_has_exts(
946 ssl,
947 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
948 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000949}
Jerry Yue5991322022-11-07 14:03:44 +0800950#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000951
Jerry Yue5991322022-11-07 14:03:44 +0800952#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000953MBEDTLS_CHECK_RETURN_CRITICAL
954static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000956{
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 return ssl_tls13_client_hello_has_exts(
958 ssl,
959 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
960 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
961 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
962 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000963}
Jerry Yue5991322022-11-07 14:03:44 +0800964#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000965
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200966MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100967static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000968{
Jerry Yue5991322022-11-07 14:03:44 +0800969#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100970 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
971 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800972#else
973 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100974 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800975#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000976}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000977
Jerry Yu77f01482022-07-11 07:03:24 +0000978MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100979static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000980{
Jerry Yue5991322022-11-07 14:03:44 +0800981#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100982 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
983 mbedtls_ssl_tls13_psk_enabled(ssl) &&
984 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000985#else
986 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100987 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +0000988#endif
989}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000990
Jerry Yu77f01482022-07-11 07:03:24 +0000991MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100992static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000993{
Jerry Yue5991322022-11-07 14:03:44 +0800994#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100995 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
996 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
997 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000998#else
999 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001000 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001001#endif
1002}
1003
Gilles Peskine449bd832023-01-11 14:50:10 +01001004static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001005{
1006 /*
1007 * Determine the key exchange algorithm to use.
1008 * There are three types of key exchanges supported in TLS 1.3:
1009 * - (EC)DH with ECDSA,
1010 * - (EC)DH with PSK,
1011 * - plain PSK.
1012 *
1013 * The PSK-based key exchanges may additionally be used with 0-RTT.
1014 *
1015 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001016 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1017 * 2 ) Certificate Mode ( ephemeral )
1018 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001019 */
1020
1021 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1022
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001024 ssl->handshake->key_exchange_mode =
1025 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001026 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1027 } else
1028 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001029 ssl->handshake->key_exchange_mode =
1030 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001031 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1032 } else
1033 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001034 ssl->handshake->key_exchange_mode =
1035 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001036 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1037 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001038 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001039 1,
1040 ("ClientHello message misses mandatory extensions."));
1041 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1042 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1043 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001044 }
1045
Gilles Peskine449bd832023-01-11 14:50:10 +01001046 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001047
XiaokangQian7807f9f2022-02-15 10:04:37 +00001048}
1049
XiaokangQian81802f42022-06-10 13:25:22 +00001050#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001051 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001052
1053#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001054static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001055{
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001057 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001059 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001061 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001063 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001065 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001067 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001069 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001071 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001073 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001075 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001076 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001077 }
1078}
1079#endif /* MBEDTLS_USE_PSA_CRYPTO */
1080
XiaokangQian23c5be62022-06-07 02:04:34 +00001081/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001082 * Pick best ( private key, certificate chain ) pair based on the signature
1083 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001084 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001085MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001086static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001087{
XiaokangQianfb665a82022-06-15 03:57:21 +00001088 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001089 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001090
1091#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001093 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001095#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001097
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 if (key_cert_list == NULL) {
1099 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1100 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001101 }
1102
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1104 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001105 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001107
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001109 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001111
Gilles Peskine449bd832023-01-11 14:50:10 +01001112 for (key_cert = key_cert_list; key_cert != NULL;
1113 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001114#if defined(MBEDTLS_USE_PSA_CRYPTO)
1115 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1116#endif /* MBEDTLS_USE_PSA_CRYPTO */
1117
Gilles Peskine449bd832023-01-11 14:50:10 +01001118 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1119 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001120
1121 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001122 * This avoids sending the client a cert it'll reject based on
1123 * keyUsage or other extensions.
1124 */
1125 if (mbedtls_x509_crt_check_key_usage(
1126 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001127 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001128 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1130 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1131 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001132 continue;
1133 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001134
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 MBEDTLS_SSL_DEBUG_MSG(3,
1136 ("ssl_tls13_pick_key_cert:"
1137 "check signature algorithm %s [%04x]",
1138 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1139 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001140#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001142#endif /* MBEDTLS_USE_PSA_CRYPTO */
1143
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1145 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001146#if defined(MBEDTLS_USE_PSA_CRYPTO)
1147 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001148 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1149 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001150#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001152 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 MBEDTLS_SSL_DEBUG_MSG(3,
1154 ("ssl_tls13_pick_key_cert:"
1155 "selected signature algorithm"
1156 " %s [%04x]",
1157 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1158 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001159 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001160 3, "selected certificate (chain)",
1161 ssl->handshake->key_cert->cert);
1162 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001163 }
XiaokangQian81802f42022-06-10 13:25:22 +00001164 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001165 }
1166
Gilles Peskine449bd832023-01-11 14:50:10 +01001167 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1168 "no suitable certificate found"));
1169 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001170}
XiaokangQian81802f42022-06-10 13:25:22 +00001171#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001172 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001173
XiaokangQian4080a7f2022-04-11 09:55:18 +00001174/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001175 *
1176 * STATE HANDLING: ClientHello
1177 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001178 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001179 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001180 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001181 *
1182 * In this case, the server progresses to sending its ServerHello.
1183 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001184 * 2) The ClientHello was well-formed but didn't match the server's
1185 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001186 *
1187 * For example, the client might not have offered a key share which
1188 * the server supports, or the server might require a cookie.
1189 *
1190 * In this case, the server sends a HelloRetryRequest.
1191 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001192 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001193 *
1194 * In this case, we abort the handshake.
1195 *
1196 */
1197
1198/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001199 * Structure of this message:
1200 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001201 * uint16 ProtocolVersion;
1202 * opaque Random[32];
1203 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001204 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001205 * struct {
1206 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1207 * Random random;
1208 * opaque legacy_session_id<0..32>;
1209 * CipherSuite cipher_suites<2..2^16-2>;
1210 * opaque legacy_compression_methods<1..2^8-1>;
1211 * Extension extensions<8..2^16-1>;
1212 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001213 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001214
1215#define SSL_CLIENT_HELLO_OK 0
1216#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1217
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001218MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001219static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1220 const unsigned char *buf,
1221 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001222{
XiaokangQianb67384d2022-04-19 00:02:38 +00001223 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1224 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001225 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001226 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001227 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001228 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001229 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001230 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001231 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001232
Ronald Cron41a443a2022-10-04 16:38:25 +02001233#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001234 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001235 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001236 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001237#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001238
XiaokangQian7807f9f2022-02-15 10:04:37 +00001239 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001240 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001241 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001242 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001243 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001244 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001245 * .. . .. ciphersuite list length ( 2 bytes )
1246 * .. . .. ciphersuite list
1247 * .. . .. compression alg. list length ( 1 byte )
1248 * .. . .. compression alg. list
1249 * .. . .. extensions length ( 2 bytes, optional )
1250 * .. . .. extensions ( optional )
1251 */
1252
XiaokangQianb67384d2022-04-19 00:02:38 +00001253 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001254 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001255 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1256 * read at least up to session id length without worrying.
1257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001258 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001259
1260 /* ...
1261 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1262 * ...
1263 * with ProtocolVersion defined as:
1264 * uint16 ProtocolVersion;
1265 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001266 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1267 MBEDTLS_SSL_VERSION_TLS1_2) {
1268 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1269 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1270 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1271 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001272 }
1273 p += 2;
1274
1275 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001276 * Only support TLS 1.3 currently, temporarily set the version.
1277 */
XiaokangQiande333912022-04-20 08:49:42 +00001278 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001279
Jerry Yue67bef42022-07-07 07:29:42 +00001280#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1281 /* Store minor version for later use with ticket serialization. */
1282 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001283 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001284#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001285
Jerry Yuc1be19f2022-04-23 16:11:39 +08001286 /* ...
1287 * Random random;
1288 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001289 * with Random defined as:
1290 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001292 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1293 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001294
Gilles Peskine449bd832023-01-11 14:50:10 +01001295 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001296 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001297
Jerry Yuc1be19f2022-04-23 16:11:39 +08001298 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001299 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001300 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001301 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001302 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001303 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001304
Gilles Peskine449bd832023-01-11 14:50:10 +01001305 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1306 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1307 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308 }
1309
XiaokangQian4080a7f2022-04-11 09:55:18 +00001310 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001311 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1312 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001313 /*
1314 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001315 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001316 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318
Gilles Peskine449bd832023-01-11 14:50:10 +01001319 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001320 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001321
Gilles Peskine449bd832023-01-11 14:50:10 +01001322 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323 p += 2;
1324
XiaokangQianb67384d2022-04-19 00:02:38 +00001325 /* Check we have enough data for the ciphersuite list, the legacy
1326 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001327 *
1328 * cipher_suites cipher_suites_len bytes
1329 * legacy_compression_methods 2 bytes
1330 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001333
Gilles Peskine449bd832023-01-11 14:50:10 +01001334 /* ...
1335 * CipherSuite cipher_suites<2..2^16-2>;
1336 * ...
1337 * with CipherSuite defined as:
1338 * uint8 CipherSuite[2];
1339 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001340#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001341 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001342#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001343 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1345 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001346
1347 /*
1348 * Search for a matching ciphersuite
1349 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001351 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001355
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001357 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001358 ssl, cipher_suite);
1359 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001360 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001361 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001362
Jerry Yu5725f1c2022-08-21 17:27:16 +08001363 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001364 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1366 cipher_suite,
1367 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001368 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001369
Gilles Peskine449bd832023-01-11 14:50:10 +01001370 if (handshake->ciphersuite_info == NULL) {
1371 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1372 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1373 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001374 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001375
XiaokangQian4080a7f2022-04-11 09:55:18 +00001376 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001377 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001378 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001379 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001380 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1381 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1382 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1383 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1384 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001385 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001386 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001387
Jerry Yuc1be19f2022-04-23 16:11:39 +08001388 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001389 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001390 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001391 * with Extension defined as:
1392 * struct {
1393 * ExtensionType extension_type;
1394 * opaque extension_data<0..2^16-1>;
1395 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001396 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001398 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001399 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001400 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001401
Gilles Peskine449bd832023-01-11 14:50:10 +01001402 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001403
Jerry Yu63a459c2022-10-31 13:38:40 +08001404 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001405
Gilles Peskine449bd832023-01-11 14:50:10 +01001406 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001407 unsigned int extension_type;
1408 size_t extension_data_len;
1409 const unsigned char *extension_data_end;
1410
Jerry Yu0c354a22022-08-29 15:25:36 +08001411 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001412 *
1413 * The "pre_shared_key" extension MUST be the last extension in the
1414 * ClientHello (this facilitates implementation as described below).
1415 * Servers MUST check that it is the last extension and otherwise fail
1416 * the handshake with an "illegal_parameter" alert.
1417 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001419 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001420 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001421 MBEDTLS_SSL_PEND_FATAL_ALERT(
1422 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001423 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1424 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001425 }
1426
Gilles Peskine449bd832023-01-11 14:50:10 +01001427 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1428 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1429 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001430 p += 4;
1431
Gilles Peskine449bd832023-01-11 14:50:10 +01001432 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001433 extension_data_end = p + extension_data_len;
1434
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001435 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001436 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1437 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1438 if (ret != 0) {
1439 return ret;
1440 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001441
Gilles Peskine449bd832023-01-11 14:50:10 +01001442 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001443#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1444 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1446 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1447 extension_data_end);
1448 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001449 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 1, "mbedtls_ssl_parse_servername_ext", ret);
1451 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001452 }
XiaokangQian40a35232022-05-07 09:02:40 +00001453 break;
1454#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1455
XiaokangQianb67384d2022-04-19 00:02:38 +00001456#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001457 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001459
1460 /* Supported Groups Extension
1461 *
1462 * When sent by the client, the "supported_groups" extension
1463 * indicates the named groups which the client supports,
1464 * ordered from most preferred to least preferred.
1465 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001466 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001467 ssl, p, extension_data_end);
1468 if (ret != 0) {
1469 MBEDTLS_SSL_DEBUG_RET(1,
1470 "mbedtls_ssl_parse_supported_groups_ext", ret);
1471 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001472 }
1473
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001475#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001476
XiaokangQian88408882022-04-02 10:15:03 +00001477#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001478 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001480
1481 /*
1482 * Key Share Extension
1483 *
1484 * When sent by the client, the "key_share" extension
1485 * contains the endpoint's cryptographic parameters for
1486 * ECDHE/DHE key establishment methods.
1487 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001488 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001489 ssl, p, extension_data_end);
1490 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1491 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001492 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001493 }
1494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001496 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 1, "ssl_tls13_parse_key_shares_ext", ret);
1498 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001499 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500
XiaokangQian7807f9f2022-02-15 10:04:37 +00001501 break;
XiaokangQian88408882022-04-02 10:15:03 +00001502#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001503
1504 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001505 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001506
1507 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001508 ssl, p, extension_data_end);
1509 if (ret != 0) {
1510 MBEDTLS_SSL_DEBUG_RET(1,
1511 ("ssl_tls13_parse_supported_versions_ext"), ret);
1512 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001514 break;
1515
Ronald Cron41a443a2022-10-04 16:38:25 +02001516#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001517 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001519
1520 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 ssl, p, extension_data_end);
1522 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001523 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1525 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001526 }
1527
Jerry Yue19e3b92022-07-08 12:04:51 +00001528 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001529#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001530
Jerry Yu1c105562022-07-10 06:32:38 +00001531 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001532 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1533 if ((handshake->received_extensions &
1534 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001535 MBEDTLS_SSL_PEND_FATAL_ALERT(
1536 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1538 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001539 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001540#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001541 /* Delay processing of the PSK identity once we have
1542 * found out which algorithms to use. We keep a pointer
1543 * to the buffer and the size for later processing.
1544 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001545 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001546 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001547#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001548 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001549
XiaokangQianacb39922022-06-17 10:18:48 +00001550#if defined(MBEDTLS_SSL_ALPN)
1551 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001553
Gilles Peskine449bd832023-01-11 14:50:10 +01001554 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1555 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001556 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001557 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1558 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001559 }
XiaokangQianacb39922022-06-17 10:18:48 +00001560 break;
1561#endif /* MBEDTLS_SSL_ALPN */
1562
Ronald Cron928cbd32022-10-04 16:14:26 +02001563#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001564 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001566
Gabor Mezei078e8032022-04-27 21:17:56 +02001567 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 ssl, p, extension_data_end);
1569 if (ret != 0) {
1570 MBEDTLS_SSL_DEBUG_MSG(1,
1571 (
1572 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1573 ret));
1574 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001575 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001576 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001577#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001578
1579 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001580 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001581 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001582 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001583 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001584 }
1585
1586 p += extension_data_len;
1587 }
1588
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1590 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1593 MBEDTLS_SSL_HS_CLIENT_HELLO,
1594 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001595
Ronald Cron41a443a2022-10-04 16:38:25 +02001596#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001597 /* Update checksum with either
1598 * - The entire content of the CH message, if no PSK extension is present
1599 * - The content up to but excluding the PSK extension, if present.
1600 */
Jerry Yu1c105562022-07-10 06:32:38 +00001601 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001602 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1603 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1604 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1605 handshake->update_checksum(ssl, buf,
1606 pre_shared_key_ext - buf);
1607 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1608 pre_shared_key_ext,
1609 pre_shared_key_ext_end,
1610 cipher_suites,
1611 cipher_suites_end);
1612 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1613 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1614 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001615 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001616 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1617 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001618 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001619 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001620#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001621 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001623 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001624
Gilles Peskine449bd832023-01-11 14:50:10 +01001625 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1626 if (ret < 0) {
1627 return ret;
1628 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001631
Gilles Peskine449bd832023-01-11 14:50:10 +01001632 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001633}
1634
1635/* Update the handshake state machine */
1636
Ronald Cronce7d76e2022-07-08 18:56:49 +02001637MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001638static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001639{
1640 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1641
XiaokangQian7807f9f2022-02-15 10:04:37 +00001642 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001643 * Server certificate selection
1644 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1646 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1647 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001648 }
1649#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1650 ssl->handshake->sni_name = NULL;
1651 ssl->handshake->sni_name_len = 0;
1652#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001653
Gilles Peskine449bd832023-01-11 14:50:10 +01001654 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1655 if (ret != 0) {
1656 MBEDTLS_SSL_DEBUG_RET(1,
1657 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1658 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001659 }
1660
Gilles Peskine449bd832023-01-11 14:50:10 +01001661 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001662
1663}
1664
1665/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001666 * Main entry point from the state machine; orchestrates the otherfunctions.
1667 */
1668
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001669MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001670static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001671{
1672
XiaokangQian08037552022-04-20 07:16:41 +00001673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001674 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001675 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001676 int parse_client_hello_ret;
1677
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001679
Gilles Peskine449bd832023-01-11 14:50:10 +01001680 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1681 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1682 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001683
Gilles Peskine449bd832023-01-11 14:50:10 +01001684 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1685 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001686 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1687 * only SSL_CLIENT_HELLO_OK or
1688 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1689 * stage as negative error codes are handled
1690 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001693
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1695 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1696 } else {
1697 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1698 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001699
1700cleanup:
1701
Gilles Peskine449bd832023-01-11 14:50:10 +01001702 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1703 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001704}
1705
1706/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001707 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001708 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001709MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001710static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001711{
Jerry Yu637a3f12022-04-20 21:37:58 +08001712 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1713 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001714 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1715 if (ssl->conf->f_rng == NULL) {
1716 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1717 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001718 }
1719
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1721 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1722 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1723 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001724 }
1725
Gilles Peskine449bd832023-01-11 14:50:10 +01001726 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1727 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001728
1729#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001731#endif /* MBEDTLS_HAVE_TIME */
1732
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001734}
1735
Jerry Yu3bf2c642022-03-30 22:02:12 +08001736/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001737 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001738 *
1739 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001740 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001741 * } SupportedVersions;
1742 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001743MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001744static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001745 mbedtls_ssl_context *ssl,
1746 unsigned char *buf,
1747 unsigned char *end,
1748 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001749{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001750 *out_len = 0;
1751
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001753
1754 /* Check if we have space to write the extension:
1755 * - extension_type (2 bytes)
1756 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001757 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001758 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001762
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001764
Gilles Peskine449bd832023-01-11 14:50:10 +01001765 mbedtls_ssl_write_version(buf + 4,
1766 ssl->conf->transport,
1767 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001768
Gilles Peskine449bd832023-01-11 14:50:10 +01001769 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1770 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001771
Jerry Yu349a6132022-04-14 20:52:56 +08001772 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001773
Jerry Yub95dd362022-11-08 21:19:34 +08001774 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001776
Gilles Peskine449bd832023-01-11 14:50:10 +01001777 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001778}
1779
Jerry Yud9436a12022-04-20 22:28:09 +08001780
Jerry Yu3bf2c642022-03-30 22:02:12 +08001781
1782/* Generate and export a single key share. For hybrid KEMs, this can
1783 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001784MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001785static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1786 uint16_t named_group,
1787 unsigned char *buf,
1788 unsigned char *end,
1789 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001790{
1791 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001792
1793 *out_len = 0;
1794
Jerry Yu89e103c2022-03-30 22:43:29 +08001795#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001797 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001798 ssl, named_group, buf, end, out_len);
1799 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001800 MBEDTLS_SSL_DEBUG_RET(
1801 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 ret);
1803 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001804 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001806#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001807 if (0 /* Other kinds of KEMs */) {
1808 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001809 ((void) ssl);
1810 ((void) named_group);
1811 ((void) buf);
1812 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001813 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1814 }
1815
Gilles Peskine449bd832023-01-11 14:50:10 +01001816 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001817}
1818
1819/*
1820 * ssl_tls13_write_key_share_ext
1821 *
1822 * Structure of key_share extension in ServerHello:
1823 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001824 * struct {
1825 * NamedGroup group;
1826 * opaque key_exchange<1..2^16-1>;
1827 * } KeyShareEntry;
1828 * struct {
1829 * KeyShareEntry server_share;
1830 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001831 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001832MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001833static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1834 unsigned char *buf,
1835 unsigned char *end,
1836 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001837{
Jerry Yu955ddd72022-04-22 22:27:33 +08001838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001840 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001841 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001842 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843
1844 *out_len = 0;
1845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001847
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1849 mbedtls_ssl_named_group_to_str(group),
1850 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001851
Jerry Yu3bf2c642022-03-30 22:02:12 +08001852 /* Check if we have space for header and length fields:
1853 * - extension_type (2 bytes)
1854 * - extension_data_length (2 bytes)
1855 * - group (2 bytes)
1856 * - key_exchange_length (2 bytes)
1857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1859 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1860 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001861 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001862
Jerry Yu3bf2c642022-03-30 22:02:12 +08001863 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1864 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001865 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001866 ssl, group, server_share + 4, end, &key_exchange_length);
1867 if (ret != 0) {
1868 return ret;
1869 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001870 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001873
Gilles Peskine449bd832023-01-11 14:50:10 +01001874 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001875
Jerry Yu57d48412022-04-20 21:50:42 +08001876 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001879
Gilles Peskine449bd832023-01-11 14:50:10 +01001880 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001881}
Jerry Yud9436a12022-04-20 22:28:09 +08001882
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001883MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001884static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1885 unsigned char *buf,
1886 unsigned char *end,
1887 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001888{
1889 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1890 /* key_share Extension
1891 *
1892 * struct {
1893 * select (Handshake.msg_type) {
1894 * ...
1895 * case hello_retry_request:
1896 * NamedGroup selected_group;
1897 * ...
1898 * };
1899 * } KeyShare;
1900 */
1901
1902 *out_len = 0;
1903
Jerry Yub0ac10b2022-05-05 11:10:08 +08001904 /*
1905 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1906 * of the HRR is then to transmit a cookie to force the client to demonstrate
1907 * reachability at their apparent network address (primarily useful for DTLS).
1908 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1910 return 0;
1911 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001912
1913 /* We should only send the key_share extension if the client's initial
1914 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001915 if (ssl->handshake->offered_group_id != 0) {
1916 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1917 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001918 }
1919
Gilles Peskine449bd832023-01-11 14:50:10 +01001920 if (selected_group == 0) {
1921 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1922 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001923 }
1924
Jerry Yub0ac10b2022-05-05 11:10:08 +08001925 /* Check if we have enough space:
1926 * - extension_type (2 bytes)
1927 * - extension_data_length (2 bytes)
1928 * - selected_group (2 bytes)
1929 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001931
Gilles Peskine449bd832023-01-11 14:50:10 +01001932 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1933 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1934 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001935
Gilles Peskine449bd832023-01-11 14:50:10 +01001936 MBEDTLS_SSL_DEBUG_MSG(3,
1937 ("HRR selected_group: %s (%x)",
1938 mbedtls_ssl_named_group_to_str(selected_group),
1939 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001940
1941 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001944
Gilles Peskine449bd832023-01-11 14:50:10 +01001945 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001946}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001947
1948/*
1949 * Structure of ServerHello message:
1950 *
1951 * struct {
1952 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1953 * Random random;
1954 * opaque legacy_session_id_echo<0..32>;
1955 * CipherSuite cipher_suite;
1956 * uint8 legacy_compression_method = 0;
1957 * Extension extensions<6..2^16-1>;
1958 * } ServerHello;
1959 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001960MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001961static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1962 unsigned char *buf,
1963 unsigned char *end,
1964 size_t *out_len,
1965 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08001966{
Jerry Yu955ddd72022-04-22 22:27:33 +08001967 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001968 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001969 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001970 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001971
1972 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08001973 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001974
Jerry Yucfc04b32022-04-21 09:31:58 +08001975 /* ...
1976 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1977 * ...
1978 * with ProtocolVersion defined as:
1979 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001980 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001981 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
1982 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001983 p += 2;
1984
Jerry Yu1c3e6882022-04-20 21:23:40 +08001985 /* ...
1986 * Random random;
1987 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001988 * with Random defined as:
1989 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001990 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001991 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1992 if (is_hrr) {
1993 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
1994 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1995 } else {
1996 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
1997 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001998 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001999 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2000 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002001 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2002
Jerry Yucfc04b32022-04-21 09:31:58 +08002003 /* ...
2004 * opaque legacy_session_id_echo<0..32>;
2005 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002006 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002007 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2008 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2009 if (ssl->session_negotiate->id_len > 0) {
2010 memcpy(p, &ssl->session_negotiate->id[0],
2011 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002012 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002013
Gilles Peskine449bd832023-01-11 14:50:10 +01002014 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2015 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002016 }
2017
Jerry Yucfc04b32022-04-21 09:31:58 +08002018 /* ...
2019 * CipherSuite cipher_suite;
2020 * ...
2021 * with CipherSuite defined as:
2022 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002023 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2025 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002026 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002027 MBEDTLS_SSL_DEBUG_MSG(3,
2028 ("server hello, chosen ciphersuite: %s ( id=%d )",
2029 mbedtls_ssl_get_ciphersuite_name(
2030 ssl->session_negotiate->ciphersuite),
2031 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002032
Jerry Yucfc04b32022-04-21 09:31:58 +08002033 /* ...
2034 * uint8 legacy_compression_method = 0;
2035 * ...
2036 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002037 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002038 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002039
Jerry Yucfc04b32022-04-21 09:31:58 +08002040 /* ...
2041 * Extension extensions<6..2^16-1>;
2042 * ...
2043 * struct {
2044 * ExtensionType extension_type; (2 bytes)
2045 * opaque extension_data<0..2^16-1>;
2046 * } Extension;
2047 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002048 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002049 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002050 p += 2;
2051
Gilles Peskine449bd832023-01-11 14:50:10 +01002052 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2053 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002054 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002055 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2056 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002057 }
2058 p += output_len;
2059
Gilles Peskine449bd832023-01-11 14:50:10 +01002060 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2061 if (is_hrr) {
2062 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2063 } else {
2064 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2065 }
2066 if (ret != 0) {
2067 return ret;
2068 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002069 p += output_len;
2070 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002071
Ronald Cron41a443a2022-10-04 16:38:25 +02002072#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002073 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2074 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2075 if (ret != 0) {
2076 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2077 ret);
2078 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002079 }
2080 p += output_len;
2081 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002082#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2087 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002088
Jerry Yud9436a12022-04-20 22:28:09 +08002089 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002090
Gilles Peskine449bd832023-01-11 14:50:10 +01002091 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092
Jerry Yu7de2ff02022-11-08 21:43:46 +08002093 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002094 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002095 MBEDTLS_SSL_HS_SERVER_HELLO,
2096 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002097
Gilles Peskine449bd832023-01-11 14:50:10 +01002098 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002099}
2100
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002101MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002102static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002103{
2104 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002105 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2106 if (ret != 0) {
2107 MBEDTLS_SSL_DEBUG_RET(1,
2108 "mbedtls_ssl_tls13_compute_handshake_transform",
2109 ret);
2110 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002111 }
2112
Gilles Peskine449bd832023-01-11 14:50:10 +01002113 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002114}
2115
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002116MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002117static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002118{
Jerry Yu637a3f12022-04-20 21:37:58 +08002119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002120 unsigned char *buf;
2121 size_t buf_len, msg_len;
2122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002126
Gilles Peskine449bd832023-01-11 14:50:10 +01002127 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2128 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2129 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002130
Gilles Peskine449bd832023-01-11 14:50:10 +01002131 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2132 buf + buf_len,
2133 &msg_len,
2134 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002135
Jerry Yu3bf2c642022-03-30 22:02:12 +08002136 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002138
Gilles Peskine449bd832023-01-11 14:50:10 +01002139 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2140 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002143
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002144#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2145 /* The server sends a dummy change_cipher_spec record immediately
2146 * after its first handshake message. This may either be after
2147 * a ServerHello or a HelloRetryRequest.
2148 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002149 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002151#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002152 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002153#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002154
Jerry Yuf4b27e42022-03-30 17:32:21 +08002155cleanup:
2156
Gilles Peskine449bd832023-01-11 14:50:10 +01002157 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2158 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002159}
2160
Jerry Yu23d1a252022-05-12 18:08:59 +08002161
2162/*
2163 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2164 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002165MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002166static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002167{
2168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002169 if (ssl->handshake->hello_retry_request_count > 0) {
2170 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2171 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2172 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2173 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002174 }
2175
2176 /*
2177 * Create stateless transcript hash for HRR
2178 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002179 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2180 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2181 if (ret != 0) {
2182 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2183 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002184 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002186
Gilles Peskine449bd832023-01-11 14:50:10 +01002187 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002188}
2189
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002190MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002191static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002192{
2193 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2194 unsigned char *buf;
2195 size_t buf_len, msg_len;
2196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002200
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2202 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2203 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002204
Gilles Peskine449bd832023-01-11 14:50:10 +01002205 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2206 buf + buf_len,
2207 &msg_len,
2208 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002209 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002210 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002211
2212
Gilles Peskine449bd832023-01-11 14:50:10 +01002213 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2214 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002215
2216 ssl->handshake->hello_retry_request_count++;
2217
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002218#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2219 /* The server sends a dummy change_cipher_spec record immediately
2220 * after its first handshake message. This may either be after
2221 * a ServerHello or a HelloRetryRequest.
2222 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002223 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002225#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002226 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002227#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002228
2229cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002230 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2231 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002232}
2233
Jerry Yu5b64ae92022-03-30 17:15:02 +08002234/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002235 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2236 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002237
2238/*
2239 * struct {
2240 * Extension extensions<0..2 ^ 16 - 1>;
2241 * } EncryptedExtensions;
2242 *
2243 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002244MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002245static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2246 unsigned char *buf,
2247 unsigned char *end,
2248 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002249{
XiaokangQianacb39922022-06-17 10:18:48 +00002250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002251 unsigned char *p = buf;
2252 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002253 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002254 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002255
Jerry Yu4d3841a2022-04-16 12:37:19 +08002256 *out_len = 0;
2257
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002259 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002260 p += 2;
2261
Jerry Yu8937eb42022-05-03 12:12:14 +08002262 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002263 ((void) ret);
2264 ((void) output_len);
2265
2266#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2268 if (ret != 0) {
2269 return ret;
2270 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002271 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002272#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002273
Gilles Peskine449bd832023-01-11 14:50:10 +01002274 extensions_len = (p - p_extensions_len) - 2;
2275 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002276
2277 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002280
Jerry Yu7de2ff02022-11-08 21:43:46 +08002281 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002285}
2286
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002287MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002288static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002289{
2290 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2291 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002292 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 mbedtls_ssl_set_outbound_transform(ssl,
2295 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002296 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2302 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2303 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002304
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2306 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002307
2308 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002310
Gilles Peskine449bd832023-01-11 14:50:10 +01002311 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2312 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002313
Ronald Cron928cbd32022-10-04 16:14:26 +02002314#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2316 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2317 } else {
2318 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2319 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002320#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002322#endif
2323
Jerry Yu4d3841a2022-04-16 12:37:19 +08002324cleanup:
2325
Gilles Peskine449bd832023-01-11 14:50:10 +01002326 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2327 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002328}
2329
Ronald Cron928cbd32022-10-04 16:14:26 +02002330#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002331#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2332#define SSL_CERTIFICATE_REQUEST_SKIP 1
2333/* Coordination:
2334 * Check whether a CertificateRequest message should be written.
2335 * Returns a negative code on failure, or
2336 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2337 * - SSL_CERTIFICATE_REQUEST_SKIP
2338 * indicating if the writing of the CertificateRequest
2339 * should be skipped or not.
2340 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002341MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002342static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002343{
2344 int authmode;
2345
XiaokangQian40a35232022-05-07 09:02:40 +00002346#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002348 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002349 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002350#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002351 authmode = ssl->conf->authmode;
2352
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002354 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002355 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002356 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002357
XiaokangQianc3017f62022-05-13 05:55:41 +00002358 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002359
Gilles Peskine449bd832023-01-11 14:50:10 +01002360 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002361}
2362
XiaokangQiancec9ae62022-05-06 07:28:50 +00002363/*
2364 * struct {
2365 * opaque certificate_request_context<0..2^8-1>;
2366 * Extension extensions<2..2^16-1>;
2367 * } CertificateRequest;
2368 *
2369 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002370MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002371static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2372 unsigned char *buf,
2373 const unsigned char *end,
2374 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002375{
2376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2377 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002378 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002379 unsigned char *p_extensions_len;
2380
2381 *out_len = 0;
2382
2383 /* Check if we have enough space:
2384 * - certificate_request_context (1 byte)
2385 * - extensions length (2 bytes)
2386 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002387 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002388
2389 /*
2390 * Write certificate_request_context
2391 */
2392 /*
2393 * We use a zero length context for the normal handshake
2394 * messages. For post-authentication handshake messages
2395 * this request context would be set to a non-zero value.
2396 */
2397 *p++ = 0x0;
2398
2399 /*
2400 * Write extensions
2401 */
2402 /* The extensions must contain the signature_algorithms. */
2403 p_extensions_len = p;
2404 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002405 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2406 if (ret != 0) {
2407 return ret;
2408 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002409
XiaokangQianec6efb92022-05-06 09:53:10 +00002410 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002412
2413 *out_len = p - buf;
2414
Jerry Yu7de2ff02022-11-08 21:43:46 +08002415 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002417
Gilles Peskine449bd832023-01-11 14:50:10 +01002418 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002419}
2420
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002421MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002422static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002423{
2424 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002429
Gilles Peskine449bd832023-01-11 14:50:10 +01002430 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002431 unsigned char *buf;
2432 size_t buf_len, msg_len;
2433
Gilles Peskine449bd832023-01-11 14:50:10 +01002434 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2435 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2436 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002437
Gilles Peskine449bd832023-01-11 14:50:10 +01002438 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2439 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002440
2441 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002443
Gilles Peskine449bd832023-01-11 14:50:10 +01002444 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2445 ssl, buf_len, msg_len));
2446 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2447 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002448 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002449 } else {
2450 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002451 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2452 goto cleanup;
2453 }
2454
Gilles Peskine449bd832023-01-11 14:50:10 +01002455 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002456cleanup:
2457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2459 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002460}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002461
Jerry Yu4d3841a2022-04-16 12:37:19 +08002462/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002463 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002464 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002465MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002466static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002467{
Jerry Yu5a26f302022-05-10 20:46:40 +08002468 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002469
2470#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002471 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2472 mbedtls_ssl_own_cert(ssl) == NULL) {
2473 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2474 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2475 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2476 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002477 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002478#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2481 if (ret != 0) {
2482 return ret;
2483 }
2484 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2485 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002486}
2487
2488/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002489 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
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_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002493{
Gilles Peskine449bd832023-01-11 14:50:10 +01002494 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2495 if (ret != 0) {
2496 return ret;
2497 }
2498 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2499 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002500}
Ronald Cron928cbd32022-10-04 16:14:26 +02002501#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002502
2503/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002504 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002505 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002506MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002507static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002508{
Jerry Yud6e253d2022-05-18 13:59:24 +08002509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2512 if (ret != 0) {
2513 return ret;
2514 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2517 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002518 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002519 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2520 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2521 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002522 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2525 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002526
Gilles Peskine449bd832023-01-11 14:50:10 +01002527 if (ssl->handshake->certificate_request_sent) {
2528 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2529 } else {
2530 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2531 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2532 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002533 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002534
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002536}
2537
2538/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002539 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002540 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002541MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002542static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002543{
Jerry Yud6e253d2022-05-18 13:59:24 +08002544 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2547 if (ret != 0) {
2548 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002549 }
2550
Gilles Peskine449bd832023-01-11 14:50:10 +01002551 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2552 if (ret != 0) {
2553 MBEDTLS_SSL_DEBUG_RET(1,
2554 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2555 }
2556
2557 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2558 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002559}
2560
2561/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002562 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002563 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002564MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002565static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002566{
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002568
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002570
2571#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002572/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2573 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2574 * expected to be resolved with issue#6395.
2575 */
Pengyu Lve6487fe2022-12-06 09:30:29 +08002576#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002577 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lve6487fe2022-12-06 09:30:29 +08002578 if (!mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2579 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002580 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002581#endif
Pengyu Lve6487fe2022-12-06 09:30:29 +08002582 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
2583#else
2584 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2585#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002586 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002587}
2588
2589/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002590 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002591 */
2592#define SSL_NEW_SESSION_TICKET_SKIP 0
2593#define SSL_NEW_SESSION_TICKET_WRITE 1
2594MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002595static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002596{
2597 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002598 if (ssl->conf->f_ticket_write == NULL) {
2599 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2600 " callback is not set"));
2601 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002602 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (ssl->conf->new_session_tickets_count == 0) {
2604 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2605 " configured count is zero"));
2606 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002607 }
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 if (ssl->handshake->new_session_tickets_count == 0) {
2610 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2611 "been sent."));
2612 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002613 }
2614
Gilles Peskine449bd832023-01-11 14:50:10 +01002615 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002616}
2617
2618#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2619MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002620static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2621 unsigned char *ticket_nonce,
2622 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002623{
2624 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2625 mbedtls_ssl_session *session = ssl->session;
2626 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2627 psa_algorithm_t psa_hash_alg;
2628 int hash_length;
2629
Gilles Peskine449bd832023-01-11 14:50:10 +01002630 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002631
2632#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002633 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002634#endif
2635
Pengyu Lv9f926952022-11-17 15:22:33 +08002636 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002637 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002638 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002639#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002640 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002641 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002642#endif
Pengyu Lv9f926952022-11-17 15:22:33 +08002643 MBEDTLS_SSL_DEBUG_TICKET_FLAGS(4, session->ticket_flags);
2644
Jerry Yue67bef42022-07-07 07:29:42 +00002645 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2647 (unsigned char *) &session->ticket_age_add,
2648 sizeof(session->ticket_age_add)) != 0)) {
2649 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2650 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002651 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002652 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2653 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002654
2655 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2657 if (ret != 0) {
2658 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2659 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002660 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002661 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2662 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002663
2664 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2666 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2667 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2668 if (hash_length == -1 ||
2669 (size_t) hash_length > sizeof(session->resumption_key)) {
2670 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002671 }
2672
Jerry Yue67bef42022-07-07 07:29:42 +00002673 /* In this code the psk key length equals the length of the hash */
2674 session->resumption_key_len = hash_length;
2675 session->ciphersuite = ciphersuite_info->id;
2676
2677 /* Compute resumption key
2678 *
2679 * HKDF-Expand-Label( resumption_master_secret,
2680 * "resumption", ticket_nonce, Hash.length )
2681 */
2682 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002683 psa_hash_alg,
2684 session->app_secrets.resumption_master_secret,
2685 hash_length,
2686 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2687 ticket_nonce,
2688 ticket_nonce_size,
2689 session->resumption_key,
2690 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002691
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 if (ret != 0) {
2693 MBEDTLS_SSL_DEBUG_RET(2,
2694 "Creating the ticket-resumed PSK failed",
2695 ret);
2696 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002697 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002698 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2699 session->resumption_key,
2700 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002701
Gilles Peskine449bd832023-01-11 14:50:10 +01002702 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2703 session->app_secrets.resumption_master_secret,
2704 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002707}
2708
2709/* This function creates a NewSessionTicket message in the following format:
2710 *
2711 * struct {
2712 * uint32 ticket_lifetime;
2713 * uint32 ticket_age_add;
2714 * opaque ticket_nonce<0..255>;
2715 * opaque ticket<1..2^16-1>;
2716 * Extension extensions<0..2^16-2>;
2717 * } NewSessionTicket;
2718 *
2719 * The ticket inside the NewSessionTicket message is an encrypted container
2720 * carrying the necessary information so that the server is later able to
2721 * re-start the communication.
2722 *
2723 * The following fields are placed inside the ticket by the
2724 * f_ticket_write() function:
2725 *
2726 * - creation time (start)
2727 * - flags (flags)
2728 * - age add (ticket_age_add)
2729 * - key (key)
2730 * - key length (key_len)
2731 * - ciphersuite (ciphersuite)
2732 */
2733MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002734static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2735 unsigned char *buf,
2736 unsigned char *end,
2737 size_t *out_len,
2738 unsigned char *ticket_nonce,
2739 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002740{
2741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2742 unsigned char *p = buf;
2743 mbedtls_ssl_session *session = ssl->session;
2744 size_t ticket_len;
2745 uint32_t ticket_lifetime;
2746
2747 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002749
2750 /*
2751 * ticket_lifetime 4 bytes
2752 * ticket_age_add 4 bytes
2753 * ticket_nonce 1 + ticket_nonce_size bytes
2754 * ticket >=2 bytes
2755 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002757
2758 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002759 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2760 session,
2761 p + 9 + ticket_nonce_size + 2,
2762 end,
2763 &ticket_len,
2764 &ticket_lifetime);
2765 if (ret != 0) {
2766 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2767 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002768 }
2769 /* RFC 8446 4.6.1
2770 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2771 * unsigned integer in network byte order from the time of ticket
2772 * issuance. Servers MUST NOT use any value greater than
2773 * 604800 seconds (7 days). The value of zero indicates that the
2774 * ticket should be discarded immediately. Clients MUST NOT cache
2775 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2776 * and MAY delete tickets earlier based on local policy. A server
2777 * MAY treat a ticket as valid for a shorter period of time than what
2778 * is stated in the ticket_lifetime.
2779 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002780 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002781 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 }
2783 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2784 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2785 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002786
2787 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2789 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2790 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002791
2792 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002793 p[8] = (unsigned char) ticket_nonce_size;
2794 if (ticket_nonce_size > 0) {
2795 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002796 }
2797 p += 9 + ticket_nonce_size;
2798
2799 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002800 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002801 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002802 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002803 p += ticket_len;
2804
2805 /* Ticket Extensions
2806 *
2807 * Note: We currently don't have any extensions.
2808 * Set length to zero.
2809 */
Jerry Yuedab6372022-10-31 14:37:31 +08002810 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2811
Gilles Peskine449bd832023-01-11 14:50:10 +01002812 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2813 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002814 p += 2;
2815
2816 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2818 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002819
Jerry Yu7de2ff02022-11-08 21:43:46 +08002820 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002821 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002822
Gilles Peskine449bd832023-01-11 14:50:10 +01002823 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002824}
2825
2826/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002827 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002828 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002829static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002830{
2831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2832
Gilles Peskine449bd832023-01-11 14:50:10 +01002833 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002834
Gilles Peskine449bd832023-01-11 14:50:10 +01002835 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002836 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2837 unsigned char *buf;
2838 size_t buf_len, msg_len;
2839
Gilles Peskine449bd832023-01-11 14:50:10 +01002840 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2841 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002842
Gilles Peskine449bd832023-01-11 14:50:10 +01002843 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2844 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2845 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2848 ssl, buf, buf + buf_len, &msg_len,
2849 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2852 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002853
Jerry Yu359e65f2022-09-22 23:47:43 +08002854 /* Limit session tickets count to one when resumption connection.
2855 *
2856 * See document of mbedtls_ssl_conf_new_session_tickets.
2857 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002858 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002859 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002860 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002861 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002862 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002863
Jerry Yua8d3c502022-10-30 14:51:23 +08002864 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2866 } else {
2867 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002868 }
2869
Jerry Yue67bef42022-07-07 07:29:42 +00002870cleanup:
2871
Gilles Peskine449bd832023-01-11 14:50:10 +01002872 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002873}
2874#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2875
2876/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002877 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002878 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002879int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002880{
XiaokangQian08037552022-04-20 07:16:41 +00002881 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002882
Gilles Peskine449bd832023-01-11 14:50:10 +01002883 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2884 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2885 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002886
Gilles Peskine449bd832023-01-11 14:50:10 +01002887 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2888 mbedtls_ssl_states_str(ssl->state),
2889 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002890
Gilles Peskine449bd832023-01-11 14:50:10 +01002891 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002892 /* start state */
2893 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002894 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002895 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002896 break;
2897
XiaokangQian7807f9f2022-02-15 10:04:37 +00002898 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002899 ret = ssl_tls13_process_client_hello(ssl);
2900 if (ret != 0) {
2901 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2902 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002903 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002904
Jerry Yuf41553b2022-05-09 22:20:30 +08002905 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002906 ret = ssl_tls13_write_hello_retry_request(ssl);
2907 if (ret != 0) {
2908 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2909 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002910 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002911 break;
2912
Jerry Yu5b64ae92022-03-30 17:15:02 +08002913 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002915 break;
2916
Xiaofei Baicba64af2022-02-15 10:00:56 +00002917 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002918 ret = ssl_tls13_write_encrypted_extensions(ssl);
2919 if (ret != 0) {
2920 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2921 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002922 }
Jerry Yu48330562022-05-06 21:35:44 +08002923 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002924
Ronald Cron928cbd32022-10-04 16:14:26 +02002925#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002926 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002928 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002929
Jerry Yu83da34e2022-04-16 13:59:52 +08002930 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002931 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002932 break;
2933
2934 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002936 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002937#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002938
Gilles Peskine449bd832023-01-11 14:50:10 +01002939 /*
2940 * Injection of dummy-CCS's for middlebox compatibility
2941 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002942#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002943 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002944 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2945 if (ret == 0) {
2946 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2947 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002948 break;
2949
2950 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002951 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2952 if (ret == 0) {
2953 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2954 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002955 break;
2956#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2957
Jerry Yu69dd8d42022-04-16 12:51:26 +08002958 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002959 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002960 break;
2961
2962 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002963 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002964 break;
2965
Jerry Yu69dd8d42022-04-16 12:51:26 +08002966 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002968 break;
2969
Ronald Cron766c0cd2022-10-18 12:17:11 +02002970#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00002971 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2973 if (ret == 0) {
2974 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02002975 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2977 } else {
2978 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02002979 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002981 }
XiaokangQian6b916b12022-04-25 07:29:34 +00002982 }
2983 break;
2984
2985 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002986 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2987 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00002988 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002989 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00002990 }
2991 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02002992#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00002993
Jerry Yue67bef42022-07-07 07:29:42 +00002994#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08002995 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01002996 ret = ssl_tls13_write_new_session_ticket(ssl);
2997 if (ret != 0) {
2998 MBEDTLS_SSL_DEBUG_RET(1,
2999 "ssl_tls13_write_new_session_ticket ",
3000 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003001 }
3002 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003003 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003004 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003005 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003006 * as part of ssl_prepare_handshake_step.
3007 */
3008 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003009
Gilles Peskine449bd832023-01-11 14:50:10 +01003010 if (ssl->handshake->new_session_tickets_count == 0) {
3011 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3012 } else {
3013 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3014 }
Jerry Yue67bef42022-07-07 07:29:42 +00003015 break;
3016
3017#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3018
XiaokangQian7807f9f2022-02-15 10:04:37 +00003019 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3021 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003022 }
3023
Gilles Peskine449bd832023-01-11 14:50:10 +01003024 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003025}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003026
Jerry Yufb4b6472022-01-27 15:03:26 +08003027#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */