blob: 6445a00a19603b8ad20aa40f9356f41bbc73978a [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
Gilles Peskine449bd832023-01-11 14:50:10 +0100162 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800163 goto exit;
164 }
Jerry Yu95699e72022-08-21 19:22:23 +0800165
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800166 /* RFC 8446 section 4.2.9
167 *
168 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
169 * compatible with the advertised modes; however, if a server does so,
170 * the impact will just be that the client's attempts at resumption fail.
171 *
172 * We regard the ticket with incompatible key exchange modes as not match.
173 */
Pengyu Lv18946532023-01-12 12:28:09 +0800174 ret = MBEDTLS_ERR_ERROR_GENERIC_ERROR;
Pengyu Lv4938a562023-01-16 11:28:49 +0800175 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4,
Pengyu Lv80270b22023-01-12 11:54:04 +0800176 session->ticket_flags);
Pengyu Lve2f1dbf2023-01-16 12:28:27 +0800177 if (mbedtls_ssl_tls13_check_kex_modes(
178 ssl,
179 mbedtls_ssl_session_get_ticket_flags(
180 session,
181 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800182 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
183 goto exit;
184 }
185
Gilles Peskine449bd832023-01-11 14:50:10 +0100186 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
187#if defined(MBEDTLS_HAVE_TIME)
188 now = mbedtls_time(NULL);
189
190 if (now < session->start) {
191 MBEDTLS_SSL_DEBUG_MSG(
192 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
193 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
194 (long long) now, (long long) session->start));
195 goto exit;
196 }
197
198 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800199
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800200 /* RFC 8446 section 4.6.1
201 *
202 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
203 *
204 * RFC 8446 section 4.2.11.1
205 *
206 * Clients MUST NOT attempt to use tickets which have ages greater than
207 * the "ticket_lifetime" value which was provided with the ticket.
208 *
209 * For time being, the age MUST be less than 604800 seconds (7 days).
210 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100211 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800212 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100213 3, ("Ticket age exceeds limitation ticket_age=%lu",
214 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800215 goto exit;
216 }
Jerry Yu95699e72022-08-21 19:22:23 +0800217
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800218 /* RFC 8446 section 4.2.10
219 *
220 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
221 * the ticket age for the selected PSK identity (computed by subtracting
222 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
223 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800224 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800225 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
226 * as the age units are different on the server (s) and in the
227 * client (ms) side. Add a -1000 ms tolerance window to take this
228 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800229 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800230 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100231 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
232 if (age_diff_in_ms <= -1000 ||
233 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800234 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100235 3, ("Ticket age outside tolerance window ( diff=%d )",
236 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800237 goto exit;
238 }
239
240 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800241
242#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800243
244exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100245 if (ret != 0) {
246 mbedtls_ssl_session_free(session);
247 }
Jerry Yu95699e72022-08-21 19:22:23 +0800248
Gilles Peskine449bd832023-01-11 14:50:10 +0100249 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
250 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800251}
252#endif /* MBEDTLS_SSL_SESSION_TICKETS */
253
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800254MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000255static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100256 mbedtls_ssl_context *ssl,
257 const unsigned char *identity,
258 size_t identity_len,
259 uint32_t obfuscated_ticket_age,
260 int *psk_type,
261 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000262{
Ronald Cron606671e2023-02-17 11:36:33 +0100263 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
264
Jerry Yu95699e72022-08-21 19:22:23 +0800265 ((void) session);
266 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800267 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800268
Gilles Peskine449bd832023-01-11 14:50:10 +0100269 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800270 ssl->handshake->resume = 0;
271
Jerry Yu95699e72022-08-21 19:22:23 +0800272#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800274 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100275 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800276 ssl->handshake->resume = 1;
277 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Ronald Cron606671e2023-02-17 11:36:33 +0100278 ret = mbedtls_ssl_set_hs_psk(ssl,
279 session->resumption_key,
280 session->resumption_key_len);
281 if (ret != 0) {
282 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
283 return ret;
284 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100285
286 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
287 session->resumption_key,
288 session->resumption_key_len);
289 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
290 (unsigned) obfuscated_ticket_age));
291 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800292 }
293#endif /* MBEDTLS_SSL_SESSION_TICKETS */
294
Jerry Yu1c105562022-07-10 06:32:38 +0000295 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100296 if (ssl->conf->f_psk != NULL) {
297 if (ssl->conf->f_psk(
298 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
299 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000300 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100301 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000302 }
303
Gilles Peskine449bd832023-01-11 14:50:10 +0100304 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000305 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100306 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800307 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100308 mbedtls_ct_memcmp(ssl->conf->psk_identity,
309 identity, identity_len) == 0) {
Ronald Cron606671e2023-02-17 11:36:33 +0100310 ret = mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
311 if (ret != 0) {
312 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_set_hs_psk", ret);
313 return ret;
314 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100315 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000316 }
317
Gilles Peskine449bd832023-01-11 14:50:10 +0100318 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000319}
320
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800321MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000322static int ssl_tls13_offered_psks_check_binder_match(
323 mbedtls_ssl_context *ssl,
324 const unsigned char *binder, size_t binder_len,
325 int psk_type, psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000326{
327 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800328
Jerry Yudaf375a2022-07-20 21:31:43 +0800329 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000330 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800331 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800332 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800333 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000334
Jerry Yu1c105562022-07-10 06:32:38 +0000335 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800336 ret = mbedtls_ssl_get_handshake_transcript(
Manuel Pégourié-Gonnard2d6d9932023-03-28 11:38:08 +0200337 ssl, mbedtls_md_type_from_psa_alg(psk_hash_alg),
Gilles Peskine449bd832023-01-11 14:50:10 +0100338 transcript, sizeof(transcript), &transcript_len);
339 if (ret != 0) {
340 return ret;
341 }
Jerry Yu1c105562022-07-10 06:32:38 +0000342
Gilles Peskine449bd832023-01-11 14:50:10 +0100343 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
344 if (ret != 0) {
345 return ret;
346 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800347
Gilles Peskine449bd832023-01-11 14:50:10 +0100348 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
349 psk, psk_len, psk_type,
350 transcript,
351 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800352#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100353 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800354#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100355 if (ret != 0) {
356 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
357 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000358 }
359
Gilles Peskine449bd832023-01-11 14:50:10 +0100360 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
361 server_computed_binder, transcript_len);
362 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000363
Gilles Peskine449bd832023-01-11 14:50:10 +0100364 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
365 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000366 }
367
Gilles Peskine449bd832023-01-11 14:50:10 +0100368 mbedtls_platform_zeroize(server_computed_binder,
369 sizeof(server_computed_binder));
370 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000371}
Jerry Yu96a2e362022-07-21 15:11:34 +0800372
Jerry Yu5725f1c2022-08-21 17:27:16 +0800373MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800374static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100375 mbedtls_ssl_context *ssl,
376 const unsigned char *cipher_suites,
377 const unsigned char *cipher_suites_end,
378 uint16_t *selected_ciphersuite,
379 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800380{
Jerry Yuf35ba382022-08-23 17:58:26 +0800381 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800382
Jerry Yu0baf9072022-08-25 11:21:04 +0800383 *selected_ciphersuite = 0;
384 *selected_ciphersuite_info = NULL;
385
Jerry Yuf35ba382022-08-23 17:58:26 +0800386 /* RFC 8446, page 55.
387 *
388 * For externally established PSKs, the Hash algorithm MUST be set when the
389 * PSK is established or default to SHA-256 if no such algorithm is defined.
390 *
391 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800392
Jerry Yu5725f1c2022-08-21 17:27:16 +0800393 /*
394 * Search for a matching ciphersuite
395 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100396 for (const unsigned char *p = cipher_suites;
397 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800398 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800399 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800400
Gilles Peskine449bd832023-01-11 14:50:10 +0100401 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
402 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
403 cipher_suite);
404 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800405 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100406 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800407
Jerry Yu5725f1c2022-08-21 17:27:16 +0800408 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
409 * Otherwise, client should reject.
410 */
Dave Rodgman2eab4622023-10-05 13:30:37 +0100411 if (psk_hash_alg ==
412 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800413 *selected_ciphersuite = cipher_suite;
414 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100415 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800416 }
417 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100418 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
419 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800420}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800421
Jerry Yu82534862022-08-30 10:42:33 +0800422#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800423MBEDTLS_CHECK_RETURN_CRITICAL
424static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100425 mbedtls_ssl_context *ssl,
426 const unsigned char *cipher_suites,
427 const unsigned char *cipher_suites_end,
428 mbedtls_ssl_session *session,
429 uint16_t *selected_ciphersuite,
430 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800431{
Jerry Yu82534862022-08-30 10:42:33 +0800432
Jerry Yuf35ba382022-08-23 17:58:26 +0800433 *selected_ciphersuite = 0;
434 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100435 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
436 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800437 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
438
Gilles Peskine449bd832023-01-11 14:50:10 +0100439 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800440 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100441 }
Jerry Yu82534862022-08-30 10:42:33 +0800442
Gilles Peskine449bd832023-01-11 14:50:10 +0100443 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
444 cipher_suite);
445 if (ciphersuite_info == NULL) {
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
Jerry Yu4746b102022-09-13 11:11:48 +0800449 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800450 *selected_ciphersuite_info = ciphersuite_info;
451
Gilles Peskine449bd832023-01-11 14:50:10 +0100452 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800453 }
454
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800456}
Jerry Yuf35ba382022-08-23 17:58:26 +0800457
Jerry Yu82534862022-08-30 10:42:33 +0800458MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100459static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
460 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800461{
Jerry Yu82534862022-08-30 10:42:33 +0800462 dst->ticket_age_add = src->ticket_age_add;
463 dst->ticket_flags = src->ticket_flags;
464 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100465 if (src->resumption_key_len == 0) {
466 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
467 }
468 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800469
Gilles Peskine449bd832023-01-11 14:50:10 +0100470 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800471}
472#endif /* MBEDTLS_SSL_SESSION_TICKETS */
473
Jerry Yu1c105562022-07-10 06:32:38 +0000474/* Parser for pre_shared_key extension in client hello
475 * struct {
476 * opaque identity<1..2^16-1>;
477 * uint32 obfuscated_ticket_age;
478 * } PskIdentity;
479 *
480 * opaque PskBinderEntry<32..255>;
481 *
482 * struct {
483 * PskIdentity identities<7..2^16-1>;
484 * PskBinderEntry binders<33..2^16-1>;
485 * } OfferedPsks;
486 *
487 * struct {
488 * select (Handshake.msg_type) {
489 * case client_hello: OfferedPsks;
490 * ....
491 * };
492 * } PreSharedKeyExtension;
493 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800494MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000495static int ssl_tls13_parse_pre_shared_key_ext(
496 mbedtls_ssl_context *ssl,
497 const unsigned char *pre_shared_key_ext,
498 const unsigned char *pre_shared_key_ext_end,
499 const unsigned char *ciphersuites,
500 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000501{
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100502 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800503 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800504 const unsigned char *p_identity_len;
505 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000506 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800507 const unsigned char *binders;
508 const unsigned char *p_binder_len;
509 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000510 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800511 int matched_identity = -1;
512 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000513
Gilles Peskine449bd832023-01-11 14:50:10 +0100514 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
515 pre_shared_key_ext,
516 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000517
Jerry Yu96a2e362022-07-21 15:11:34 +0800518 /* identities_len 2 bytes
519 * identities_data >= 7 bytes
520 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
522 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800523 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
525 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800526 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000527
Jerry Yu96a2e362022-07-21 15:11:34 +0800528 /* binders_len 2 bytes
529 * binders >= 33 bytes
530 */
Jerry Yu568ec252022-07-22 21:27:34 +0800531 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100532 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
533 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800534 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100535 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800536 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000537
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100538 ret = ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
539 identities_end - pre_shared_key_ext);
540 if (0 != ret) {
541 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
542 return ret;
543 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800544
Gilles Peskine449bd832023-01-11 14:50:10 +0100545 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000546 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800547 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800548 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800549 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800550 size_t binder_len;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800551 int psk_type;
552 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800553 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800554#if defined(MBEDTLS_SSL_SESSION_TICKETS)
555 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100556 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800557#endif
Jerry Yubb852022022-07-20 21:10:44 +0800558
Gilles Peskine449bd832023-01-11 14:50:10 +0100559 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
560 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800561 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
563 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800564 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000565
Gilles Peskine449bd832023-01-11 14:50:10 +0100566 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800567 binder_len = *p_binder_len;
568 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100569 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800570 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800571
Jerry Yu96a2e362022-07-21 15:11:34 +0800572 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100573 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000574 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100575 }
Jerry Yu1c105562022-07-10 06:32:38 +0000576
Jerry Yu96a2e362022-07-21 15:11:34 +0800577 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100578 ssl, identity, identity_len, obfuscated_ticket_age,
579 &psk_type, &session);
580 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800581 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100582 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800583
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
585 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800586 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
587 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100588 ssl, ciphersuites, ciphersuites_end,
589 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800590 break;
591 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800592#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800593 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100594 ssl, ciphersuites, ciphersuites_end, &session,
595 &cipher_suite, &ciphersuite_info);
596 if (ret != 0) {
597 mbedtls_ssl_session_free(&session);
598 }
Jerry Yu82534862022-08-30 10:42:33 +0800599#else
600 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
601#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800602 break;
603 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800605 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800607 /* See below, no cipher_suite available, abort handshake */
608 MBEDTLS_SSL_PEND_FATAL_ALERT(
609 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100610 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800611 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100612 2, "ssl_tls13_select_ciphersuite", ret);
613 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800614 }
615
Jerry Yu96a2e362022-07-21 15:11:34 +0800616 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100617 ssl, binder, binder_len, psk_type,
Dave Rodgman2eab4622023-10-05 13:30:37 +0100618 mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac));
Gilles Peskine449bd832023-01-11 14:50:10 +0100619 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800620 /* For security reasons, the handshake should be aborted when we
621 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
622 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800623#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100624 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800625#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100626 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000627 MBEDTLS_SSL_DEBUG_RET(
628 1, "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800629 MBEDTLS_SSL_PEND_FATAL_ALERT(
630 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100631 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
632 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800633 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800634
635 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800636
637 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800638 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800639 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100640 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
641 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800642#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100643 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
644 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
645 &session);
646 mbedtls_ssl_session_free(&session);
647 if (ret != 0) {
648 return ret;
649 }
Jerry Yu82534862022-08-30 10:42:33 +0800650 }
651#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000652 }
653
Gilles Peskine449bd832023-01-11 14:50:10 +0100654 if (p_identity_len != identities_end || p_binder_len != binders_end) {
655 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
656 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
657 MBEDTLS_ERR_SSL_DECODE_ERROR);
658 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000659 }
660
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800661 /* Update the handshake transcript with the binder list. */
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000662 ret = ssl->handshake->update_checksum(
663 ssl, identities_end, (size_t) (binders_end - identities_end));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +0100664 if (0 != ret) {
665 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
666 return ret;
667 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100668 if (matched_identity == -1) {
669 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
670 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000671 }
672
Gilles Peskine449bd832023-01-11 14:50:10 +0100673 ssl->handshake->selected_identity = (uint16_t) matched_identity;
674 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000675
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000677}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678
679/*
680 * struct {
681 * select ( Handshake.msg_type ) {
682 * ....
683 * case server_hello:
684 * uint16 selected_identity;
685 * }
686 * } PreSharedKeyExtension;
687 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100688static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
689 unsigned char *buf,
690 unsigned char *end,
691 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000692{
Gilles Peskine449bd832023-01-11 14:50:10 +0100693 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694
695 *olen = 0;
696
David Horstmann21b89762022-10-06 18:34:28 +0100697 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000700#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100703 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000704 /* We shouldn't have called this extension writer unless we've
705 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100706 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000707 }
708
Gilles Peskine449bd832023-01-11 14:50:10 +0100709 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
710 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000711
Gilles Peskine449bd832023-01-11 14:50:10 +0100712 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
713 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000714
Gilles Peskine449bd832023-01-11 14:50:10 +0100715 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000716
717 *olen = 6;
718
Gilles Peskine449bd832023-01-11 14:50:10 +0100719 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
720 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800723
Gilles Peskine449bd832023-01-11 14:50:10 +0100724 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000725}
726
Ronald Cron41a443a2022-10-04 16:38:25 +0200727#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000728
XiaokangQian7807f9f2022-02-15 10:04:37 +0000729/* From RFC 8446:
730 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000731 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000732 * } SupportedVersions;
733 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200734MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100735static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
736 const unsigned char *buf,
737 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000739 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000740 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000741 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000742 uint16_t tls_version;
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100743 int found_supported_version = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000744
Gilles Peskine449bd832023-01-11 14:50:10 +0100745 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000746 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000747 p += 1;
748
Gilles Peskine449bd832023-01-11 14:50:10 +0100749 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000750 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 while (p < versions_end) {
752 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
753 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000754 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000755
Ronald Cron3bd2b022023-04-03 16:45:39 +0200756 if (MBEDTLS_SSL_VERSION_TLS1_3 == tls_version) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100757 found_supported_version = 1;
758 break;
759 }
760
Ronald Cron3bd2b022023-04-03 16:45:39 +0200761 if ((MBEDTLS_SSL_VERSION_TLS1_2 == tls_version) &&
762 mbedtls_ssl_conf_is_tls12_enabled(ssl->conf)) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100763 found_supported_version = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000764 break;
765 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000766 }
767
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100768 if (!found_supported_version) {
769 MBEDTLS_SSL_DEBUG_MSG(1, ("No supported version found."));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000770
Gilles Peskine449bd832023-01-11 14:50:10 +0100771 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
772 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
773 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000774 }
775
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100776 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version: [%04x]",
Gilles Peskine449bd832023-01-11 14:50:10 +0100777 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778
Ronald Cron5af4c7f2023-03-07 20:46:59 +0100779 return (int) tls_version;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780}
781
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200782#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000783/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784 *
785 * From RFC 8446:
786 * enum {
787 * ... (0xFFFF)
788 * } NamedGroup;
789 * struct {
790 * NamedGroup named_group_list<2..2^16-1>;
791 * } NamedGroupList;
792 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200793MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100794static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
795 const unsigned char *buf,
796 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000797{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000798 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000799 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000800 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000801
Gilles Peskine449bd832023-01-11 14:50:10 +0100802 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
803 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
804 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000805 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100806 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000807 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000808 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000809
Gilles Peskine449bd832023-01-11 14:50:10 +0100810 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000811 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100812 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
813 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000814 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000815
Gilles Peskine449bd832023-01-11 14:50:10 +0100816 MBEDTLS_SSL_DEBUG_MSG(2,
817 ("got named group: %s(%04x)",
818 mbedtls_ssl_named_group_to_str(named_group),
819 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000820
Gilles Peskine449bd832023-01-11 14:50:10 +0100821 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
822 !mbedtls_ssl_named_group_is_supported(named_group) ||
823 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000824 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825 }
826
Gilles Peskine449bd832023-01-11 14:50:10 +0100827 MBEDTLS_SSL_DEBUG_MSG(2,
828 ("add named group %s(%04x) into received list.",
829 mbedtls_ssl_named_group_to_str(named_group),
830 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800831
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000832 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000833 }
834
Gilles Peskine449bd832023-01-11 14:50:10 +0100835 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000836
837}
Przemek Stekiel8c0a9532023-06-15 16:48:19 +0200838#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839
XiaokangQian08037552022-04-20 07:16:41 +0000840#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
841
Valerio Settic9ae8622023-07-25 11:23:50 +0200842#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000843/*
844 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000845 * extension is correct and stores the first acceptable key share and its
846 * associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000847 *
848 * Possible return values are:
849 * - 0: Successful processing of the client provided key share extension.
Xiaokang Qian9f1747b2023-03-30 02:50:04 +0000850 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by
851 * the client does not match a group supported by the server. A
852 * HelloRetryRequest will be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000853 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800854 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200855MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100856static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
857 const unsigned char *buf,
858 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000859{
XiaokangQianb67384d2022-04-19 00:02:38 +0000860 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000861 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000862 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800863 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864
865 /* From RFC 8446:
866 *
867 * struct {
868 * KeyShareEntry client_shares<0..2^16-1>;
869 * } KeyShareClientHello;
870 *
871 */
872
Gilles Peskine449bd832023-01-11 14:50:10 +0100873 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
874 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000875 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100876 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000877
878 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000879 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000880
881 /* We try to find a suitable key share entry and copy it to the
882 * handshake context. Later, we have to find out whether we can do
883 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000884 * dismiss it and send a HelloRetryRequest message.
885 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000886
Gilles Peskine449bd832023-01-11 14:50:10 +0100887 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000888 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800889 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800890 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000891
892 /*
893 * struct {
894 * NamedGroup group;
895 * opaque key_exchange<1..2^16-1>;
896 * } KeyShareEntry;
897 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100898 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
899 group = MBEDTLS_GET_UINT16_BE(p, 0);
900 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800901 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800902 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100903 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800904 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000905
906 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000907 * for input validation purposes.
908 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
910 !mbedtls_ssl_named_group_is_supported(group) ||
911 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000912 continue;
913 }
XiaokangQian060d8672022-04-21 09:24:56 +0000914
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915 /*
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200916 * ECDHE and FFDHE groups are supported
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917 */
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200918 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +0200919 mbedtls_ssl_tls13_named_group_is_ffdh(group)) {
Przemek Stekielc89f3ea2023-05-18 15:45:53 +0200920 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH/FFDH group: %s (%04x)",
Gilles Peskine449bd832023-01-11 14:50:10 +0100921 mbedtls_ssl_named_group_to_str(group),
922 group));
Przemek Stekiel7ac93be2023-07-04 10:02:38 +0200923 ret = mbedtls_ssl_tls13_read_public_xxdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100924 ssl, key_exchange - 2, key_exchange_len + 2);
925 if (ret != 0) {
926 return ret;
927 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000928
Gilles Peskine449bd832023-01-11 14:50:10 +0100929 } else {
930 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
931 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932 continue;
933 }
934
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000935 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000936 }
937
Jerry Yuc1be19f2022-04-23 16:11:39 +0800938
Gilles Peskine449bd832023-01-11 14:50:10 +0100939 if (ssl->handshake->offered_group_id == 0) {
940 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
941 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000942 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000944}
Valerio Settic9ae8622023-07-25 11:23:50 +0200945#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000946
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200947MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100948static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
949 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000950{
Jerry Yu0c354a22022-08-29 15:25:36 +0800951 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100952 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000953}
954
Jerry Yue5991322022-11-07 14:03:44 +0800955#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200956MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000957static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100958 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000959{
Gilles Peskine449bd832023-01-11 14:50:10 +0100960 return ssl_tls13_client_hello_has_exts(
961 ssl,
962 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
963 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
964 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000965}
Jerry Yue5991322022-11-07 14:03:44 +0800966#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000967
Jerry Yue5991322022-11-07 14:03:44 +0800968#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000969MBEDTLS_CHECK_RETURN_CRITICAL
970static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100971 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000972{
Gilles Peskine449bd832023-01-11 14:50:10 +0100973 return ssl_tls13_client_hello_has_exts(
974 ssl,
975 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
976 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000977}
Jerry Yue5991322022-11-07 14:03:44 +0800978#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000979
Jerry Yue5991322022-11-07 14:03:44 +0800980#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000981MBEDTLS_CHECK_RETURN_CRITICAL
982static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100983 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000984{
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 return ssl_tls13_client_hello_has_exts(
986 ssl,
987 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
988 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
989 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
990 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000991}
Jerry Yue5991322022-11-07 14:03:44 +0800992#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000993
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200994MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100995static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000996{
Jerry Yue5991322022-11-07 14:03:44 +0800997#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
999 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +08001000#else
1001 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001002 return 0;
Jerry Yue5991322022-11-07 14:03:44 +08001003#endif
Jerry Yu77f01482022-07-11 07:03:24 +00001004}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001005
Jerry Yu77f01482022-07-11 07:03:24 +00001006MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001007static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001008{
Jerry Yue5991322022-11-07 14:03:44 +08001009#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001010 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
1011 mbedtls_ssl_tls13_psk_enabled(ssl) &&
1012 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001013#else
1014 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001015 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001016#endif
1017}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001018
Jerry Yu77f01482022-07-11 07:03:24 +00001019MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001020static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001021{
Jerry Yue5991322022-11-07 14:03:44 +08001022#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01001023 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
1024 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
1025 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +00001026#else
1027 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +01001028 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001029#endif
1030}
1031
Gilles Peskine449bd832023-01-11 14:50:10 +01001032static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001033{
1034 /*
1035 * Determine the key exchange algorithm to use.
1036 * There are three types of key exchanges supported in TLS 1.3:
1037 * - (EC)DH with ECDSA,
1038 * - (EC)DH with PSK,
1039 * - plain PSK.
1040 *
1041 * The PSK-based key exchanges may additionally be used with 0-RTT.
1042 *
1043 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001044 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1045 * 2 ) Certificate Mode ( ephemeral )
1046 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001047 */
1048
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001049 ssl->handshake->key_exchange_mode =
1050 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
Jerry Yu77f01482022-07-11 07:03:24 +00001051
Gilles Peskine449bd832023-01-11 14:50:10 +01001052 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001053 ssl->handshake->key_exchange_mode =
1054 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001055 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1056 } else
1057 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001058 ssl->handshake->key_exchange_mode =
1059 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1061 } else
1062 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001063 ssl->handshake->key_exchange_mode =
1064 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001065 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1066 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001067 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 1,
1069 ("ClientHello message misses mandatory extensions."));
1070 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1071 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1072 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001073 }
1074
Gilles Peskine449bd832023-01-11 14:50:10 +01001075 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001076
XiaokangQian7807f9f2022-02-15 10:04:37 +00001077}
1078
XiaokangQian81802f42022-06-10 13:25:22 +00001079#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001080 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001081
1082#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001083static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001084{
Gilles Peskine449bd832023-01-11 14:50:10 +01001085 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001086 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001087 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001088 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001089 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001090 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001091 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001092 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001093 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001094 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001095 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001096 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001097 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001098 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001099 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001100 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001102 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001103 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001104 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001105 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001106 }
1107}
1108#endif /* MBEDTLS_USE_PSA_CRYPTO */
1109
XiaokangQian23c5be62022-06-07 02:04:34 +00001110/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001111 * Pick best ( private key, certificate chain ) pair based on the signature
1112 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001113 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001114MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001115static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001116{
XiaokangQianfb665a82022-06-15 03:57:21 +00001117 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001118 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001119
1120#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001121 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001122 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001123 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001124#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001125 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001126
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 if (key_cert_list == NULL) {
1128 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1129 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001130 }
1131
Gilles Peskine449bd832023-01-11 14:50:10 +01001132 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1133 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001134 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001135 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001136
Gilles Peskine449bd832023-01-11 14:50:10 +01001137 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001138 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001140
Gilles Peskine449bd832023-01-11 14:50:10 +01001141 for (key_cert = key_cert_list; key_cert != NULL;
1142 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001143#if defined(MBEDTLS_USE_PSA_CRYPTO)
1144 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1145#endif /* MBEDTLS_USE_PSA_CRYPTO */
1146
Gilles Peskine449bd832023-01-11 14:50:10 +01001147 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1148 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001149
1150 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 * This avoids sending the client a cert it'll reject based on
1152 * keyUsage or other extensions.
1153 */
1154 if (mbedtls_x509_crt_check_key_usage(
1155 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001156 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001157 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1159 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1160 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001161 continue;
1162 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001163
Gilles Peskine449bd832023-01-11 14:50:10 +01001164 MBEDTLS_SSL_DEBUG_MSG(3,
1165 ("ssl_tls13_pick_key_cert:"
1166 "check signature algorithm %s [%04x]",
1167 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1168 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001169#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001170 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001171#endif /* MBEDTLS_USE_PSA_CRYPTO */
1172
Gilles Peskine449bd832023-01-11 14:50:10 +01001173 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1174 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001175#if defined(MBEDTLS_USE_PSA_CRYPTO)
1176 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001177 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1178 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001179#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001180 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001181 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001182 MBEDTLS_SSL_DEBUG_MSG(3,
1183 ("ssl_tls13_pick_key_cert:"
1184 "selected signature algorithm"
1185 " %s [%04x]",
1186 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1187 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001188 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001189 3, "selected certificate (chain)",
1190 ssl->handshake->key_cert->cert);
1191 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001192 }
XiaokangQian81802f42022-06-10 13:25:22 +00001193 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001194 }
1195
Gilles Peskine449bd832023-01-11 14:50:10 +01001196 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1197 "no suitable certificate found"));
1198 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001199}
XiaokangQian81802f42022-06-10 13:25:22 +00001200#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001201 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001202
XiaokangQian4080a7f2022-04-11 09:55:18 +00001203/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001204 *
1205 * STATE HANDLING: ClientHello
1206 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001207 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001208 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001209 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001210 *
1211 * In this case, the server progresses to sending its ServerHello.
1212 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001213 * 2) The ClientHello was well-formed but didn't match the server's
1214 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001215 *
1216 * For example, the client might not have offered a key share which
1217 * the server supports, or the server might require a cookie.
1218 *
1219 * In this case, the server sends a HelloRetryRequest.
1220 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001221 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001222 *
1223 * In this case, we abort the handshake.
1224 *
1225 */
1226
1227/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001228 * Structure of this message:
1229 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001230 * uint16 ProtocolVersion;
1231 * opaque Random[32];
1232 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001233 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001234 * struct {
1235 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1236 * Random random;
1237 * opaque legacy_session_id<0..32>;
1238 * CipherSuite cipher_suites<2..2^16-2>;
1239 * opaque legacy_compression_methods<1..2^8-1>;
1240 * Extension extensions<8..2^16-1>;
1241 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001242 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001243
1244#define SSL_CLIENT_HELLO_OK 0
1245#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001246#define SSL_CLIENT_HELLO_TLS1_2 2
XiaokangQianed582dd2022-04-13 08:21:05 +00001247
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001248MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001249static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1250 const unsigned char *buf,
1251 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001252{
XiaokangQianb67384d2022-04-19 00:02:38 +00001253 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1254 const unsigned char *p = buf;
Ronald Crond540d992023-03-07 09:41:48 +01001255 const unsigned char *random;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001256 size_t legacy_session_id_len;
Ronald Croncada4102023-03-07 09:51:39 +01001257 const unsigned char *legacy_session_id;
XiaokangQian318dc762022-04-20 09:43:51 +00001258 size_t cipher_suites_len;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001259 const unsigned char *cipher_suites;
XiaokangQian060d8672022-04-21 09:24:56 +00001260 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001261 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001262 const unsigned char *extensions_end;
Ronald Croneff56732023-04-03 17:36:31 +02001263 const unsigned char *supported_versions_data;
1264 const unsigned char *supported_versions_data_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001265 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001266 int hrr_required = 0;
Ronald Cron8a74f072023-06-14 17:59:29 +02001267 int no_usable_share_for_key_agreement = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001268
Ronald Cron41a443a2022-10-04 16:38:25 +02001269#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu29d9faa2022-08-23 17:52:45 +08001270 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001271 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001272#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001273
XiaokangQian7807f9f2022-02-15 10:04:37 +00001274 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001275 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001277 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001278 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001279 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001280 * .. . .. ciphersuite list length ( 2 bytes )
1281 * .. . .. ciphersuite list
1282 * .. . .. compression alg. list length ( 1 byte )
1283 * .. . .. compression alg. list
1284 * .. . .. extensions length ( 2 bytes, optional )
1285 * .. . .. extensions ( optional )
1286 */
1287
XiaokangQianb67384d2022-04-19 00:02:38 +00001288 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001289 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001290 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1291 * read at least up to session id length without worrying.
1292 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001294
1295 /* ...
1296 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1297 * ...
1298 * with ProtocolVersion defined as:
1299 * uint16 ProtocolVersion;
1300 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001301 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1302 MBEDTLS_SSL_VERSION_TLS1_2) {
1303 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1304 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1305 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1306 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001307 }
1308 p += 2;
1309
Jerry Yuc1be19f2022-04-23 16:11:39 +08001310 /* ...
1311 * Random random;
1312 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001313 * with Random defined as:
1314 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001315 */
Ronald Crond540d992023-03-07 09:41:48 +01001316 random = p;
XiaokangQian08037552022-04-20 07:16:41 +00001317 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318
Jerry Yuc1be19f2022-04-23 16:11:39 +08001319 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001320 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001321 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322 */
Ronald Croncada4102023-03-07 09:51:39 +01001323 legacy_session_id_len = *(p++);
1324 legacy_session_id = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001325
XiaokangQianb67384d2022-04-19 00:02:38 +00001326 /*
1327 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001328 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001331 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001332
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001333 /* ...
1334 * CipherSuite cipher_suites<2..2^16-2>;
1335 * ...
1336 * with CipherSuite defined as:
1337 * uint8 CipherSuite[2];
1338 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001339 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001340 p += 2;
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001341 cipher_suites = p;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001342
Ronald Cronfc7ae872023-02-16 15:32:19 +01001343 /*
1344 * The length of the ciphersuite list has to be even.
1345 */
1346 if (cipher_suites_len & 1) {
1347 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1348 MBEDTLS_ERR_SSL_DECODE_ERROR);
1349 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1350 }
1351
XiaokangQianb67384d2022-04-19 00:02:38 +00001352 /* Check we have enough data for the ciphersuite list, the legacy
1353 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001354 *
1355 * cipher_suites cipher_suites_len bytes
1356 * legacy_compression_methods 2 bytes
1357 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001358 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
Ronald Cron8c527d02023-03-07 15:47:47 +01001360 p += cipher_suites_len;
1361 cipher_suites_end = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001362
1363 /*
Ronald Cron8c527d02023-03-07 15:47:47 +01001364 * Search for the supported versions extension and parse it to determine
1365 * if the client supports TLS 1.3.
1366 */
1367 ret = mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts(
1368 ssl, p + 2, end,
Ronald Croneff56732023-04-03 17:36:31 +02001369 &supported_versions_data, &supported_versions_data_end);
Ronald Cron8c527d02023-03-07 15:47:47 +01001370 if (ret < 0) {
1371 MBEDTLS_SSL_DEBUG_RET(1,
1372 ("mbedtls_ssl_tls13_is_supported_versions_ext_present_in_exts"), ret);
1373 return ret;
1374 }
1375
1376 if (ret == 0) {
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001377 return SSL_CLIENT_HELLO_TLS1_2;
Ronald Cron8c527d02023-03-07 15:47:47 +01001378 }
1379
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001380 if (ret == 1) {
1381 ret = ssl_tls13_parse_supported_versions_ext(ssl,
Ronald Croneff56732023-04-03 17:36:31 +02001382 supported_versions_data,
1383 supported_versions_data_end);
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001384 if (ret < 0) {
1385 MBEDTLS_SSL_DEBUG_RET(1,
1386 ("ssl_tls13_parse_supported_versions_ext"), ret);
1387 return ret;
1388 }
1389
Ronald Cronb828c7d2023-04-03 16:37:22 +02001390 /*
1391 * The supported versions extension was parsed successfully as the
1392 * value returned by ssl_tls13_parse_supported_versions_ext() is
1393 * positive. The return value is then equal to
1394 * MBEDTLS_SSL_VERSION_TLS1_2 or MBEDTLS_SSL_VERSION_TLS1_3, defining
1395 * the TLS version to negotiate.
1396 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001397 if (MBEDTLS_SSL_VERSION_TLS1_2 == ret) {
1398 return SSL_CLIENT_HELLO_TLS1_2;
1399 }
Ronald Cron8c527d02023-03-07 15:47:47 +01001400 }
1401
1402 /*
1403 * We negotiate TLS 1.3.
Ronald Cron64582392023-03-07 09:21:40 +01001404 */
1405 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1406
1407#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1408 /* Store minor version for later use with ticket serialization. */
1409 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
1410 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1411#endif
1412
1413 /*
Ronald Crondad02b22023-04-06 09:57:52 +02001414 * We are negotiating the version 1.3 of the protocol. Do what we have
Ronald Croncada4102023-03-07 09:51:39 +01001415 * postponed: copy of the client random bytes, copy of the legacy session
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001416 * identifier and selection of the TLS 1.3 cipher suite.
Ronald Crond540d992023-03-07 09:41:48 +01001417 */
1418 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1419 random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1420 memcpy(&handshake->randbytes[0], random, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
1421
Ronald Croncada4102023-03-07 09:51:39 +01001422 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1423 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1424 return MBEDTLS_ERR_SSL_DECODE_ERROR;
1425 }
1426 ssl->session_negotiate->id_len = legacy_session_id_len;
1427 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1428 legacy_session_id, legacy_session_id_len);
1429 memcpy(&ssl->session_negotiate->id[0],
1430 legacy_session_id, legacy_session_id_len);
1431
Ronald Crond540d992023-03-07 09:41:48 +01001432 /*
Jerry Yu5725f1c2022-08-21 17:27:16 +08001433 * Search for a matching ciphersuite
1434 */
Ronald Cron2f16b4e2023-03-07 10:07:32 +01001435 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, list of cipher suites",
1436 cipher_suites, cipher_suites_len);
Ronald Crone45afd72023-04-04 15:10:06 +02001437 for (const unsigned char *cipher_suites_p = cipher_suites;
1438 cipher_suites_p < cipher_suites_end; cipher_suites_p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001439 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001441
Ronald Crond89360b2023-02-21 08:53:33 +01001442 /*
Ronald Crone45afd72023-04-04 15:10:06 +02001443 * "cipher_suites_end - cipher_suites_p is even" is an invariant of the
1444 * loop. As cipher_suites_end - cipher_suites_p > 0, we have
1445 * cipher_suites_end - cipher_suites_p >= 2 and it is thus safe to read
1446 * two bytes.
Ronald Crond89360b2023-02-21 08:53:33 +01001447 */
Ronald Crone45afd72023-04-04 15:10:06 +02001448 cipher_suite = MBEDTLS_GET_UINT16_BE(cipher_suites_p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001449 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001450 ssl, cipher_suite);
1451 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001452 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001453 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001454
Jerry Yu5725f1c2022-08-21 17:27:16 +08001455 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001456 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001457 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1458 cipher_suite,
1459 ciphersuite_info->name));
Ronald Cron25e9ec62023-02-16 15:35:16 +01001460 break;
XiaokangQian17f974c2022-04-19 09:57:41 +00001461 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001462
Gilles Peskine449bd832023-01-11 14:50:10 +01001463 if (handshake->ciphersuite_info == NULL) {
1464 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1465 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1466 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001467 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001468
XiaokangQian4080a7f2022-04-11 09:55:18 +00001469 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001470 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001471 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001472 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001473 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1474 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1475 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1476 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1477 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001478 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001479 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001480
Jerry Yuc1be19f2022-04-23 16:11:39 +08001481 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001482 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001483 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001484 * with Extension defined as:
1485 * struct {
1486 * ExtensionType extension_type;
1487 * opaque extension_data<0..2^16-1>;
1488 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001489 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001490 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001491 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001492 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001493 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001494
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
Jerry Yu63a459c2022-10-31 13:38:40 +08001496 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001497
Gilles Peskine449bd832023-01-11 14:50:10 +01001498 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001499 unsigned int extension_type;
1500 size_t extension_data_len;
1501 const unsigned char *extension_data_end;
1502
Jerry Yu0c354a22022-08-29 15:25:36 +08001503 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001504 *
1505 * The "pre_shared_key" extension MUST be the last extension in the
1506 * ClientHello (this facilitates implementation as described below).
1507 * Servers MUST check that it is the last extension and otherwise fail
1508 * the handshake with an "illegal_parameter" alert.
1509 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001510 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001511 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001512 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001513 MBEDTLS_SSL_PEND_FATAL_ALERT(
1514 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001515 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1516 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001517 }
1518
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1520 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1521 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001522 p += 4;
1523
Gilles Peskine449bd832023-01-11 14:50:10 +01001524 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001525 extension_data_end = p + extension_data_len;
1526
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001527 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001528 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1529 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1530 if (ret != 0) {
1531 return ret;
1532 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001533
Gilles Peskine449bd832023-01-11 14:50:10 +01001534 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001535#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1536 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001537 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1538 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1539 extension_data_end);
1540 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001541 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001542 1, "mbedtls_ssl_parse_servername_ext", ret);
1543 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001544 }
XiaokangQian40a35232022-05-07 09:02:40 +00001545 break;
1546#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1547
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001548#if defined(PSA_WANT_ALG_ECDH) || defined(PSA_WANT_ALG_FFDH)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001549 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001551
1552 /* Supported Groups Extension
1553 *
1554 * When sent by the client, the "supported_groups" extension
1555 * indicates the named groups which the client supports,
1556 * ordered from most preferred to least preferred.
1557 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001558 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001559 ssl, p, extension_data_end);
1560 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001561 MBEDTLS_SSL_DEBUG_RET(
Xiaokang Qian8bce0e62023-04-04 10:15:48 +00001562 1, "ssl_tls13_parse_supported_groups_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001564 }
1565
XiaokangQian7807f9f2022-02-15 10:04:37 +00001566 break;
Przemek Stekiel8c0a9532023-06-15 16:48:19 +02001567#endif /* PSA_WANT_ALG_ECDH || PSA_WANT_ALG_FFDH*/
XiaokangQian7807f9f2022-02-15 10:04:37 +00001568
Valerio Settic9ae8622023-07-25 11:23:50 +02001569#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001570 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001571 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001572
1573 /*
1574 * Key Share Extension
1575 *
1576 * When sent by the client, the "key_share" extension
1577 * contains the endpoint's cryptographic parameters for
1578 * ECDHE/DHE key establishment methods.
1579 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001580 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001581 ssl, p, extension_data_end);
1582 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
Ronald Cron8a74f072023-06-14 17:59:29 +02001583 MBEDTLS_SSL_DEBUG_MSG(2, ("No usable share for key agreement."));
1584 no_usable_share_for_key_agreement = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001585 }
1586
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001588 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001589 1, "ssl_tls13_parse_key_shares_ext", ret);
1590 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001591 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001592
XiaokangQian7807f9f2022-02-15 10:04:37 +00001593 break;
Valerio Settic9ae8622023-07-25 11:23:50 +02001594#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001595
1596 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Ronald Cron8c527d02023-03-07 15:47:47 +01001597 /* Already parsed */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001598 break;
1599
Ronald Cron41a443a2022-10-04 16:38:25 +02001600#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001601 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001602 MBEDTLS_SSL_DEBUG_MSG(
1603 3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001604
1605 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001606 ssl, p, extension_data_end);
1607 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001608 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001609 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1610 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001611 }
1612
Jerry Yue19e3b92022-07-08 12:04:51 +00001613 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001614#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001615
Jerry Yu1c105562022-07-10 06:32:38 +00001616 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1618 if ((handshake->received_extensions &
1619 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001620 MBEDTLS_SSL_PEND_FATAL_ALERT(
1621 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001622 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1623 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001624 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001625#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001626 /* Delay processing of the PSK identity once we have
1627 * found out which algorithms to use. We keep a pointer
1628 * to the buffer and the size for later processing.
1629 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001630 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001631 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001632#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001633 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001634
XiaokangQianacb39922022-06-17 10:18:48 +00001635#if defined(MBEDTLS_SSL_ALPN)
1636 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001637 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001638
Gilles Peskine449bd832023-01-11 14:50:10 +01001639 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1640 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001641 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001642 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1643 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001644 }
XiaokangQianacb39922022-06-17 10:18:48 +00001645 break;
1646#endif /* MBEDTLS_SSL_ALPN */
1647
Ronald Cron928cbd32022-10-04 16:14:26 +02001648#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001649 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001650 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001651
Gabor Mezei078e8032022-04-27 21:17:56 +02001652 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001653 ssl, p, extension_data_end);
1654 if (ret != 0) {
Xiaokang Qian49f39c12023-04-06 02:31:02 +00001655 MBEDTLS_SSL_DEBUG_RET(
1656 1, "mbedtls_ssl_parse_sig_alg_ext", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01001657 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001658 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001659 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001660#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001661
Jan Bruckner151f6422023-02-10 12:45:19 +01001662#if defined(MBEDTLS_SSL_RECORD_SIZE_LIMIT)
1663 case MBEDTLS_TLS_EXT_RECORD_SIZE_LIMIT:
1664 MBEDTLS_SSL_DEBUG_MSG(3, ("found record_size_limit extension"));
1665
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00001666 ret = mbedtls_ssl_tls13_parse_record_size_limit_ext(
1667 ssl, p, extension_data_end);
Jan Bruckner151f6422023-02-10 12:45:19 +01001668
Xiaokang Qian09c3ccc2023-04-04 10:18:38 +00001669 /*
1670 * TODO: Return unconditionally here until we handle the record
1671 * size limit correctly.
1672 * Once handled correctly, only return in case of errors.
1673 */
Jan Bruckner151f6422023-02-10 12:45:19 +01001674 return ret;
1675
1676 break;
1677#endif /* MBEDTLS_SSL_RECORD_SIZE_LIMIT */
1678
XiaokangQian7807f9f2022-02-15 10:04:37 +00001679 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001680 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001681 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001683 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001684 }
1685
1686 p += extension_data_len;
1687 }
1688
Gilles Peskine449bd832023-01-11 14:50:10 +01001689 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1690 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001691
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001692 ret = mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1693 MBEDTLS_SSL_HS_CLIENT_HELLO,
1694 p - buf);
1695 if (0 != ret) {
1696 MBEDTLS_SSL_DEBUG_RET(1, ("mbedtls_ssl_add_hs_hdr_to_checksum"), ret);
1697 return ret;
1698 }
Jerry Yu032b15ce2022-07-11 06:10:03 +00001699
Ronald Cron41a443a2022-10-04 16:38:25 +02001700#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001701 /* Update checksum with either
1702 * - The entire content of the CH message, if no PSK extension is present
1703 * - The content up to but excluding the PSK extension, if present.
1704 */
Jerry Yu1c105562022-07-10 06:32:38 +00001705 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001706 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1707 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1708 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001709 ret = handshake->update_checksum(ssl, buf,
1710 pre_shared_key_ext - buf);
1711 if (0 != ret) {
1712 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1713 return ret;
1714 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001715 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1716 pre_shared_key_ext,
1717 pre_shared_key_ext_end,
1718 cipher_suites,
1719 cipher_suites_end);
1720 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1721 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1722 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001723 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1725 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001726 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001727 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001728#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001729 {
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01001730 ret = handshake->update_checksum(ssl, buf, p - buf);
1731 if (0 != ret) {
1732 MBEDTLS_SSL_DEBUG_RET(1, ("update_checksum"), ret);
1733 return ret;
1734 }
Jerry Yu1c105562022-07-10 06:32:38 +00001735 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001736
Gilles Peskine449bd832023-01-11 14:50:10 +01001737 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1738 if (ret < 0) {
1739 return ret;
1740 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001741
Ronald Cron8a74f072023-06-14 17:59:29 +02001742 if (ssl->handshake->key_exchange_mode !=
1743 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK) {
1744 hrr_required = (no_usable_share_for_key_agreement != 0);
1745 }
1746
Gilles Peskine449bd832023-01-11 14:50:10 +01001747 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001748
Gilles Peskine449bd832023-01-11 14:50:10 +01001749 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001750}
1751
Jerry Yuab0da372023-02-08 13:55:24 +08001752#if defined(MBEDTLS_SSL_EARLY_DATA)
1753static void ssl_tls13_update_early_data_status(mbedtls_ssl_context *ssl)
1754{
1755 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
1756
1757 if ((handshake->received_extensions &
1758 MBEDTLS_SSL_EXT_MASK(EARLY_DATA)) == 0) {
1759 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yub47b2992023-10-18 15:50:35 +08001760 1, ("EarlyData: no early data extension received."));
Jerry Yuab0da372023-02-08 13:55:24 +08001761 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_NOT_RECEIVED;
1762 return;
1763 }
1764
Jerry Yub47b2992023-10-18 15:50:35 +08001765 /* We do not accept early data for the time being */
Jerry Yuab0da372023-02-08 13:55:24 +08001766 ssl->early_data_status = MBEDTLS_SSL_EARLY_DATA_STATUS_REJECTED;
1767
Jerry Yuab0da372023-02-08 13:55:24 +08001768}
1769#endif /* MBEDTLS_SSL_EARLY_DATA */
1770
XiaokangQian75fe8c72022-06-15 09:42:45 +00001771/* Update the handshake state machine */
1772
Ronald Cronce7d76e2022-07-08 18:56:49 +02001773MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001774static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001775{
1776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1777
XiaokangQian7807f9f2022-02-15 10:04:37 +00001778 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001779 * Server certificate selection
1780 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001781 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1782 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1783 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001784 }
1785#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1786 ssl->handshake->sni_name = NULL;
1787 ssl->handshake->sni_name_len = 0;
1788#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001789
Gilles Peskine449bd832023-01-11 14:50:10 +01001790 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1791 if (ret != 0) {
1792 MBEDTLS_SSL_DEBUG_RET(1,
1793 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1794 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001795 }
1796
Jerry Yuab0da372023-02-08 13:55:24 +08001797#if defined(MBEDTLS_SSL_EARLY_DATA)
1798 /* There is enough information, update early data state. */
1799 ssl_tls13_update_early_data_status(ssl);
Jerry Yuab0da372023-02-08 13:55:24 +08001800#endif /* MBEDTLS_SSL_EARLY_DATA */
1801
Gilles Peskine449bd832023-01-11 14:50:10 +01001802 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001803
1804}
1805
1806/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001807 * Main entry point from the state machine; orchestrates the otherfunctions.
1808 */
1809
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001810MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001811static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001812{
1813
XiaokangQian08037552022-04-20 07:16:41 +00001814 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001815 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001816 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001817 int parse_client_hello_ret;
1818
Gilles Peskine449bd832023-01-11 14:50:10 +01001819 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001820
Gilles Peskine449bd832023-01-11 14:50:10 +01001821 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1822 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1823 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001824
Gilles Peskine449bd832023-01-11 14:50:10 +01001825 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1826 buf + buflen));
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001827 parse_client_hello_ret = ret; /* Store positive return value of
1828 * parse_client_hello,
1829 * as negative error codes are handled
Jerry Yuf41553b2022-05-09 22:20:30 +08001830 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001831
Ronald Cronb828c7d2023-04-03 16:37:22 +02001832 /*
1833 * Version 1.2 of the protocol has been chosen, set the
1834 * ssl->keep_current_message flag for the ClientHello to be kept and parsed
1835 * as a TLS 1.2 ClientHello. We also change ssl->tls_version to
1836 * MBEDTLS_SSL_VERSION_TLS1_2 thus from now on mbedtls_ssl_handshake_step()
1837 * will dispatch to the TLS 1.2 state machine.
1838 */
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001839 if (SSL_CLIENT_HELLO_TLS1_2 == parse_client_hello_ret) {
1840 ssl->keep_current_message = 1;
1841 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
1842 return 0;
1843 }
1844
Gilles Peskine449bd832023-01-11 14:50:10 +01001845 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001846
Ronald Cron5af4c7f2023-03-07 20:46:59 +01001847 if (SSL_CLIENT_HELLO_OK == parse_client_hello_ret) {
Gilles Peskine449bd832023-01-11 14:50:10 +01001848 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1849 } else {
1850 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1851 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001852
1853cleanup:
1854
Gilles Peskine449bd832023-01-11 14:50:10 +01001855 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1856 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001857}
1858
1859/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001860 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001861 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001862MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001863static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001864{
Jerry Yu637a3f12022-04-20 21:37:58 +08001865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1866 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001867 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1868 if (ssl->conf->f_rng == NULL) {
1869 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1870 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001871 }
1872
Gilles Peskine449bd832023-01-11 14:50:10 +01001873 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1874 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1875 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1876 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001877 }
1878
Gilles Peskine449bd832023-01-11 14:50:10 +01001879 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1880 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001881
1882#if defined(MBEDTLS_HAVE_TIME)
YxCda609132023-05-22 12:08:12 -07001883 ssl->session_negotiate->start = mbedtls_time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001884#endif /* MBEDTLS_HAVE_TIME */
1885
Gilles Peskine449bd832023-01-11 14:50:10 +01001886 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001887}
1888
Jerry Yu3bf2c642022-03-30 22:02:12 +08001889/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001890 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001891 *
1892 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001893 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001894 * } SupportedVersions;
1895 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001896MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001897static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001898 mbedtls_ssl_context *ssl,
1899 unsigned char *buf,
1900 unsigned char *end,
1901 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001902{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001903 *out_len = 0;
1904
Gilles Peskine449bd832023-01-11 14:50:10 +01001905 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001906
1907 /* Check if we have space to write the extension:
1908 * - extension_type (2 bytes)
1909 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001910 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001911 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001912 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001913
Gilles Peskine449bd832023-01-11 14:50:10 +01001914 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001915
Gilles Peskine449bd832023-01-11 14:50:10 +01001916 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 mbedtls_ssl_write_version(buf + 4,
1919 ssl->conf->transport,
1920 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001921
Gilles Peskine449bd832023-01-11 14:50:10 +01001922 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1923 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001924
Jerry Yu349a6132022-04-14 20:52:56 +08001925 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001926
Jerry Yub95dd362022-11-08 21:19:34 +08001927 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001931}
1932
Jerry Yud9436a12022-04-20 22:28:09 +08001933
Jerry Yu3bf2c642022-03-30 22:02:12 +08001934
1935/* Generate and export a single key share. For hybrid KEMs, this can
1936 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001937MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001938static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1939 uint16_t named_group,
1940 unsigned char *buf,
1941 unsigned char *end,
1942 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001943{
1944 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001945
1946 *out_len = 0;
1947
Valerio Settic9ae8622023-07-25 11:23:50 +02001948#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED)
Przemek Stekiel29c219c2023-05-31 15:21:04 +02001949 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group) ||
Przemek Stekield5f79e72023-06-29 09:08:43 +02001950 mbedtls_ssl_tls13_named_group_is_ffdh(named_group)) {
Przemek Stekiel408569f2023-07-06 11:26:44 +02001951 ret = mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001952 ssl, named_group, buf, end, out_len);
1953 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001954 MBEDTLS_SSL_DEBUG_RET(
Przemek Stekiel408569f2023-07-06 11:26:44 +02001955 1, "mbedtls_ssl_tls13_generate_and_write_xxdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001956 ret);
1957 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001958 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001959 } else
Valerio Settic9ae8622023-07-25 11:23:50 +02001960#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_EPHEMERAL_ENABLED */
Gilles Peskine449bd832023-01-11 14:50:10 +01001961 if (0 /* Other kinds of KEMs */) {
1962 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001963 ((void) ssl);
1964 ((void) named_group);
1965 ((void) buf);
1966 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001967 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1968 }
1969
Gilles Peskine449bd832023-01-11 14:50:10 +01001970 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001971}
1972
1973/*
1974 * ssl_tls13_write_key_share_ext
1975 *
1976 * Structure of key_share extension in ServerHello:
1977 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001978 * struct {
1979 * NamedGroup group;
1980 * opaque key_exchange<1..2^16-1>;
1981 * } KeyShareEntry;
1982 * struct {
1983 * KeyShareEntry server_share;
1984 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001985 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001986MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001987static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1988 unsigned char *buf,
1989 unsigned char *end,
1990 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001991{
Jerry Yu955ddd72022-04-22 22:27:33 +08001992 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001993 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001994 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001995 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001996 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001997
1998 *out_len = 0;
1999
Gilles Peskine449bd832023-01-11 14:50:10 +01002000 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002001
Gilles Peskine449bd832023-01-11 14:50:10 +01002002 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
2003 mbedtls_ssl_named_group_to_str(group),
2004 group));
Jerry Yu58af2332022-09-06 11:19:31 +08002005
Jerry Yu3bf2c642022-03-30 22:02:12 +08002006 /* Check if we have space for header and length fields:
2007 * - extension_type (2 bytes)
2008 * - extension_data_length (2 bytes)
2009 * - group (2 bytes)
2010 * - key_exchange_length (2 bytes)
2011 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
2013 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
2014 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002015 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08002016
Jerry Yu3bf2c642022-03-30 22:02:12 +08002017 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
2018 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08002019 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01002020 ssl, group, server_share + 4, end, &key_exchange_length);
2021 if (ret != 0) {
2022 return ret;
2023 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002024 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08002025
Gilles Peskine449bd832023-01-11 14:50:10 +01002026 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002027
Gilles Peskine449bd832023-01-11 14:50:10 +01002028 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002029
Jerry Yu57d48412022-04-20 21:50:42 +08002030 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08002031
Gilles Peskine449bd832023-01-11 14:50:10 +01002032 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002033
Gilles Peskine449bd832023-01-11 14:50:10 +01002034 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002035}
Jerry Yud9436a12022-04-20 22:28:09 +08002036
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002037MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002038static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
2039 unsigned char *buf,
2040 unsigned char *end,
2041 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002042{
2043 uint16_t selected_group = ssl->handshake->hrr_selected_group;
2044 /* key_share Extension
2045 *
2046 * struct {
2047 * select (Handshake.msg_type) {
2048 * ...
2049 * case hello_retry_request:
2050 * NamedGroup selected_group;
2051 * ...
2052 * };
2053 * } KeyShare;
2054 */
2055
2056 *out_len = 0;
2057
Jerry Yub0ac10b2022-05-05 11:10:08 +08002058 /*
2059 * For a pure PSK key exchange, there is no group to agree upon. The purpose
2060 * of the HRR is then to transmit a cookie to force the client to demonstrate
2061 * reachability at their apparent network address (primarily useful for DTLS).
2062 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002063 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2064 return 0;
2065 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002066
2067 /* We should only send the key_share extension if the client's initial
2068 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01002069 if (ssl->handshake->offered_group_id != 0) {
2070 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
2071 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002072 }
2073
Gilles Peskine449bd832023-01-11 14:50:10 +01002074 if (selected_group == 0) {
2075 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
2076 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002077 }
2078
Jerry Yub0ac10b2022-05-05 11:10:08 +08002079 /* Check if we have enough space:
2080 * - extension_type (2 bytes)
2081 * - extension_data_length (2 bytes)
2082 * - selected_group (2 bytes)
2083 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002085
Gilles Peskine449bd832023-01-11 14:50:10 +01002086 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
2087 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
2088 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002089
Gilles Peskine449bd832023-01-11 14:50:10 +01002090 MBEDTLS_SSL_DEBUG_MSG(3,
2091 ("HRR selected_group: %s (%x)",
2092 mbedtls_ssl_named_group_to_str(selected_group),
2093 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002094
2095 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002096
Gilles Peskine449bd832023-01-11 14:50:10 +01002097 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08002098
Gilles Peskine449bd832023-01-11 14:50:10 +01002099 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002100}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101
2102/*
2103 * Structure of ServerHello message:
2104 *
2105 * struct {
2106 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2107 * Random random;
2108 * opaque legacy_session_id_echo<0..32>;
2109 * CipherSuite cipher_suite;
2110 * uint8 legacy_compression_method = 0;
2111 * Extension extensions<6..2^16-1>;
2112 * } ServerHello;
2113 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002114MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002115static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
2116 unsigned char *buf,
2117 unsigned char *end,
2118 size_t *out_len,
2119 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08002120{
Jerry Yu955ddd72022-04-22 22:27:33 +08002121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002122 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002123 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002124 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002125
2126 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002127 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002128
Jerry Yucfc04b32022-04-21 09:31:58 +08002129 /* ...
2130 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2131 * ...
2132 * with ProtocolVersion defined as:
2133 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002134 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2136 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002137 p += 2;
2138
Jerry Yu1c3e6882022-04-20 21:23:40 +08002139 /* ...
2140 * Random random;
2141 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002142 * with Random defined as:
2143 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002144 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002145 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2146 if (is_hrr) {
2147 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
2148 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
2149 } else {
2150 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
2151 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002152 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002153 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
2154 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002155 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2156
Jerry Yucfc04b32022-04-21 09:31:58 +08002157 /* ...
2158 * opaque legacy_session_id_echo<0..32>;
2159 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002160 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002161 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2162 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2163 if (ssl->session_negotiate->id_len > 0) {
2164 memcpy(p, &ssl->session_negotiate->id[0],
2165 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002166 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002167
Gilles Peskine449bd832023-01-11 14:50:10 +01002168 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2169 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002170 }
2171
Jerry Yucfc04b32022-04-21 09:31:58 +08002172 /* ...
2173 * CipherSuite cipher_suite;
2174 * ...
2175 * with CipherSuite defined as:
2176 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002177 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002178 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2179 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002180 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002181 MBEDTLS_SSL_DEBUG_MSG(3,
2182 ("server hello, chosen ciphersuite: %s ( id=%d )",
2183 mbedtls_ssl_get_ciphersuite_name(
2184 ssl->session_negotiate->ciphersuite),
2185 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002186
Jerry Yucfc04b32022-04-21 09:31:58 +08002187 /* ...
2188 * uint8 legacy_compression_method = 0;
2189 * ...
2190 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002191 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002192 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002193
Jerry Yucfc04b32022-04-21 09:31:58 +08002194 /* ...
2195 * Extension extensions<6..2^16-1>;
2196 * ...
2197 * struct {
2198 * ExtensionType extension_type; (2 bytes)
2199 * opaque extension_data<0..2^16-1>;
2200 * } Extension;
2201 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002202 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002203 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002204 p += 2;
2205
Gilles Peskine449bd832023-01-11 14:50:10 +01002206 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2207 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002208 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002209 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2210 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002211 }
2212 p += output_len;
2213
Gilles Peskine449bd832023-01-11 14:50:10 +01002214 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2215 if (is_hrr) {
2216 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2217 } else {
2218 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2219 }
2220 if (ret != 0) {
2221 return ret;
2222 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002223 p += output_len;
2224 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002225
Ronald Cron41a443a2022-10-04 16:38:25 +02002226#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002227 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2228 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2229 if (ret != 0) {
2230 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2231 ret);
2232 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002233 }
2234 p += output_len;
2235 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002236#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002237
Gilles Peskine449bd832023-01-11 14:50:10 +01002238 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002239
Gilles Peskine449bd832023-01-11 14:50:10 +01002240 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2241 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002242
Jerry Yud9436a12022-04-20 22:28:09 +08002243 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002244
Gilles Peskine449bd832023-01-11 14:50:10 +01002245 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002246
Jerry Yu7de2ff02022-11-08 21:43:46 +08002247 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002248 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002249 MBEDTLS_SSL_HS_SERVER_HELLO,
2250 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002251
Gilles Peskine449bd832023-01-11 14:50:10 +01002252 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002253}
2254
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002255MBEDTLS_CHECK_RETURN_CRITICAL
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002256static int ssl_tls13_finalize_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002257{
2258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002259 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2260 if (ret != 0) {
2261 MBEDTLS_SSL_DEBUG_RET(1,
2262 "mbedtls_ssl_tls13_compute_handshake_transform",
2263 ret);
2264 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002265 }
2266
Gilles Peskine449bd832023-01-11 14:50:10 +01002267 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002268}
2269
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002270MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002271static int ssl_tls13_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002272{
Jerry Yu637a3f12022-04-20 21:37:58 +08002273 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002274 unsigned char *buf;
2275 size_t buf_len, msg_len;
2276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002278
Gilles Peskine449bd832023-01-11 14:50:10 +01002279 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002280
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002281 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2282 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002283
Gilles Peskine449bd832023-01-11 14:50:10 +01002284 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2285 buf + buf_len,
2286 &msg_len,
2287 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002288
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002289 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002290 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2293 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002294
Xiaokang Qian934ce6f2023-02-06 10:23:04 +00002295 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002296
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002297#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2298 /* The server sends a dummy change_cipher_spec record immediately
2299 * after its first handshake message. This may either be after
2300 * a ServerHello or a HelloRetryRequest.
2301 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002302 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002304#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002305 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002306#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002307
Jerry Yuf4b27e42022-03-30 17:32:21 +08002308cleanup:
2309
Gilles Peskine449bd832023-01-11 14:50:10 +01002310 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2311 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002312}
2313
Jerry Yu23d1a252022-05-12 18:08:59 +08002314
2315/*
2316 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2317 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002318MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002319static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002320{
2321 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002322 if (ssl->handshake->hello_retry_request_count > 0) {
2323 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2324 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2325 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2326 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002327 }
2328
2329 /*
2330 * Create stateless transcript hash for HRR
2331 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002332 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2333 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2334 if (ret != 0) {
2335 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2336 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002337 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002338 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002339
Gilles Peskine449bd832023-01-11 14:50:10 +01002340 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002341}
2342
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002343MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002344static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002345{
2346 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2347 unsigned char *buf;
2348 size_t buf_len, msg_len;
2349
Gilles Peskine449bd832023-01-11 14:50:10 +01002350 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002351
Gilles Peskine449bd832023-01-11 14:50:10 +01002352 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002353
Gilles Peskine449bd832023-01-11 14:50:10 +01002354 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2355 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2356 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2359 buf + buf_len,
2360 &msg_len,
2361 1));
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002362 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Manuel Pégourié-Gonnard43cc1272023-02-06 11:48:19 +01002363 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002364
2365
Gilles Peskine449bd832023-01-11 14:50:10 +01002366 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2367 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002368
2369 ssl->handshake->hello_retry_request_count++;
2370
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002371#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2372 /* The server sends a dummy change_cipher_spec record immediately
2373 * after its first handshake message. This may either be after
2374 * a ServerHello or a HelloRetryRequest.
2375 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002376 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002377 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002378#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002379 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002380#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002381
2382cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002383 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2384 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002385}
2386
Jerry Yu5b64ae92022-03-30 17:15:02 +08002387/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002388 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2389 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002390
2391/*
2392 * struct {
2393 * Extension extensions<0..2 ^ 16 - 1>;
2394 * } EncryptedExtensions;
2395 *
2396 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002397MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002398static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2399 unsigned char *buf,
2400 unsigned char *end,
2401 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002402{
XiaokangQianacb39922022-06-17 10:18:48 +00002403 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002404 unsigned char *p = buf;
2405 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002406 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002407 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002408
Jerry Yu4d3841a2022-04-16 12:37:19 +08002409 *out_len = 0;
2410
Gilles Peskine449bd832023-01-11 14:50:10 +01002411 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002412 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002413 p += 2;
2414
Jerry Yu8937eb42022-05-03 12:12:14 +08002415 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002416 ((void) ret);
2417 ((void) output_len);
2418
2419#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002420 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2421 if (ret != 0) {
2422 return ret;
2423 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002424 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002425#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002426
Gilles Peskine449bd832023-01-11 14:50:10 +01002427 extensions_len = (p - p_extensions_len) - 2;
2428 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002429
2430 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002433
Jerry Yu7de2ff02022-11-08 21:43:46 +08002434 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002435 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002436
Gilles Peskine449bd832023-01-11 14:50:10 +01002437 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002438}
2439
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002440MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002441static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002442{
2443 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2444 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002445 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002446
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 mbedtls_ssl_set_outbound_transform(ssl,
2448 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002449 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002450 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002451
Gilles Peskine449bd832023-01-11 14:50:10 +01002452 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002453
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002454 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2455 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2456 &buf, &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002457
Gilles Peskine449bd832023-01-11 14:50:10 +01002458 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2459 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002460
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002461 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002462 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2463 buf, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002464
Gilles Peskine449bd832023-01-11 14:50:10 +01002465 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2466 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002467
Ronald Cron928cbd32022-10-04 16:14:26 +02002468#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2470 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2471 } else {
2472 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2473 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002474#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002475 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002476#endif
2477
Jerry Yu4d3841a2022-04-16 12:37:19 +08002478cleanup:
2479
Gilles Peskine449bd832023-01-11 14:50:10 +01002480 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2481 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002482}
2483
Ronald Cron928cbd32022-10-04 16:14:26 +02002484#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002485#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2486#define SSL_CERTIFICATE_REQUEST_SKIP 1
2487/* Coordination:
2488 * Check whether a CertificateRequest message should be written.
2489 * Returns a negative code on failure, or
2490 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2491 * - SSL_CERTIFICATE_REQUEST_SKIP
2492 * indicating if the writing of the CertificateRequest
2493 * should be skipped or not.
2494 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002495MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002496static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002497{
2498 int authmode;
2499
XiaokangQian40a35232022-05-07 09:02:40 +00002500#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002501 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002502 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002503 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002504#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002505 authmode = ssl->conf->authmode;
2506
Gilles Peskine449bd832023-01-11 14:50:10 +01002507 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002508 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002510 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002511
XiaokangQianc3017f62022-05-13 05:55:41 +00002512 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002515}
2516
XiaokangQiancec9ae62022-05-06 07:28:50 +00002517/*
2518 * struct {
2519 * opaque certificate_request_context<0..2^8-1>;
2520 * Extension extensions<2..2^16-1>;
2521 * } CertificateRequest;
2522 *
2523 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002524MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002525static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2526 unsigned char *buf,
2527 const unsigned char *end,
2528 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002529{
2530 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2531 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002532 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002533 unsigned char *p_extensions_len;
2534
2535 *out_len = 0;
2536
2537 /* Check if we have enough space:
2538 * - certificate_request_context (1 byte)
2539 * - extensions length (2 bytes)
2540 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002541 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002542
2543 /*
2544 * Write certificate_request_context
2545 */
2546 /*
2547 * We use a zero length context for the normal handshake
2548 * messages. For post-authentication handshake messages
2549 * this request context would be set to a non-zero value.
2550 */
2551 *p++ = 0x0;
2552
2553 /*
2554 * Write extensions
2555 */
2556 /* The extensions must contain the signature_algorithms. */
2557 p_extensions_len = p;
2558 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002559 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2560 if (ret != 0) {
2561 return ret;
2562 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002563
XiaokangQianec6efb92022-05-06 09:53:10 +00002564 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002566
2567 *out_len = p - buf;
2568
Jerry Yu7de2ff02022-11-08 21:43:46 +08002569 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002570 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002571
Gilles Peskine449bd832023-01-11 14:50:10 +01002572 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002573}
2574
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002575MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002576static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002577{
2578 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2579
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002581
Gilles Peskine449bd832023-01-11 14:50:10 +01002582 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002583
Gilles Peskine449bd832023-01-11 14:50:10 +01002584 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002585 unsigned char *buf;
2586 size_t buf_len, msg_len;
2587
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002588 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2589 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2590 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002591
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2593 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002594
Manuel Pégourié-Gonnardb8b07aa2023-02-06 00:34:21 +01002595 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_add_hs_msg_to_checksum(
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002596 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2597 buf, msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002598
Gilles Peskine449bd832023-01-11 14:50:10 +01002599 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2600 ssl, buf_len, msg_len));
2601 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2602 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002603 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002604 } else {
2605 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002606 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2607 goto cleanup;
2608 }
2609
Gilles Peskine449bd832023-01-11 14:50:10 +01002610 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002611cleanup:
2612
Gilles Peskine449bd832023-01-11 14:50:10 +01002613 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2614 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002615}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002616
Jerry Yu4d3841a2022-04-16 12:37:19 +08002617/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002618 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002619 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002620MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002621static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002622{
Jerry Yu5a26f302022-05-10 20:46:40 +08002623 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002624
2625#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002626 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2627 mbedtls_ssl_own_cert(ssl) == NULL) {
2628 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2629 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2630 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2631 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002632 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002633#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002634
Gilles Peskine449bd832023-01-11 14:50:10 +01002635 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2636 if (ret != 0) {
2637 return ret;
2638 }
2639 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2640 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002641}
2642
2643/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002644 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002645 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002646MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002647static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002648{
Gilles Peskine449bd832023-01-11 14:50:10 +01002649 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2650 if (ret != 0) {
2651 return ret;
2652 }
2653 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2654 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002655}
Ronald Cron928cbd32022-10-04 16:14:26 +02002656#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002657
2658/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002659 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002660 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002661MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002662static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002663{
Jerry Yud6e253d2022-05-18 13:59:24 +08002664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002665
Gilles Peskine449bd832023-01-11 14:50:10 +01002666 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2667 if (ret != 0) {
2668 return ret;
2669 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002670
Gilles Peskine449bd832023-01-11 14:50:10 +01002671 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2672 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002673 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002674 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2675 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2676 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002677 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002678
Gilles Peskine449bd832023-01-11 14:50:10 +01002679 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2680 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002681
Gilles Peskine449bd832023-01-11 14:50:10 +01002682 if (ssl->handshake->certificate_request_sent) {
2683 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2684 } else {
2685 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2686 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2687 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002688 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002689
Gilles Peskine449bd832023-01-11 14:50:10 +01002690 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002691}
2692
2693/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002694 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002695 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002696MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002697static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002698{
Jerry Yud6e253d2022-05-18 13:59:24 +08002699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2700
Gilles Peskine449bd832023-01-11 14:50:10 +01002701 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2702 if (ret != 0) {
2703 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002704 }
2705
Gilles Peskine449bd832023-01-11 14:50:10 +01002706 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2707 if (ret != 0) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002708 MBEDTLS_SSL_DEBUG_RET(
2709 1, "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
Gilles Peskine449bd832023-01-11 14:50:10 +01002710 }
2711
2712 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2713 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002714}
2715
2716/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002717 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002718 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002719MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002720static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002721{
Gilles Peskine449bd832023-01-11 14:50:10 +01002722 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002723
Gilles Peskine449bd832023-01-11 14:50:10 +01002724 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002725
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002726#if defined(MBEDTLS_SSL_SESSION_TICKETS) && \
2727 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lva1aa31b2022-12-13 13:49:59 +08002728/* TODO: Remove the check of SOME_PSK_ENABLED since SESSION_TICKETS requires
2729 * SOME_PSK_ENABLED to be enabled. Here is just to make CI happy. It is
2730 * expected to be resolved with issue#6395.
2731 */
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002732 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002733 if (mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002734 mbedtls_ssl_handshake_set_state(
2735 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002736 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002737#endif
Pengyu Lv3643fdb2023-01-12 16:46:28 +08002738 {
2739 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2740 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002741 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002742}
2743
2744/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002745 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002746 */
2747#define SSL_NEW_SESSION_TICKET_SKIP 0
2748#define SSL_NEW_SESSION_TICKET_WRITE 1
2749MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002750static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002751{
2752 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 if (ssl->conf->f_ticket_write == NULL) {
2754 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2755 " callback is not set"));
2756 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002757 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002758 if (ssl->conf->new_session_tickets_count == 0) {
2759 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2760 " configured count is zero"));
2761 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002762 }
2763
Gilles Peskine449bd832023-01-11 14:50:10 +01002764 if (ssl->handshake->new_session_tickets_count == 0) {
2765 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2766 "been sent."));
2767 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002768 }
2769
Gilles Peskine449bd832023-01-11 14:50:10 +01002770 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002771}
2772
2773#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2774MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002775static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2776 unsigned char *ticket_nonce,
2777 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002778{
2779 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2780 mbedtls_ssl_session *session = ssl->session;
2781 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2782 psa_algorithm_t psa_hash_alg;
2783 int hash_length;
2784
Gilles Peskine449bd832023-01-11 14:50:10 +01002785 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002786
2787#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002788 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002789#endif
2790
Pengyu Lv9f926952022-11-17 15:22:33 +08002791 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv80270b22023-01-12 11:54:04 +08002792 mbedtls_ssl_session_clear_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002793 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002794#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv80270b22023-01-12 11:54:04 +08002795 mbedtls_ssl_session_set_ticket_flags(
Pengyu Lv9eacb442022-12-09 14:39:19 +08002796 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002797#endif
Pengyu Lv4938a562023-01-16 11:28:49 +08002798 MBEDTLS_SSL_PRINT_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv9f926952022-11-17 15:22:33 +08002799
Jerry Yue67bef42022-07-07 07:29:42 +00002800 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002801 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2802 (unsigned char *) &session->ticket_age_add,
2803 sizeof(session->ticket_age_add)) != 0)) {
2804 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2805 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002806 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002807 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2808 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002809
2810 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2812 if (ret != 0) {
2813 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2814 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002815 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002816 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2817 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002818
2819 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002820 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
Dave Rodgman2eab4622023-10-05 13:30:37 +01002821 psa_hash_alg = mbedtls_md_psa_alg_from_type((mbedtls_md_type_t) ciphersuite_info->mac);
Gilles Peskine449bd832023-01-11 14:50:10 +01002822 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2823 if (hash_length == -1 ||
2824 (size_t) hash_length > sizeof(session->resumption_key)) {
2825 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002826 }
2827
Jerry Yue67bef42022-07-07 07:29:42 +00002828 /* In this code the psk key length equals the length of the hash */
2829 session->resumption_key_len = hash_length;
2830 session->ciphersuite = ciphersuite_info->id;
2831
2832 /* Compute resumption key
2833 *
2834 * HKDF-Expand-Label( resumption_master_secret,
2835 * "resumption", ticket_nonce, Hash.length )
2836 */
2837 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002838 psa_hash_alg,
2839 session->app_secrets.resumption_master_secret,
2840 hash_length,
2841 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2842 ticket_nonce,
2843 ticket_nonce_size,
2844 session->resumption_key,
2845 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002846
Gilles Peskine449bd832023-01-11 14:50:10 +01002847 if (ret != 0) {
2848 MBEDTLS_SSL_DEBUG_RET(2,
2849 "Creating the ticket-resumed PSK failed",
2850 ret);
2851 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002852 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002853 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2854 session->resumption_key,
2855 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002856
Gilles Peskine449bd832023-01-11 14:50:10 +01002857 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2858 session->app_secrets.resumption_master_secret,
2859 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002860
Gilles Peskine449bd832023-01-11 14:50:10 +01002861 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002862}
2863
2864/* This function creates a NewSessionTicket message in the following format:
2865 *
2866 * struct {
2867 * uint32 ticket_lifetime;
2868 * uint32 ticket_age_add;
2869 * opaque ticket_nonce<0..255>;
2870 * opaque ticket<1..2^16-1>;
2871 * Extension extensions<0..2^16-2>;
2872 * } NewSessionTicket;
2873 *
2874 * The ticket inside the NewSessionTicket message is an encrypted container
2875 * carrying the necessary information so that the server is later able to
2876 * re-start the communication.
2877 *
2878 * The following fields are placed inside the ticket by the
2879 * f_ticket_write() function:
2880 *
2881 * - creation time (start)
2882 * - flags (flags)
2883 * - age add (ticket_age_add)
2884 * - key (key)
2885 * - key length (key_len)
2886 * - ciphersuite (ciphersuite)
2887 */
2888MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002889static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2890 unsigned char *buf,
2891 unsigned char *end,
2892 size_t *out_len,
2893 unsigned char *ticket_nonce,
2894 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002895{
2896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2897 unsigned char *p = buf;
2898 mbedtls_ssl_session *session = ssl->session;
2899 size_t ticket_len;
2900 uint32_t ticket_lifetime;
2901
2902 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002903 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002904
2905 /*
2906 * ticket_lifetime 4 bytes
2907 * ticket_age_add 4 bytes
2908 * ticket_nonce 1 + ticket_nonce_size bytes
2909 * ticket >=2 bytes
2910 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002911 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002912
2913 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002914 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2915 session,
2916 p + 9 + ticket_nonce_size + 2,
2917 end,
2918 &ticket_len,
2919 &ticket_lifetime);
2920 if (ret != 0) {
2921 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2922 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002923 }
2924 /* RFC 8446 4.6.1
2925 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2926 * unsigned integer in network byte order from the time of ticket
2927 * issuance. Servers MUST NOT use any value greater than
2928 * 604800 seconds (7 days). The value of zero indicates that the
2929 * ticket should be discarded immediately. Clients MUST NOT cache
2930 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2931 * and MAY delete tickets earlier based on local policy. A server
2932 * MAY treat a ticket as valid for a shorter period of time than what
2933 * is stated in the ticket_lifetime.
2934 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002935 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002936 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002937 }
2938 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2939 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2940 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002941
2942 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002943 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2944 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2945 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002946
2947 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002948 p[8] = (unsigned char) ticket_nonce_size;
2949 if (ticket_nonce_size > 0) {
2950 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002951 }
2952 p += 9 + ticket_nonce_size;
2953
2954 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002955 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002956 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002958 p += ticket_len;
2959
2960 /* Ticket Extensions
2961 *
2962 * Note: We currently don't have any extensions.
2963 * Set length to zero.
2964 */
Jerry Yuedab6372022-10-31 14:37:31 +08002965 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2966
Gilles Peskine449bd832023-01-11 14:50:10 +01002967 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2968 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002969 p += 2;
2970
2971 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002972 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2973 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002974
Jerry Yu7de2ff02022-11-08 21:43:46 +08002975 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002976 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002977
Gilles Peskine449bd832023-01-11 14:50:10 +01002978 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002979}
2980
2981/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002982 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002983 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002984static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002985{
2986 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2987
Gilles Peskine449bd832023-01-11 14:50:10 +01002988 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002989
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002991 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2992 unsigned char *buf;
2993 size_t buf_len, msg_len;
2994
Gilles Peskine449bd832023-01-11 14:50:10 +01002995 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2996 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002997
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00002998 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2999 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
3000 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00003001
Gilles Peskine449bd832023-01-11 14:50:10 +01003002 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
3003 ssl, buf, buf + buf_len, &msg_len,
3004 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00003005
Gilles Peskine449bd832023-01-11 14:50:10 +01003006 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
3007 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08003008
Jerry Yu359e65f2022-09-22 23:47:43 +08003009 /* Limit session tickets count to one when resumption connection.
3010 *
3011 * See document of mbedtls_ssl_conf_new_session_tickets.
3012 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003013 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08003014 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01003015 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08003016 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01003017 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08003018
Jerry Yua8d3c502022-10-30 14:51:23 +08003019 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003020 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
3021 } else {
3022 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00003023 }
3024
Jerry Yue67bef42022-07-07 07:29:42 +00003025cleanup:
3026
Gilles Peskine449bd832023-01-11 14:50:10 +01003027 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00003028}
3029#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3030
3031/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00003032 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00003033 */
Gilles Peskine449bd832023-01-11 14:50:10 +01003034int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08003035{
XiaokangQian08037552022-04-20 07:16:41 +00003036 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003037
Gilles Peskine449bd832023-01-11 14:50:10 +01003038 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
3039 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
3040 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003041
Gilles Peskine449bd832023-01-11 14:50:10 +01003042 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
Dave Rodgman2eab4622023-10-05 13:30:37 +01003043 mbedtls_ssl_states_str((mbedtls_ssl_states) ssl->state),
Gilles Peskine449bd832023-01-11 14:50:10 +01003044 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08003045
Gilles Peskine449bd832023-01-11 14:50:10 +01003046 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00003047 /* start state */
3048 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003049 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00003050 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003051 break;
3052
XiaokangQian7807f9f2022-02-15 10:04:37 +00003053 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003054 ret = ssl_tls13_process_client_hello(ssl);
3055 if (ret != 0) {
3056 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
3057 }
Jerry Yuf41553b2022-05-09 22:20:30 +08003058 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003059
Jerry Yuf41553b2022-05-09 22:20:30 +08003060 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003061 ret = ssl_tls13_write_hello_retry_request(ssl);
3062 if (ret != 0) {
3063 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
3064 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08003065 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00003066 break;
3067
Jerry Yu5b64ae92022-03-30 17:15:02 +08003068 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003069 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08003070 break;
3071
Xiaofei Baicba64af2022-02-15 10:00:56 +00003072 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01003073 ret = ssl_tls13_write_encrypted_extensions(ssl);
3074 if (ret != 0) {
3075 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
3076 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00003077 }
Jerry Yu48330562022-05-06 21:35:44 +08003078 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08003079
Ronald Cron928cbd32022-10-04 16:14:26 +02003080#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003081 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003082 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003083 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00003084
Jerry Yu83da34e2022-04-16 13:59:52 +08003085 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003086 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003087 break;
3088
3089 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003090 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08003091 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003092#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003093
Gilles Peskine449bd832023-01-11 14:50:10 +01003094 /*
3095 * Injection of dummy-CCS's for middlebox compatibility
3096 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003097#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003098 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01003099 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3100 if (ret == 0) {
3101 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
3102 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003103 break;
3104
3105 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01003106 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
3107 if (ret == 0) {
3108 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
3109 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003110 break;
3111#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3112
Jerry Yu69dd8d42022-04-16 12:51:26 +08003113 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003114 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003115 break;
3116
3117 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01003118 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003119 break;
3120
Jerry Yu69dd8d42022-04-16 12:51:26 +08003121 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01003122 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08003123 break;
3124
Ronald Cron766c0cd2022-10-18 12:17:11 +02003125#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003126 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01003127 ret = mbedtls_ssl_tls13_process_certificate(ssl);
3128 if (ret == 0) {
3129 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02003130 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003131 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
3132 } else {
3133 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02003134 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003135 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02003136 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003137 }
3138 break;
3139
3140 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01003141 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
3142 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00003143 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01003144 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00003145 }
3146 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003147#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003148
Jerry Yue67bef42022-07-07 07:29:42 +00003149#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003150 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01003151 ret = ssl_tls13_write_new_session_ticket(ssl);
3152 if (ret != 0) {
3153 MBEDTLS_SSL_DEBUG_RET(1,
3154 "ssl_tls13_write_new_session_ticket ",
3155 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00003156 }
3157 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003158 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003159 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003160 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003161 * as part of ssl_prepare_handshake_step.
3162 */
3163 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003164
Gilles Peskine449bd832023-01-11 14:50:10 +01003165 if (ssl->handshake->new_session_tickets_count == 0) {
3166 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3167 } else {
Xiaokang Qian9f1747b2023-03-30 02:50:04 +00003168 mbedtls_ssl_handshake_set_state(
3169 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
Gilles Peskine449bd832023-01-11 14:50:10 +01003170 }
Jerry Yue67bef42022-07-07 07:29:42 +00003171 break;
3172
3173#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3174
XiaokangQian7807f9f2022-02-15 10:04:37 +00003175 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003176 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3177 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003178 }
3179
Gilles Peskine449bd832023-01-11 14:50:10 +01003180 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003181}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003182
Jerry Yufb4b6472022-01-27 15:03:26 +08003183#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */