blob: 61559462bfe0f32fe81e5b815d5d460ce7e68a1e [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Manuel Pégourié-Gonnardd55d66f2023-06-20 10:14:58 +020028#include "mbedtls/oid.h"
Manuel Pégourié-Gonnard02b10d82023-03-28 12:33:20 +020029#include "md_psa.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080030
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000031#include "ssl_misc.h"
32#include "ssl_tls13_keys.h"
33#include "ssl_debug_helpers.h"
34
Jerry Yuf35ba382022-08-23 17:58:26 +080035
Jerry Yuc5a23a02022-08-25 10:51:44 +080036static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010037 mbedtls_ssl_context *ssl,
38 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080039{
40 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010041 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
42 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080043 }
Gilles Peskine449bd832023-01-11 14:50:10 +010044
45 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
46 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
47 ssl->tls_version,
48 ssl->tls_version) != 0)) {
49 return NULL;
50 }
51 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080052}
53
Ronald Cron41a443a2022-10-04 16:38:25 +020054#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000055/* From RFC 8446:
56 *
57 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
58 * struct {
59 * PskKeyExchangeMode ke_modes<1..255>;
60 * } PskKeyExchangeModes;
61 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080062MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010063static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
64 const unsigned char *buf,
65 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000066{
Jerry Yu299e31f2022-07-13 23:06:36 +080067 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000068 size_t ke_modes_len;
69 int ke_modes = 0;
70
Jerry Yu854dd9e2022-07-15 14:28:27 +080071 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010072 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080073 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000074 /* Currently, there are only two PSK modes, so even without looking
75 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010076 if (ke_modes_len > 2) {
77 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
78 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
79 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080080 }
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000083
Gilles Peskine449bd832023-01-11 14:50:10 +010084 while (ke_modes_len-- != 0) {
85 switch (*p++) {
86 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
87 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
88 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
89 break;
90 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
91 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
92 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
93 break;
94 default:
95 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
96 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
97 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000098 }
99 }
100
101 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100102 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000103}
Jerry Yu1c105562022-07-10 06:32:38 +0000104
Jerry Yue9d4fc02022-08-20 19:21:15 +0800105#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
106#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800107
108#if defined(MBEDTLS_SSL_SESSION_TICKETS)
109
110MBEDTLS_CHECK_RETURN_CRITICAL
111static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100112 mbedtls_ssl_context *ssl,
113 const unsigned char *identity,
114 size_t identity_len,
115 uint32_t obfuscated_ticket_age,
116 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800117{
Jerry Yufd310eb2022-09-06 09:16:35 +0800118 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800119 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800120#if defined(MBEDTLS_HAVE_TIME)
121 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800122 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800123 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800124#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800125
126 ((void) obfuscated_ticket_age);
127
Gilles Peskine449bd832023-01-11 14:50:10 +0100128 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800129
Jerry Yufd310eb2022-09-06 09:16:35 +0800130 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100131 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
132 return 0;
133 }
Jerry Yu95699e72022-08-21 19:22:23 +0800134
Jerry Yu4746b102022-09-13 11:11:48 +0800135 /* We create a copy of the encrypted ticket since the ticket parsing
136 * function is allowed to use its input buffer as an output buffer
137 * (in-place decryption). We do, however, need the original buffer for
138 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800139 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100140 ticket_buffer = mbedtls_calloc(1, identity_len);
141 if (ticket_buffer == NULL) {
142 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
143 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800144 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800146
Gilles Peskine449bd832023-01-11 14:50:10 +0100147 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
148 session,
149 ticket_buffer, identity_len)) != 0) {
150 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
152 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
153 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
154 } else {
155 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
156 }
Jerry Yu95699e72022-08-21 19:22:23 +0800157 }
158
159 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800161
Jerry Yuce3b95e2023-10-31 16:02:04 +0800162 if (ret == 0 && session->tls_version != MBEDTLS_SSL_VERSION_TLS1_3) {
163 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket version invalid."));
164 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
165 }
Jerry Yuce3b95e2023-10-31 16:02:04 +0800166
Gilles Peskine449bd832023-01-11 14:50:10 +0100167 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800168 goto exit;
169 }
Jerry Yu95699e72022-08-21 19:22:23 +0800170
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800171 /* RFC 8446 section 4.2.9
172 *
173 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
174 * compatible with the advertised modes; however, if a server does so,
175 * the impact will just be that the client's attempts at resumption fail.
176 *
177 * We regard the ticket with incompatible key exchange modes as not match.
178 */
Pengyu Lv18946532023-01-12 12:28:09 +0800179 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv4938a562023-01-16 11:28:49 +0800180 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
Pengyu Lv80270b22023-01-12 11:54:04 +0800181 session->ticket_flags);
Pengyu Lve2f1dbf2023-01-16 12:28:27 +0800182 if (mbedtls_ssl_tls13_check_kex_modes(
183 ssl,
184 mbedtls_ssl_session_get_ticket_flags(
185 session,
186 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800187 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
188 goto exit;
189 }
190
Gilles Peskine449bd832023-01-11 14:50:10 +0100191 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
192#if defined(MBEDTLS_HAVE_TIME)
193 now = mbedtls_time(NULL);
194
195 if (now < session->start) {
196 MBEDTLS_SSL_DEBUG_MSG(
197 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
198 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
199 (long long) now, (long long) session->start));
200 goto exit;
201 }
202
203 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800204
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800205 /* RFC 8446 section 4.6.1
206 *
207 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
208 *
209 * RFC 8446 section 4.2.11.1
210 *
211 * Clients MUST NOT attempt to use tickets which have ages greater than
212 * the "ticket_lifetime" value which was provided with the ticket.
213 *
214 * For time being, the age MUST be less than 604800 seconds (7 days).
215 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100216 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800217 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100218 3, ("Ticket age exceeds limitation ticket_age=%lu",
219 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800220 goto exit;
221 }
Jerry Yu95699e72022-08-21 19:22:23 +0800222
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800223 /* RFC 8446 section 4.2.10
224 *
225 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
226 * the ticket age for the selected PSK identity (computed by subtracting
227 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
228 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800229 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800230 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
231 * as the age units are different on the server (s) and in the
232 * client (ms) side. Add a -1000 ms tolerance window to take this
233 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800234 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800235 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100236 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
237 if (age_diff_in_ms <= -1000 ||
238 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800239 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 3, ("Ticket age outside tolerance window ( diff=%d )",
241 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800242 goto exit;
243 }
244
245 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800246
247#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800248
249exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100250 if (ret != 0) {
251 mbedtls_ssl_session_free(session);
252 }
Jerry Yu95699e72022-08-21 19:22:23 +0800253
Gilles Peskine449bd832023-01-11 14:50:10 +0100254 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
255 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800256}
257#endif /* MBEDTLS_SSL_SESSION_TICKETS */
258
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800259MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000260static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100261 mbedtls_ssl_context *ssl,
262 const unsigned char *identity,
263 size_t identity_len,
264 uint32_t obfuscated_ticket_age,
265 int *psk_type,
266 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000267{
Ronald Cron606671e2023-02-17 11:36:33 +0100268 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
269
Jerry Yu95699e72022-08-21 19:22:23 +0800270 ((void) session);
271 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800272 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800273
Gilles Peskine449bd832023-01-11 14:50:10 +0100274 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800275 ssl->handshake->resume = 0;
276
Jerry Yu95699e72022-08-21 19:22:23 +0800277#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100278 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800279 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100280 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800281 ssl->handshake->resume = 1;
282 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100283 ret = mbedtls_ssl_set_hs_psk(ssl,
284 session->resumption_key,
285 session->resumption_key_len);
286 if (ret != 0) {
287 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
288 return ret;
289 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100290
291 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
292 session->resumption_key,
293 session->resumption_key_len);
294 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
295 (unsigned) obfuscated_ticket_age));
296 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800297 }
298#endif /* MBEDTLS_SSL_SESSION_TICKETS */
299
Jerry Yu1c105562022-07-10 06:32:38 +0000300 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 if (ssl->conf->f_psk != NULL) {
302 if (ssl->conf->f_psk(
303 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
304 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000305 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000307 }
308
Gilles Peskine449bd832023-01-11 14:50:10 +0100309 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000310 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100311 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800312 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100313 mbedtls_ct_memcmp(ssl->conf->psk_identity,
314 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100315 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
316 if (ret != 0) {
317 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
318 return ret;
319 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100320 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000321 }
322
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000324}
325
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800326MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000327static int ssl_tls13_offered_psks_check_binder_match(
328 mbedtls_ssl_context *ssl,
329 const unsigned char *binder, size_t binder_len,
330 int psk_type, psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000331{
332 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800333
Jerry Yudaf375a2022-07-20 21:31:43 +0800334 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000335 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800336 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800337 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800338 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000339
Jerry Yu1c105562022-07-10 06:32:38 +0000340 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800341 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200342 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 transcript, sizeof(transcript), &transcript_len);
344 if (ret != 0) {
345 return ret;
346 }
Jerry Yu1c105562022-07-10 06:32:38 +0000347
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
349 if (ret != 0) {
350 return ret;
351 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800352
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
354 psk, psk_len, psk_type,
355 transcript,
356 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800357#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100358 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800359#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 if (ret != 0) {
361 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
362 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000363 }
364
Gilles Peskine449bd832023-01-11 14:50:10 +0100365 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
366 server_computed_binder, transcript_len);
367 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000368
Gilles Peskine449bd832023-01-11 14:50:10 +0100369 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
370 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000371 }
372
Gilles Peskine449bd832023-01-11 14:50:10 +0100373 mbedtls_platform_zeroize(server_computed_binder,
374 sizeof(server_computed_binder));
375 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000376}
Jerry Yu96a2e362022-07-21 15:11:34 +0800377
Jerry Yu5725f1c2022-08-21 17:27:16 +0800378MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800379static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100380 mbedtls_ssl_context *ssl,
381 const unsigned char *cipher_suites,
382 const unsigned char *cipher_suites_end,
383 uint16_t *selected_ciphersuite,
384 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385{
Jerry Yuf35ba382022-08-23 17:58:26 +0800386 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800387
Jerry Yu0baf9072022-08-25 11:21:04 +0800388 *selected_ciphersuite = 0;
389 *selected_ciphersuite_info = NULL;
390
Jerry Yuf35ba382022-08-23 17:58:26 +0800391 /* RFC 8446, page 55.
392 *
393 * For externally established PSKs, the Hash algorithm MUST be set when the
394 * PSK is established or default to SHA-256 if no such algorithm is defined.
395 *
396 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800397
Jerry Yu5725f1c2022-08-21 17:27:16 +0800398 /*
399 * Search for a matching ciphersuite
400 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100401 for (const unsigned char *p = cipher_suites;
402 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800403 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800404 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800405
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
407 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
408 cipher_suite);
409 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800410 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100411 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800412
Jerry Yu5725f1c2022-08-21 17:27:16 +0800413 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
414 * Otherwise, client should reject.
415 */
Dave Rodgman2eab4622023-10-05 13:30:37 +0100416 if (psk_hash_alg ==
417 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800418 *selected_ciphersuite = cipher_suite;
419 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800421 }
422 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100423 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
424 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800425}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800426
Jerry Yu82534862022-08-30 10:42:33 +0800427#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800428MBEDTLS_CHECK_RETURN_CRITICAL
429static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100430 mbedtls_ssl_context *ssl,
431 const unsigned char *cipher_suites,
432 const unsigned char *cipher_suites_end,
433 mbedtls_ssl_session *session,
434 uint16_t *selected_ciphersuite,
435 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800436{
Jerry Yu82534862022-08-30 10:42:33 +0800437
Jerry Yuf35ba382022-08-23 17:58:26 +0800438 *selected_ciphersuite = 0;
439 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
441 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800442 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
443
Gilles Peskine449bd832023-01-11 14:50:10 +0100444 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800445 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100446 }
Jerry Yu82534862022-08-30 10:42:33 +0800447
Gilles Peskine449bd832023-01-11 14:50:10 +0100448 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
449 cipher_suite);
450 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800451 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 }
Jerry Yu82534862022-08-30 10:42:33 +0800453
Jerry Yu4746b102022-09-13 11:11:48 +0800454 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800455 *selected_ciphersuite_info = ciphersuite_info;
456
Gilles Peskine449bd832023-01-11 14:50:10 +0100457 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800458 }
459
Gilles Peskine449bd832023-01-11 14:50:10 +0100460 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800461}
Jerry Yuf35ba382022-08-23 17:58:26 +0800462
Jerry Yu82534862022-08-30 10:42:33 +0800463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100464static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
465 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800466{
Jerry Yu82534862022-08-30 10:42:33 +0800467 dst->ticket_age_add = src->ticket_age_add;
468 dst->ticket_flags = src->ticket_flags;
469 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 if (src->resumption_key_len == 0) {
471 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
472 }
473 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800474
Gilles Peskine449bd832023-01-11 14:50:10 +0100475 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800476}
477#endif /* MBEDTLS_SSL_SESSION_TICKETS */
478
Jerry Yu1c105562022-07-10 06:32:38 +0000479/* Parser for pre_shared_key extension in client hello
480 * struct {
481 * opaque identity<1..2^16-1>;
482 * uint32 obfuscated_ticket_age;
483 * } PskIdentity;
484 *
485 * opaque PskBinderEntry<32..255>;
486 *
487 * struct {
488 * PskIdentity identities<7..2^16-1>;
489 * PskBinderEntry binders<33..2^16-1>;
490 * } OfferedPsks;
491 *
492 * struct {
493 * select (Handshake.msg_type) {
494 * case client_hello: OfferedPsks;
495 * ....
496 * };
497 * } PreSharedKeyExtension;
498 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800499MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000500static int ssl_tls13_parse_pre_shared_key_ext(
501 mbedtls_ssl_context *ssl,
502 const unsigned char *pre_shared_key_ext,
503 const unsigned char *pre_shared_key_ext_end,
504 const unsigned char *ciphersuites,
505 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000506{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800508 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800509 const unsigned char *p_identity_len;
510 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000511 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800512 const unsigned char *binders;
513 const unsigned char *p_binder_len;
514 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000515 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800516 int matched_identity = -1;
517 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000518
Gilles Peskine449bd832023-01-11 14:50:10 +0100519 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
520 pre_shared_key_ext,
521 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000522
Jerry Yu96a2e362022-07-21 15:11:34 +0800523 /* identities_len 2 bytes
524 * identities_data >= 7 bytes
525 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100526 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
527 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800528 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100529 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
530 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800531 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000532
Jerry Yu96a2e362022-07-21 15:11:34 +0800533 /* binders_len 2 bytes
534 * binders >= 33 bytes
535 */
Jerry Yu568ec252022-07-22 21:27:34 +0800536 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100537 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
538 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800539 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100540 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800541 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000542
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100543 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
544 identities_end - pre_shared_key_ext);
545 if (0 != ret) {
546 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
547 return ret;
548 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800549
Gilles Peskine449bd832023-01-11 14:50:10 +0100550 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000551 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800552 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800553 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800554 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800555 size_t binder_len;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800556 int psk_type;
557 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800558 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800559#if defined(MBEDTLS_SSL_SESSION_TICKETS)
560 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100561 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800562#endif
Jerry Yubb852022022-07-20 21:10:44 +0800563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
565 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800566 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100567 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
568 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800569 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000570
Gilles Peskine449bd832023-01-11 14:50:10 +0100571 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800572 binder_len = *p_binder_len;
573 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800575 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800576
Jerry Yu96a2e362022-07-21 15:11:34 +0800577 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000579 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100580 }
Jerry Yu1c105562022-07-10 06:32:38 +0000581
Jerry Yu96a2e362022-07-21 15:11:34 +0800582 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100583 ssl, identity, identity_len, obfuscated_ticket_age,
584 &psk_type, &session);
585 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800586 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100587 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800588
Gilles Peskine449bd832023-01-11 14:50:10 +0100589 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
590 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800591 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
592 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100593 ssl, ciphersuites, ciphersuites_end,
594 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800595 break;
596 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800597#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800598 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100599 ssl, ciphersuites, ciphersuites_end, &session,
600 &cipher_suite, &ciphersuite_info);
601 if (ret != 0) {
602 mbedtls_ssl_session_free(&session);
603 }
Jerry Yu82534862022-08-30 10:42:33 +0800604#else
605 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
606#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800607 break;
608 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100609 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800610 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800612 /* See below, no cipher_suite available, abort handshake */
613 MBEDTLS_SSL_PEND_FATAL_ALERT(
614 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100615 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800616 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 2, "ssl_tls13_select_ciphersuite", ret);
618 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800619 }
620
Jerry Yu96a2e362022-07-21 15:11:34 +0800621 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100622 ssl, binder, binder_len, psk_type,
Dave Rodgman2eab4622023-10-05 13:30:37 +0100623 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac));
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800625 /* For security reasons, the handshake should be aborted when we
626 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
627 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800628#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100629 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800630#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000632 MBEDTLS_SSL_DEBUG_RET(
633 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800634 MBEDTLS_SSL_PEND_FATAL_ALERT(
635 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100636 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
637 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800638 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800639
640 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800641
642 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800643 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800644 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100645 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
646 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800647#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100648 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
649 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
650 &session);
651 mbedtls_ssl_session_free(&session);
652 if (ret != 0) {
653 return ret;
654 }
Jerry Yu82534862022-08-30 10:42:33 +0800655 }
656#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000657 }
658
Gilles Peskine449bd832023-01-11 14:50:10 +0100659 if (p_identity_len != identities_end || p_binder_len != binders_end) {
660 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
661 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
662 MBEDTLS_ERR_SSL_DECODE_ERROR);
663 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000664 }
665
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800666 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000667 ret = ssl->handshake->update_checksum(
668 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100669 if (0 != ret) {
670 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
671 return ret;
672 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 if (matched_identity == -1) {
674 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
675 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000676 }
677
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 ssl->handshake->selected_identity = (uint16_t) matched_identity;
679 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000680
Gilles Peskine449bd832023-01-11 14:50:10 +0100681 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000682}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000683
684/*
685 * struct {
686 * select ( Handshake.msg_type ) {
687 * ....
688 * case server_hello:
689 * uint16 selected_identity;
690 * }
691 * } PreSharedKeyExtension;
692 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100693static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
694 unsigned char *buf,
695 unsigned char *end,
696 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000697{
Gilles Peskine449bd832023-01-11 14:50:10 +0100698 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000699
700 *olen = 0;
701
David Horstmann21b89762022-10-06 18:34:28 +0100702 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000703#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100704 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000707#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100708 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000709 /* We shouldn't have called this extension writer unless we've
710 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100711 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000712 }
713
Gilles Peskine449bd832023-01-11 14:50:10 +0100714 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
715 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000716
Gilles Peskine449bd832023-01-11 14:50:10 +0100717 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
718 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000719
Gilles Peskine449bd832023-01-11 14:50:10 +0100720 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000721
722 *olen = 6;
723
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
725 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000726
Gilles Peskine449bd832023-01-11 14:50:10 +0100727 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800728
Gilles Peskine449bd832023-01-11 14:50:10 +0100729 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000730}
731
Ronald Cron41a443a2022-10-04 16:38:25 +0200732#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000733
XiaokangQian7807f9f2022-02-15 10:04:37 +0000734/* From RFC 8446:
735 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000736 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737 * } SupportedVersions;
738 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200739MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100740static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
741 const unsigned char *buf,
742 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000743{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000744 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000745 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000746 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000747 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100748 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000749
Gilles Peskine449bd832023-01-11 14:50:10 +0100750 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000751 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000752 p += 1;
753
Gilles Peskine449bd832023-01-11 14:50:10 +0100754 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000755 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100756 while (p < versions_end) {
757 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
758 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000759 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000760
Ronald Cron3bd2b022023-04-03 16:45:39 +0200761 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100762 found_supported_version = 1;
763 break;
764 }
765
Ronald Cron3bd2b022023-04-03 16:45:39 +0200766 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
767 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100768 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000769 break;
770 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000771 }
772
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100773 if (!found_supported_version) {
774 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000775
Gilles Peskine449bd832023-01-11 14:50:10 +0100776 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
777 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
778 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000779 }
780
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100781 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000783
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100784 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000785}
786
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200787#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000788/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000789 *
790 * From RFC 8446:
791 * enum {
792 * ... (0xFFFF)
793 * } NamedGroup;
794 * struct {
795 * NamedGroup named_group_list<2..2^16-1>;
796 * } NamedGroupList;
797 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200798MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100799static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
800 const unsigned char *buf,
801 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000802{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000803 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000804 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000805 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000806
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
808 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
809 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000810 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100811 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000812 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000813 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814
Gilles Peskine449bd832023-01-11 14:50:10 +0100815 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000816 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100817 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
818 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000819 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000820
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 MBEDTLS_SSL_DEBUG_MSG(2,
822 ("got named group: %s(%04x)",
823 mbedtls_ssl_named_group_to_str(named_group),
824 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000825
Gilles Peskine449bd832023-01-11 14:50:10 +0100826 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
827 !mbedtls_ssl_named_group_is_supported(named_group) ||
828 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000829 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000830 }
831
Gilles Peskine449bd832023-01-11 14:50:10 +0100832 MBEDTLS_SSL_DEBUG_MSG(2,
833 ("add named group %s(%04x) into received list.",
834 mbedtls_ssl_named_group_to_str(named_group),
835 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800836
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000837 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000838 }
839
Gilles Peskine449bd832023-01-11 14:50:10 +0100840 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000841
842}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200843#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000844
XiaokangQian08037552022-04-20 07:16:41 +0000845#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
846
Valerio Settic9ae8622023-07-25 11:23:50 +0200847#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000848/*
849 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000850 * extension is correct and stores the first acceptable key share and its
851 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000852 *
853 * Possible return values are:
854 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000855 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
856 * the client does not match a group supported by the server. A
857 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000858 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800859 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200860MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100861static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
862 const unsigned char *buf,
863 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864{
XiaokangQianb67384d2022-04-19 00:02:38 +0000865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000866 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000867 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800868 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000869
870 /* From RFC 8446:
871 *
872 * struct {
873 * KeyShareEntry client_shares<0..2^16-1>;
874 * } KeyShareClientHello;
875 *
876 */
877
Gilles Peskine449bd832023-01-11 14:50:10 +0100878 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
879 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000880 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100881 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000882
883 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000884 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000885
886 /* We try to find a suitable key share entry and copy it to the
887 * handshake context. Later, we have to find out whether we can do
888 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000889 * dismiss it and send a HelloRetryRequest message.
890 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000891
Gilles Peskine449bd832023-01-11 14:50:10 +0100892 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000893 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800894 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800895 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000896
897 /*
898 * struct {
899 * NamedGroup group;
900 * opaque key_exchange<1..2^16-1>;
901 * } KeyShareEntry;
902 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
904 group = MBEDTLS_GET_UINT16_BE(p, 0);
905 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800906 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800907 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100908 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800909 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000910
911 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000912 * for input validation purposes.
913 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100914 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
915 !mbedtls_ssl_named_group_is_supported(group) ||
916 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000917 continue;
918 }
XiaokangQian060d8672022-04-21 09:24:56 +0000919
XiaokangQian7807f9f2022-02-15 10:04:37 +0000920 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200921 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000922 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200923 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200924 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200925 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100926 mbedtls_ssl_named_group_to_str(group),
927 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200928 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 ssl, key_exchange - 2, key_exchange_len + 2);
930 if (ret != 0) {
931 return ret;
932 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000933
Gilles Peskine449bd832023-01-11 14:50:10 +0100934 } else {
935 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
936 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937 continue;
938 }
939
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000940 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000941 }
942
Jerry Yuc1be19f2022-04-23 16:11:39 +0800943
Gilles Peskine449bd832023-01-11 14:50:10 +0100944 if (ssl->handshake->offered_group_id == 0) {
945 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
946 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000947 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100948 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000949}
Valerio Settic9ae8622023-07-25 11:23:50 +0200950#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000951
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100953static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
954 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000955{
Jerry Yu0c354a22022-08-29 15:25:36 +0800956 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100957 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000958}
959
Jerry Yue5991322022-11-07 14:03:44 +0800960#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200961MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000962static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100963 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000964{
Gilles Peskine449bd832023-01-11 14:50:10 +0100965 return ssl_tls13_client_hello_has_exts(
966 ssl,
967 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
968 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
969 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000970}
Jerry Yue5991322022-11-07 14:03:44 +0800971#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000972
Jerry Yue5991322022-11-07 14:03:44 +0800973#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000974MBEDTLS_CHECK_RETURN_CRITICAL
975static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100976 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000977{
Gilles Peskine449bd832023-01-11 14:50:10 +0100978 return ssl_tls13_client_hello_has_exts(
979 ssl,
980 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
981 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000982}
Jerry Yue5991322022-11-07 14:03:44 +0800983#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000984
Jerry Yue5991322022-11-07 14:03:44 +0800985#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000986MBEDTLS_CHECK_RETURN_CRITICAL
987static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100988 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000989{
Gilles Peskine449bd832023-01-11 14:50:10 +0100990 return ssl_tls13_client_hello_has_exts(
991 ssl,
992 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
993 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
994 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
995 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000996}
Jerry Yue5991322022-11-07 14:03:44 +0800997#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000998
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200999MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001000static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001001{
Jerry Yue5991322022-11-07 14:03:44 +08001002#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001003 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
1004 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +08001005#else
1006 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001007 return 0;
Jerry Yue5991322022-11-07 14:03:44 +08001008#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001009}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001010
Jerry Yu77f01482022-07-11 07:03:24 +00001011MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001012static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001013{
Jerry Yue5991322022-11-07 14:03:44 +08001014#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1016 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1017 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001018#else
1019 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001020 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001021#endif
1022}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001023
Jerry Yu77f01482022-07-11 07:03:24 +00001024MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001025static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001026{
Jerry Yue5991322022-11-07 14:03:44 +08001027#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1029 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1030 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001031#else
1032 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001033 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001034#endif
1035}
1036
Gilles Peskine449bd832023-01-11 14:50:10 +01001037static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001038{
1039 /*
1040 * Determine the key exchange algorithm to use.
1041 * There are three types of key exchanges supported in TLS 1.3:
1042 * - (EC)DH with ECDSA,
1043 * - (EC)DH with PSK,
1044 * - plain PSK.
1045 *
1046 * The PSK-based key exchanges may additionally be used with 0-RTT.
1047 *
1048 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001049 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1050 * 2 ) Certificate Mode ( ephemeral )
1051 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001052 */
1053
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001054 ssl->handshake->key_exchange_mode =
1055 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
Jerry Yu77f01482022-07-11 07:03:24 +00001056
Gilles Peskine449bd832023-01-11 14:50:10 +01001057 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001058 ssl->handshake->key_exchange_mode =
1059 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1061 } else
1062 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001063 ssl->handshake->key_exchange_mode =
1064 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1066 } else
1067 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001068 ssl->handshake->key_exchange_mode =
1069 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1071 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001072 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001073 1,
1074 ("ClientHello message misses mandatory extensions."));
1075 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1076 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1077 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001078 }
1079
Gilles Peskine449bd832023-01-11 14:50:10 +01001080 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001081
XiaokangQian7807f9f2022-02-15 10:04:37 +00001082}
1083
XiaokangQian81802f42022-06-10 13:25:22 +00001084#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001085 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001086
1087#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001088static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001089{
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001097 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001098 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001099 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001100 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001101 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001102 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001103 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001105 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001107 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001109 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001111 }
1112}
1113#endif /* MBEDTLS_USE_PSA_CRYPTO */
1114
XiaokangQian23c5be62022-06-07 02:04:34 +00001115/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001116 * Pick best ( private key, certificate chain ) pair based on the signature
1117 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001118 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001119MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001120static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001121{
XiaokangQianfb665a82022-06-15 03:57:21 +00001122 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001123 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001124
1125#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001126 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001127 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001128 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001129#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001130 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 if (key_cert_list == NULL) {
1133 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1134 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001135 }
1136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1138 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001139 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001140 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001143 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001144 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001145
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 for (key_cert = key_cert_list; key_cert != NULL;
1147 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001148#if defined(MBEDTLS_USE_PSA_CRYPTO)
1149 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1150#endif /* MBEDTLS_USE_PSA_CRYPTO */
1151
Gilles Peskine449bd832023-01-11 14:50:10 +01001152 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1153 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001154
1155 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001156 * This avoids sending the client a cert it'll reject based on
1157 * keyUsage or other extensions.
1158 */
1159 if (mbedtls_x509_crt_check_key_usage(
1160 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001161 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001162 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001163 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1164 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1165 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001166 continue;
1167 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001168
Gilles Peskine449bd832023-01-11 14:50:10 +01001169 MBEDTLS_SSL_DEBUG_MSG(3,
1170 ("ssl_tls13_pick_key_cert:"
1171 "check signature algorithm %s [%04x]",
1172 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1173 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001174#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001175 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001176#endif /* MBEDTLS_USE_PSA_CRYPTO */
1177
Gilles Peskine449bd832023-01-11 14:50:10 +01001178 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1179 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001180#if defined(MBEDTLS_USE_PSA_CRYPTO)
1181 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1183 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001184#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001185 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001186 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001187 MBEDTLS_SSL_DEBUG_MSG(3,
1188 ("ssl_tls13_pick_key_cert:"
1189 "selected signature algorithm"
1190 " %s [%04x]",
1191 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1192 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001193 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001194 3, "selected certificate (chain)",
1195 ssl->handshake->key_cert->cert);
1196 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001197 }
XiaokangQian81802f42022-06-10 13:25:22 +00001198 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001199 }
1200
Gilles Peskine449bd832023-01-11 14:50:10 +01001201 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1202 "no suitable certificate found"));
1203 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001204}
XiaokangQian81802f42022-06-10 13:25:22 +00001205#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001206 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001207
XiaokangQian4080a7f2022-04-11 09:55:18 +00001208/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001209 *
1210 * STATE HANDLING: ClientHello
1211 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001212 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001213 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001214 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001215 *
1216 * In this case, the server progresses to sending its ServerHello.
1217 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001218 * 2) The ClientHello was well-formed but didn't match the server's
1219 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001220 *
1221 * For example, the client might not have offered a key share which
1222 * the server supports, or the server might require a cookie.
1223 *
1224 * In this case, the server sends a HelloRetryRequest.
1225 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001226 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001227 *
1228 * In this case, we abort the handshake.
1229 *
1230 */
1231
1232/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001233 * Structure of this message:
1234 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001235 * uint16 ProtocolVersion;
1236 * opaque Random[32];
1237 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001238 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001239 * struct {
1240 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1241 * Random random;
1242 * opaque legacy_session_id<0..32>;
1243 * CipherSuite cipher_suites<2..2^16-2>;
1244 * opaque legacy_compression_methods<1..2^8-1>;
1245 * Extension extensions<8..2^16-1>;
1246 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001247 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001248
1249#define SSL_CLIENT_HELLO_OK 0
1250#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001251#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001252
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001253MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001254static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1255 const unsigned char *buf,
1256 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257{
XiaokangQianb67384d2022-04-19 00:02:38 +00001258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1259 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001260 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001261 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001262 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001263 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001264 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001265 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001266 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001267 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001268 const unsigned char *supported_versions_data;
1269 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001270 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001271 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001272 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273
Ronald Cron41a443a2022-10-04 16:38:25 +02001274#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu29d9faa2022-08-23 17:52:45 +08001275 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001276 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001277#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001278
XiaokangQian7807f9f2022-02-15 10:04:37 +00001279 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001280 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001281 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001282 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001283 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001284 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001285 * .. . .. ciphersuite list length ( 2 bytes )
1286 * .. . .. ciphersuite list
1287 * .. . .. compression alg. list length ( 1 byte )
1288 * .. . .. compression alg. list
1289 * .. . .. extensions length ( 2 bytes, optional )
1290 * .. . .. extensions ( optional )
1291 */
1292
XiaokangQianb67384d2022-04-19 00:02:38 +00001293 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001294 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001295 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1296 * read at least up to session id length without worrying.
1297 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001298 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001299
1300 /* ...
1301 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1302 * ...
1303 * with ProtocolVersion defined as:
1304 * uint16 ProtocolVersion;
1305 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001306 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1307 MBEDTLS_SSL_VERSION_TLS1_2) {
1308 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1309 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1310 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1311 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001312 }
1313 p += 2;
1314
Jerry Yuc1be19f2022-04-23 16:11:39 +08001315 /* ...
1316 * Random random;
1317 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001318 * with Random defined as:
1319 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320 */
Ronald Crond540d992023-03-07 09:41:48 +01001321 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001322 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323
Jerry Yuc1be19f2022-04-23 16:11:39 +08001324 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001325 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001326 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001327 */
Ronald Croncada4102023-03-07 09:51:39 +01001328 legacy_session_id_len = *(p++);
1329 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330
XiaokangQianb67384d2022-04-19 00:02:38 +00001331 /*
1332 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001333 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001334 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001335 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001336 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001338 /* ...
1339 * CipherSuite cipher_suites<2..2^16-2>;
1340 * ...
1341 * with CipherSuite defined as:
1342 * uint8 CipherSuite[2];
1343 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001344 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001345 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001346 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001347
Ronald Cronfc7ae872023-02-16 15:32:19 +01001348 /*
1349 * The length of the ciphersuite list has to be even.
1350 */
1351 if (cipher_suites_len & 1) {
1352 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1353 MBEDTLS_ERR_SSL_DECODE_ERROR);
1354 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1355 }
1356
XiaokangQianb67384d2022-04-19 00:02:38 +00001357 /* Check we have enough data for the ciphersuite list, the legacy
1358 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001359 *
1360 * cipher_suites cipher_suites_len bytes
1361 * legacy_compression_methods 2 bytes
1362 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001363 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001364 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001365 p += cipher_suites_len;
1366 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001367
1368 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001369 * Search for the supported versions extension and parse it to determine
1370 * if the client supports TLS 1.3.
1371 */
1372 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1373 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001374 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001375 if (ret < 0) {
1376 MBEDTLS_SSL_DEBUG_RET(1,
1377 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1378 return ret;
1379 }
1380
1381 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001382 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001383 }
1384
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001385 if (ret == 1) {
1386 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001387 supported_versions_data,
1388 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001389 if (ret < 0) {
1390 MBEDTLS_SSL_DEBUG_RET(1,
1391 ("ssl_tls13_parse_supported_versions_ext"), ret);
1392 return ret;
1393 }
1394
Ronald Cronb828c7d2023-04-03 16:37:22 +02001395 /*
1396 * The supported versions extension was parsed successfully as the
1397 * value returned by ssl_tls13_parse_supported_versions_ext() is
1398 * positive. The return value is then equal to
1399 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1400 * the TLS version to negotiate.
1401 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001402 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1403 return SSL_CLIENT_HELLO_TLS1_2;
1404 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001405 }
1406
1407 /*
1408 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001409 */
1410 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1411
1412#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1413 /* Store minor version for later use with ticket serialization. */
1414 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1415 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1416#endif
1417
1418 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001419 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001420 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001421 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001422 */
1423 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1424 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1425 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1426
Ronald Croncada4102023-03-07 09:51:39 +01001427 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1428 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1429 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1430 }
1431 ssl->session_negotiate->id_len = legacy_session_id_len;
1432 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1433 legacy_session_id, legacy_session_id_len);
1434 memcpy(&ssl->session_negotiate->id[0],
1435 legacy_session_id, legacy_session_id_len);
1436
Ronald Crond540d992023-03-07 09:41:48 +01001437 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001438 * Search for a matching ciphersuite
1439 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001440 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1441 cipher_suites, cipher_suites_len);
Ronald Crone45afd72023-04-04 15:10:06 +02001442 for (const unsigned char *cipher_suites_p = cipher_suites;
1443 cipher_suites_p < cipher_suites_end; cipher_suites_p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001444 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001445 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001446
Ronald Crond89360b2023-02-21 08:53:33 +01001447 /*
Ronald Crone45afd72023-04-04 15:10:06 +02001448 * "cipher_suites_end - cipher_suites_p is even" is an invariant of the
1449 * loop. As cipher_suites_end - cipher_suites_p > 0, we have
1450 * cipher_suites_end - cipher_suites_p >= 2 and it is thus safe to read
1451 * two bytes.
Ronald Crond89360b2023-02-21 08:53:33 +01001452 */
Ronald Crone45afd72023-04-04 15:10:06 +02001453 cipher_suite = MBEDTLS_GET_UINT16_BE(cipher_suites_p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001454 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001455 ssl, cipher_suite);
1456 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001457 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001458 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001459
Jerry Yu5725f1c2022-08-21 17:27:16 +08001460 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001461 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001462 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1463 cipher_suite,
1464 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001465 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001466 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001467
Gilles Peskine449bd832023-01-11 14:50:10 +01001468 if (handshake->ciphersuite_info == NULL) {
1469 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1470 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1471 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001472 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001473
XiaokangQian4080a7f2022-04-11 09:55:18 +00001474 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001475 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001476 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001477 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001478 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1479 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1480 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1481 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1482 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001483 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001484 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001485
Jerry Yuc1be19f2022-04-23 16:11:39 +08001486 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001487 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001488 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001489 * with Extension defined as:
1490 * struct {
1491 * ExtensionType extension_type;
1492 * opaque extension_data<0..2^16-1>;
1493 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001494 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001496 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001497 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001498 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001499
Gilles Peskine449bd832023-01-11 14:50:10 +01001500 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001501 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001502
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001504 unsigned int extension_type;
1505 size_t extension_data_len;
1506 const unsigned char *extension_data_end;
1507
Jerry Yu0c354a22022-08-29 15:25:36 +08001508 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001509 *
1510 * The "pre_shared_key" extension MUST be the last extension in the
1511 * ClientHello (this facilitates implementation as described below).
1512 * Servers MUST check that it is the last extension and otherwise fail
1513 * the handshake with an "illegal_parameter" alert.
1514 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001516 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001517 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001518 MBEDTLS_SSL_PEND_FATAL_ALERT(
1519 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001520 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1521 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001522 }
1523
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1525 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1526 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001527 p += 4;
1528
Gilles Peskine449bd832023-01-11 14:50:10 +01001529 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001530 extension_data_end = p + extension_data_len;
1531
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001532 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001533 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1534 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1535 if (ret != 0) {
1536 return ret;
1537 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001538
Gilles Peskine449bd832023-01-11 14:50:10 +01001539 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001540#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1541 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1543 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1544 extension_data_end);
1545 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001546 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001547 1, "mbedtls_ssl_parse_servername_ext", ret);
1548 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001549 }
XiaokangQian40a35232022-05-07 09:02:40 +00001550 break;
1551#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1552
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001553#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001554 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001556
1557 /* Supported Groups Extension
1558 *
1559 * When sent by the client, the "supported_groups" extension
1560 * indicates the named groups which the client supports,
1561 * ordered from most preferred to least preferred.
1562 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001563 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001564 ssl, p, extension_data_end);
1565 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001566 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001567 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001568 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001569 }
1570
XiaokangQian7807f9f2022-02-15 10:04:37 +00001571 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001572#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001573
Valerio Settic9ae8622023-07-25 11:23:50 +02001574#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001575 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001576 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001577
1578 /*
1579 * Key Share Extension
1580 *
1581 * When sent by the client, the "key_share" extension
1582 * contains the endpoint's cryptographic parameters for
1583 * ECDHE/DHE key establishment methods.
1584 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001585 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001586 ssl, p, extension_data_end);
1587 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001588 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1589 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001590 }
1591
Gilles Peskine449bd832023-01-11 14:50:10 +01001592 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001593 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001594 1, "ssl_tls13_parse_key_shares_ext", ret);
1595 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001596 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001597
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001599#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001600
1601 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001602 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001603 break;
1604
Ronald Cron41a443a2022-10-04 16:38:25 +02001605#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001606 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001607 MBEDTLS_SSL_DEBUG_MSG(
1608 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001609
1610 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001611 ssl, p, extension_data_end);
1612 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001613 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1615 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001616 }
1617
Jerry Yue19e3b92022-07-08 12:04:51 +00001618 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001619#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001620
Jerry Yu1c105562022-07-10 06:32:38 +00001621 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1623 if ((handshake->received_extensions &
1624 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001625 MBEDTLS_SSL_PEND_FATAL_ALERT(
1626 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001627 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1628 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001629 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001630#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001631 /* Delay processing of the PSK identity once we have
1632 * found out which algorithms to use. We keep a pointer
1633 * to the buffer and the size for later processing.
1634 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001635 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001636 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001637#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001638 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001639
XiaokangQianacb39922022-06-17 10:18:48 +00001640#if defined(MBEDTLS_SSL_ALPN)
1641 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001643
Gilles Peskine449bd832023-01-11 14:50:10 +01001644 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1645 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001646 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001647 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1648 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001649 }
XiaokangQianacb39922022-06-17 10:18:48 +00001650 break;
1651#endif /* MBEDTLS_SSL_ALPN */
1652
Ronald Cron928cbd32022-10-04 16:14:26 +02001653#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001654 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001655 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001656
Gabor Mezei078e8032022-04-27 21:17:56 +02001657 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001658 ssl, p, extension_data_end);
1659 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001660 MBEDTLS_SSL_DEBUG_RET(
1661 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001662 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001663 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001664 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001665#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001666
Jan Bruckner151f6422023-02-10 12:45:19 +01001667#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1668 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1669 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1670
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001671 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1672 ssl, p, extension_data_end);
Jan Bruckner151f6422023-02-10 12:45:19 +01001673
Xiaokang Qian09c3ccc2023-04-04 10:18:38 +00001674 /*
1675 * TODO: Return unconditionally here until we handle the record
1676 * size limit correctly.
1677 * Once handled correctly, only return in case of errors.
1678 */
Jan Bruckner151f6422023-02-10 12:45:19 +01001679 return ret;
1680
1681 break;
1682#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1683
XiaokangQian7807f9f2022-02-15 10:04:37 +00001684 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001685 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001686 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001687 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001688 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001689 }
1690
1691 p += extension_data_len;
1692 }
1693
Gilles Peskine449bd832023-01-11 14:50:10 +01001694 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1695 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001696
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001697 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1698 MBEDTLS_SSL_HS_CLIENT_HELLO,
1699 p - buf);
1700 if (0 != ret) {
1701 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1702 return ret;
1703 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001704
Ronald Cron41a443a2022-10-04 16:38:25 +02001705#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001706 /* Update checksum with either
1707 * - The entire content of the CH message, if no PSK extension is present
1708 * - The content up to but excluding the PSK extension, if present.
1709 */
Jerry Yu1c105562022-07-10 06:32:38 +00001710 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001711 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1712 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1713 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001714 ret = handshake->update_checksum(ssl, buf,
1715 pre_shared_key_ext - buf);
1716 if (0 != ret) {
1717 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1718 return ret;
1719 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001720 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1721 pre_shared_key_ext,
1722 pre_shared_key_ext_end,
1723 cipher_suites,
1724 cipher_suites_end);
1725 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1726 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1727 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001728 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001729 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1730 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001731 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001732 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001733#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001734 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001735 ret = handshake->update_checksum(ssl, buf, p - buf);
1736 if (0 != ret) {
1737 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1738 return ret;
1739 }
Jerry Yu1c105562022-07-10 06:32:38 +00001740 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001741
Gilles Peskine449bd832023-01-11 14:50:10 +01001742 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1743 if (ret < 0) {
1744 return ret;
1745 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001746
Ronald Cron8a74f072023-06-14 17:59:29 +02001747 if (ssl->handshake->key_exchange_mode !=
1748 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1749 hrr_required = (no_usable_share_for_key_agreement != 0);
1750 }
1751
Gilles Peskine449bd832023-01-11 14:50:10 +01001752 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001753
Gilles Peskine449bd832023-01-11 14:50:10 +01001754 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001755}
1756
Jerry Yuab0da372023-02-08 13:55:24 +08001757#if defined(MBEDTLS_SSL_EARLY_DATA)
1758static void ssl_tls13_update_early_data_status(mbedtls_ssl_context *ssl)
1759{
1760 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1761
1762 if ((handshake->received_extensions &
1763 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) == 0) {
1764 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yub47b2992023-10-18 15:50:35 +08001765 1, ("EarlyData: no early data extension received."));
Jerry Yuab0da372023-02-08 13:55:24 +08001766 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_RECEIVED;
1767 return;
1768 }
1769
1770 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
1771
Jerry Yu985c9672022-12-04 14:06:30 +08001772 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_DISABLED) {
1773 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu985c9672022-12-04 14:06:30 +08001774 1,
Jerry Yu454dda32023-10-31 15:13:54 +08001775 ("EarlyData: rejected, feature disabled in server configuration."));
Jerry Yu985c9672022-12-04 14:06:30 +08001776 return;
1777 }
1778
Jerry Yu454dda32023-10-31 15:13:54 +08001779 if (!handshake->resume) {
1780 /* We currently support early data only in the case of PSKs established
1781 via a NewSessionTicket message thus in the case of a session
1782 resumption. */
Jerry Yu985c9672022-12-04 14:06:30 +08001783 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu454dda32023-10-31 15:13:54 +08001784 1, ("EarlyData: rejected, not resumption session."));
Jerry Yu985c9672022-12-04 14:06:30 +08001785 return;
1786 }
1787
Jerry Yu82fd6c12023-10-31 16:32:19 +08001788 /* RFC 8446 4.2.10
1789 *
1790 * In order to accept early data, the server MUST have accepted a PSK cipher
1791 * suite and selected the first key offered in the client's "pre_shared_key"
1792 * extension. In addition, it MUST verify that the following values are the
1793 * same as those associated with the selected PSK:
1794 * - The TLS version number
1795 * - The selected cipher suite
1796 * - The selected ALPN [RFC7301] protocol, if any
1797 *
1798 * NOTE:
1799 * - ALPN hasn't been checked.
1800 * - TLS version is checked in
1801 * ssl_tls13_offered_psks_check_identity_match_ticket()
1802 */
1803
1804 if (handshake->selected_identity != 0) {
1805 MBEDTLS_SSL_DEBUG_MSG(
1806 1, ("EarlyData: rejected, first psk key is not offered."));
1807 return;
1808 }
1809
1810 if (handshake->ciphersuite_info->id !=
1811 ssl->session_negotiate->ciphersuite) {
1812 MBEDTLS_SSL_DEBUG_MSG(
1813 1, ("EarlyData: rejected, selected ciphersuite mismatch."));
1814 return;
1815
1816 }
Jerry Yu985c9672022-12-04 14:06:30 +08001817
1818 /* TODO: Add more checks here. */
1819
1820 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
1821
Jerry Yuab0da372023-02-08 13:55:24 +08001822}
1823#endif /* MBEDTLS_SSL_EARLY_DATA */
1824
XiaokangQian75fe8c72022-06-15 09:42:45 +00001825/* Update the handshake state machine */
1826
Ronald Cronce7d76e2022-07-08 18:56:49 +02001827MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001828static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001829{
1830 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1831
XiaokangQian7807f9f2022-02-15 10:04:37 +00001832 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001833 * Server certificate selection
1834 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001835 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1836 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1837 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001838 }
1839#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1840 ssl->handshake->sni_name = NULL;
1841 ssl->handshake->sni_name_len = 0;
1842#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1845 if (ret != 0) {
1846 MBEDTLS_SSL_DEBUG_RET(1,
1847 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1848 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001849 }
1850
Jerry Yuab0da372023-02-08 13:55:24 +08001851#if defined(MBEDTLS_SSL_EARLY_DATA)
1852 /* There is enough information, update early data state. */
1853 ssl_tls13_update_early_data_status(ssl);
Jerry Yuab0da372023-02-08 13:55:24 +08001854#endif /* MBEDTLS_SSL_EARLY_DATA */
1855
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001857
1858}
1859
1860/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001861 * Main entry point from the state machine; orchestrates the otherfunctions.
1862 */
1863
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001864MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001865static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001866{
1867
XiaokangQian08037552022-04-20 07:16:41 +00001868 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001869 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001870 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001871 int parse_client_hello_ret;
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1876 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1877 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1880 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001881 parse_client_hello_ret = ret; /* Store positive return value of
1882 * parse_client_hello,
1883 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001884 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001885
Ronald Cronb828c7d2023-04-03 16:37:22 +02001886 /*
1887 * Version 1.2 of the protocol has been chosen, set the
1888 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1889 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1890 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1891 * will dispatch to the TLS 1.2 state machine.
1892 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001893 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
1894 ssl->keep_current_message = 1;
1895 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1896 return 0;
1897 }
1898
Gilles Peskine449bd832023-01-11 14:50:10 +01001899 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001900
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001901 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001902 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1903 } else {
1904 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1905 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001906
1907cleanup:
1908
Gilles Peskine449bd832023-01-11 14:50:10 +01001909 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1910 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001911}
1912
1913/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001914 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001915 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001916MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001917static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001918{
Jerry Yu637a3f12022-04-20 21:37:58 +08001919 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1920 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001921 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1922 if (ssl->conf->f_rng == NULL) {
1923 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1924 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001925 }
1926
Gilles Peskine449bd832023-01-11 14:50:10 +01001927 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1928 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1929 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1930 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001931 }
1932
Gilles Peskine449bd832023-01-11 14:50:10 +01001933 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1934 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001935
1936#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001937 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001938#endif /* MBEDTLS_HAVE_TIME */
1939
Gilles Peskine449bd832023-01-11 14:50:10 +01001940 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001941}
1942
Jerry Yu3bf2c642022-03-30 22:02:12 +08001943/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001944 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001945 *
1946 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001947 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001948 * } SupportedVersions;
1949 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001950MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001951static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 mbedtls_ssl_context *ssl,
1953 unsigned char *buf,
1954 unsigned char *end,
1955 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001956{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001957 *out_len = 0;
1958
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001960
1961 /* Check if we have space to write the extension:
1962 * - extension_type (2 bytes)
1963 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001964 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001965 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001966 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001967
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 mbedtls_ssl_write_version(buf + 4,
1973 ssl->conf->transport,
1974 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001975
Gilles Peskine449bd832023-01-11 14:50:10 +01001976 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1977 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001978
Jerry Yu349a6132022-04-14 20:52:56 +08001979 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001980
Jerry Yub95dd362022-11-08 21:19:34 +08001981 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001982 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001983
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001985}
1986
Jerry Yud9436a12022-04-20 22:28:09 +08001987
Jerry Yu3bf2c642022-03-30 22:02:12 +08001988
1989/* Generate and export a single key share. For hybrid KEMs, this can
1990 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001991MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001992static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1993 uint16_t named_group,
1994 unsigned char *buf,
1995 unsigned char *end,
1996 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001997{
1998 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001999
2000 *out_len = 0;
2001
Valerio Settic9ae8622023-07-25 11:23:50 +02002002#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02002003 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02002004 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02002005 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002006 ssl, named_group, buf, end, out_len);
2007 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08002008 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02002009 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01002010 ret);
2011 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002012 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002013 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02002014#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 if (0 /* Other kinds of KEMs */) {
2016 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08002017 ((void) ssl);
2018 ((void) named_group);
2019 ((void) buf);
2020 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002021 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2022 }
2023
Gilles Peskine449bd832023-01-11 14:50:10 +01002024 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002025}
2026
2027/*
2028 * ssl_tls13_write_key_share_ext
2029 *
2030 * Structure of key_share extension in ServerHello:
2031 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08002032 * struct {
2033 * NamedGroup group;
2034 * opaque key_exchange<1..2^16-1>;
2035 * } KeyShareEntry;
2036 * struct {
2037 * KeyShareEntry server_share;
2038 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002039 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002040MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002041static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
2042 unsigned char *buf,
2043 unsigned char *end,
2044 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002045{
Jerry Yu955ddd72022-04-22 22:27:33 +08002046 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002047 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08002048 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002050 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051
2052 *out_len = 0;
2053
Gilles Peskine449bd832023-01-11 14:50:10 +01002054 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2057 mbedtls_ssl_named_group_to_str(group),
2058 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002059
Jerry Yu3bf2c642022-03-30 22:02:12 +08002060 /* Check if we have space for header and length fields:
2061 * - extension_type (2 bytes)
2062 * - extension_data_length (2 bytes)
2063 * - group (2 bytes)
2064 * - key_exchange_length (2 bytes)
2065 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002066 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2067 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2068 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002069 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002070
Jerry Yu3bf2c642022-03-30 22:02:12 +08002071 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2072 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002073 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 ssl, group, server_share + 4, end, &key_exchange_length);
2075 if (ret != 0) {
2076 return ret;
2077 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002078 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002079
Gilles Peskine449bd832023-01-11 14:50:10 +01002080 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083
Jerry Yu57d48412022-04-20 21:50:42 +08002084 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002089}
Jerry Yud9436a12022-04-20 22:28:09 +08002090
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002091MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002092static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2093 unsigned char *buf,
2094 unsigned char *end,
2095 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002096{
2097 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2098 /* key_share Extension
2099 *
2100 * struct {
2101 * select (Handshake.msg_type) {
2102 * ...
2103 * case hello_retry_request:
2104 * NamedGroup selected_group;
2105 * ...
2106 * };
2107 * } KeyShare;
2108 */
2109
2110 *out_len = 0;
2111
Jerry Yub0ac10b2022-05-05 11:10:08 +08002112 /*
2113 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2114 * of the HRR is then to transmit a cookie to force the client to demonstrate
2115 * reachability at their apparent network address (primarily useful for DTLS).
2116 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002117 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2118 return 0;
2119 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002120
2121 /* We should only send the key_share extension if the client's initial
2122 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 if (ssl->handshake->offered_group_id != 0) {
2124 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2125 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002126 }
2127
Gilles Peskine449bd832023-01-11 14:50:10 +01002128 if (selected_group == 0) {
2129 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2130 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002131 }
2132
Jerry Yub0ac10b2022-05-05 11:10:08 +08002133 /* Check if we have enough space:
2134 * - extension_type (2 bytes)
2135 * - extension_data_length (2 bytes)
2136 * - selected_group (2 bytes)
2137 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002138 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2141 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2142 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002143
Gilles Peskine449bd832023-01-11 14:50:10 +01002144 MBEDTLS_SSL_DEBUG_MSG(3,
2145 ("HRR selected_group: %s (%x)",
2146 mbedtls_ssl_named_group_to_str(selected_group),
2147 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002148
2149 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002150
Gilles Peskine449bd832023-01-11 14:50:10 +01002151 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002154}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002155
2156/*
2157 * Structure of ServerHello message:
2158 *
2159 * struct {
2160 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2161 * Random random;
2162 * opaque legacy_session_id_echo<0..32>;
2163 * CipherSuite cipher_suite;
2164 * uint8 legacy_compression_method = 0;
2165 * Extension extensions<6..2^16-1>;
2166 * } ServerHello;
2167 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002168MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002169static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2170 unsigned char *buf,
2171 unsigned char *end,
2172 size_t *out_len,
2173 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002174{
Jerry Yu955ddd72022-04-22 22:27:33 +08002175 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002176 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002177 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002178 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002179
2180 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002181 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002182
Jerry Yucfc04b32022-04-21 09:31:58 +08002183 /* ...
2184 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2185 * ...
2186 * with ProtocolVersion defined as:
2187 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002188 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002189 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2190 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002191 p += 2;
2192
Jerry Yu1c3e6882022-04-20 21:23:40 +08002193 /* ...
2194 * Random random;
2195 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002196 * with Random defined as:
2197 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002198 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2200 if (is_hrr) {
2201 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2202 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2203 } else {
2204 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2205 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002206 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002207 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2208 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002209 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2210
Jerry Yucfc04b32022-04-21 09:31:58 +08002211 /* ...
2212 * opaque legacy_session_id_echo<0..32>;
2213 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002214 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002215 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2216 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2217 if (ssl->session_negotiate->id_len > 0) {
2218 memcpy(p, &ssl->session_negotiate->id[0],
2219 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002220 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002221
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2223 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002224 }
2225
Jerry Yucfc04b32022-04-21 09:31:58 +08002226 /* ...
2227 * CipherSuite cipher_suite;
2228 * ...
2229 * with CipherSuite defined as:
2230 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002231 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002232 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2233 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002234 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002235 MBEDTLS_SSL_DEBUG_MSG(3,
2236 ("server hello, chosen ciphersuite: %s ( id=%d )",
2237 mbedtls_ssl_get_ciphersuite_name(
2238 ssl->session_negotiate->ciphersuite),
2239 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002240
Jerry Yucfc04b32022-04-21 09:31:58 +08002241 /* ...
2242 * uint8 legacy_compression_method = 0;
2243 * ...
2244 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002246 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002247
Jerry Yucfc04b32022-04-21 09:31:58 +08002248 /* ...
2249 * Extension extensions<6..2^16-1>;
2250 * ...
2251 * struct {
2252 * ExtensionType extension_type; (2 bytes)
2253 * opaque extension_data<0..2^16-1>;
2254 * } Extension;
2255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002257 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002258 p += 2;
2259
Gilles Peskine449bd832023-01-11 14:50:10 +01002260 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2261 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002262 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002263 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2264 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002265 }
2266 p += output_len;
2267
Gilles Peskine449bd832023-01-11 14:50:10 +01002268 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2269 if (is_hrr) {
2270 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2271 } else {
2272 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2273 }
2274 if (ret != 0) {
2275 return ret;
2276 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002277 p += output_len;
2278 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002279
Ronald Cron41a443a2022-10-04 16:38:25 +02002280#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002281 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2282 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2283 if (ret != 0) {
2284 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2285 ret);
2286 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002287 }
2288 p += output_len;
2289 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002290#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2295 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002296
Jerry Yud9436a12022-04-20 22:28:09 +08002297 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002300
Jerry Yu7de2ff02022-11-08 21:43:46 +08002301 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002302 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 MBEDTLS_SSL_HS_SERVER_HELLO,
2304 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002305
Gilles Peskine449bd832023-01-11 14:50:10 +01002306 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002307}
2308
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002309MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002310static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002311{
2312 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2314 if (ret != 0) {
2315 MBEDTLS_SSL_DEBUG_RET(1,
2316 "mbedtls_ssl_tls13_compute_handshake_transform",
2317 ret);
2318 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002319 }
2320
Gilles Peskine449bd832023-01-11 14:50:10 +01002321 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002322}
2323
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002324MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002325static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002326{
Jerry Yu637a3f12022-04-20 21:37:58 +08002327 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002328 unsigned char *buf;
2329 size_t buf_len, msg_len;
2330
Gilles Peskine449bd832023-01-11 14:50:10 +01002331 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002332
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002334
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002335 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2336 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002337
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2339 buf + buf_len,
2340 &msg_len,
2341 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002342
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002343 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002344 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002345
Gilles Peskine449bd832023-01-11 14:50:10 +01002346 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2347 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002348
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002349 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002350
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002351#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2352 /* The server sends a dummy change_cipher_spec record immediately
2353 * after its first handshake message. This may either be after
2354 * a ServerHello or a HelloRetryRequest.
2355 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002356 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002357 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002358#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002360#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002361
Jerry Yuf4b27e42022-03-30 17:32:21 +08002362cleanup:
2363
Gilles Peskine449bd832023-01-11 14:50:10 +01002364 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2365 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002366}
2367
Jerry Yu23d1a252022-05-12 18:08:59 +08002368
2369/*
2370 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2371 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002372MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002373static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002374{
2375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002376 if (ssl->handshake->hello_retry_request_count > 0) {
2377 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2378 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2379 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2380 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002381 }
2382
2383 /*
2384 * Create stateless transcript hash for HRR
2385 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002386 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2387 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2388 if (ret != 0) {
2389 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2390 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002391 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002392 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002393
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002395}
2396
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002398static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002399{
2400 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2401 unsigned char *buf;
2402 size_t buf_len, msg_len;
2403
Gilles Peskine449bd832023-01-11 14:50:10 +01002404 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002407
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2409 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2410 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002411
Gilles Peskine449bd832023-01-11 14:50:10 +01002412 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2413 buf + buf_len,
2414 &msg_len,
2415 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002416 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002417 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002418
2419
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2421 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002422
2423 ssl->handshake->hello_retry_request_count++;
2424
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002425#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2426 /* The server sends a dummy change_cipher_spec record immediately
2427 * after its first handshake message. This may either be after
2428 * a ServerHello or a HelloRetryRequest.
2429 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002430 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002431 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002432#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002434#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002435
2436cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2438 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002439}
2440
Jerry Yu5b64ae92022-03-30 17:15:02 +08002441/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002442 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2443 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002444
2445/*
2446 * struct {
2447 * Extension extensions<0..2 ^ 16 - 1>;
2448 * } EncryptedExtensions;
2449 *
2450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002451MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002452static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2453 unsigned char *buf,
2454 unsigned char *end,
2455 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002456{
XiaokangQianacb39922022-06-17 10:18:48 +00002457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002458 unsigned char *p = buf;
2459 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002460 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002461 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002462
Jerry Yu4d3841a2022-04-16 12:37:19 +08002463 *out_len = 0;
2464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002466 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002467 p += 2;
2468
Jerry Yu8937eb42022-05-03 12:12:14 +08002469 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002470 ((void) ret);
2471 ((void) output_len);
2472
2473#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002474 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2475 if (ret != 0) {
2476 return ret;
2477 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002478 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002479#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002480
Jerry Yu71c14f12022-12-12 11:10:35 +08002481#if defined(MBEDTLS_SSL_EARLY_DATA)
2482 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2483 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &output_len);
2484 if (ret != 0) {
2485 return ret;
2486 }
2487 p += output_len;
2488 }
2489#endif /* MBEDTLS_SSL_EARLY_DATA */
2490
Gilles Peskine449bd832023-01-11 14:50:10 +01002491 extensions_len = (p - p_extensions_len) - 2;
2492 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002493
2494 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002495
Gilles Peskine449bd832023-01-11 14:50:10 +01002496 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002497
Jerry Yu7de2ff02022-11-08 21:43:46 +08002498 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002499 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002500
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002502}
2503
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002504MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002505static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002506{
2507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2508 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002509 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002510
Gilles Peskine449bd832023-01-11 14:50:10 +01002511 mbedtls_ssl_set_outbound_transform(ssl,
2512 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002513 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002515
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002517
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002518 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2519 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2520 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2523 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002524
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002525 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002526 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2527 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002528
Gilles Peskine449bd832023-01-11 14:50:10 +01002529 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2530 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002531
Ronald Cron928cbd32022-10-04 16:14:26 +02002532#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2534 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2535 } else {
2536 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2537 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002538#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002539 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002540#endif
2541
Jerry Yu4d3841a2022-04-16 12:37:19 +08002542cleanup:
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2545 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002546}
2547
Ronald Cron928cbd32022-10-04 16:14:26 +02002548#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002549#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2550#define SSL_CERTIFICATE_REQUEST_SKIP 1
2551/* Coordination:
2552 * Check whether a CertificateRequest message should be written.
2553 * Returns a negative code on failure, or
2554 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2555 * - SSL_CERTIFICATE_REQUEST_SKIP
2556 * indicating if the writing of the CertificateRequest
2557 * should be skipped or not.
2558 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002559MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002560static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002561{
2562 int authmode;
2563
XiaokangQian40a35232022-05-07 09:02:40 +00002564#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002566 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002568#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002569 authmode = ssl->conf->authmode;
2570
Gilles Peskine449bd832023-01-11 14:50:10 +01002571 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002572 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002574 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002575
XiaokangQianc3017f62022-05-13 05:55:41 +00002576 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002577
Gilles Peskine449bd832023-01-11 14:50:10 +01002578 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002579}
2580
XiaokangQiancec9ae62022-05-06 07:28:50 +00002581/*
2582 * struct {
2583 * opaque certificate_request_context<0..2^8-1>;
2584 * Extension extensions<2..2^16-1>;
2585 * } CertificateRequest;
2586 *
2587 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2590 unsigned char *buf,
2591 const unsigned char *end,
2592 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002593{
2594 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2595 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002596 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002597 unsigned char *p_extensions_len;
2598
2599 *out_len = 0;
2600
2601 /* Check if we have enough space:
2602 * - certificate_request_context (1 byte)
2603 * - extensions length (2 bytes)
2604 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002605 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002606
2607 /*
2608 * Write certificate_request_context
2609 */
2610 /*
2611 * We use a zero length context for the normal handshake
2612 * messages. For post-authentication handshake messages
2613 * this request context would be set to a non-zero value.
2614 */
2615 *p++ = 0x0;
2616
2617 /*
2618 * Write extensions
2619 */
2620 /* The extensions must contain the signature_algorithms. */
2621 p_extensions_len = p;
2622 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002623 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2624 if (ret != 0) {
2625 return ret;
2626 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002627
XiaokangQianec6efb92022-05-06 09:53:10 +00002628 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002629 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002630
2631 *out_len = p - buf;
2632
Jerry Yu7de2ff02022-11-08 21:43:46 +08002633 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002634 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002635
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002637}
2638
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002639MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002640static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002641{
2642 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2643
Gilles Peskine449bd832023-01-11 14:50:10 +01002644 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002649 unsigned char *buf;
2650 size_t buf_len, msg_len;
2651
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002652 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2653 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2654 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002655
Gilles Peskine449bd832023-01-11 14:50:10 +01002656 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2657 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002658
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002659 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002660 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2661 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002662
Gilles Peskine449bd832023-01-11 14:50:10 +01002663 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2664 ssl, buf_len, msg_len));
2665 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2666 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002667 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002668 } else {
2669 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002670 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2671 goto cleanup;
2672 }
2673
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002675cleanup:
2676
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2678 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002679}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002680
Jerry Yu4d3841a2022-04-16 12:37:19 +08002681/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002682 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002683 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002684MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002685static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002686{
Jerry Yu5a26f302022-05-10 20:46:40 +08002687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002688
2689#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2691 mbedtls_ssl_own_cert(ssl) == NULL) {
2692 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2693 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2694 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2695 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002696 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002697#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002698
Gilles Peskine449bd832023-01-11 14:50:10 +01002699 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2700 if (ret != 0) {
2701 return ret;
2702 }
2703 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2704 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002705}
2706
2707/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002708 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002709 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002710MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002711static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002712{
Gilles Peskine449bd832023-01-11 14:50:10 +01002713 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2714 if (ret != 0) {
2715 return ret;
2716 }
2717 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2718 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002719}
Ronald Cron928cbd32022-10-04 16:14:26 +02002720#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002721
2722/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002723 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002724 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002725MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002726static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002727{
Jerry Yud6e253d2022-05-18 13:59:24 +08002728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002729
Gilles Peskine449bd832023-01-11 14:50:10 +01002730 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2731 if (ret != 0) {
2732 return ret;
2733 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002734
Gilles Peskine449bd832023-01-11 14:50:10 +01002735 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2736 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002737 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002738 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2739 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2740 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002741 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002742
Gilles Peskine449bd832023-01-11 14:50:10 +01002743 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2744 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002745
Gilles Peskine449bd832023-01-11 14:50:10 +01002746 if (ssl->handshake->certificate_request_sent) {
2747 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2748 } else {
2749 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2750 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2751 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002752 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002753
Gilles Peskine449bd832023-01-11 14:50:10 +01002754 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002755}
2756
2757/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002758 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002759 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002760MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002761static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002762{
Jerry Yud6e253d2022-05-18 13:59:24 +08002763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2764
Gilles Peskine449bd832023-01-11 14:50:10 +01002765 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2766 if (ret != 0) {
2767 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002768 }
2769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2771 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002772 MBEDTLS_SSL_DEBUG_RET(
2773 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 }
2775
2776 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2777 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002778}
2779
2780/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002781 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002782 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002783MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002784static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002785{
Gilles Peskine449bd832023-01-11 14:50:10 +01002786 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002787
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002789
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002790#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2791 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002792/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2793 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2794 * expected to be resolved with issue#6395.
2795 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002796 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002797 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002798 mbedtls_ssl_handshake_set_state(
2799 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002800 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002801#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002802 {
2803 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2804 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002805 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002806}
2807
2808/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002809 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002810 */
2811#define SSL_NEW_SESSION_TICKET_SKIP 0
2812#define SSL_NEW_SESSION_TICKET_WRITE 1
2813MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002814static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002815{
2816 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 if (ssl->conf->f_ticket_write == NULL) {
2818 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2819 " callback is not set"));
2820 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002821 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 if (ssl->conf->new_session_tickets_count == 0) {
2823 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2824 " configured count is zero"));
2825 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002826 }
2827
Gilles Peskine449bd832023-01-11 14:50:10 +01002828 if (ssl->handshake->new_session_tickets_count == 0) {
2829 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2830 "been sent."));
2831 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002832 }
2833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002835}
2836
2837#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2838MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002839static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2840 unsigned char *ticket_nonce,
2841 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002842{
2843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2844 mbedtls_ssl_session *session = ssl->session;
2845 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2846 psa_algorithm_t psa_hash_alg;
2847 int hash_length;
2848
Gilles Peskine449bd832023-01-11 14:50:10 +01002849 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002850
2851#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002853#endif
2854
Pengyu Lv9f926952022-11-17 15:22:33 +08002855 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002856 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002857 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002858#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002859 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002860 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002861#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002862 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002863
Jerry Yue67bef42022-07-07 07:29:42 +00002864 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002865 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2866 (unsigned char *) &session->ticket_age_add,
2867 sizeof(session->ticket_age_add)) != 0)) {
2868 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2869 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002870 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002871 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2872 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002873
2874 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002875 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2876 if (ret != 0) {
2877 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2878 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002879 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002880 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2881 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002882
2883 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002884 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002885 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2887 if (hash_length == -1 ||
2888 (size_t) hash_length > sizeof(session->resumption_key)) {
2889 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002890 }
2891
Jerry Yue67bef42022-07-07 07:29:42 +00002892 /* In this code the psk key length equals the length of the hash */
2893 session->resumption_key_len = hash_length;
2894 session->ciphersuite = ciphersuite_info->id;
2895
2896 /* Compute resumption key
2897 *
2898 * HKDF-Expand-Label( resumption_master_secret,
2899 * "resumption", ticket_nonce, Hash.length )
2900 */
2901 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002902 psa_hash_alg,
2903 session->app_secrets.resumption_master_secret,
2904 hash_length,
2905 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2906 ticket_nonce,
2907 ticket_nonce_size,
2908 session->resumption_key,
2909 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002910
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 if (ret != 0) {
2912 MBEDTLS_SSL_DEBUG_RET(2,
2913 "Creating the ticket-resumed PSK failed",
2914 ret);
2915 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002916 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002917 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2918 session->resumption_key,
2919 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002920
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2922 session->app_secrets.resumption_master_secret,
2923 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002924
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002926}
2927
2928/* This function creates a NewSessionTicket message in the following format:
2929 *
2930 * struct {
2931 * uint32 ticket_lifetime;
2932 * uint32 ticket_age_add;
2933 * opaque ticket_nonce<0..255>;
2934 * opaque ticket<1..2^16-1>;
2935 * Extension extensions<0..2^16-2>;
2936 * } NewSessionTicket;
2937 *
2938 * The ticket inside the NewSessionTicket message is an encrypted container
2939 * carrying the necessary information so that the server is later able to
2940 * re-start the communication.
2941 *
2942 * The following fields are placed inside the ticket by the
2943 * f_ticket_write() function:
2944 *
2945 * - creation time (start)
2946 * - flags (flags)
2947 * - age add (ticket_age_add)
2948 * - key (key)
2949 * - key length (key_len)
2950 * - ciphersuite (ciphersuite)
2951 */
2952MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002953static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2954 unsigned char *buf,
2955 unsigned char *end,
2956 size_t *out_len,
2957 unsigned char *ticket_nonce,
2958 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002959{
2960 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2961 unsigned char *p = buf;
2962 mbedtls_ssl_session *session = ssl->session;
2963 size_t ticket_len;
2964 uint32_t ticket_lifetime;
2965
2966 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002968
2969 /*
2970 * ticket_lifetime 4 bytes
2971 * ticket_age_add 4 bytes
2972 * ticket_nonce 1 + ticket_nonce_size bytes
2973 * ticket >=2 bytes
2974 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002975 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002976
2977 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2979 session,
2980 p + 9 + ticket_nonce_size + 2,
2981 end,
2982 &ticket_len,
2983 &ticket_lifetime);
2984 if (ret != 0) {
2985 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2986 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002987 }
2988 /* RFC 8446 4.6.1
2989 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2990 * unsigned integer in network byte order from the time of ticket
2991 * issuance. Servers MUST NOT use any value greater than
2992 * 604800 seconds (7 days). The value of zero indicates that the
2993 * ticket should be discarded immediately. Clients MUST NOT cache
2994 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2995 * and MAY delete tickets earlier based on local policy. A server
2996 * MAY treat a ticket as valid for a shorter period of time than what
2997 * is stated in the ticket_lifetime.
2998 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002999 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00003000 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 }
3002 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
3003 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
3004 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00003005
3006 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003007 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
3008 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3009 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003010
3011 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003012 p[8] = (unsigned char) ticket_nonce_size;
3013 if (ticket_nonce_size > 0) {
3014 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003015 }
3016 p += 9 + ticket_nonce_size;
3017
3018 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01003019 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003020 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003022 p += ticket_len;
3023
3024 /* Ticket Extensions
3025 *
3026 * Note: We currently don't have any extensions.
3027 * Set length to zero.
3028 */
Jerry Yuedab6372022-10-31 14:37:31 +08003029 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
3030
Gilles Peskine449bd832023-01-11 14:50:10 +01003031 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
3032 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003033 p += 2;
3034
3035 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01003036 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
3037 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00003038
Jerry Yu7de2ff02022-11-08 21:43:46 +08003039 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01003040 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08003041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003043}
3044
3045/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003046 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003047 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003048static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003049{
3050 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3051
Gilles Peskine449bd832023-01-11 14:50:10 +01003052 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00003053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00003055 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
3056 unsigned char *buf;
3057 size_t buf_len, msg_len;
3058
Gilles Peskine449bd832023-01-11 14:50:10 +01003059 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
3060 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003061
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003062 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
3063 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3064 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003065
Gilles Peskine449bd832023-01-11 14:50:10 +01003066 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3067 ssl, buf, buf + buf_len, &msg_len,
3068 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003069
Gilles Peskine449bd832023-01-11 14:50:10 +01003070 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3071 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003072
Jerry Yu359e65f2022-09-22 23:47:43 +08003073 /* Limit session tickets count to one when resumption connection.
3074 *
3075 * See document of mbedtls_ssl_conf_new_session_tickets.
3076 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003077 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003078 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003080 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003082
Jerry Yua8d3c502022-10-30 14:51:23 +08003083 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003084 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3085 } else {
3086 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003087 }
3088
Jerry Yue67bef42022-07-07 07:29:42 +00003089cleanup:
3090
Gilles Peskine449bd832023-01-11 14:50:10 +01003091 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003092}
3093#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3094
3095/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003096 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003097 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003098int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003099{
XiaokangQian08037552022-04-20 07:16:41 +00003100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003101
Gilles Peskine449bd832023-01-11 14:50:10 +01003102 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3103 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3104 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003105
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003107 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003109
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003111 /* start state */
3112 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003113 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003114 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003115 break;
3116
XiaokangQian7807f9f2022-02-15 10:04:37 +00003117 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 ret = ssl_tls13_process_client_hello(ssl);
3119 if (ret != 0) {
3120 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3121 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003122 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003123
Jerry Yuf41553b2022-05-09 22:20:30 +08003124 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003125 ret = ssl_tls13_write_hello_retry_request(ssl);
3126 if (ret != 0) {
3127 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3128 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003129 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003130 break;
3131
Jerry Yu5b64ae92022-03-30 17:15:02 +08003132 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003133 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003134 break;
3135
Xiaofei Baicba64af2022-02-15 10:00:56 +00003136 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003137 ret = ssl_tls13_write_encrypted_extensions(ssl);
3138 if (ret != 0) {
3139 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3140 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003141 }
Jerry Yu48330562022-05-06 21:35:44 +08003142 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003143
Ronald Cron928cbd32022-10-04 16:14:26 +02003144#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003145 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003146 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003147 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003148
Jerry Yu83da34e2022-04-16 13:59:52 +08003149 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003150 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003151 break;
3152
3153 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003154 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003155 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003156#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003157
Gilles Peskine449bd832023-01-11 14:50:10 +01003158 /*
3159 * Injection of dummy-CCS's for middlebox compatibility
3160 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003161#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003162 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003163 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3164 if (ret == 0) {
3165 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3166 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003167 break;
3168
3169 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3171 if (ret == 0) {
3172 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3173 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003174 break;
3175#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3176
Jerry Yu69dd8d42022-04-16 12:51:26 +08003177 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003178 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003179 break;
3180
3181 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003182 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003183 break;
3184
Jerry Yu69dd8d42022-04-16 12:51:26 +08003185 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003186 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003187 break;
3188
Ronald Cron766c0cd2022-10-18 12:17:11 +02003189#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003190 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003191 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3192 if (ret == 0) {
3193 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003194 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003195 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3196 } else {
3197 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003198 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003199 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003200 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003201 }
3202 break;
3203
3204 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003205 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3206 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003207 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003208 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003209 }
3210 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003211#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003212
Jerry Yue67bef42022-07-07 07:29:42 +00003213#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003214 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003215 ret = ssl_tls13_write_new_session_ticket(ssl);
3216 if (ret != 0) {
3217 MBEDTLS_SSL_DEBUG_RET(1,
3218 "ssl_tls13_write_new_session_ticket ",
3219 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003220 }
3221 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003222 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003223 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003224 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003225 * as part of ssl_prepare_handshake_step.
3226 */
3227 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003228
Gilles Peskine449bd832023-01-11 14:50:10 +01003229 if (ssl->handshake->new_session_tickets_count == 0) {
3230 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3231 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003232 mbedtls_ssl_handshake_set_state(
3233 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003234 }
Jerry Yue67bef42022-07-07 07:29:42 +00003235 break;
3236
3237#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3238
XiaokangQian7807f9f2022-02-15 10:04:37 +00003239 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003240 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3241 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003242 }
3243
Gilles Peskine449bd832023-01-11 14:50:10 +01003244 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003245}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003246
Jerry Yufb4b6472022-01-27 15:03:26 +08003247#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */