blob: ee6e89c59f38162caa784f4b9dcddb36e32b988c [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) {
Jerry Yu7ef9fd82023-11-07 14:30:38 +0800163 MBEDTLS_SSL_DEBUG_MSG(3, ("Ticket TLS version is not 1.3."));
164 /* TODO: Define new return value for this case. */
Jerry Yuce3b95e2023-10-31 16:02:04 +0800165 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
166 }
Jerry Yuce3b95e2023-10-31 16:02:04 +0800167
Gilles Peskine449bd832023-01-11 14:50:10 +0100168 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800169 goto exit;
170 }
Jerry Yu95699e72022-08-21 19:22:23 +0800171
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800172 /* RFC 8446 section 4.2.9
173 *
174 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
175 * compatible with the advertised modes; however, if a server does so,
176 * the impact will just be that the client's attempts at resumption fail.
177 *
178 * We regard the ticket with incompatible key exchange modes as not match.
179 */
Pengyu Lv18946532023-01-12 12:28:09 +0800180 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv4938a562023-01-16 11:28:49 +0800181 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
Pengyu Lv80270b22023-01-12 11:54:04 +0800182 session->ticket_flags);
Pengyu Lve2f1dbf2023-01-16 12:28:27 +0800183 if (mbedtls_ssl_tls13_check_kex_modes(
184 ssl,
185 mbedtls_ssl_session_get_ticket_flags(
186 session,
187 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800188 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
189 goto exit;
190 }
191
Gilles Peskine449bd832023-01-11 14:50:10 +0100192 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
193#if defined(MBEDTLS_HAVE_TIME)
194 now = mbedtls_time(NULL);
195
196 if (now < session->start) {
197 MBEDTLS_SSL_DEBUG_MSG(
198 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
199 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
200 (long long) now, (long long) session->start));
201 goto exit;
202 }
203
204 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800205
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800206 /* RFC 8446 section 4.6.1
207 *
208 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
209 *
210 * RFC 8446 section 4.2.11.1
211 *
212 * Clients MUST NOT attempt to use tickets which have ages greater than
213 * the "ticket_lifetime" value which was provided with the ticket.
214 *
215 * For time being, the age MUST be less than 604800 seconds (7 days).
216 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100217 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800218 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100219 3, ("Ticket age exceeds limitation ticket_age=%lu",
220 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800221 goto exit;
222 }
Jerry Yu95699e72022-08-21 19:22:23 +0800223
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800224 /* RFC 8446 section 4.2.10
225 *
226 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
227 * the ticket age for the selected PSK identity (computed by subtracting
228 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
229 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800230 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800231 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
232 * as the age units are different on the server (s) and in the
233 * client (ms) side. Add a -1000 ms tolerance window to take this
234 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800235 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800236 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100237 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
238 if (age_diff_in_ms <= -1000 ||
239 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800240 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100241 3, ("Ticket age outside tolerance window ( diff=%d )",
242 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800243 goto exit;
244 }
245
246 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800247
248#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800249
250exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 if (ret != 0) {
252 mbedtls_ssl_session_free(session);
253 }
Jerry Yu95699e72022-08-21 19:22:23 +0800254
Gilles Peskine449bd832023-01-11 14:50:10 +0100255 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
256 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800257}
258#endif /* MBEDTLS_SSL_SESSION_TICKETS */
259
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800260MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000261static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 mbedtls_ssl_context *ssl,
263 const unsigned char *identity,
264 size_t identity_len,
265 uint32_t obfuscated_ticket_age,
266 int *psk_type,
267 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000268{
Ronald Cron606671e2023-02-17 11:36:33 +0100269 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
270
Jerry Yu95699e72022-08-21 19:22:23 +0800271 ((void) session);
272 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800273 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800274
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800276 ssl->handshake->resume = 0;
277
Jerry Yu95699e72022-08-21 19:22:23 +0800278#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100279 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800280 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100281 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800282 ssl->handshake->resume = 1;
283 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100284 ret = mbedtls_ssl_set_hs_psk(ssl,
285 session->resumption_key,
286 session->resumption_key_len);
287 if (ret != 0) {
288 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
289 return ret;
290 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100291
292 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
293 session->resumption_key,
294 session->resumption_key_len);
295 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
296 (unsigned) obfuscated_ticket_age));
297 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800298 }
299#endif /* MBEDTLS_SSL_SESSION_TICKETS */
300
Jerry Yu1c105562022-07-10 06:32:38 +0000301 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100302 if (ssl->conf->f_psk != NULL) {
303 if (ssl->conf->f_psk(
304 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
305 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000306 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100307 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000308 }
309
Gilles Peskine449bd832023-01-11 14:50:10 +0100310 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000311 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100312 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800313 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100314 mbedtls_ct_memcmp(ssl->conf->psk_identity,
315 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100316 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
317 if (ret != 0) {
318 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
319 return ret;
320 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100321 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000322 }
323
Gilles Peskine449bd832023-01-11 14:50:10 +0100324 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000325}
326
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800327MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000328static int ssl_tls13_offered_psks_check_binder_match(
329 mbedtls_ssl_context *ssl,
330 const unsigned char *binder, size_t binder_len,
331 int psk_type, psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000332{
333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800334
Jerry Yudaf375a2022-07-20 21:31:43 +0800335 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000336 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800337 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800338 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800339 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000340
Jerry Yu1c105562022-07-10 06:32:38 +0000341 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800342 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200343 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100344 transcript, sizeof(transcript), &transcript_len);
345 if (ret != 0) {
346 return ret;
347 }
Jerry Yu1c105562022-07-10 06:32:38 +0000348
Gilles Peskine449bd832023-01-11 14:50:10 +0100349 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
350 if (ret != 0) {
351 return ret;
352 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800353
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
355 psk, psk_len, psk_type,
356 transcript,
357 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800358#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100359 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800360#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 if (ret != 0) {
362 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
363 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000364 }
365
Gilles Peskine449bd832023-01-11 14:50:10 +0100366 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
367 server_computed_binder, transcript_len);
368 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000369
Gilles Peskine449bd832023-01-11 14:50:10 +0100370 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
371 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000372 }
373
Gilles Peskine449bd832023-01-11 14:50:10 +0100374 mbedtls_platform_zeroize(server_computed_binder,
375 sizeof(server_computed_binder));
376 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000377}
Jerry Yu96a2e362022-07-21 15:11:34 +0800378
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800380static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100381 mbedtls_ssl_context *ssl,
382 const unsigned char *cipher_suites,
383 const unsigned char *cipher_suites_end,
384 uint16_t *selected_ciphersuite,
385 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800386{
Jerry Yuf35ba382022-08-23 17:58:26 +0800387 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800388
Jerry Yu0baf9072022-08-25 11:21:04 +0800389 *selected_ciphersuite = 0;
390 *selected_ciphersuite_info = NULL;
391
Jerry Yuf35ba382022-08-23 17:58:26 +0800392 /* RFC 8446, page 55.
393 *
394 * For externally established PSKs, the Hash algorithm MUST be set when the
395 * PSK is established or default to SHA-256 if no such algorithm is defined.
396 *
397 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800398
Jerry Yu5725f1c2022-08-21 17:27:16 +0800399 /*
400 * Search for a matching ciphersuite
401 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100402 for (const unsigned char *p = cipher_suites;
403 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800404 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800405 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800406
Gilles Peskine449bd832023-01-11 14:50:10 +0100407 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
408 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
409 cipher_suite);
410 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800411 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100412 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800413
Jerry Yu5725f1c2022-08-21 17:27:16 +0800414 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
415 * Otherwise, client should reject.
416 */
Dave Rodgman2eab4622023-10-05 13:30:37 +0100417 if (psk_hash_alg ==
418 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800419 *selected_ciphersuite = cipher_suite;
420 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100421 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800422 }
423 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
425 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800426}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800427
Jerry Yu82534862022-08-30 10:42:33 +0800428#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800429MBEDTLS_CHECK_RETURN_CRITICAL
430static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100431 mbedtls_ssl_context *ssl,
432 const unsigned char *cipher_suites,
433 const unsigned char *cipher_suites_end,
434 mbedtls_ssl_session *session,
435 uint16_t *selected_ciphersuite,
436 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800437{
Jerry Yu82534862022-08-30 10:42:33 +0800438
Jerry Yuf35ba382022-08-23 17:58:26 +0800439 *selected_ciphersuite = 0;
440 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
442 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800443 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
444
Gilles Peskine449bd832023-01-11 14:50:10 +0100445 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800446 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100447 }
Jerry Yu82534862022-08-30 10:42:33 +0800448
Gilles Peskine449bd832023-01-11 14:50:10 +0100449 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
450 cipher_suite);
451 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800452 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100453 }
Jerry Yu82534862022-08-30 10:42:33 +0800454
Jerry Yu4746b102022-09-13 11:11:48 +0800455 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800456 *selected_ciphersuite_info = ciphersuite_info;
457
Gilles Peskine449bd832023-01-11 14:50:10 +0100458 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800459 }
460
Gilles Peskine449bd832023-01-11 14:50:10 +0100461 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800462}
Jerry Yuf35ba382022-08-23 17:58:26 +0800463
Jerry Yu82534862022-08-30 10:42:33 +0800464MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100465static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
466 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800467{
Jerry Yu82534862022-08-30 10:42:33 +0800468 dst->ticket_age_add = src->ticket_age_add;
469 dst->ticket_flags = src->ticket_flags;
470 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100471 if (src->resumption_key_len == 0) {
472 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
473 }
474 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800475
Gilles Peskine449bd832023-01-11 14:50:10 +0100476 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800477}
478#endif /* MBEDTLS_SSL_SESSION_TICKETS */
479
Jerry Yu1c105562022-07-10 06:32:38 +0000480/* Parser for pre_shared_key extension in client hello
481 * struct {
482 * opaque identity<1..2^16-1>;
483 * uint32 obfuscated_ticket_age;
484 * } PskIdentity;
485 *
486 * opaque PskBinderEntry<32..255>;
487 *
488 * struct {
489 * PskIdentity identities<7..2^16-1>;
490 * PskBinderEntry binders<33..2^16-1>;
491 * } OfferedPsks;
492 *
493 * struct {
494 * select (Handshake.msg_type) {
495 * case client_hello: OfferedPsks;
496 * ....
497 * };
498 * } PreSharedKeyExtension;
499 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800500MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000501static int ssl_tls13_parse_pre_shared_key_ext(
502 mbedtls_ssl_context *ssl,
503 const unsigned char *pre_shared_key_ext,
504 const unsigned char *pre_shared_key_ext_end,
505 const unsigned char *ciphersuites,
506 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000507{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100508 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800509 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800510 const unsigned char *p_identity_len;
511 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000512 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800513 const unsigned char *binders;
514 const unsigned char *p_binder_len;
515 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000516 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800517 int matched_identity = -1;
518 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000519
Gilles Peskine449bd832023-01-11 14:50:10 +0100520 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
521 pre_shared_key_ext,
522 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000523
Jerry Yu96a2e362022-07-21 15:11:34 +0800524 /* identities_len 2 bytes
525 * identities_data >= 7 bytes
526 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100527 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
528 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800529 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100530 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
531 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800532 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000533
Jerry Yu96a2e362022-07-21 15:11:34 +0800534 /* binders_len 2 bytes
535 * binders >= 33 bytes
536 */
Jerry Yu568ec252022-07-22 21:27:34 +0800537 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100538 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
539 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800540 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100541 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800542 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000543
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100544 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
545 identities_end - pre_shared_key_ext);
546 if (0 != ret) {
547 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
548 return ret;
549 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800550
Gilles Peskine449bd832023-01-11 14:50:10 +0100551 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000552 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800553 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800554 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800555 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800556 size_t binder_len;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800557 int psk_type;
558 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800559 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800560#if defined(MBEDTLS_SSL_SESSION_TICKETS)
561 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800563#endif
Jerry Yubb852022022-07-20 21:10:44 +0800564
Gilles Peskine449bd832023-01-11 14:50:10 +0100565 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
566 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800567 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
569 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800570 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000571
Gilles Peskine449bd832023-01-11 14:50:10 +0100572 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800573 binder_len = *p_binder_len;
574 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800576 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800577
Jerry Yu96a2e362022-07-21 15:11:34 +0800578 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100579 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000580 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100581 }
Jerry Yu1c105562022-07-10 06:32:38 +0000582
Jerry Yu96a2e362022-07-21 15:11:34 +0800583 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 ssl, identity, identity_len, obfuscated_ticket_age,
585 &psk_type, &session);
586 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800587 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800589
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
591 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800592 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
593 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 ssl, ciphersuites, ciphersuites_end,
595 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800596 break;
597 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800598#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800599 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100600 ssl, ciphersuites, ciphersuites_end, &session,
601 &cipher_suite, &ciphersuite_info);
602 if (ret != 0) {
603 mbedtls_ssl_session_free(&session);
604 }
Jerry Yu82534862022-08-30 10:42:33 +0800605#else
606 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
607#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800608 break;
609 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800611 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800613 /* See below, no cipher_suite available, abort handshake */
614 MBEDTLS_SSL_PEND_FATAL_ALERT(
615 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100616 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800617 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100618 2, "ssl_tls13_select_ciphersuite", ret);
619 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800620 }
621
Jerry Yu96a2e362022-07-21 15:11:34 +0800622 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 ssl, binder, binder_len, psk_type,
Dave Rodgman2eab4622023-10-05 13:30:37 +0100624 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac));
Gilles Peskine449bd832023-01-11 14:50:10 +0100625 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800626 /* For security reasons, the handshake should be aborted when we
627 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
628 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800629#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100630 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800631#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100632 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000633 MBEDTLS_SSL_DEBUG_RET(
634 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800635 MBEDTLS_SSL_PEND_FATAL_ALERT(
636 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100637 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
638 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800639 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800640
641 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800642
643 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800644 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800645 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100646 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
647 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800648#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100649 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
650 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
651 &session);
652 mbedtls_ssl_session_free(&session);
653 if (ret != 0) {
654 return ret;
655 }
Jerry Yu82534862022-08-30 10:42:33 +0800656 }
657#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000658 }
659
Gilles Peskine449bd832023-01-11 14:50:10 +0100660 if (p_identity_len != identities_end || p_binder_len != binders_end) {
661 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
662 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
663 MBEDTLS_ERR_SSL_DECODE_ERROR);
664 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000665 }
666
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800667 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000668 ret = ssl->handshake->update_checksum(
669 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100670 if (0 != ret) {
671 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
672 return ret;
673 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100674 if (matched_identity == -1) {
675 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
676 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000677 }
678
Gilles Peskine449bd832023-01-11 14:50:10 +0100679 ssl->handshake->selected_identity = (uint16_t) matched_identity;
680 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000681
Gilles Peskine449bd832023-01-11 14:50:10 +0100682 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000683}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684
685/*
686 * struct {
687 * select ( Handshake.msg_type ) {
688 * ....
689 * case server_hello:
690 * uint16 selected_identity;
691 * }
692 * } PreSharedKeyExtension;
693 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100694static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
695 unsigned char *buf,
696 unsigned char *end,
697 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698{
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000700
701 *olen = 0;
702
David Horstmann21b89762022-10-06 18:34:28 +0100703 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000704#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100705 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000706#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100707 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000708#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000710 /* We shouldn't have called this extension writer unless we've
711 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000713 }
714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
716 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000717
Gilles Peskine449bd832023-01-11 14:50:10 +0100718 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
719 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000720
Gilles Peskine449bd832023-01-11 14:50:10 +0100721 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000722
723 *olen = 6;
724
Gilles Peskine449bd832023-01-11 14:50:10 +0100725 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
726 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000727
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800729
Gilles Peskine449bd832023-01-11 14:50:10 +0100730 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000731}
732
Ronald Cron41a443a2022-10-04 16:38:25 +0200733#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000734
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735/* From RFC 8446:
736 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000737 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 * } SupportedVersions;
739 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200740MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100741static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
742 const unsigned char *buf,
743 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000744{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000746 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000747 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000748 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100749 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000752 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753 p += 1;
754
Gilles Peskine449bd832023-01-11 14:50:10 +0100755 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000756 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100757 while (p < versions_end) {
758 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
759 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000760 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000761
Ronald Cron3bd2b022023-04-03 16:45:39 +0200762 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100763 found_supported_version = 1;
764 break;
765 }
766
Ronald Cron3bd2b022023-04-03 16:45:39 +0200767 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
768 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100769 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000770 break;
771 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000772 }
773
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100774 if (!found_supported_version) {
775 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
778 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
779 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780 }
781
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100782 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100783 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100785 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000786}
787
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200788#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000789/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790 *
791 * From RFC 8446:
792 * enum {
793 * ... (0xFFFF)
794 * } NamedGroup;
795 * struct {
796 * NamedGroup named_group_list<2..2^16-1>;
797 * } NamedGroupList;
798 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200799MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100800static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
801 const unsigned char *buf,
802 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000803{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000805 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000806 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000807
Gilles Peskine449bd832023-01-11 14:50:10 +0100808 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
809 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
810 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000811 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000813 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000814 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000815
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000817 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100818 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
819 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000820 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000821
Gilles Peskine449bd832023-01-11 14:50:10 +0100822 MBEDTLS_SSL_DEBUG_MSG(2,
823 ("got named group: %s(%04x)",
824 mbedtls_ssl_named_group_to_str(named_group),
825 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000826
Gilles Peskine449bd832023-01-11 14:50:10 +0100827 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
828 !mbedtls_ssl_named_group_is_supported(named_group) ||
829 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000830 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831 }
832
Gilles Peskine449bd832023-01-11 14:50:10 +0100833 MBEDTLS_SSL_DEBUG_MSG(2,
834 ("add named group %s(%04x) into received list.",
835 mbedtls_ssl_named_group_to_str(named_group),
836 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800837
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000838 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839 }
840
Gilles Peskine449bd832023-01-11 14:50:10 +0100841 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000842
843}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200844#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000845
XiaokangQian08037552022-04-20 07:16:41 +0000846#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
847
Valerio Settic9ae8622023-07-25 11:23:50 +0200848#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000849/*
850 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000851 * extension is correct and stores the first acceptable key share and its
852 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853 *
854 * Possible return values are:
855 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000856 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
857 * the client does not match a group supported by the server. A
858 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000859 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800860 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200861MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100862static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
863 const unsigned char *buf,
864 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000865{
XiaokangQianb67384d2022-04-19 00:02:38 +0000866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000867 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000868 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800869 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000870
871 /* From RFC 8446:
872 *
873 * struct {
874 * KeyShareEntry client_shares<0..2^16-1>;
875 * } KeyShareClientHello;
876 *
877 */
878
Gilles Peskine449bd832023-01-11 14:50:10 +0100879 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
880 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000881 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100882 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000883
884 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000885 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000886
887 /* We try to find a suitable key share entry and copy it to the
888 * handshake context. Later, we have to find out whether we can do
889 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000890 * dismiss it and send a HelloRetryRequest message.
891 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000892
Gilles Peskine449bd832023-01-11 14:50:10 +0100893 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000894 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800895 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800896 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000897
898 /*
899 * struct {
900 * NamedGroup group;
901 * opaque key_exchange<1..2^16-1>;
902 * } KeyShareEntry;
903 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100904 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
905 group = MBEDTLS_GET_UINT16_BE(p, 0);
906 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800907 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800908 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800910 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000911
912 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000913 * for input validation purposes.
914 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100915 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
916 !mbedtls_ssl_named_group_is_supported(group) ||
917 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000918 continue;
919 }
XiaokangQian060d8672022-04-21 09:24:56 +0000920
XiaokangQian7807f9f2022-02-15 10:04:37 +0000921 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200922 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200924 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200925 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200926 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100927 mbedtls_ssl_named_group_to_str(group),
928 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200929 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 ssl, key_exchange - 2, key_exchange_len + 2);
931 if (ret != 0) {
932 return ret;
933 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000934
Gilles Peskine449bd832023-01-11 14:50:10 +0100935 } else {
936 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
937 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000938 continue;
939 }
940
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000941 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000942 }
943
Jerry Yuc1be19f2022-04-23 16:11:39 +0800944
Gilles Peskine449bd832023-01-11 14:50:10 +0100945 if (ssl->handshake->offered_group_id == 0) {
946 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
947 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000948 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100949 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000950}
Valerio Settic9ae8622023-07-25 11:23:50 +0200951#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000952
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200953MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100954static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
955 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000956{
Jerry Yu0c354a22022-08-29 15:25:36 +0800957 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000959}
960
Jerry Yue5991322022-11-07 14:03:44 +0800961#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200962MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000963static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100964 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000965{
Gilles Peskine449bd832023-01-11 14:50:10 +0100966 return ssl_tls13_client_hello_has_exts(
967 ssl,
968 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
969 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
970 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000971}
Jerry Yue5991322022-11-07 14:03:44 +0800972#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000973
Jerry Yue5991322022-11-07 14:03:44 +0800974#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000975MBEDTLS_CHECK_RETURN_CRITICAL
976static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100977 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000978{
Gilles Peskine449bd832023-01-11 14:50:10 +0100979 return ssl_tls13_client_hello_has_exts(
980 ssl,
981 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
982 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000983}
Jerry Yue5991322022-11-07 14:03:44 +0800984#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000985
Jerry Yue5991322022-11-07 14:03:44 +0800986#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000987MBEDTLS_CHECK_RETURN_CRITICAL
988static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100989 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000990{
Gilles Peskine449bd832023-01-11 14:50:10 +0100991 return ssl_tls13_client_hello_has_exts(
992 ssl,
993 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
994 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
995 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
996 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000997}
Jerry Yue5991322022-11-07 14:03:44 +0800998#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000999
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001000MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001001static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001002{
Jerry Yue5991322022-11-07 14:03:44 +08001003#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001004 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
1005 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +08001006#else
1007 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001008 return 0;
Jerry Yue5991322022-11-07 14:03:44 +08001009#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001010}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001011
Jerry Yu77f01482022-07-11 07:03:24 +00001012MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001013static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001014{
Jerry Yue5991322022-11-07 14:03:44 +08001015#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001016 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1017 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1018 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001019#else
1020 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001022#endif
1023}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001024
Jerry Yu77f01482022-07-11 07:03:24 +00001025MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001026static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001027{
Jerry Yue5991322022-11-07 14:03:44 +08001028#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1030 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1031 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001032#else
1033 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001035#endif
1036}
1037
Gilles Peskine449bd832023-01-11 14:50:10 +01001038static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001039{
1040 /*
1041 * Determine the key exchange algorithm to use.
1042 * There are three types of key exchanges supported in TLS 1.3:
1043 * - (EC)DH with ECDSA,
1044 * - (EC)DH with PSK,
1045 * - plain PSK.
1046 *
1047 * The PSK-based key exchanges may additionally be used with 0-RTT.
1048 *
1049 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001050 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1051 * 2 ) Certificate Mode ( ephemeral )
1052 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001053 */
1054
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001055 ssl->handshake->key_exchange_mode =
1056 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
Jerry Yu77f01482022-07-11 07:03:24 +00001057
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001059 ssl->handshake->key_exchange_mode =
1060 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001061 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1062 } else
1063 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001064 ssl->handshake->key_exchange_mode =
1065 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1067 } else
1068 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001069 ssl->handshake->key_exchange_mode =
1070 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001071 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1072 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001073 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 1,
1075 ("ClientHello message misses mandatory extensions."));
1076 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1077 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1078 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001079 }
1080
Gilles Peskine449bd832023-01-11 14:50:10 +01001081 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001082
XiaokangQian7807f9f2022-02-15 10:04:37 +00001083}
1084
XiaokangQian81802f42022-06-10 13:25:22 +00001085#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001086 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001087
1088#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001089static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001090{
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001098 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001100 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001102 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001104 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001106 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001107 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001108 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001109 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001110 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001111 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001112 }
1113}
1114#endif /* MBEDTLS_USE_PSA_CRYPTO */
1115
XiaokangQian23c5be62022-06-07 02:04:34 +00001116/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001117 * Pick best ( private key, certificate chain ) pair based on the signature
1118 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001119 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001120MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001121static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001122{
XiaokangQianfb665a82022-06-15 03:57:21 +00001123 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001124 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001125
1126#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001128 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001129 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001130#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001131 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 if (key_cert_list == NULL) {
1134 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1135 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001136 }
1137
Gilles Peskine449bd832023-01-11 14:50:10 +01001138 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1139 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001140 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001142
Gilles Peskine449bd832023-01-11 14:50:10 +01001143 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001144 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001145 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 for (key_cert = key_cert_list; key_cert != NULL;
1148 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001149#if defined(MBEDTLS_USE_PSA_CRYPTO)
1150 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1151#endif /* MBEDTLS_USE_PSA_CRYPTO */
1152
Gilles Peskine449bd832023-01-11 14:50:10 +01001153 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1154 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001155
1156 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001157 * This avoids sending the client a cert it'll reject based on
1158 * keyUsage or other extensions.
1159 */
1160 if (mbedtls_x509_crt_check_key_usage(
1161 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001162 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001163 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1165 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1166 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001167 continue;
1168 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001169
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 MBEDTLS_SSL_DEBUG_MSG(3,
1171 ("ssl_tls13_pick_key_cert:"
1172 "check signature algorithm %s [%04x]",
1173 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1174 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001175#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001176 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001177#endif /* MBEDTLS_USE_PSA_CRYPTO */
1178
Gilles Peskine449bd832023-01-11 14:50:10 +01001179 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1180 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001181#if defined(MBEDTLS_USE_PSA_CRYPTO)
1182 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001183 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1184 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001185#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001186 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001187 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001188 MBEDTLS_SSL_DEBUG_MSG(3,
1189 ("ssl_tls13_pick_key_cert:"
1190 "selected signature algorithm"
1191 " %s [%04x]",
1192 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1193 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001194 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001195 3, "selected certificate (chain)",
1196 ssl->handshake->key_cert->cert);
1197 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001198 }
XiaokangQian81802f42022-06-10 13:25:22 +00001199 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001200 }
1201
Gilles Peskine449bd832023-01-11 14:50:10 +01001202 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1203 "no suitable certificate found"));
1204 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001205}
XiaokangQian81802f42022-06-10 13:25:22 +00001206#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001207 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001208
XiaokangQian4080a7f2022-04-11 09:55:18 +00001209/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001210 *
1211 * STATE HANDLING: ClientHello
1212 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001213 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001214 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001215 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001216 *
1217 * In this case, the server progresses to sending its ServerHello.
1218 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001219 * 2) The ClientHello was well-formed but didn't match the server's
1220 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001221 *
1222 * For example, the client might not have offered a key share which
1223 * the server supports, or the server might require a cookie.
1224 *
1225 * In this case, the server sends a HelloRetryRequest.
1226 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001227 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001228 *
1229 * In this case, we abort the handshake.
1230 *
1231 */
1232
1233/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001234 * Structure of this message:
1235 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001236 * uint16 ProtocolVersion;
1237 * opaque Random[32];
1238 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001239 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001240 * struct {
1241 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1242 * Random random;
1243 * opaque legacy_session_id<0..32>;
1244 * CipherSuite cipher_suites<2..2^16-2>;
1245 * opaque legacy_compression_methods<1..2^8-1>;
1246 * Extension extensions<8..2^16-1>;
1247 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001248 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001249
1250#define SSL_CLIENT_HELLO_OK 0
1251#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001252#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001253
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001254MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001255static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1256 const unsigned char *buf,
1257 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258{
XiaokangQianb67384d2022-04-19 00:02:38 +00001259 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1260 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001261 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001262 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001263 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001264 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001265 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001266 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001267 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001268 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001269 const unsigned char *supported_versions_data;
1270 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001271 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001272 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001273 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274
Ronald Cron41a443a2022-10-04 16:38:25 +02001275#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu29d9faa2022-08-23 17:52:45 +08001276 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001277 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001278#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001279
XiaokangQian7807f9f2022-02-15 10:04:37 +00001280 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001281 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001282 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001283 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001284 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001285 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001286 * .. . .. ciphersuite list length ( 2 bytes )
1287 * .. . .. ciphersuite list
1288 * .. . .. compression alg. list length ( 1 byte )
1289 * .. . .. compression alg. list
1290 * .. . .. extensions length ( 2 bytes, optional )
1291 * .. . .. extensions ( optional )
1292 */
1293
XiaokangQianb67384d2022-04-19 00:02:38 +00001294 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001295 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001296 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1297 * read at least up to session id length without worrying.
1298 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001299 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001300
1301 /* ...
1302 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1303 * ...
1304 * with ProtocolVersion defined as:
1305 * uint16 ProtocolVersion;
1306 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001307 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1308 MBEDTLS_SSL_VERSION_TLS1_2) {
1309 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1310 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1311 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1312 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313 }
1314 p += 2;
1315
Jerry Yuc1be19f2022-04-23 16:11:39 +08001316 /* ...
1317 * Random random;
1318 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001319 * with Random defined as:
1320 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001321 */
Ronald Crond540d992023-03-07 09:41:48 +01001322 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001323 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001324
Jerry Yuc1be19f2022-04-23 16:11:39 +08001325 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001326 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001327 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001328 */
Ronald Croncada4102023-03-07 09:51:39 +01001329 legacy_session_id_len = *(p++);
1330 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001331
XiaokangQianb67384d2022-04-19 00:02:38 +00001332 /*
1333 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001334 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001335 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001336 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001337 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001338
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001339 /* ...
1340 * CipherSuite cipher_suites<2..2^16-2>;
1341 * ...
1342 * with CipherSuite defined as:
1343 * uint8 CipherSuite[2];
1344 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001345 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001346 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001347 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001348
Ronald Cronfc7ae872023-02-16 15:32:19 +01001349 /*
1350 * The length of the ciphersuite list has to be even.
1351 */
1352 if (cipher_suites_len & 1) {
1353 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1354 MBEDTLS_ERR_SSL_DECODE_ERROR);
1355 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1356 }
1357
XiaokangQianb67384d2022-04-19 00:02:38 +00001358 /* Check we have enough data for the ciphersuite list, the legacy
1359 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001360 *
1361 * cipher_suites cipher_suites_len bytes
1362 * legacy_compression_methods 2 bytes
1363 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001364 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001365 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001366 p += cipher_suites_len;
1367 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001368
1369 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001370 * Search for the supported versions extension and parse it to determine
1371 * if the client supports TLS 1.3.
1372 */
1373 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1374 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001375 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001376 if (ret < 0) {
1377 MBEDTLS_SSL_DEBUG_RET(1,
1378 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1379 return ret;
1380 }
1381
1382 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001383 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001384 }
1385
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001386 if (ret == 1) {
1387 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001388 supported_versions_data,
1389 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001390 if (ret < 0) {
1391 MBEDTLS_SSL_DEBUG_RET(1,
1392 ("ssl_tls13_parse_supported_versions_ext"), ret);
1393 return ret;
1394 }
1395
Ronald Cronb828c7d2023-04-03 16:37:22 +02001396 /*
1397 * The supported versions extension was parsed successfully as the
1398 * value returned by ssl_tls13_parse_supported_versions_ext() is
1399 * positive. The return value is then equal to
1400 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1401 * the TLS version to negotiate.
1402 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001403 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1404 return SSL_CLIENT_HELLO_TLS1_2;
1405 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001406 }
1407
1408 /*
1409 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001410 */
1411 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1412
1413#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1414 /* Store minor version for later use with ticket serialization. */
1415 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1416 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1417#endif
1418
1419 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001420 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001421 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001422 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001423 */
1424 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1425 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1426 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1427
Ronald Croncada4102023-03-07 09:51:39 +01001428 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1429 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1430 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1431 }
1432 ssl->session_negotiate->id_len = legacy_session_id_len;
1433 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1434 legacy_session_id, legacy_session_id_len);
1435 memcpy(&ssl->session_negotiate->id[0],
1436 legacy_session_id, legacy_session_id_len);
1437
Ronald Crond540d992023-03-07 09:41:48 +01001438 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001439 * Search for a matching ciphersuite
1440 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001441 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1442 cipher_suites, cipher_suites_len);
Ronald Crone45afd72023-04-04 15:10:06 +02001443 for (const unsigned char *cipher_suites_p = cipher_suites;
1444 cipher_suites_p < cipher_suites_end; cipher_suites_p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001445 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001446 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001447
Ronald Crond89360b2023-02-21 08:53:33 +01001448 /*
Ronald Crone45afd72023-04-04 15:10:06 +02001449 * "cipher_suites_end - cipher_suites_p is even" is an invariant of the
1450 * loop. As cipher_suites_end - cipher_suites_p > 0, we have
1451 * cipher_suites_end - cipher_suites_p >= 2 and it is thus safe to read
1452 * two bytes.
Ronald Crond89360b2023-02-21 08:53:33 +01001453 */
Ronald Crone45afd72023-04-04 15:10:06 +02001454 cipher_suite = MBEDTLS_GET_UINT16_BE(cipher_suites_p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001455 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 ssl, cipher_suite);
1457 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001458 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001459 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001460
Jerry Yu5725f1c2022-08-21 17:27:16 +08001461 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001462 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1464 cipher_suite,
1465 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001466 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001467 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001468
Gilles Peskine449bd832023-01-11 14:50:10 +01001469 if (handshake->ciphersuite_info == NULL) {
1470 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1471 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1472 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001473 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001474
XiaokangQian4080a7f2022-04-11 09:55:18 +00001475 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001476 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001477 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001478 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001479 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1480 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1481 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1482 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1483 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001484 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001485 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001486
Jerry Yuc1be19f2022-04-23 16:11:39 +08001487 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001488 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001489 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001490 * with Extension defined as:
1491 * struct {
1492 * ExtensionType extension_type;
1493 * opaque extension_data<0..2^16-1>;
1494 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001495 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001496 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001497 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001499 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500
Gilles Peskine449bd832023-01-11 14:50:10 +01001501 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001502 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001503
Gilles Peskine449bd832023-01-11 14:50:10 +01001504 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001505 unsigned int extension_type;
1506 size_t extension_data_len;
1507 const unsigned char *extension_data_end;
1508
Jerry Yu0c354a22022-08-29 15:25:36 +08001509 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001510 *
1511 * The "pre_shared_key" extension MUST be the last extension in the
1512 * ClientHello (this facilitates implementation as described below).
1513 * Servers MUST check that it is the last extension and otherwise fail
1514 * the handshake with an "illegal_parameter" alert.
1515 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001517 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001518 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001519 MBEDTLS_SSL_PEND_FATAL_ALERT(
1520 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001521 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1522 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001523 }
1524
Gilles Peskine449bd832023-01-11 14:50:10 +01001525 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1526 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1527 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001528 p += 4;
1529
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001531 extension_data_end = p + extension_data_len;
1532
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001533 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1535 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1536 if (ret != 0) {
1537 return ret;
1538 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001539
Gilles Peskine449bd832023-01-11 14:50:10 +01001540 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001541#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1542 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001543 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1544 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1545 extension_data_end);
1546 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001547 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001548 1, "mbedtls_ssl_parse_servername_ext", ret);
1549 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001550 }
XiaokangQian40a35232022-05-07 09:02:40 +00001551 break;
1552#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1553
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001554#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001555 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001556 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001557
1558 /* Supported Groups Extension
1559 *
1560 * When sent by the client, the "supported_groups" extension
1561 * indicates the named groups which the client supports,
1562 * ordered from most preferred to least preferred.
1563 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001564 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001565 ssl, p, extension_data_end);
1566 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001567 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001568 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001569 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001570 }
1571
XiaokangQian7807f9f2022-02-15 10:04:37 +00001572 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001573#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001574
Valerio Settic9ae8622023-07-25 11:23:50 +02001575#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001576 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001577 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001578
1579 /*
1580 * Key Share Extension
1581 *
1582 * When sent by the client, the "key_share" extension
1583 * contains the endpoint's cryptographic parameters for
1584 * ECDHE/DHE key establishment methods.
1585 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001586 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 ssl, p, extension_data_end);
1588 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001589 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1590 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001591 }
1592
Gilles Peskine449bd832023-01-11 14:50:10 +01001593 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001594 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001595 1, "ssl_tls13_parse_key_shares_ext", ret);
1596 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001597 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598
XiaokangQian7807f9f2022-02-15 10:04:37 +00001599 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001600#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001601
1602 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001603 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001604 break;
1605
Ronald Cron41a443a2022-10-04 16:38:25 +02001606#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001607 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001608 MBEDTLS_SSL_DEBUG_MSG(
1609 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001610
1611 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001612 ssl, p, extension_data_end);
1613 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001614 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001615 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1616 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001617 }
1618
Jerry Yue19e3b92022-07-08 12:04:51 +00001619 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001620#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001621
Jerry Yu1c105562022-07-10 06:32:38 +00001622 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1624 if ((handshake->received_extensions &
1625 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001626 MBEDTLS_SSL_PEND_FATAL_ALERT(
1627 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1629 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001630 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001631#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001632 /* Delay processing of the PSK identity once we have
1633 * found out which algorithms to use. We keep a pointer
1634 * to the buffer and the size for later processing.
1635 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001636 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001637 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001638#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001639 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001640
XiaokangQianacb39922022-06-17 10:18:48 +00001641#if defined(MBEDTLS_SSL_ALPN)
1642 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001644
Gilles Peskine449bd832023-01-11 14:50:10 +01001645 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1646 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001647 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001648 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1649 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001650 }
XiaokangQianacb39922022-06-17 10:18:48 +00001651 break;
1652#endif /* MBEDTLS_SSL_ALPN */
1653
Ronald Cron928cbd32022-10-04 16:14:26 +02001654#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001655 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001656 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001657
Gabor Mezei078e8032022-04-27 21:17:56 +02001658 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 ssl, p, extension_data_end);
1660 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001661 MBEDTLS_SSL_DEBUG_RET(
1662 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001663 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001664 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001665 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001666#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001667
Jan Bruckner151f6422023-02-10 12:45:19 +01001668#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1669 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1670 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1671
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001672 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1673 ssl, p, extension_data_end);
Jan Bruckner151f6422023-02-10 12:45:19 +01001674
Xiaokang Qian09c3ccc2023-04-04 10:18:38 +00001675 /*
1676 * TODO: Return unconditionally here until we handle the record
1677 * size limit correctly.
1678 * Once handled correctly, only return in case of errors.
1679 */
Jan Bruckner151f6422023-02-10 12:45:19 +01001680 return ret;
1681
1682 break;
1683#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1684
XiaokangQian7807f9f2022-02-15 10:04:37 +00001685 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001686 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001687 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001688 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001689 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001690 }
1691
1692 p += extension_data_len;
1693 }
1694
Gilles Peskine449bd832023-01-11 14:50:10 +01001695 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1696 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001697
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001698 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1699 MBEDTLS_SSL_HS_CLIENT_HELLO,
1700 p - buf);
1701 if (0 != ret) {
1702 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1703 return ret;
1704 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001705
Ronald Cron41a443a2022-10-04 16:38:25 +02001706#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001707 /* Update checksum with either
1708 * - The entire content of the CH message, if no PSK extension is present
1709 * - The content up to but excluding the PSK extension, if present.
1710 */
Jerry Yu1c105562022-07-10 06:32:38 +00001711 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1713 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1714 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001715 ret = handshake->update_checksum(ssl, buf,
1716 pre_shared_key_ext - buf);
1717 if (0 != ret) {
1718 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1719 return ret;
1720 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001721 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1722 pre_shared_key_ext,
1723 pre_shared_key_ext_end,
1724 cipher_suites,
1725 cipher_suites_end);
1726 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1727 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1728 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001729 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001730 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1731 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001732 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001733 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001734#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001735 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001736 ret = handshake->update_checksum(ssl, buf, p - buf);
1737 if (0 != ret) {
1738 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1739 return ret;
1740 }
Jerry Yu1c105562022-07-10 06:32:38 +00001741 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001742
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1744 if (ret < 0) {
1745 return ret;
1746 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001747
Ronald Cron8a74f072023-06-14 17:59:29 +02001748 if (ssl->handshake->key_exchange_mode !=
1749 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1750 hrr_required = (no_usable_share_for_key_agreement != 0);
1751 }
1752
Gilles Peskine449bd832023-01-11 14:50:10 +01001753 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001754
Gilles Peskine449bd832023-01-11 14:50:10 +01001755 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001756}
1757
Jerry Yuab0da372023-02-08 13:55:24 +08001758#if defined(MBEDTLS_SSL_EARLY_DATA)
1759static void ssl_tls13_update_early_data_status(mbedtls_ssl_context *ssl)
1760{
1761 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1762
1763 if ((handshake->received_extensions &
1764 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) == 0) {
1765 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yub47b2992023-10-18 15:50:35 +08001766 1, ("EarlyData: no early data extension received."));
Jerry Yuab0da372023-02-08 13:55:24 +08001767 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_RECEIVED;
1768 return;
1769 }
1770
1771 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
1772
Jerry Yu985c9672022-12-04 14:06:30 +08001773 if (ssl->conf->early_data_enabled == MBEDTLS_SSL_EARLY_DATA_DISABLED) {
1774 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu985c9672022-12-04 14:06:30 +08001775 1,
Jerry Yu454dda32023-10-31 15:13:54 +08001776 ("EarlyData: rejected, feature disabled in server configuration."));
Jerry Yu985c9672022-12-04 14:06:30 +08001777 return;
1778 }
1779
Jerry Yu454dda32023-10-31 15:13:54 +08001780 if (!handshake->resume) {
1781 /* We currently support early data only in the case of PSKs established
1782 via a NewSessionTicket message thus in the case of a session
1783 resumption. */
Jerry Yu985c9672022-12-04 14:06:30 +08001784 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001785 1, ("EarlyData: rejected, not a session resumption."));
Jerry Yu985c9672022-12-04 14:06:30 +08001786 return;
1787 }
1788
Jerry Yu82fd6c12023-10-31 16:32:19 +08001789 /* RFC 8446 4.2.10
1790 *
1791 * In order to accept early data, the server MUST have accepted a PSK cipher
1792 * suite and selected the first key offered in the client's "pre_shared_key"
1793 * extension. In addition, it MUST verify that the following values are the
1794 * same as those associated with the selected PSK:
1795 * - The TLS version number
1796 * - The selected cipher suite
1797 * - The selected ALPN [RFC7301] protocol, if any
1798 *
1799 * NOTE:
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001800 * - The TLS version number is checked in
1801 * ssl_tls13_offered_psks_check_identity_match_ticket().
1802 * - ALPN is not checked for the time being (TODO).
Jerry Yu82fd6c12023-10-31 16:32:19 +08001803 */
1804
1805 if (handshake->selected_identity != 0) {
1806 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001807 1, ("EarlyData: rejected, the selected key in "
1808 "`pre_shared_key` is not the first one."));
Jerry Yu82fd6c12023-10-31 16:32:19 +08001809 return;
1810 }
1811
1812 if (handshake->ciphersuite_info->id !=
1813 ssl->session_negotiate->ciphersuite) {
1814 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu7ef9fd82023-11-07 14:30:38 +08001815 1, ("EarlyData: rejected, the selected ciphersuite is not the one "
1816 "of the selected pre-shared key."));
Jerry Yu82fd6c12023-10-31 16:32:19 +08001817 return;
1818
1819 }
Jerry Yu985c9672022-12-04 14:06:30 +08001820
Jerry Yu985c9672022-12-04 14:06:30 +08001821
1822 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED;
1823
Jerry Yuab0da372023-02-08 13:55:24 +08001824}
1825#endif /* MBEDTLS_SSL_EARLY_DATA */
1826
XiaokangQian75fe8c72022-06-15 09:42:45 +00001827/* Update the handshake state machine */
1828
Ronald Cronce7d76e2022-07-08 18:56:49 +02001829MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001830static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001831{
1832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1833
XiaokangQian7807f9f2022-02-15 10:04:37 +00001834 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001835 * Server certificate selection
1836 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001837 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1838 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1839 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001840 }
1841#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1842 ssl->handshake->sni_name = NULL;
1843 ssl->handshake->sni_name_len = 0;
1844#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1847 if (ret != 0) {
1848 MBEDTLS_SSL_DEBUG_RET(1,
1849 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1850 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001851 }
1852
Jerry Yuab0da372023-02-08 13:55:24 +08001853#if defined(MBEDTLS_SSL_EARLY_DATA)
1854 /* There is enough information, update early data state. */
1855 ssl_tls13_update_early_data_status(ssl);
Jerry Yuab0da372023-02-08 13:55:24 +08001856#endif /* MBEDTLS_SSL_EARLY_DATA */
1857
Gilles Peskine449bd832023-01-11 14:50:10 +01001858 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001859
1860}
1861
1862/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001863 * Main entry point from the state machine; orchestrates the otherfunctions.
1864 */
1865
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001866MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001867static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001868{
1869
XiaokangQian08037552022-04-20 07:16:41 +00001870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001871 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001872 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001873 int parse_client_hello_ret;
1874
Gilles Peskine449bd832023-01-11 14:50:10 +01001875 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001876
Gilles Peskine449bd832023-01-11 14:50:10 +01001877 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1878 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1879 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001880
Gilles Peskine449bd832023-01-11 14:50:10 +01001881 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1882 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001883 parse_client_hello_ret = ret; /* Store positive return value of
1884 * parse_client_hello,
1885 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001886 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001887
Ronald Cronb828c7d2023-04-03 16:37:22 +02001888 /*
1889 * Version 1.2 of the protocol has been chosen, set the
1890 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1891 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1892 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1893 * will dispatch to the TLS 1.2 state machine.
1894 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001895 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
1896 ssl->keep_current_message = 1;
1897 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1898 return 0;
1899 }
1900
Gilles Peskine449bd832023-01-11 14:50:10 +01001901 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001902
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001903 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001904 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1905 } else {
1906 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1907 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001908
1909cleanup:
1910
Gilles Peskine449bd832023-01-11 14:50:10 +01001911 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1912 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001913}
1914
1915/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001916 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001917 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001918MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001919static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001920{
Jerry Yu637a3f12022-04-20 21:37:58 +08001921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1922 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001923 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1924 if (ssl->conf->f_rng == NULL) {
1925 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1926 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001927 }
1928
Gilles Peskine449bd832023-01-11 14:50:10 +01001929 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1930 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1931 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1932 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001933 }
1934
Gilles Peskine449bd832023-01-11 14:50:10 +01001935 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1936 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001937
1938#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001939 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001940#endif /* MBEDTLS_HAVE_TIME */
1941
Gilles Peskine449bd832023-01-11 14:50:10 +01001942 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001943}
1944
Jerry Yu3bf2c642022-03-30 22:02:12 +08001945/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001946 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001947 *
1948 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001949 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001950 * } SupportedVersions;
1951 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001952MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001953static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001954 mbedtls_ssl_context *ssl,
1955 unsigned char *buf,
1956 unsigned char *end,
1957 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001958{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001959 *out_len = 0;
1960
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001962
1963 /* Check if we have space to write the extension:
1964 * - extension_type (2 bytes)
1965 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001966 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001967 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001968 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001971
Gilles Peskine449bd832023-01-11 14:50:10 +01001972 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001973
Gilles Peskine449bd832023-01-11 14:50:10 +01001974 mbedtls_ssl_write_version(buf + 4,
1975 ssl->conf->transport,
1976 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001977
Gilles Peskine449bd832023-01-11 14:50:10 +01001978 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1979 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001980
Jerry Yu349a6132022-04-14 20:52:56 +08001981 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001982
Jerry Yub95dd362022-11-08 21:19:34 +08001983 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001984 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001985
Gilles Peskine449bd832023-01-11 14:50:10 +01001986 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001987}
1988
Jerry Yud9436a12022-04-20 22:28:09 +08001989
Jerry Yu3bf2c642022-03-30 22:02:12 +08001990
1991/* Generate and export a single key share. For hybrid KEMs, this can
1992 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001993MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001994static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1995 uint16_t named_group,
1996 unsigned char *buf,
1997 unsigned char *end,
1998 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001999{
2000 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08002001
2002 *out_len = 0;
2003
Valerio Settic9ae8622023-07-25 11:23:50 +02002004#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02002005 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02002006 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02002007 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01002008 ssl, named_group, buf, end, out_len);
2009 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08002010 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02002011 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 ret);
2013 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002015 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02002016#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01002017 if (0 /* Other kinds of KEMs */) {
2018 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08002019 ((void) ssl);
2020 ((void) named_group);
2021 ((void) buf);
2022 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002023 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2024 }
2025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002027}
2028
2029/*
2030 * ssl_tls13_write_key_share_ext
2031 *
2032 * Structure of key_share extension in ServerHello:
2033 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08002034 * struct {
2035 * NamedGroup group;
2036 * opaque key_exchange<1..2^16-1>;
2037 * } KeyShareEntry;
2038 * struct {
2039 * KeyShareEntry server_share;
2040 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002041 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002042MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002043static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
2044 unsigned char *buf,
2045 unsigned char *end,
2046 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08002047{
Jerry Yu955ddd72022-04-22 22:27:33 +08002048 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08002050 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002052 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002053
2054 *out_len = 0;
2055
Gilles Peskine449bd832023-01-11 14:50:10 +01002056 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2059 mbedtls_ssl_named_group_to_str(group),
2060 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002061
Jerry Yu3bf2c642022-03-30 22:02:12 +08002062 /* Check if we have space for header and length fields:
2063 * - extension_type (2 bytes)
2064 * - extension_data_length (2 bytes)
2065 * - group (2 bytes)
2066 * - key_exchange_length (2 bytes)
2067 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002068 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2069 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2070 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002071 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002072
Jerry Yu3bf2c642022-03-30 22:02:12 +08002073 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2074 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002075 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002076 ssl, group, server_share + 4, end, &key_exchange_length);
2077 if (ret != 0) {
2078 return ret;
2079 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002080 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002085
Jerry Yu57d48412022-04-20 21:50:42 +08002086 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002087
Gilles Peskine449bd832023-01-11 14:50:10 +01002088 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002091}
Jerry Yud9436a12022-04-20 22:28:09 +08002092
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002093MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002094static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2095 unsigned char *buf,
2096 unsigned char *end,
2097 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002098{
2099 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2100 /* key_share Extension
2101 *
2102 * struct {
2103 * select (Handshake.msg_type) {
2104 * ...
2105 * case hello_retry_request:
2106 * NamedGroup selected_group;
2107 * ...
2108 * };
2109 * } KeyShare;
2110 */
2111
2112 *out_len = 0;
2113
Jerry Yub0ac10b2022-05-05 11:10:08 +08002114 /*
2115 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2116 * of the HRR is then to transmit a cookie to force the client to demonstrate
2117 * reachability at their apparent network address (primarily useful for DTLS).
2118 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002119 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2120 return 0;
2121 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002122
2123 /* We should only send the key_share extension if the client's initial
2124 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 if (ssl->handshake->offered_group_id != 0) {
2126 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2127 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002128 }
2129
Gilles Peskine449bd832023-01-11 14:50:10 +01002130 if (selected_group == 0) {
2131 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2132 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002133 }
2134
Jerry Yub0ac10b2022-05-05 11:10:08 +08002135 /* Check if we have enough space:
2136 * - extension_type (2 bytes)
2137 * - extension_data_length (2 bytes)
2138 * - selected_group (2 bytes)
2139 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002141
Gilles Peskine449bd832023-01-11 14:50:10 +01002142 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2143 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2144 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002145
Gilles Peskine449bd832023-01-11 14:50:10 +01002146 MBEDTLS_SSL_DEBUG_MSG(3,
2147 ("HRR selected_group: %s (%x)",
2148 mbedtls_ssl_named_group_to_str(selected_group),
2149 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002150
2151 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002152
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002156}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002157
2158/*
2159 * Structure of ServerHello message:
2160 *
2161 * struct {
2162 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2163 * Random random;
2164 * opaque legacy_session_id_echo<0..32>;
2165 * CipherSuite cipher_suite;
2166 * uint8 legacy_compression_method = 0;
2167 * Extension extensions<6..2^16-1>;
2168 * } ServerHello;
2169 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002170MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002171static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2172 unsigned char *buf,
2173 unsigned char *end,
2174 size_t *out_len,
2175 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002176{
Jerry Yu955ddd72022-04-22 22:27:33 +08002177 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002178 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002179 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002180 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002181
2182 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002183 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002184
Jerry Yucfc04b32022-04-21 09:31:58 +08002185 /* ...
2186 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2187 * ...
2188 * with ProtocolVersion defined as:
2189 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2192 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002193 p += 2;
2194
Jerry Yu1c3e6882022-04-20 21:23:40 +08002195 /* ...
2196 * Random random;
2197 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002198 * with Random defined as:
2199 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002200 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002201 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2202 if (is_hrr) {
2203 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2204 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2205 } else {
2206 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2207 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002208 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2210 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002211 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2212
Jerry Yucfc04b32022-04-21 09:31:58 +08002213 /* ...
2214 * opaque legacy_session_id_echo<0..32>;
2215 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002216 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002217 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2218 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2219 if (ssl->session_negotiate->id_len > 0) {
2220 memcpy(p, &ssl->session_negotiate->id[0],
2221 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002222 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002223
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2225 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002226 }
2227
Jerry Yucfc04b32022-04-21 09:31:58 +08002228 /* ...
2229 * CipherSuite cipher_suite;
2230 * ...
2231 * with CipherSuite defined as:
2232 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002233 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002234 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2235 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002236 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002237 MBEDTLS_SSL_DEBUG_MSG(3,
2238 ("server hello, chosen ciphersuite: %s ( id=%d )",
2239 mbedtls_ssl_get_ciphersuite_name(
2240 ssl->session_negotiate->ciphersuite),
2241 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002242
Jerry Yucfc04b32022-04-21 09:31:58 +08002243 /* ...
2244 * uint8 legacy_compression_method = 0;
2245 * ...
2246 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002247 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002248 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002249
Jerry Yucfc04b32022-04-21 09:31:58 +08002250 /* ...
2251 * Extension extensions<6..2^16-1>;
2252 * ...
2253 * struct {
2254 * ExtensionType extension_type; (2 bytes)
2255 * opaque extension_data<0..2^16-1>;
2256 * } Extension;
2257 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002258 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002259 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002260 p += 2;
2261
Gilles Peskine449bd832023-01-11 14:50:10 +01002262 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2263 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002264 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2266 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002267 }
2268 p += output_len;
2269
Gilles Peskine449bd832023-01-11 14:50:10 +01002270 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2271 if (is_hrr) {
2272 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2273 } else {
2274 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2275 }
2276 if (ret != 0) {
2277 return ret;
2278 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002279 p += output_len;
2280 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002281
Ronald Cron41a443a2022-10-04 16:38:25 +02002282#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002283 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2284 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2285 if (ret != 0) {
2286 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2287 ret);
2288 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002289 }
2290 p += output_len;
2291 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002292#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002293
Gilles Peskine449bd832023-01-11 14:50:10 +01002294 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002295
Gilles Peskine449bd832023-01-11 14:50:10 +01002296 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2297 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002298
Jerry Yud9436a12022-04-20 22:28:09 +08002299 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002300
Gilles Peskine449bd832023-01-11 14:50:10 +01002301 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002302
Jerry Yu7de2ff02022-11-08 21:43:46 +08002303 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002304 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 MBEDTLS_SSL_HS_SERVER_HELLO,
2306 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002307
Gilles Peskine449bd832023-01-11 14:50:10 +01002308 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002309}
2310
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002311MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002312static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002313{
2314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002315 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2316 if (ret != 0) {
2317 MBEDTLS_SSL_DEBUG_RET(1,
2318 "mbedtls_ssl_tls13_compute_handshake_transform",
2319 ret);
2320 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002321 }
2322
Gilles Peskine449bd832023-01-11 14:50:10 +01002323 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002324}
2325
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002326MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002327static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002328{
Jerry Yu637a3f12022-04-20 21:37:58 +08002329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002330 unsigned char *buf;
2331 size_t buf_len, msg_len;
2332
Gilles Peskine449bd832023-01-11 14:50:10 +01002333 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002334
Gilles Peskine449bd832023-01-11 14:50:10 +01002335 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002336
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002337 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2338 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2341 buf + buf_len,
2342 &msg_len,
2343 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002344
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002345 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002346 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002347
Gilles Peskine449bd832023-01-11 14:50:10 +01002348 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2349 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002350
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002351 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002352
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002353#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2354 /* The server sends a dummy change_cipher_spec record immediately
2355 * after its first handshake message. This may either be after
2356 * a ServerHello or a HelloRetryRequest.
2357 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002358 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002359 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002360#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002361 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002362#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002363
Jerry Yuf4b27e42022-03-30 17:32:21 +08002364cleanup:
2365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2367 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002368}
2369
Jerry Yu23d1a252022-05-12 18:08:59 +08002370
2371/*
2372 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2373 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002374MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002375static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002376{
2377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002378 if (ssl->handshake->hello_retry_request_count > 0) {
2379 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2380 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2381 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2382 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002383 }
2384
2385 /*
2386 * Create stateless transcript hash for HRR
2387 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002388 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2389 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2390 if (ret != 0) {
2391 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2392 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002393 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002394 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002395
Gilles Peskine449bd832023-01-11 14:50:10 +01002396 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002397}
2398
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002399MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002400static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002401{
2402 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2403 unsigned char *buf;
2404 size_t buf_len, msg_len;
2405
Gilles Peskine449bd832023-01-11 14:50:10 +01002406 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002407
Gilles Peskine449bd832023-01-11 14:50:10 +01002408 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002409
Gilles Peskine449bd832023-01-11 14:50:10 +01002410 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2411 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2412 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002413
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2415 buf + buf_len,
2416 &msg_len,
2417 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002418 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002419 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002420
2421
Gilles Peskine449bd832023-01-11 14:50:10 +01002422 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2423 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002424
2425 ssl->handshake->hello_retry_request_count++;
2426
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002427#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2428 /* The server sends a dummy change_cipher_spec record immediately
2429 * after its first handshake message. This may either be after
2430 * a ServerHello or a HelloRetryRequest.
2431 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002432 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002433 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002434#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002436#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002437
2438cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002439 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2440 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002441}
2442
Jerry Yu5b64ae92022-03-30 17:15:02 +08002443/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002444 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2445 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002446
2447/*
2448 * struct {
2449 * Extension extensions<0..2 ^ 16 - 1>;
2450 * } EncryptedExtensions;
2451 *
2452 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002453MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002454static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2455 unsigned char *buf,
2456 unsigned char *end,
2457 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002458{
XiaokangQianacb39922022-06-17 10:18:48 +00002459 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002460 unsigned char *p = buf;
2461 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002462 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002463 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002464
Jerry Yu4d3841a2022-04-16 12:37:19 +08002465 *out_len = 0;
2466
Gilles Peskine449bd832023-01-11 14:50:10 +01002467 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002468 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002469 p += 2;
2470
Jerry Yu8937eb42022-05-03 12:12:14 +08002471 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002472 ((void) ret);
2473 ((void) output_len);
2474
2475#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002476 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2477 if (ret != 0) {
2478 return ret;
2479 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002480 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002481#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002482
Jerry Yu71c14f12022-12-12 11:10:35 +08002483#if defined(MBEDTLS_SSL_EARLY_DATA)
2484 if (ssl->early_data_status == MBEDTLS_SSL_EARLY_DATA_STATUS_ACCEPTED) {
2485 ret = mbedtls_ssl_tls13_write_early_data_ext(ssl, p, end, &output_len);
2486 if (ret != 0) {
2487 return ret;
2488 }
2489 p += output_len;
2490 }
2491#endif /* MBEDTLS_SSL_EARLY_DATA */
2492
Gilles Peskine449bd832023-01-11 14:50:10 +01002493 extensions_len = (p - p_extensions_len) - 2;
2494 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002495
2496 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002497
Gilles Peskine449bd832023-01-11 14:50:10 +01002498 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002499
Jerry Yu7de2ff02022-11-08 21:43:46 +08002500 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002502
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002504}
2505
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002506MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002507static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002508{
2509 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2510 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002511 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002512
Gilles Peskine449bd832023-01-11 14:50:10 +01002513 mbedtls_ssl_set_outbound_transform(ssl,
2514 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002515 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002516 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002517
Gilles Peskine449bd832023-01-11 14:50:10 +01002518 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002519
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002520 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2521 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2522 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002523
Gilles Peskine449bd832023-01-11 14:50:10 +01002524 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2525 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002526
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002527 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002528 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2529 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002530
Gilles Peskine449bd832023-01-11 14:50:10 +01002531 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2532 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002533
Ronald Cron928cbd32022-10-04 16:14:26 +02002534#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002535 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2536 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2537 } else {
2538 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2539 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002540#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002542#endif
2543
Jerry Yu4d3841a2022-04-16 12:37:19 +08002544cleanup:
2545
Gilles Peskine449bd832023-01-11 14:50:10 +01002546 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2547 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002548}
2549
Ronald Cron928cbd32022-10-04 16:14:26 +02002550#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002551#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2552#define SSL_CERTIFICATE_REQUEST_SKIP 1
2553/* Coordination:
2554 * Check whether a CertificateRequest message should be written.
2555 * Returns a negative code on failure, or
2556 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2557 * - SSL_CERTIFICATE_REQUEST_SKIP
2558 * indicating if the writing of the CertificateRequest
2559 * should be skipped or not.
2560 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002561MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002562static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002563{
2564 int authmode;
2565
XiaokangQian40a35232022-05-07 09:02:40 +00002566#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002568 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002569 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002570#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002571 authmode = ssl->conf->authmode;
2572
Gilles Peskine449bd832023-01-11 14:50:10 +01002573 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002574 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002575 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002576 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002577
XiaokangQianc3017f62022-05-13 05:55:41 +00002578 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002581}
2582
XiaokangQiancec9ae62022-05-06 07:28:50 +00002583/*
2584 * struct {
2585 * opaque certificate_request_context<0..2^8-1>;
2586 * Extension extensions<2..2^16-1>;
2587 * } CertificateRequest;
2588 *
2589 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002590MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002591static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2592 unsigned char *buf,
2593 const unsigned char *end,
2594 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002595{
2596 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2597 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002598 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002599 unsigned char *p_extensions_len;
2600
2601 *out_len = 0;
2602
2603 /* Check if we have enough space:
2604 * - certificate_request_context (1 byte)
2605 * - extensions length (2 bytes)
2606 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002607 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002608
2609 /*
2610 * Write certificate_request_context
2611 */
2612 /*
2613 * We use a zero length context for the normal handshake
2614 * messages. For post-authentication handshake messages
2615 * this request context would be set to a non-zero value.
2616 */
2617 *p++ = 0x0;
2618
2619 /*
2620 * Write extensions
2621 */
2622 /* The extensions must contain the signature_algorithms. */
2623 p_extensions_len = p;
2624 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002625 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2626 if (ret != 0) {
2627 return ret;
2628 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002629
XiaokangQianec6efb92022-05-06 09:53:10 +00002630 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002631 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002632
2633 *out_len = p - buf;
2634
Jerry Yu7de2ff02022-11-08 21:43:46 +08002635 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002636 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002637
Gilles Peskine449bd832023-01-11 14:50:10 +01002638 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002639}
2640
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002641MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002642static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002643{
2644 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2645
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002647
Gilles Peskine449bd832023-01-11 14:50:10 +01002648 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002649
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002651 unsigned char *buf;
2652 size_t buf_len, msg_len;
2653
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002654 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2655 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2656 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002657
Gilles Peskine449bd832023-01-11 14:50:10 +01002658 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2659 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002660
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002661 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002662 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2663 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002664
Gilles Peskine449bd832023-01-11 14:50:10 +01002665 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2666 ssl, buf_len, msg_len));
2667 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2668 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002669 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002670 } else {
2671 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002672 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2673 goto cleanup;
2674 }
2675
Gilles Peskine449bd832023-01-11 14:50:10 +01002676 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002677cleanup:
2678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2680 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002681}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002682
Jerry Yu4d3841a2022-04-16 12:37:19 +08002683/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002684 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002685 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002686MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002687static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002688{
Jerry Yu5a26f302022-05-10 20:46:40 +08002689 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002690
2691#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2693 mbedtls_ssl_own_cert(ssl) == NULL) {
2694 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2695 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2696 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2697 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002698 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002699#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2702 if (ret != 0) {
2703 return ret;
2704 }
2705 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2706 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002707}
2708
2709/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002710 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002711 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002712MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002713static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002714{
Gilles Peskine449bd832023-01-11 14:50:10 +01002715 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2716 if (ret != 0) {
2717 return ret;
2718 }
2719 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2720 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002721}
Ronald Cron928cbd32022-10-04 16:14:26 +02002722#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002723
2724/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002725 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002726 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002727MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002728static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002729{
Jerry Yud6e253d2022-05-18 13:59:24 +08002730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002731
Gilles Peskine449bd832023-01-11 14:50:10 +01002732 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2733 if (ret != 0) {
2734 return ret;
2735 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002736
Gilles Peskine449bd832023-01-11 14:50:10 +01002737 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2738 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002739 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002740 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2741 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2742 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002743 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002744
Gilles Peskine449bd832023-01-11 14:50:10 +01002745 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2746 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002747
Gilles Peskine449bd832023-01-11 14:50:10 +01002748 if (ssl->handshake->certificate_request_sent) {
2749 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2750 } else {
2751 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2752 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2753 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002754 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002755
Gilles Peskine449bd832023-01-11 14:50:10 +01002756 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002757}
2758
2759/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002760 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002761 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002762MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002763static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002764{
Jerry Yud6e253d2022-05-18 13:59:24 +08002765 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2766
Gilles Peskine449bd832023-01-11 14:50:10 +01002767 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2768 if (ret != 0) {
2769 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002770 }
2771
Gilles Peskine449bd832023-01-11 14:50:10 +01002772 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2773 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002774 MBEDTLS_SSL_DEBUG_RET(
2775 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 }
2777
2778 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2779 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002780}
2781
2782/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002783 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002784 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002785MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002786static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002787{
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002789
Gilles Peskine449bd832023-01-11 14:50:10 +01002790 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002791
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002792#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2793 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002794/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2795 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2796 * expected to be resolved with issue#6395.
2797 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002798 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002799 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002800 mbedtls_ssl_handshake_set_state(
2801 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002802 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002803#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002804 {
2805 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2806 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002808}
2809
2810/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002811 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002812 */
2813#define SSL_NEW_SESSION_TICKET_SKIP 0
2814#define SSL_NEW_SESSION_TICKET_WRITE 1
2815MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002816static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002817{
2818 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002819 if (ssl->conf->f_ticket_write == NULL) {
2820 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2821 " callback is not set"));
2822 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002823 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002824 if (ssl->conf->new_session_tickets_count == 0) {
2825 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2826 " configured count is zero"));
2827 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002828 }
2829
Gilles Peskine449bd832023-01-11 14:50:10 +01002830 if (ssl->handshake->new_session_tickets_count == 0) {
2831 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2832 "been sent."));
2833 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002834 }
2835
Gilles Peskine449bd832023-01-11 14:50:10 +01002836 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002837}
2838
2839#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2840MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002841static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2842 unsigned char *ticket_nonce,
2843 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002844{
2845 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2846 mbedtls_ssl_session *session = ssl->session;
2847 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2848 psa_algorithm_t psa_hash_alg;
2849 int hash_length;
2850
Gilles Peskine449bd832023-01-11 14:50:10 +01002851 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002852
2853#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002855#endif
2856
Pengyu Lv9f926952022-11-17 15:22:33 +08002857 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002858 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002859 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002860#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002861 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002862 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002863#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002864 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002865
Jerry Yue67bef42022-07-07 07:29:42 +00002866 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002867 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2868 (unsigned char *) &session->ticket_age_add,
2869 sizeof(session->ticket_age_add)) != 0)) {
2870 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2871 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002872 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002873 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2874 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002875
2876 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2878 if (ret != 0) {
2879 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2880 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002881 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002882 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2883 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002884
2885 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002886 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002887 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2889 if (hash_length == -1 ||
2890 (size_t) hash_length > sizeof(session->resumption_key)) {
2891 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002892 }
2893
Jerry Yue67bef42022-07-07 07:29:42 +00002894 /* In this code the psk key length equals the length of the hash */
2895 session->resumption_key_len = hash_length;
2896 session->ciphersuite = ciphersuite_info->id;
2897
2898 /* Compute resumption key
2899 *
2900 * HKDF-Expand-Label( resumption_master_secret,
2901 * "resumption", ticket_nonce, Hash.length )
2902 */
2903 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002904 psa_hash_alg,
2905 session->app_secrets.resumption_master_secret,
2906 hash_length,
2907 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2908 ticket_nonce,
2909 ticket_nonce_size,
2910 session->resumption_key,
2911 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002912
Gilles Peskine449bd832023-01-11 14:50:10 +01002913 if (ret != 0) {
2914 MBEDTLS_SSL_DEBUG_RET(2,
2915 "Creating the ticket-resumed PSK failed",
2916 ret);
2917 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002918 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002919 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2920 session->resumption_key,
2921 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002922
Gilles Peskine449bd832023-01-11 14:50:10 +01002923 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2924 session->app_secrets.resumption_master_secret,
2925 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002926
Gilles Peskine449bd832023-01-11 14:50:10 +01002927 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002928}
2929
2930/* This function creates a NewSessionTicket message in the following format:
2931 *
2932 * struct {
2933 * uint32 ticket_lifetime;
2934 * uint32 ticket_age_add;
2935 * opaque ticket_nonce<0..255>;
2936 * opaque ticket<1..2^16-1>;
2937 * Extension extensions<0..2^16-2>;
2938 * } NewSessionTicket;
2939 *
2940 * The ticket inside the NewSessionTicket message is an encrypted container
2941 * carrying the necessary information so that the server is later able to
2942 * re-start the communication.
2943 *
2944 * The following fields are placed inside the ticket by the
2945 * f_ticket_write() function:
2946 *
2947 * - creation time (start)
2948 * - flags (flags)
2949 * - age add (ticket_age_add)
2950 * - key (key)
2951 * - key length (key_len)
2952 * - ciphersuite (ciphersuite)
2953 */
2954MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002955static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2956 unsigned char *buf,
2957 unsigned char *end,
2958 size_t *out_len,
2959 unsigned char *ticket_nonce,
2960 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002961{
2962 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2963 unsigned char *p = buf;
2964 mbedtls_ssl_session *session = ssl->session;
2965 size_t ticket_len;
2966 uint32_t ticket_lifetime;
2967
2968 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002969 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002970
2971 /*
2972 * ticket_lifetime 4 bytes
2973 * ticket_age_add 4 bytes
2974 * ticket_nonce 1 + ticket_nonce_size bytes
2975 * ticket >=2 bytes
2976 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002977 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002978
2979 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2981 session,
2982 p + 9 + ticket_nonce_size + 2,
2983 end,
2984 &ticket_len,
2985 &ticket_lifetime);
2986 if (ret != 0) {
2987 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2988 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002989 }
2990 /* RFC 8446 4.6.1
2991 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2992 * unsigned integer in network byte order from the time of ticket
2993 * issuance. Servers MUST NOT use any value greater than
2994 * 604800 seconds (7 days). The value of zero indicates that the
2995 * ticket should be discarded immediately. Clients MUST NOT cache
2996 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2997 * and MAY delete tickets earlier based on local policy. A server
2998 * MAY treat a ticket as valid for a shorter period of time than what
2999 * is stated in the ticket_lifetime.
3000 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003001 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00003002 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01003003 }
3004 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
3005 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
3006 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00003007
3008 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01003009 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
3010 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
3011 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00003012
3013 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 p[8] = (unsigned char) ticket_nonce_size;
3015 if (ticket_nonce_size > 0) {
3016 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00003017 }
3018 p += 9 + ticket_nonce_size;
3019
3020 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01003021 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003022 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01003023 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00003024 p += ticket_len;
3025
3026 /* Ticket Extensions
3027 *
3028 * Note: We currently don't have any extensions.
3029 * Set length to zero.
3030 */
Jerry Yuedab6372022-10-31 14:37:31 +08003031 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
3032
Gilles Peskine449bd832023-01-11 14:50:10 +01003033 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
3034 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00003035 p += 2;
3036
3037 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
3039 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00003040
Jerry Yu7de2ff02022-11-08 21:43:46 +08003041 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08003043
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00003045}
3046
3047/*
Jerry Yua8d3c502022-10-30 14:51:23 +08003048 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003049 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003050static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00003051{
3052 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
3053
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00003055
Gilles Peskine449bd832023-01-11 14:50:10 +01003056 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00003057 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
3058 unsigned char *buf;
3059 size_t buf_len, msg_len;
3060
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
3062 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003063
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003064 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
3065 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3066 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003067
Gilles Peskine449bd832023-01-11 14:50:10 +01003068 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3069 ssl, buf, buf + buf_len, &msg_len,
3070 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003071
Gilles Peskine449bd832023-01-11 14:50:10 +01003072 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3073 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003074
Jerry Yu359e65f2022-09-22 23:47:43 +08003075 /* Limit session tickets count to one when resumption connection.
3076 *
3077 * See document of mbedtls_ssl_conf_new_session_tickets.
3078 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003079 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003080 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003081 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003082 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003083 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003084
Jerry Yua8d3c502022-10-30 14:51:23 +08003085 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3087 } else {
3088 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003089 }
3090
Jerry Yue67bef42022-07-07 07:29:42 +00003091cleanup:
3092
Gilles Peskine449bd832023-01-11 14:50:10 +01003093 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003094}
3095#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3096
3097/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003098 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003099 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003100int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003101{
XiaokangQian08037552022-04-20 07:16:41 +00003102 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003103
Gilles Peskine449bd832023-01-11 14:50:10 +01003104 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3105 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3106 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003107
Gilles Peskine449bd832023-01-11 14:50:10 +01003108 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003109 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003110 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003111
Gilles Peskine449bd832023-01-11 14:50:10 +01003112 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003113 /* start state */
3114 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003115 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003116 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003117 break;
3118
XiaokangQian7807f9f2022-02-15 10:04:37 +00003119 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003120 ret = ssl_tls13_process_client_hello(ssl);
3121 if (ret != 0) {
3122 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3123 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003124 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003125
Jerry Yuf41553b2022-05-09 22:20:30 +08003126 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 ret = ssl_tls13_write_hello_retry_request(ssl);
3128 if (ret != 0) {
3129 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3130 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003131 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003132 break;
3133
Jerry Yu5b64ae92022-03-30 17:15:02 +08003134 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003136 break;
3137
Xiaofei Baicba64af2022-02-15 10:00:56 +00003138 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003139 ret = ssl_tls13_write_encrypted_extensions(ssl);
3140 if (ret != 0) {
3141 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3142 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003143 }
Jerry Yu48330562022-05-06 21:35:44 +08003144 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003145
Ronald Cron928cbd32022-10-04 16:14:26 +02003146#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003147 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003148 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003149 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003150
Jerry Yu83da34e2022-04-16 13:59:52 +08003151 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003152 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003153 break;
3154
3155 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003156 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003157 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003158#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003159
Gilles Peskine449bd832023-01-11 14:50:10 +01003160 /*
3161 * Injection of dummy-CCS's for middlebox compatibility
3162 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003163#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003164 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3166 if (ret == 0) {
3167 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3168 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003169 break;
3170
3171 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003172 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3173 if (ret == 0) {
3174 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3175 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003176 break;
3177#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3178
Jerry Yu69dd8d42022-04-16 12:51:26 +08003179 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003181 break;
3182
3183 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003184 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003185 break;
3186
Jerry Yu69dd8d42022-04-16 12:51:26 +08003187 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003188 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003189 break;
3190
Ronald Cron766c0cd2022-10-18 12:17:11 +02003191#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003192 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003193 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3194 if (ret == 0) {
3195 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003196 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003197 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3198 } else {
3199 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003200 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003201 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003202 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003203 }
3204 break;
3205
3206 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003207 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3208 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003209 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003210 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003211 }
3212 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003213#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003214
Jerry Yue67bef42022-07-07 07:29:42 +00003215#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003216 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003217 ret = ssl_tls13_write_new_session_ticket(ssl);
3218 if (ret != 0) {
3219 MBEDTLS_SSL_DEBUG_RET(1,
3220 "ssl_tls13_write_new_session_ticket ",
3221 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003222 }
3223 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003224 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003225 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003226 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003227 * as part of ssl_prepare_handshake_step.
3228 */
3229 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003230
Gilles Peskine449bd832023-01-11 14:50:10 +01003231 if (ssl->handshake->new_session_tickets_count == 0) {
3232 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3233 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003234 mbedtls_ssl_handshake_set_state(
3235 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003236 }
Jerry Yue67bef42022-07-07 07:29:42 +00003237 break;
3238
3239#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3240
XiaokangQian7807f9f2022-02-15 10:04:37 +00003241 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003242 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3243 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003244 }
3245
Gilles Peskine449bd832023-01-11 14:50:10 +01003246 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003247}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003248
Jerry Yufb4b6472022-01-27 15:03:26 +08003249#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */