blob: 49b4c2de2889c2456e7ef72e4f38142b139f18b5 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
Gilles Peskine449bd832023-01-11 14:50:10 +010018 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080019
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
Jerry Yuf35ba382022-08-23 17:58:26 +080033
Jerry Yuc5a23a02022-08-25 10:51:44 +080034static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +010035 mbedtls_ssl_context *ssl,
36 unsigned int cipher_suite)
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +010039 if (!mbedtls_ssl_tls13_cipher_suite_is_offered(ssl, cipher_suite)) {
40 return NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +080041 }
Gilles Peskine449bd832023-01-11 14:50:10 +010042
43 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id(cipher_suite);
44 if ((mbedtls_ssl_validate_ciphersuite(ssl, ciphersuite_info,
45 ssl->tls_version,
46 ssl->tls_version) != 0)) {
47 return NULL;
48 }
49 return ciphersuite_info;
Jerry Yuf35ba382022-08-23 17:58:26 +080050}
51
Ronald Cron41a443a2022-10-04 16:38:25 +020052#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000053/* From RFC 8446:
54 *
55 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
56 * struct {
57 * PskKeyExchangeMode ke_modes<1..255>;
58 * } PskKeyExchangeModes;
59 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080060MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +010061static int ssl_tls13_parse_key_exchange_modes_ext(mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
63 const unsigned char *end)
Jerry Yue19e3b92022-07-08 12:04:51 +000064{
Jerry Yu299e31f2022-07-13 23:06:36 +080065 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000066 size_t ke_modes_len;
67 int ke_modes = 0;
68
Jerry Yu854dd9e2022-07-15 14:28:27 +080069 /* Read ke_modes length (1 Byte) */
Gilles Peskine449bd832023-01-11 14:50:10 +010070 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
Jerry Yu299e31f2022-07-13 23:06:36 +080071 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000072 /* Currently, there are only two PSK modes, so even without looking
73 * at the content, something's wrong if the list has more than 2 items. */
Gilles Peskine449bd832023-01-11 14:50:10 +010074 if (ke_modes_len > 2) {
75 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
76 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
77 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu299e31f2022-07-13 23:06:36 +080078 }
Jerry Yue19e3b92022-07-08 12:04:51 +000079
Gilles Peskine449bd832023-01-11 14:50:10 +010080 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, ke_modes_len);
Jerry Yue19e3b92022-07-08 12:04:51 +000081
Gilles Peskine449bd832023-01-11 14:50:10 +010082 while (ke_modes_len-- != 0) {
83 switch (*p++) {
84 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
85 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
86 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK KEX MODE"));
87 break;
88 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
89 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
90 MBEDTLS_SSL_DEBUG_MSG(3, ("Found PSK_EPHEMERAL KEX MODE"));
91 break;
92 default:
93 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
94 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
95 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yue19e3b92022-07-08 12:04:51 +000096 }
97 }
98
99 ssl->handshake->tls13_kex_modes = ke_modes;
Gilles Peskine449bd832023-01-11 14:50:10 +0100100 return 0;
Jerry Yue19e3b92022-07-08 12:04:51 +0000101}
Jerry Yu1c105562022-07-10 06:32:38 +0000102
Jerry Yue9d4fc02022-08-20 19:21:15 +0800103#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
104#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800105
106#if defined(MBEDTLS_SSL_SESSION_TICKETS)
107
108MBEDTLS_CHECK_RETURN_CRITICAL
109static int ssl_tls13_offered_psks_check_identity_match_ticket(
Gilles Peskine449bd832023-01-11 14:50:10 +0100110 mbedtls_ssl_context *ssl,
111 const unsigned char *identity,
112 size_t identity_len,
113 uint32_t obfuscated_ticket_age,
114 mbedtls_ssl_session *session)
Jerry Yu95699e72022-08-21 19:22:23 +0800115{
Jerry Yufd310eb2022-09-06 09:16:35 +0800116 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800117 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800118#if defined(MBEDTLS_HAVE_TIME)
119 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800120 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800121 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800122#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800123
124 ((void) obfuscated_ticket_age);
125
Gilles Peskine449bd832023-01-11 14:50:10 +0100126 MBEDTLS_SSL_DEBUG_MSG(2, ("=> check_identity_match_ticket"));
Jerry Yu95699e72022-08-21 19:22:23 +0800127
Jerry Yufd310eb2022-09-06 09:16:35 +0800128 /* Ticket parser is not configured, Skip */
Gilles Peskine449bd832023-01-11 14:50:10 +0100129 if (ssl->conf->f_ticket_parse == NULL || identity_len == 0) {
130 return 0;
131 }
Jerry Yu95699e72022-08-21 19:22:23 +0800132
Jerry Yu4746b102022-09-13 11:11:48 +0800133 /* We create a copy of the encrypted ticket since the ticket parsing
134 * function is allowed to use its input buffer as an output buffer
135 * (in-place decryption). We do, however, need the original buffer for
136 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800137 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100138 ticket_buffer = mbedtls_calloc(1, identity_len);
139 if (ticket_buffer == NULL) {
140 MBEDTLS_SSL_DEBUG_MSG(1, ("buffer too small"));
141 return MBEDTLS_ERR_SSL_ALLOC_FAILED;
Jerry Yu95699e72022-08-21 19:22:23 +0800142 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100143 memcpy(ticket_buffer, identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Gilles Peskine449bd832023-01-11 14:50:10 +0100145 if ((ret = ssl->conf->f_ticket_parse(ssl->conf->p_ticket,
146 session,
147 ticket_buffer, identity_len)) != 0) {
148 if (ret == MBEDTLS_ERR_SSL_INVALID_MAC) {
149 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is not authentic"));
150 } else if (ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED) {
151 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket is expired"));
152 } else {
153 MBEDTLS_SSL_DEBUG_RET(1, "ticket_parse", ret);
154 }
Jerry Yu95699e72022-08-21 19:22:23 +0800155 }
156
157 /* We delete the temporary buffer */
Gilles Peskine449bd832023-01-11 14:50:10 +0100158 mbedtls_free(ticket_buffer);
Jerry Yu95699e72022-08-21 19:22:23 +0800159
Gilles Peskine449bd832023-01-11 14:50:10 +0100160 if (ret != 0) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800161 goto exit;
162 }
Jerry Yu95699e72022-08-21 19:22:23 +0800163
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800164 /* RFC 8446 section 4.2.9
165 *
166 * Servers SHOULD NOT send NewSessionTicket with tickets that are not
167 * compatible with the advertised modes; however, if a server does so,
168 * the impact will just be that the client's attempts at resumption fail.
169 *
170 * We regard the ticket with incompatible key exchange modes as not match.
171 */
172 ret = MBEDTLS_ERR_SSL_TICKET_INVALID_KEX_MODE;
Pengyu Lv9eacb442022-12-09 14:39:19 +0800173 MBEDTLS_SSL_DEBUG_TICKET_FLAGS(4, session->ticket_flags);
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800174 if (mbedtls_ssl_tls13_check_kex_modes(ssl,
Pengyu Lv9eacb442022-12-09 14:39:19 +0800175 mbedtls_ssl_tls13_session_get_ticket_flags(
176 session, MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_ALL))) {
Pengyu Lv3eb49be2022-12-05 16:35:12 +0800177 MBEDTLS_SSL_DEBUG_MSG(3, ("No suitable key exchange mode"));
178 goto exit;
179 }
180
Gilles Peskine449bd832023-01-11 14:50:10 +0100181 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
182#if defined(MBEDTLS_HAVE_TIME)
183 now = mbedtls_time(NULL);
184
185 if (now < session->start) {
186 MBEDTLS_SSL_DEBUG_MSG(
187 3, ("Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
188 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
189 (long long) now, (long long) session->start));
190 goto exit;
191 }
192
193 age_in_s = (uint64_t) (now - session->start);
Jerry Yu95699e72022-08-21 19:22:23 +0800194
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800195 /* RFC 8446 section 4.6.1
196 *
197 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
198 *
199 * RFC 8446 section 4.2.11.1
200 *
201 * Clients MUST NOT attempt to use tickets which have ages greater than
202 * the "ticket_lifetime" value which was provided with the ticket.
203 *
204 * For time being, the age MUST be less than 604800 seconds (7 days).
205 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100206 if (age_in_s > 604800) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800207 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100208 3, ("Ticket age exceeds limitation ticket_age=%lu",
209 (long unsigned int) age_in_s));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 goto exit;
211 }
Jerry Yu95699e72022-08-21 19:22:23 +0800212
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800213 /* RFC 8446 section 4.2.10
214 *
215 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
216 * the ticket age for the selected PSK identity (computed by subtracting
217 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
218 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800219 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800220 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
221 * as the age units are different on the server (s) and in the
222 * client (ms) side. Add a -1000 ms tolerance window to take this
223 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800224 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800225 age_diff_in_ms = age_in_s * 1000;
Gilles Peskine449bd832023-01-11 14:50:10 +0100226 age_diff_in_ms -= (obfuscated_ticket_age - session->ticket_age_add);
227 if (age_diff_in_ms <= -1000 ||
228 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE) {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800229 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +0100230 3, ("Ticket age outside tolerance window ( diff=%d )",
231 (int) age_diff_in_ms));
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800232 goto exit;
233 }
234
235 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800236
237#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800238
239exit:
Gilles Peskine449bd832023-01-11 14:50:10 +0100240 if (ret != 0) {
241 mbedtls_ssl_session_free(session);
242 }
Jerry Yu95699e72022-08-21 19:22:23 +0800243
Gilles Peskine449bd832023-01-11 14:50:10 +0100244 MBEDTLS_SSL_DEBUG_MSG(2, ("<= check_identity_match_ticket"));
245 return ret;
Jerry Yu95699e72022-08-21 19:22:23 +0800246}
247#endif /* MBEDTLS_SSL_SESSION_TICKETS */
248
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800249MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000250static int ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100251 mbedtls_ssl_context *ssl,
252 const unsigned char *identity,
253 size_t identity_len,
254 uint32_t obfuscated_ticket_age,
255 int *psk_type,
256 mbedtls_ssl_session *session)
Jerry Yu1c105562022-07-10 06:32:38 +0000257{
Jerry Yu95699e72022-08-21 19:22:23 +0800258 ((void) session);
259 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800260 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800261
Gilles Peskine449bd832023-01-11 14:50:10 +0100262 MBEDTLS_SSL_DEBUG_BUF(4, "identity", identity, identity_len);
Jerry Yu95699e72022-08-21 19:22:23 +0800263 ssl->handshake->resume = 0;
264
Jerry Yu95699e72022-08-21 19:22:23 +0800265#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100266 if (ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800267 ssl, identity, identity_len, obfuscated_ticket_age,
Gilles Peskine449bd832023-01-11 14:50:10 +0100268 session) == SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu95699e72022-08-21 19:22:23 +0800269 ssl->handshake->resume = 1;
270 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
Gilles Peskine449bd832023-01-11 14:50:10 +0100271 mbedtls_ssl_set_hs_psk(ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800272 session->resumption_key,
Gilles Peskine449bd832023-01-11 14:50:10 +0100273 session->resumption_key_len);
274
275 MBEDTLS_SSL_DEBUG_BUF(4, "Ticket-resumed PSK:",
276 session->resumption_key,
277 session->resumption_key_len);
278 MBEDTLS_SSL_DEBUG_MSG(4, ("ticket: obfuscated_ticket_age: %u",
279 (unsigned) obfuscated_ticket_age));
280 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu95699e72022-08-21 19:22:23 +0800281 }
282#endif /* MBEDTLS_SSL_SESSION_TICKETS */
283
Jerry Yu1c105562022-07-10 06:32:38 +0000284 /* Check identity with external configured function */
Gilles Peskine449bd832023-01-11 14:50:10 +0100285 if (ssl->conf->f_psk != NULL) {
286 if (ssl->conf->f_psk(
287 ssl->conf->p_psk, ssl, identity, identity_len) == 0) {
288 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000289 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100290 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000291 }
292
Gilles Peskine449bd832023-01-11 14:50:10 +0100293 MBEDTLS_SSL_DEBUG_BUF(5, "identity", identity, identity_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000294 /* Check identity with pre-configured psk */
Gilles Peskine449bd832023-01-11 14:50:10 +0100295 if (ssl->conf->psk_identity != NULL &&
Jerry Yu2f0abc92022-07-22 19:34:48 +0800296 identity_len == ssl->conf->psk_identity_len &&
Gilles Peskine449bd832023-01-11 14:50:10 +0100297 mbedtls_ct_memcmp(ssl->conf->psk_identity,
298 identity, identity_len) == 0) {
299 mbedtls_ssl_set_hs_psk(ssl, ssl->conf->psk, ssl->conf->psk_len);
300 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000301 }
302
Gilles Peskine449bd832023-01-11 14:50:10 +0100303 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000304}
305
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800306MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100307static int ssl_tls13_offered_psks_check_binder_match(mbedtls_ssl_context *ssl,
308 const unsigned char *binder,
309 size_t binder_len,
310 int psk_type,
311 psa_algorithm_t psk_hash_alg)
Jerry Yu1c105562022-07-10 06:32:38 +0000312{
313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800314
Jerry Yudaf375a2022-07-20 21:31:43 +0800315 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000316 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800317 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800318 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800319 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000320
Jerry Yu1c105562022-07-10 06:32:38 +0000321 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800322 ret = mbedtls_ssl_get_handshake_transcript(
Gilles Peskine449bd832023-01-11 14:50:10 +0100323 ssl, mbedtls_hash_info_md_from_psa(psk_hash_alg),
324 transcript, sizeof(transcript), &transcript_len);
325 if (ret != 0) {
326 return ret;
327 }
Jerry Yu1c105562022-07-10 06:32:38 +0000328
Gilles Peskine449bd832023-01-11 14:50:10 +0100329 ret = mbedtls_ssl_tls13_export_handshake_psk(ssl, &psk, &psk_len);
330 if (ret != 0) {
331 return ret;
332 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800333
Gilles Peskine449bd832023-01-11 14:50:10 +0100334 ret = mbedtls_ssl_tls13_create_psk_binder(ssl, psk_hash_alg,
335 psk, psk_len, psk_type,
336 transcript,
337 server_computed_binder);
Jerry Yu96a2e362022-07-21 15:11:34 +0800338#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100339 mbedtls_free((void *) psk);
Jerry Yu96a2e362022-07-21 15:11:34 +0800340#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100341 if (ret != 0) {
342 MBEDTLS_SSL_DEBUG_MSG(1, ("PSK binder calculation failed."));
343 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu1c105562022-07-10 06:32:38 +0000344 }
345
Gilles Peskine449bd832023-01-11 14:50:10 +0100346 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( computed ): ",
347 server_computed_binder, transcript_len);
348 MBEDTLS_SSL_DEBUG_BUF(3, "psk binder ( received ): ", binder, binder_len);
Jerry Yu1c105562022-07-10 06:32:38 +0000349
Gilles Peskine449bd832023-01-11 14:50:10 +0100350 if (mbedtls_ct_memcmp(server_computed_binder, binder, binder_len) == 0) {
351 return SSL_TLS1_3_OFFERED_PSK_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000352 }
353
Gilles Peskine449bd832023-01-11 14:50:10 +0100354 mbedtls_platform_zeroize(server_computed_binder,
355 sizeof(server_computed_binder));
356 return SSL_TLS1_3_OFFERED_PSK_NOT_MATCH;
Jerry Yu1c105562022-07-10 06:32:38 +0000357}
Jerry Yu96a2e362022-07-21 15:11:34 +0800358
Jerry Yu5725f1c2022-08-21 17:27:16 +0800359MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800360static int ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100361 mbedtls_ssl_context *ssl,
362 const unsigned char *cipher_suites,
363 const unsigned char *cipher_suites_end,
364 uint16_t *selected_ciphersuite,
365 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yu5725f1c2022-08-21 17:27:16 +0800366{
Jerry Yuf35ba382022-08-23 17:58:26 +0800367 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800368
Jerry Yu0baf9072022-08-25 11:21:04 +0800369 *selected_ciphersuite = 0;
370 *selected_ciphersuite_info = NULL;
371
Jerry Yuf35ba382022-08-23 17:58:26 +0800372 /* RFC 8446, page 55.
373 *
374 * For externally established PSKs, the Hash algorithm MUST be set when the
375 * PSK is established or default to SHA-256 if no such algorithm is defined.
376 *
377 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800378
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379 /*
380 * Search for a matching ciphersuite
381 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100382 for (const unsigned char *p = cipher_suites;
383 p < cipher_suites_end; p += 2) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800384 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800385 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800386
Gilles Peskine449bd832023-01-11 14:50:10 +0100387 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
388 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
389 cipher_suite);
390 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +0800391 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100392 }
Jerry Yu5725f1c2022-08-21 17:27:16 +0800393
Jerry Yu5725f1c2022-08-21 17:27:16 +0800394 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
395 * Otherwise, client should reject.
396 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100397 if (psk_hash_alg == mbedtls_psa_translate_md(ciphersuite_info->mac)) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 *selected_ciphersuite = cipher_suite;
399 *selected_ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +0100400 return 0;
Jerry Yuf35ba382022-08-23 17:58:26 +0800401 }
402 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100403 MBEDTLS_SSL_DEBUG_MSG(2, ("No matched ciphersuite"));
404 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yuf35ba382022-08-23 17:58:26 +0800405}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800406
Jerry Yu82534862022-08-30 10:42:33 +0800407#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800408MBEDTLS_CHECK_RETURN_CRITICAL
409static int ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100410 mbedtls_ssl_context *ssl,
411 const unsigned char *cipher_suites,
412 const unsigned char *cipher_suites_end,
413 mbedtls_ssl_session *session,
414 uint16_t *selected_ciphersuite,
415 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info)
Jerry Yuf35ba382022-08-23 17:58:26 +0800416{
Jerry Yu82534862022-08-30 10:42:33 +0800417
Jerry Yuf35ba382022-08-23 17:58:26 +0800418 *selected_ciphersuite = 0;
419 *selected_ciphersuite_info = NULL;
Gilles Peskine449bd832023-01-11 14:50:10 +0100420 for (const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2) {
421 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yu82534862022-08-30 10:42:33 +0800422 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
423
Gilles Peskine449bd832023-01-11 14:50:10 +0100424 if (cipher_suite != session->ciphersuite) {
Jerry Yu82534862022-08-30 10:42:33 +0800425 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100426 }
Jerry Yu82534862022-08-30 10:42:33 +0800427
Gilles Peskine449bd832023-01-11 14:50:10 +0100428 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(ssl,
429 cipher_suite);
430 if (ciphersuite_info == NULL) {
Jerry Yu82534862022-08-30 10:42:33 +0800431 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100432 }
Jerry Yu82534862022-08-30 10:42:33 +0800433
Jerry Yu4746b102022-09-13 11:11:48 +0800434 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800435 *selected_ciphersuite_info = ciphersuite_info;
436
Gilles Peskine449bd832023-01-11 14:50:10 +0100437 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800438 }
439
Gilles Peskine449bd832023-01-11 14:50:10 +0100440 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800441}
Jerry Yuf35ba382022-08-23 17:58:26 +0800442
Jerry Yu82534862022-08-30 10:42:33 +0800443MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100444static int ssl_tls13_session_copy_ticket(mbedtls_ssl_session *dst,
445 const mbedtls_ssl_session *src)
Jerry Yu82534862022-08-30 10:42:33 +0800446{
Jerry Yu82534862022-08-30 10:42:33 +0800447 dst->ticket_age_add = src->ticket_age_add;
448 dst->ticket_flags = src->ticket_flags;
449 dst->resumption_key_len = src->resumption_key_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100450 if (src->resumption_key_len == 0) {
451 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
452 }
453 memcpy(dst->resumption_key, src->resumption_key, src->resumption_key_len);
Jerry Yu4746b102022-09-13 11:11:48 +0800454
Gilles Peskine449bd832023-01-11 14:50:10 +0100455 return 0;
Jerry Yu82534862022-08-30 10:42:33 +0800456}
457#endif /* MBEDTLS_SSL_SESSION_TICKETS */
458
Jerry Yu1c105562022-07-10 06:32:38 +0000459/* Parser for pre_shared_key extension in client hello
460 * struct {
461 * opaque identity<1..2^16-1>;
462 * uint32 obfuscated_ticket_age;
463 * } PskIdentity;
464 *
465 * opaque PskBinderEntry<32..255>;
466 *
467 * struct {
468 * PskIdentity identities<7..2^16-1>;
469 * PskBinderEntry binders<33..2^16-1>;
470 * } OfferedPsks;
471 *
472 * struct {
473 * select (Handshake.msg_type) {
474 * case client_hello: OfferedPsks;
475 * ....
476 * };
477 * } PreSharedKeyExtension;
478 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800479MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100480static int ssl_tls13_parse_pre_shared_key_ext(mbedtls_ssl_context *ssl,
481 const unsigned char *pre_shared_key_ext,
482 const unsigned char *pre_shared_key_ext_end,
483 const unsigned char *ciphersuites,
484 const unsigned char *ciphersuites_end)
Jerry Yu1c105562022-07-10 06:32:38 +0000485{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800486 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800487 const unsigned char *p_identity_len;
488 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000489 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800490 const unsigned char *binders;
491 const unsigned char *p_binder_len;
492 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000493 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800494 int matched_identity = -1;
495 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000496
Gilles Peskine449bd832023-01-11 14:50:10 +0100497 MBEDTLS_SSL_DEBUG_BUF(3, "pre_shared_key extension",
498 pre_shared_key_ext,
499 pre_shared_key_ext_end - pre_shared_key_ext);
Jerry Yu1c105562022-07-10 06:32:38 +0000500
Jerry Yu96a2e362022-07-21 15:11:34 +0800501 /* identities_len 2 bytes
502 * identities_data >= 7 bytes
503 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100504 MBEDTLS_SSL_CHK_BUF_READ_PTR(identities, pre_shared_key_ext_end, 7 + 2);
505 identities_len = MBEDTLS_GET_UINT16_BE(identities, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800506 p_identity_len = identities + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100507 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, pre_shared_key_ext_end,
508 identities_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800509 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000510
Jerry Yu96a2e362022-07-21 15:11:34 +0800511 /* binders_len 2 bytes
512 * binders >= 33 bytes
513 */
Jerry Yu568ec252022-07-22 21:27:34 +0800514 binders = identities_end;
Gilles Peskine449bd832023-01-11 14:50:10 +0100515 MBEDTLS_SSL_CHK_BUF_READ_PTR(binders, pre_shared_key_ext_end, 33 + 2);
516 binders_len = MBEDTLS_GET_UINT16_BE(binders, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800517 p_binder_len = binders + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100518 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, pre_shared_key_ext_end, binders_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800519 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000520
Gilles Peskine449bd832023-01-11 14:50:10 +0100521 ssl->handshake->update_checksum(ssl, pre_shared_key_ext,
522 identities_end - pre_shared_key_ext);
Jerry Yu96a2e362022-07-21 15:11:34 +0800523
Gilles Peskine449bd832023-01-11 14:50:10 +0100524 while (p_identity_len < identities_end && p_binder_len < binders_end) {
Jerry Yu1c105562022-07-10 06:32:38 +0000525 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800526 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800527 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800528 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800529 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800530 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800531 int psk_type;
532 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800533 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800534#if defined(MBEDTLS_SSL_SESSION_TICKETS)
535 mbedtls_ssl_session session;
Gilles Peskine449bd832023-01-11 14:50:10 +0100536 mbedtls_ssl_session_init(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800537#endif
Jerry Yubb852022022-07-20 21:10:44 +0800538
Gilles Peskine449bd832023-01-11 14:50:10 +0100539 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_identity_len, identities_end, 2 + 1 + 4);
540 identity_len = MBEDTLS_GET_UINT16_BE(p_identity_len, 0);
Jerry Yu568ec252022-07-22 21:27:34 +0800541 identity = p_identity_len + 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100542 MBEDTLS_SSL_CHK_BUF_READ_PTR(identity, identities_end, identity_len + 4);
543 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE(identity, identity_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800544 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000545
Gilles Peskine449bd832023-01-11 14:50:10 +0100546 MBEDTLS_SSL_CHK_BUF_READ_PTR(p_binder_len, binders_end, 1 + 32);
Jerry Yu568ec252022-07-22 21:27:34 +0800547 binder_len = *p_binder_len;
548 binder = p_binder_len + 1;
Gilles Peskine449bd832023-01-11 14:50:10 +0100549 MBEDTLS_SSL_CHK_BUF_READ_PTR(binder, binders_end, binder_len);
Jerry Yu568ec252022-07-22 21:27:34 +0800550 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800551
Jerry Yu96a2e362022-07-21 15:11:34 +0800552 identity_id++;
Gilles Peskine449bd832023-01-11 14:50:10 +0100553 if (matched_identity != -1) {
Jerry Yu1c105562022-07-10 06:32:38 +0000554 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100555 }
Jerry Yu1c105562022-07-10 06:32:38 +0000556
Jerry Yu96a2e362022-07-21 15:11:34 +0800557 ret = ssl_tls13_offered_psks_check_identity_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100558 ssl, identity, identity_len, obfuscated_ticket_age,
559 &psk_type, &session);
560 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yu96a2e362022-07-21 15:11:34 +0800561 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +0100562 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800563
Gilles Peskine449bd832023-01-11 14:50:10 +0100564 MBEDTLS_SSL_DEBUG_MSG(4, ("found matched identity"));
565 switch (psk_type) {
Jerry Yu0baf9072022-08-25 11:21:04 +0800566 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
567 ret = ssl_tls13_select_ciphersuite_for_psk(
Gilles Peskine449bd832023-01-11 14:50:10 +0100568 ssl, ciphersuites, ciphersuites_end,
569 &cipher_suite, &ciphersuite_info);
Jerry Yu0baf9072022-08-25 11:21:04 +0800570 break;
571 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800572#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800573 ret = ssl_tls13_select_ciphersuite_for_resumption(
Gilles Peskine449bd832023-01-11 14:50:10 +0100574 ssl, ciphersuites, ciphersuites_end, &session,
575 &cipher_suite, &ciphersuite_info);
576 if (ret != 0) {
577 mbedtls_ssl_session_free(&session);
578 }
Jerry Yu82534862022-08-30 10:42:33 +0800579#else
580 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
581#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800582 break;
583 default:
Gilles Peskine449bd832023-01-11 14:50:10 +0100584 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu0baf9072022-08-25 11:21:04 +0800585 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100586 if (ret != 0) {
Jerry Yuf35ba382022-08-23 17:58:26 +0800587 /* See below, no cipher_suite available, abort handshake */
588 MBEDTLS_SSL_PEND_FATAL_ALERT(
589 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100590 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf35ba382022-08-23 17:58:26 +0800591 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +0100592 2, "ssl_tls13_select_ciphersuite", ret);
593 return ret;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800594 }
595
Jerry Yu96a2e362022-07-21 15:11:34 +0800596 ret = ssl_tls13_offered_psks_check_binder_match(
Gilles Peskine449bd832023-01-11 14:50:10 +0100597 ssl, binder, binder_len, psk_type,
598 mbedtls_psa_translate_md(ciphersuite_info->mac));
599 if (ret != SSL_TLS1_3_OFFERED_PSK_MATCH) {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800600 /* For security reasons, the handshake should be aborted when we
601 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
602 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800603#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100604 mbedtls_ssl_session_free(&session);
Jerry Yu82534862022-08-30 10:42:33 +0800605#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100606 MBEDTLS_SSL_DEBUG_MSG(3, ("Invalid binder."));
607 MBEDTLS_SSL_DEBUG_RET(1,
608 "ssl_tls13_offered_psks_check_binder_match", ret);
Jerry Yu96a2e362022-07-21 15:11:34 +0800609 MBEDTLS_SSL_PEND_FATAL_ALERT(
610 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
Gilles Peskine449bd832023-01-11 14:50:10 +0100611 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
612 return ret;
Jerry Yu96a2e362022-07-21 15:11:34 +0800613 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800614
615 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800616
617 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800618 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800619 ssl->session_negotiate->ciphersuite = cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +0100620 MBEDTLS_SSL_DEBUG_MSG(2, ("overwrite ciphersuite: %04x - %s",
621 cipher_suite, ciphersuite_info->name));
Jerry Yu82534862022-08-30 10:42:33 +0800622#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Gilles Peskine449bd832023-01-11 14:50:10 +0100623 if (psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION) {
624 ret = ssl_tls13_session_copy_ticket(ssl->session_negotiate,
625 &session);
626 mbedtls_ssl_session_free(&session);
627 if (ret != 0) {
628 return ret;
629 }
Jerry Yu82534862022-08-30 10:42:33 +0800630 }
631#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000632 }
633
Gilles Peskine449bd832023-01-11 14:50:10 +0100634 if (p_identity_len != identities_end || p_binder_len != binders_end) {
635 MBEDTLS_SSL_DEBUG_MSG(3, ("pre_shared_key extension decode error"));
636 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
637 MBEDTLS_ERR_SSL_DECODE_ERROR);
638 return MBEDTLS_ERR_SSL_DECODE_ERROR;
Jerry Yu1c105562022-07-10 06:32:38 +0000639 }
640
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800641 /* Update the handshake transcript with the binder list. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100642 ssl->handshake->update_checksum(ssl,
643 identities_end,
644 (size_t) (binders_end - identities_end));
645 if (matched_identity == -1) {
646 MBEDTLS_SSL_DEBUG_MSG(3, ("No matched PSK or ticket."));
647 return MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY;
Jerry Yu1c105562022-07-10 06:32:38 +0000648 }
649
Gilles Peskine449bd832023-01-11 14:50:10 +0100650 ssl->handshake->selected_identity = (uint16_t) matched_identity;
651 MBEDTLS_SSL_DEBUG_MSG(3, ("Pre shared key found"));
Jerry Yu1c105562022-07-10 06:32:38 +0000652
Gilles Peskine449bd832023-01-11 14:50:10 +0100653 return 0;
Jerry Yu1c105562022-07-10 06:32:38 +0000654}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000655
656/*
657 * struct {
658 * select ( Handshake.msg_type ) {
659 * ....
660 * case server_hello:
661 * uint16 selected_identity;
662 * }
663 * } PreSharedKeyExtension;
664 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100665static int ssl_tls13_write_server_pre_shared_key_ext(mbedtls_ssl_context *ssl,
666 unsigned char *buf,
667 unsigned char *end,
668 size_t *olen)
Jerry Yu032b15ce2022-07-11 06:10:03 +0000669{
Gilles Peskine449bd832023-01-11 14:50:10 +0100670 unsigned char *p = (unsigned char *) buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000671
672 *olen = 0;
673
David Horstmann21b89762022-10-06 18:34:28 +0100674 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000675#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +0100676 not_using_psk = (mbedtls_svc_key_id_is_null(ssl->handshake->psk_opaque));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000677#else
Gilles Peskine449bd832023-01-11 14:50:10 +0100678 not_using_psk = (ssl->handshake->psk == NULL);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000679#endif
Gilles Peskine449bd832023-01-11 14:50:10 +0100680 if (not_using_psk) {
Jerry Yu032b15ce2022-07-11 06:10:03 +0000681 /* We shouldn't have called this extension writer unless we've
682 * chosen to use a PSK. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100683 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684 }
685
Gilles Peskine449bd832023-01-11 14:50:10 +0100686 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding pre_shared_key extension"));
687 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 6);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000688
Gilles Peskine449bd832023-01-11 14:50:10 +0100689 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0);
690 MBEDTLS_PUT_UINT16_BE(2, p, 2);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000691
Gilles Peskine449bd832023-01-11 14:50:10 +0100692 MBEDTLS_PUT_UINT16_BE(ssl->handshake->selected_identity, p, 4);
Jerry Yu032b15ce2022-07-11 06:10:03 +0000693
694 *olen = 6;
695
Gilles Peskine449bd832023-01-11 14:50:10 +0100696 MBEDTLS_SSL_DEBUG_MSG(4, ("sent selected_identity: %u",
697 ssl->handshake->selected_identity));
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698
Gilles Peskine449bd832023-01-11 14:50:10 +0100699 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY);
Jerry Yub95dd362022-11-08 21:19:34 +0800700
Gilles Peskine449bd832023-01-11 14:50:10 +0100701 return 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702}
703
Ronald Cron41a443a2022-10-04 16:38:25 +0200704#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000705
XiaokangQian7807f9f2022-02-15 10:04:37 +0000706/* From RFC 8446:
707 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000708 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000709 * } SupportedVersions;
710 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200711MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100712static int ssl_tls13_parse_supported_versions_ext(mbedtls_ssl_context *ssl,
713 const unsigned char *buf,
714 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000715{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000716 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000717 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000718 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000719 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000720 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000721
Gilles Peskine449bd832023-01-11 14:50:10 +0100722 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 1);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000723 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000724 p += 1;
725
Gilles Peskine449bd832023-01-11 14:50:10 +0100726 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, versions_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +0000727 versions_end = p + versions_len;
Gilles Peskine449bd832023-01-11 14:50:10 +0100728 while (p < versions_end) {
729 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, versions_end, 2);
730 tls_version = mbedtls_ssl_read_version(p, ssl->conf->transport);
XiaokangQianb67384d2022-04-19 00:02:38 +0000731 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000732
733 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
Gilles Peskine449bd832023-01-11 14:50:10 +0100734 if (tls_version == MBEDTLS_SSL_VERSION_TLS1_3) {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735 tls13_supported = 1;
736 break;
737 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 }
739
Gilles Peskine449bd832023-01-11 14:50:10 +0100740 if (!tls13_supported) {
741 MBEDTLS_SSL_DEBUG_MSG(1, ("TLS 1.3 is not supported by the client"));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742
Gilles Peskine449bd832023-01-11 14:50:10 +0100743 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
744 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
745 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000746 }
747
Gilles Peskine449bd832023-01-11 14:50:10 +0100748 MBEDTLS_SSL_DEBUG_MSG(1, ("Negotiated version. Supported is [%04x]",
749 (unsigned int) tls_version));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000750
Gilles Peskine449bd832023-01-11 14:50:10 +0100751 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000752}
753
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000754#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000755/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000756 *
757 * From RFC 8446:
758 * enum {
759 * ... (0xFFFF)
760 * } NamedGroup;
761 * struct {
762 * NamedGroup named_group_list<2..2^16-1>;
763 * } NamedGroupList;
764 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200765MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100766static int ssl_tls13_parse_supported_groups_ext(mbedtls_ssl_context *ssl,
767 const unsigned char *buf,
768 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000769{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000770 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000771 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000772 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773
Gilles Peskine449bd832023-01-11 14:50:10 +0100774 MBEDTLS_SSL_DEBUG_BUF(3, "supported_groups extension", p, end - buf);
775 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
776 named_group_list_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000777 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100778 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, named_group_list_len);
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000779 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000780 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000781
Gilles Peskine449bd832023-01-11 14:50:10 +0100782 while (p < named_group_list_end) {
XiaokangQian08037552022-04-20 07:16:41 +0000783 uint16_t named_group;
Gilles Peskine449bd832023-01-11 14:50:10 +0100784 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, named_group_list_end, 2);
785 named_group = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian08037552022-04-20 07:16:41 +0000786 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000787
Gilles Peskine449bd832023-01-11 14:50:10 +0100788 MBEDTLS_SSL_DEBUG_MSG(2,
789 ("got named group: %s(%04x)",
790 mbedtls_ssl_named_group_to_str(named_group),
791 named_group));
XiaokangQian08037552022-04-20 07:16:41 +0000792
Gilles Peskine449bd832023-01-11 14:50:10 +0100793 if (!mbedtls_ssl_named_group_is_offered(ssl, named_group) ||
794 !mbedtls_ssl_named_group_is_supported(named_group) ||
795 ssl->handshake->hrr_selected_group != 0) {
XiaokangQian08037552022-04-20 07:16:41 +0000796 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000797 }
798
Gilles Peskine449bd832023-01-11 14:50:10 +0100799 MBEDTLS_SSL_DEBUG_MSG(2,
800 ("add named group %s(%04x) into received list.",
801 mbedtls_ssl_named_group_to_str(named_group),
802 named_group));
Jerry Yuc1be19f2022-04-23 16:11:39 +0800803
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000804 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000805 }
806
Gilles Peskine449bd832023-01-11 14:50:10 +0100807 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808
809}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000810#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000811
XiaokangQian08037552022-04-20 07:16:41 +0000812#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
813
XiaokangQian88408882022-04-02 10:15:03 +0000814#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000815/*
816 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000817 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818 *
819 * Possible return values are:
820 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000821 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000822 * does not match a group supported by the server. A HelloRetryRequest will
823 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000824 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800825 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200826MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100827static int ssl_tls13_parse_key_shares_ext(mbedtls_ssl_context *ssl,
828 const unsigned char *buf,
829 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000830{
XiaokangQianb67384d2022-04-19 00:02:38 +0000831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000832 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000833 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800834 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000835
836 /* From RFC 8446:
837 *
838 * struct {
839 * KeyShareEntry client_shares<0..2^16-1>;
840 * } KeyShareClientHello;
841 *
842 */
843
Gilles Peskine449bd832023-01-11 14:50:10 +0100844 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 2);
845 client_shares_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000846 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +0100847 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, client_shares_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +0000848
849 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000850 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000851
852 /* We try to find a suitable key share entry and copy it to the
853 * handshake context. Later, we have to find out whether we can do
854 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000855 * dismiss it and send a HelloRetryRequest message.
856 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000857
Gilles Peskine449bd832023-01-11 14:50:10 +0100858 while (p < client_shares_end) {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000859 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800860 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800861 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000862
863 /*
864 * struct {
865 * NamedGroup group;
866 * opaque key_exchange<1..2^16-1>;
867 * } KeyShareEntry;
868 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100869 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, 4);
870 group = MBEDTLS_GET_UINT16_BE(p, 0);
871 key_exchange_len = MBEDTLS_GET_UINT16_BE(p, 2);
Jerry Yuc1be19f2022-04-23 16:11:39 +0800872 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800873 key_exchange = p;
Gilles Peskine449bd832023-01-11 14:50:10 +0100874 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, client_shares_end, key_exchange_len);
Jerry Yu086edc22022-05-05 10:50:38 +0800875 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000876
877 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000878 * for input validation purposes.
879 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100880 if (!mbedtls_ssl_named_group_is_offered(ssl, group) ||
881 !mbedtls_ssl_named_group_is_supported(group) ||
882 ssl->handshake->offered_group_id != 0) {
XiaokangQian060d8672022-04-21 09:24:56 +0000883 continue;
884 }
XiaokangQian060d8672022-04-21 09:24:56 +0000885
XiaokangQian7807f9f2022-02-15 10:04:37 +0000886 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000887 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000888 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100889 if (mbedtls_ssl_tls13_named_group_is_ecdhe(group)) {
890 MBEDTLS_SSL_DEBUG_MSG(2, ("ECDH group: %s (%04x)",
891 mbedtls_ssl_named_group_to_str(group),
892 group));
XiaokangQian318dc762022-04-20 09:43:51 +0000893 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Gilles Peskine449bd832023-01-11 14:50:10 +0100894 ssl, key_exchange - 2, key_exchange_len + 2);
895 if (ret != 0) {
896 return ret;
897 }
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000898
Gilles Peskine449bd832023-01-11 14:50:10 +0100899 } else {
900 MBEDTLS_SSL_DEBUG_MSG(4, ("Unrecognized NamedGroup %u",
901 (unsigned) group));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000902 continue;
903 }
904
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000905 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000906 }
907
Jerry Yuc1be19f2022-04-23 16:11:39 +0800908
Gilles Peskine449bd832023-01-11 14:50:10 +0100909 if (ssl->handshake->offered_group_id == 0) {
910 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching key share"));
911 return SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000912 }
Gilles Peskine449bd832023-01-11 14:50:10 +0100913 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000914}
XiaokangQian88408882022-04-02 10:15:03 +0000915#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000916
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200917MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100918static int ssl_tls13_client_hello_has_exts(mbedtls_ssl_context *ssl,
919 int exts_mask)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000920{
Jerry Yu0c354a22022-08-29 15:25:36 +0800921 int masked = ssl->handshake->received_extensions & exts_mask;
Gilles Peskine449bd832023-01-11 14:50:10 +0100922 return masked == exts_mask;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923}
924
Jerry Yue5991322022-11-07 14:03:44 +0800925#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200926MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000927static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100928 mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000929{
Gilles Peskine449bd832023-01-11 14:50:10 +0100930 return ssl_tls13_client_hello_has_exts(
931 ssl,
932 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
933 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
934 MBEDTLS_SSL_EXT_MASK(SIG_ALG));
XiaokangQian7807f9f2022-02-15 10:04:37 +0000935}
Jerry Yue5991322022-11-07 14:03:44 +0800936#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937
Jerry Yue5991322022-11-07 14:03:44 +0800938#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000939MBEDTLS_CHECK_RETURN_CRITICAL
940static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100941 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000942{
Gilles Peskine449bd832023-01-11 14:50:10 +0100943 return ssl_tls13_client_hello_has_exts(
944 ssl,
945 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
946 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000947}
Jerry Yue5991322022-11-07 14:03:44 +0800948#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000949
Jerry Yue5991322022-11-07 14:03:44 +0800950#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000951MBEDTLS_CHECK_RETURN_CRITICAL
952static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +0100953 mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000954{
Gilles Peskine449bd832023-01-11 14:50:10 +0100955 return ssl_tls13_client_hello_has_exts(
956 ssl,
957 MBEDTLS_SSL_EXT_MASK(SUPPORTED_GROUPS) |
958 MBEDTLS_SSL_EXT_MASK(KEY_SHARE) |
959 MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY) |
960 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES));
Jerry Yu77f01482022-07-11 07:03:24 +0000961}
Jerry Yue5991322022-11-07 14:03:44 +0800962#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000963
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200964MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100965static int ssl_tls13_check_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000966{
Jerry Yue5991322022-11-07 14:03:44 +0800967#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100968 return mbedtls_ssl_conf_tls13_ephemeral_enabled(ssl) &&
969 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(ssl);
Jerry Yue5991322022-11-07 14:03:44 +0800970#else
971 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100972 return 0;
Jerry Yue5991322022-11-07 14:03:44 +0800973#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000974}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000975
Jerry Yu77f01482022-07-11 07:03:24 +0000976MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100977static int ssl_tls13_check_psk_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000978{
Jerry Yue5991322022-11-07 14:03:44 +0800979#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100980 return mbedtls_ssl_conf_tls13_psk_enabled(ssl) &&
981 mbedtls_ssl_tls13_psk_enabled(ssl) &&
982 ssl_tls13_client_hello_has_exts_for_psk_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000983#else
984 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100985 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +0000986#endif
987}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000988
Jerry Yu77f01482022-07-11 07:03:24 +0000989MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +0100990static int ssl_tls13_check_psk_ephemeral_key_exchange(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +0000991{
Jerry Yue5991322022-11-07 14:03:44 +0800992#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +0100993 return mbedtls_ssl_conf_tls13_psk_ephemeral_enabled(ssl) &&
994 mbedtls_ssl_tls13_psk_ephemeral_enabled(ssl) &&
995 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(ssl);
Jerry Yu77f01482022-07-11 07:03:24 +0000996#else
997 ((void) ssl);
Gilles Peskine449bd832023-01-11 14:50:10 +0100998 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +0000999#endif
1000}
1001
Gilles Peskine449bd832023-01-11 14:50:10 +01001002static int ssl_tls13_determine_key_exchange_mode(mbedtls_ssl_context *ssl)
Jerry Yu77f01482022-07-11 07:03:24 +00001003{
1004 /*
1005 * Determine the key exchange algorithm to use.
1006 * There are three types of key exchanges supported in TLS 1.3:
1007 * - (EC)DH with ECDSA,
1008 * - (EC)DH with PSK,
1009 * - plain PSK.
1010 *
1011 * The PSK-based key exchanges may additionally be used with 0-RTT.
1012 *
1013 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001014 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1015 * 2 ) Certificate Mode ( ephemeral )
1016 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001017 */
1018
1019 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1020
Gilles Peskine449bd832023-01-11 14:50:10 +01001021 if (ssl_tls13_check_psk_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001022 ssl->handshake->key_exchange_mode =
1023 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001024 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk_ephemeral"));
1025 } else
1026 if (ssl_tls13_check_ephemeral_key_exchange(ssl)) {
Jerry Yu77f01482022-07-11 07:03:24 +00001027 ssl->handshake->key_exchange_mode =
1028 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Gilles Peskine449bd832023-01-11 14:50:10 +01001029 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: ephemeral"));
1030 } else
1031 if (ssl_tls13_check_psk_key_exchange(ssl)) {
Jerry Yuce6ed702022-07-22 21:49:53 +08001032 ssl->handshake->key_exchange_mode =
1033 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Gilles Peskine449bd832023-01-11 14:50:10 +01001034 MBEDTLS_SSL_DEBUG_MSG(2, ("key exchange mode: psk"));
1035 } else {
Jerry Yu77f01482022-07-11 07:03:24 +00001036 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001037 1,
1038 ("ClientHello message misses mandatory extensions."));
1039 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1040 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1041 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu77f01482022-07-11 07:03:24 +00001042 }
1043
Gilles Peskine449bd832023-01-11 14:50:10 +01001044 return 0;
Jerry Yu77f01482022-07-11 07:03:24 +00001045
XiaokangQian7807f9f2022-02-15 10:04:37 +00001046}
1047
XiaokangQian81802f42022-06-10 13:25:22 +00001048#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001049 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001050
1051#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001052static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg(uint16_t sig_alg)
Ronald Cron67ea2542022-09-15 17:34:42 +02001053{
Gilles Peskine449bd832023-01-11 14:50:10 +01001054 switch (sig_alg) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001055 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001056 return PSA_ALG_ECDSA(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001057 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001058 return PSA_ALG_ECDSA(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001059 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001060 return PSA_ALG_ECDSA(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001061 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001062 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001063 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001064 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001065 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001066 return PSA_ALG_RSA_PSS(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001067 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Gilles Peskine449bd832023-01-11 14:50:10 +01001068 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_256);
Ronald Cron67ea2542022-09-15 17:34:42 +02001069 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Gilles Peskine449bd832023-01-11 14:50:10 +01001070 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_384);
Ronald Cron67ea2542022-09-15 17:34:42 +02001071 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Gilles Peskine449bd832023-01-11 14:50:10 +01001072 return PSA_ALG_RSA_PKCS1V15_SIGN(PSA_ALG_SHA_512);
Ronald Cron67ea2542022-09-15 17:34:42 +02001073 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01001074 return PSA_ALG_NONE;
Ronald Cron67ea2542022-09-15 17:34:42 +02001075 }
1076}
1077#endif /* MBEDTLS_USE_PSA_CRYPTO */
1078
XiaokangQian23c5be62022-06-07 02:04:34 +00001079/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001080 * Pick best ( private key, certificate chain ) pair based on the signature
1081 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001082 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001083MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001084static int ssl_tls13_pick_key_cert(mbedtls_ssl_context *ssl)
XiaokangQian23c5be62022-06-07 02:04:34 +00001085{
XiaokangQianfb665a82022-06-15 03:57:21 +00001086 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001087 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001088
1089#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01001090 if (ssl->handshake->sni_key_cert != NULL) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001091 key_cert_list = ssl->handshake->sni_key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001092 } else
XiaokangQian23c5be62022-06-07 02:04:34 +00001093#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
Gilles Peskine449bd832023-01-11 14:50:10 +01001094 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001095
Gilles Peskine449bd832023-01-11 14:50:10 +01001096 if (key_cert_list == NULL) {
1097 MBEDTLS_SSL_DEBUG_MSG(3, ("server has no certificate"));
1098 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001099 }
1100
Gilles Peskine449bd832023-01-11 14:50:10 +01001101 for (; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++) {
1102 if (!mbedtls_ssl_sig_alg_is_offered(ssl, *sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001103 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001104 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001105
Gilles Peskine449bd832023-01-11 14:50:10 +01001106 if (!mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported(*sig_alg)) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001107 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001108 }
Ronald Cron67ea2542022-09-15 17:34:42 +02001109
Gilles Peskine449bd832023-01-11 14:50:10 +01001110 for (key_cert = key_cert_list; key_cert != NULL;
1111 key_cert = key_cert->next) {
Ronald Cron67ea2542022-09-15 17:34:42 +02001112#if defined(MBEDTLS_USE_PSA_CRYPTO)
1113 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1114#endif /* MBEDTLS_USE_PSA_CRYPTO */
1115
Gilles Peskine449bd832023-01-11 14:50:10 +01001116 MBEDTLS_SSL_DEBUG_CRT(3, "certificate (chain) candidate",
1117 key_cert->cert);
XiaokangQian81802f42022-06-10 13:25:22 +00001118
1119 /*
Gilles Peskine449bd832023-01-11 14:50:10 +01001120 * This avoids sending the client a cert it'll reject based on
1121 * keyUsage or other extensions.
1122 */
1123 if (mbedtls_x509_crt_check_key_usage(
1124 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001125 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001126 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
Gilles Peskine449bd832023-01-11 14:50:10 +01001127 MBEDTLS_OID_SIZE(MBEDTLS_OID_SERVER_AUTH)) != 0) {
1128 MBEDTLS_SSL_DEBUG_MSG(3, ("certificate mismatch: "
1129 "(extended) key usage extension"));
XiaokangQian81802f42022-06-10 13:25:22 +00001130 continue;
1131 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001132
Gilles Peskine449bd832023-01-11 14:50:10 +01001133 MBEDTLS_SSL_DEBUG_MSG(3,
1134 ("ssl_tls13_pick_key_cert:"
1135 "check signature algorithm %s [%04x]",
1136 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1137 *sig_alg));
Ronald Cron67ea2542022-09-15 17:34:42 +02001138#if defined(MBEDTLS_USE_PSA_CRYPTO)
Gilles Peskine449bd832023-01-11 14:50:10 +01001139 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg(*sig_alg);
Ronald Cron67ea2542022-09-15 17:34:42 +02001140#endif /* MBEDTLS_USE_PSA_CRYPTO */
1141
Gilles Peskine449bd832023-01-11 14:50:10 +01001142 if (mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
1143 *sig_alg, &key_cert->cert->pk)
Ronald Cron67ea2542022-09-15 17:34:42 +02001144#if defined(MBEDTLS_USE_PSA_CRYPTO)
1145 && psa_alg != PSA_ALG_NONE &&
Gilles Peskine449bd832023-01-11 14:50:10 +01001146 mbedtls_pk_can_do_ext(&key_cert->cert->pk, psa_alg,
1147 PSA_KEY_USAGE_SIGN_HASH) == 1
Ronald Cron67ea2542022-09-15 17:34:42 +02001148#endif /* MBEDTLS_USE_PSA_CRYPTO */
Gilles Peskine449bd832023-01-11 14:50:10 +01001149 ) {
XiaokangQianfb665a82022-06-15 03:57:21 +00001150 ssl->handshake->key_cert = key_cert;
Gilles Peskine449bd832023-01-11 14:50:10 +01001151 MBEDTLS_SSL_DEBUG_MSG(3,
1152 ("ssl_tls13_pick_key_cert:"
1153 "selected signature algorithm"
1154 " %s [%04x]",
1155 mbedtls_ssl_sig_alg_to_str(*sig_alg),
1156 *sig_alg));
XiaokangQianfb665a82022-06-15 03:57:21 +00001157 MBEDTLS_SSL_DEBUG_CRT(
Gilles Peskine449bd832023-01-11 14:50:10 +01001158 3, "selected certificate (chain)",
1159 ssl->handshake->key_cert->cert);
1160 return 0;
XiaokangQian81802f42022-06-10 13:25:22 +00001161 }
XiaokangQian81802f42022-06-10 13:25:22 +00001162 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001163 }
1164
Gilles Peskine449bd832023-01-11 14:50:10 +01001165 MBEDTLS_SSL_DEBUG_MSG(2, ("ssl_tls13_pick_key_cert:"
1166 "no suitable certificate found"));
1167 return -1;
XiaokangQian23c5be62022-06-07 02:04:34 +00001168}
XiaokangQian81802f42022-06-10 13:25:22 +00001169#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001170 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001171
XiaokangQian4080a7f2022-04-11 09:55:18 +00001172/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001173 *
1174 * STATE HANDLING: ClientHello
1175 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001176 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001177 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001178 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001179 *
1180 * In this case, the server progresses to sending its ServerHello.
1181 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001182 * 2) The ClientHello was well-formed but didn't match the server's
1183 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001184 *
1185 * For example, the client might not have offered a key share which
1186 * the server supports, or the server might require a cookie.
1187 *
1188 * In this case, the server sends a HelloRetryRequest.
1189 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001190 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001191 *
1192 * In this case, we abort the handshake.
1193 *
1194 */
1195
1196/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001197 * Structure of this message:
1198 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001199 * uint16 ProtocolVersion;
1200 * opaque Random[32];
1201 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001202 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001203 * struct {
1204 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1205 * Random random;
1206 * opaque legacy_session_id<0..32>;
1207 * CipherSuite cipher_suites<2..2^16-2>;
1208 * opaque legacy_compression_methods<1..2^8-1>;
1209 * Extension extensions<8..2^16-1>;
1210 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001211 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001212
1213#define SSL_CLIENT_HELLO_OK 0
1214#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1215
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001216MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001217static int ssl_tls13_parse_client_hello(mbedtls_ssl_context *ssl,
1218 const unsigned char *buf,
1219 const unsigned char *end)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001220{
XiaokangQianb67384d2022-04-19 00:02:38 +00001221 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1222 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001223 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001224 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001225 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001226 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001227 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001228 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001229 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001230
Ronald Cron41a443a2022-10-04 16:38:25 +02001231#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001232 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001233 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001234 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001235#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001236
XiaokangQian7807f9f2022-02-15 10:04:37 +00001237 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001238 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001239 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001240 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001241 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001242 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001243 * .. . .. ciphersuite list length ( 2 bytes )
1244 * .. . .. ciphersuite list
1245 * .. . .. compression alg. list length ( 1 byte )
1246 * .. . .. compression alg. list
1247 * .. . .. extensions length ( 2 bytes, optional )
1248 * .. . .. extensions ( optional )
1249 */
1250
XiaokangQianb67384d2022-04-19 00:02:38 +00001251 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001252 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001253 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1254 * read at least up to session id length without worrying.
1255 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001256 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, 38);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257
1258 /* ...
1259 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1260 * ...
1261 * with ProtocolVersion defined as:
1262 * uint16 ProtocolVersion;
1263 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001264 if (mbedtls_ssl_read_version(p, ssl->conf->transport) !=
1265 MBEDTLS_SSL_VERSION_TLS1_2) {
1266 MBEDTLS_SSL_DEBUG_MSG(1, ("Unsupported version of TLS."));
1267 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1268 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION);
1269 return MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001270 }
1271 p += 2;
1272
1273 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001274 * Only support TLS 1.3 currently, temporarily set the version.
1275 */
XiaokangQiande333912022-04-20 08:49:42 +00001276 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001277
Jerry Yue67bef42022-07-07 07:29:42 +00001278#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1279 /* Store minor version for later use with ticket serialization. */
1280 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001281 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001282#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001283
Jerry Yuc1be19f2022-04-23 16:11:39 +08001284 /* ...
1285 * Random random;
1286 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001287 * with Random defined as:
1288 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001289 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001290 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, random bytes",
1291 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001292
Gilles Peskine449bd832023-01-11 14:50:10 +01001293 memcpy(&handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN);
XiaokangQian08037552022-04-20 07:16:41 +00001294 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001295
Jerry Yuc1be19f2022-04-23 16:11:39 +08001296 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001297 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001298 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001299 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001300 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001301 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001302
Gilles Peskine449bd832023-01-11 14:50:10 +01001303 if (legacy_session_id_len > sizeof(ssl->session_negotiate->id)) {
1304 MBEDTLS_SSL_DEBUG_MSG(1, ("bad client hello message"));
1305 return MBEDTLS_ERR_SSL_DECODE_ERROR;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001306 }
1307
XiaokangQian4080a7f2022-04-11 09:55:18 +00001308 ssl->session_negotiate->id_len = legacy_session_id_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001309 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, session id",
1310 p, legacy_session_id_len);
XiaokangQianb67384d2022-04-19 00:02:38 +00001311 /*
1312 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001313 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001314 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001315 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, legacy_session_id_len + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316
Gilles Peskine449bd832023-01-11 14:50:10 +01001317 memcpy(&ssl->session_negotiate->id[0], p, legacy_session_id_len);
XiaokangQian4080a7f2022-04-11 09:55:18 +00001318 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319
Gilles Peskine449bd832023-01-11 14:50:10 +01001320 cipher_suites_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001321 p += 2;
1322
XiaokangQianb67384d2022-04-19 00:02:38 +00001323 /* Check we have enough data for the ciphersuite list, the legacy
1324 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001325 *
1326 * cipher_suites cipher_suites_len bytes
1327 * legacy_compression_methods 2 bytes
1328 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001329 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001330 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, cipher_suites_len + 2 + 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001331
Gilles Peskine449bd832023-01-11 14:50:10 +01001332 /* ...
1333 * CipherSuite cipher_suites<2..2^16-2>;
1334 * ...
1335 * with CipherSuite defined as:
1336 * uint8 CipherSuite[2];
1337 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001338#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001339 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001340#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001341 cipher_suites_end = p + cipher_suites_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01001342 MBEDTLS_SSL_DEBUG_BUF(3, "client hello, ciphersuitelist",
1343 p, cipher_suites_len);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001344
1345 /*
1346 * Search for a matching ciphersuite
1347 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001348 for (; p < cipher_suites_end; p += 2) {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001349 uint16_t cipher_suite;
Gilles Peskine449bd832023-01-11 14:50:10 +01001350 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001351
Gilles Peskine449bd832023-01-11 14:50:10 +01001352 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, cipher_suites_end, 2);
Jerry Yu5725f1c2022-08-21 17:27:16 +08001353
Gilles Peskine449bd832023-01-11 14:50:10 +01001354 cipher_suite = MBEDTLS_GET_UINT16_BE(p, 0);
Jerry Yuc5a23a02022-08-25 10:51:44 +08001355 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Gilles Peskine449bd832023-01-11 14:50:10 +01001356 ssl, cipher_suite);
1357 if (ciphersuite_info == NULL) {
Jerry Yu5725f1c2022-08-21 17:27:16 +08001358 continue;
Gilles Peskine449bd832023-01-11 14:50:10 +01001359 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001360
Jerry Yu5725f1c2022-08-21 17:27:16 +08001361 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001362 handshake->ciphersuite_info = ciphersuite_info;
Gilles Peskine449bd832023-01-11 14:50:10 +01001363 MBEDTLS_SSL_DEBUG_MSG(2, ("selected ciphersuite: %04x - %s",
1364 cipher_suite,
1365 ciphersuite_info->name));
XiaokangQian17f974c2022-04-19 09:57:41 +00001366 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001367
Gilles Peskine449bd832023-01-11 14:50:10 +01001368 if (handshake->ciphersuite_info == NULL) {
1369 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1370 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
1371 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001372 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001373
XiaokangQian4080a7f2022-04-11 09:55:18 +00001374 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001375 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001376 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001377 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001378 if (p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL) {
1379 MBEDTLS_SSL_DEBUG_MSG(1, ("bad legacy compression method"));
1380 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1381 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1382 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001383 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001384 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001385
Jerry Yuc1be19f2022-04-23 16:11:39 +08001386 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001387 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001388 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001389 * with Extension defined as:
1390 * struct {
1391 * ExtensionType extension_type;
1392 * opaque extension_data<0..2^16-1>;
1393 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001394 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001395 extensions_len = MBEDTLS_GET_UINT16_BE(p, 0);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001396 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01001397 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, end, extensions_len);
XiaokangQiane8ff3502022-04-22 02:34:40 +00001398 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001399
Gilles Peskine449bd832023-01-11 14:50:10 +01001400 MBEDTLS_SSL_DEBUG_BUF(3, "client hello extensions", p, extensions_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001401
Jerry Yu63a459c2022-10-31 13:38:40 +08001402 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001403
Gilles Peskine449bd832023-01-11 14:50:10 +01001404 while (p < extensions_end) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00001405 unsigned int extension_type;
1406 size_t extension_data_len;
1407 const unsigned char *extension_data_end;
1408
Jerry Yu0c354a22022-08-29 15:25:36 +08001409 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001410 *
1411 * The "pre_shared_key" extension MUST be the last extension in the
1412 * ClientHello (this facilitates implementation as described below).
1413 * Servers MUST check that it is the last extension and otherwise fail
1414 * the handshake with an "illegal_parameter" alert.
1415 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001416 if (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY)) {
Jerry Yu1c9247c2022-07-21 12:37:39 +08001417 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01001418 3, ("pre_shared_key is not last extension."));
Jerry Yu1c9247c2022-07-21 12:37:39 +08001419 MBEDTLS_SSL_PEND_FATAL_ALERT(
1420 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001421 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1422 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001423 }
1424
Gilles Peskine449bd832023-01-11 14:50:10 +01001425 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, 4);
1426 extension_type = MBEDTLS_GET_UINT16_BE(p, 0);
1427 extension_data_len = MBEDTLS_GET_UINT16_BE(p, 2);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001428 p += 4;
1429
Gilles Peskine449bd832023-01-11 14:50:10 +01001430 MBEDTLS_SSL_CHK_BUF_READ_PTR(p, extensions_end, extension_data_len);
XiaokangQian7807f9f2022-02-15 10:04:37 +00001431 extension_data_end = p + extension_data_len;
1432
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001433 ret = mbedtls_ssl_tls13_check_received_extension(
Gilles Peskine449bd832023-01-11 14:50:10 +01001434 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1435 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH);
1436 if (ret != 0) {
1437 return ret;
1438 }
Jerry Yue18dc7e2022-08-04 16:29:22 +08001439
Gilles Peskine449bd832023-01-11 14:50:10 +01001440 switch (extension_type) {
XiaokangQian40a35232022-05-07 09:02:40 +00001441#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1442 case MBEDTLS_TLS_EXT_SERVERNAME:
Gilles Peskine449bd832023-01-11 14:50:10 +01001443 MBEDTLS_SSL_DEBUG_MSG(3, ("found ServerName extension"));
1444 ret = mbedtls_ssl_parse_server_name_ext(ssl, p,
1445 extension_data_end);
1446 if (ret != 0) {
XiaokangQian40a35232022-05-07 09:02:40 +00001447 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001448 1, "mbedtls_ssl_parse_servername_ext", ret);
1449 return ret;
XiaokangQian40a35232022-05-07 09:02:40 +00001450 }
XiaokangQian40a35232022-05-07 09:02:40 +00001451 break;
1452#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1453
XiaokangQianb67384d2022-04-19 00:02:38 +00001454#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001455 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001456 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported group extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001457
1458 /* Supported Groups Extension
1459 *
1460 * When sent by the client, the "supported_groups" extension
1461 * indicates the named groups which the client supports,
1462 * ordered from most preferred to least preferred.
1463 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001464 ret = ssl_tls13_parse_supported_groups_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001465 ssl, p, extension_data_end);
1466 if (ret != 0) {
1467 MBEDTLS_SSL_DEBUG_RET(1,
1468 "mbedtls_ssl_parse_supported_groups_ext", ret);
1469 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001470 }
1471
XiaokangQian7807f9f2022-02-15 10:04:37 +00001472 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001473#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474
XiaokangQian88408882022-04-02 10:15:03 +00001475#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001476 case MBEDTLS_TLS_EXT_KEY_SHARE:
Gilles Peskine449bd832023-01-11 14:50:10 +01001477 MBEDTLS_SSL_DEBUG_MSG(3, ("found key share extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001478
1479 /*
1480 * Key Share Extension
1481 *
1482 * When sent by the client, the "key_share" extension
1483 * contains the endpoint's cryptographic parameters for
1484 * ECDHE/DHE key establishment methods.
1485 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001486 ret = ssl_tls13_parse_key_shares_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001487 ssl, p, extension_data_end);
1488 if (ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH) {
1489 MBEDTLS_SSL_DEBUG_MSG(2, ("HRR needed "));
Jerry Yu49ca9282022-05-05 11:05:22 +08001490 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001491 }
1492
Gilles Peskine449bd832023-01-11 14:50:10 +01001493 if (ret < 0) {
Jerry Yu582dd062022-04-22 21:59:01 +08001494 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001495 1, "ssl_tls13_parse_key_shares_ext", ret);
1496 return ret;
Jerry Yu582dd062022-04-22 21:59:01 +08001497 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001498
XiaokangQian7807f9f2022-02-15 10:04:37 +00001499 break;
XiaokangQian88408882022-04-02 10:15:03 +00001500#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001501
1502 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01001503 MBEDTLS_SSL_DEBUG_MSG(3, ("found supported versions extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001504
1505 ret = ssl_tls13_parse_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001506 ssl, p, extension_data_end);
1507 if (ret != 0) {
1508 MBEDTLS_SSL_DEBUG_RET(1,
1509 ("ssl_tls13_parse_supported_versions_ext"), ret);
1510 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001511 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001512 break;
1513
Ronald Cron41a443a2022-10-04 16:38:25 +02001514#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001515 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
Gilles Peskine449bd832023-01-11 14:50:10 +01001516 MBEDTLS_SSL_DEBUG_MSG(3, ("found psk key exchange modes extension"));
Jerry Yue19e3b92022-07-08 12:04:51 +00001517
1518 ret = ssl_tls13_parse_key_exchange_modes_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001519 ssl, p, extension_data_end);
1520 if (ret != 0) {
Jerry Yue19e3b92022-07-08 12:04:51 +00001521 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001522 1, "ssl_tls13_parse_key_exchange_modes_ext", ret);
1523 return ret;
Jerry Yue19e3b92022-07-08 12:04:51 +00001524 }
1525
Jerry Yue19e3b92022-07-08 12:04:51 +00001526 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001527#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001528
Jerry Yu1c105562022-07-10 06:32:38 +00001529 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
Gilles Peskine449bd832023-01-11 14:50:10 +01001530 MBEDTLS_SSL_DEBUG_MSG(3, ("found pre_shared_key extension"));
1531 if ((handshake->received_extensions &
1532 MBEDTLS_SSL_EXT_MASK(PSK_KEY_EXCHANGE_MODES)) == 0) {
Jerry Yu13ab81d2022-07-22 23:17:11 +08001533 MBEDTLS_SSL_PEND_FATAL_ALERT(
1534 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Gilles Peskine449bd832023-01-11 14:50:10 +01001535 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1536 return MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
Jerry Yu13ab81d2022-07-22 23:17:11 +08001537 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001538#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001539 /* Delay processing of the PSK identity once we have
1540 * found out which algorithms to use. We keep a pointer
1541 * to the buffer and the size for later processing.
1542 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001543 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001544 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001545#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001546 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001547
XiaokangQianacb39922022-06-17 10:18:48 +00001548#if defined(MBEDTLS_SSL_ALPN)
1549 case MBEDTLS_TLS_EXT_ALPN:
Gilles Peskine449bd832023-01-11 14:50:10 +01001550 MBEDTLS_SSL_DEBUG_MSG(3, ("found alpn extension"));
XiaokangQianacb39922022-06-17 10:18:48 +00001551
Gilles Peskine449bd832023-01-11 14:50:10 +01001552 ret = mbedtls_ssl_parse_alpn_ext(ssl, p, extension_data_end);
1553 if (ret != 0) {
XiaokangQianacb39922022-06-17 10:18:48 +00001554 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001555 1, ("mbedtls_ssl_parse_alpn_ext"), ret);
1556 return ret;
XiaokangQianacb39922022-06-17 10:18:48 +00001557 }
XiaokangQianacb39922022-06-17 10:18:48 +00001558 break;
1559#endif /* MBEDTLS_SSL_ALPN */
1560
Ronald Cron928cbd32022-10-04 16:14:26 +02001561#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001562 case MBEDTLS_TLS_EXT_SIG_ALG:
Gilles Peskine449bd832023-01-11 14:50:10 +01001563 MBEDTLS_SSL_DEBUG_MSG(3, ("found signature_algorithms extension"));
XiaokangQian7807f9f2022-02-15 10:04:37 +00001564
Gabor Mezei078e8032022-04-27 21:17:56 +02001565 ret = mbedtls_ssl_parse_sig_alg_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001566 ssl, p, extension_data_end);
1567 if (ret != 0) {
1568 MBEDTLS_SSL_DEBUG_MSG(1,
1569 (
1570 "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1571 ret));
1572 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001573 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001574 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001575#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001576
1577 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001578 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001579 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Gilles Peskine449bd832023-01-11 14:50:10 +01001580 extension_type, "( ignored )");
Jerry Yu0c354a22022-08-29 15:25:36 +08001581 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001582 }
1583
1584 p += extension_data_len;
1585 }
1586
Gilles Peskine449bd832023-01-11 14:50:10 +01001587 MBEDTLS_SSL_PRINT_EXTS(3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1588 handshake->received_extensions);
Jerry Yue18dc7e2022-08-04 16:29:22 +08001589
Gilles Peskine449bd832023-01-11 14:50:10 +01001590 mbedtls_ssl_add_hs_hdr_to_checksum(ssl,
1591 MBEDTLS_SSL_HS_CLIENT_HELLO,
1592 p - buf);
Jerry Yu032b15ce2022-07-11 06:10:03 +00001593
Ronald Cron41a443a2022-10-04 16:38:25 +02001594#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001595 /* Update checksum with either
1596 * - The entire content of the CH message, if no PSK extension is present
1597 * - The content up to but excluding the PSK extension, if present.
1598 */
Jerry Yu1c105562022-07-10 06:32:38 +00001599 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Gilles Peskine449bd832023-01-11 14:50:10 +01001600 if (mbedtls_ssl_tls13_some_psk_enabled(ssl) &&
1601 mbedtls_ssl_conf_tls13_some_psk_enabled(ssl) &&
1602 (handshake->received_extensions & MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY))) {
1603 handshake->update_checksum(ssl, buf,
1604 pre_shared_key_ext - buf);
1605 ret = ssl_tls13_parse_pre_shared_key_ext(ssl,
1606 pre_shared_key_ext,
1607 pre_shared_key_ext_end,
1608 cipher_suites,
1609 cipher_suites_end);
1610 if (ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY) {
1611 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK(PRE_SHARED_KEY);
1612 } else if (ret != 0) {
Jerry Yu63a459c2022-10-31 13:38:40 +08001613 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01001614 1, "ssl_tls13_parse_pre_shared_key_ext", ret);
1615 return ret;
Jerry Yu1c105562022-07-10 06:32:38 +00001616 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001617 } else
Ronald Cron41a443a2022-10-04 16:38:25 +02001618#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001619 {
Gilles Peskine449bd832023-01-11 14:50:10 +01001620 handshake->update_checksum(ssl, buf, p - buf);
Jerry Yu1c105562022-07-10 06:32:38 +00001621 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001622
Gilles Peskine449bd832023-01-11 14:50:10 +01001623 ret = ssl_tls13_determine_key_exchange_mode(ssl);
1624 if (ret < 0) {
1625 return ret;
1626 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001627
Gilles Peskine449bd832023-01-11 14:50:10 +01001628 mbedtls_ssl_optimize_checksum(ssl, handshake->ciphersuite_info);
Jerry Yue5834fd2022-08-29 20:16:09 +08001629
Gilles Peskine449bd832023-01-11 14:50:10 +01001630 return hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK;
XiaokangQian75fe8c72022-06-15 09:42:45 +00001631}
1632
1633/* Update the handshake state machine */
1634
Ronald Cronce7d76e2022-07-08 18:56:49 +02001635MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001636static int ssl_tls13_postprocess_client_hello(mbedtls_ssl_context *ssl)
XiaokangQian75fe8c72022-06-15 09:42:45 +00001637{
1638 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1639
XiaokangQian7807f9f2022-02-15 10:04:37 +00001640 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001641 * Server certificate selection
1642 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001643 if (ssl->conf->f_cert_cb && (ret = ssl->conf->f_cert_cb(ssl)) != 0) {
1644 MBEDTLS_SSL_DEBUG_RET(1, "f_cert_cb", ret);
1645 return ret;
XiaokangQianfb665a82022-06-15 03:57:21 +00001646 }
1647#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1648 ssl->handshake->sni_name = NULL;
1649 ssl->handshake->sni_name_len = 0;
1650#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001651
Gilles Peskine449bd832023-01-11 14:50:10 +01001652 ret = mbedtls_ssl_tls13_key_schedule_stage_early(ssl);
1653 if (ret != 0) {
1654 MBEDTLS_SSL_DEBUG_RET(1,
1655 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret);
1656 return ret;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001657 }
1658
Gilles Peskine449bd832023-01-11 14:50:10 +01001659 return 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001660
1661}
1662
1663/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001664 * Main entry point from the state machine; orchestrates the otherfunctions.
1665 */
1666
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001667MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001668static int ssl_tls13_process_client_hello(mbedtls_ssl_context *ssl)
XiaokangQianed582dd2022-04-13 08:21:05 +00001669{
1670
XiaokangQian08037552022-04-20 07:16:41 +00001671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01001672 unsigned char *buf = NULL;
XiaokangQianed582dd2022-04-13 08:21:05 +00001673 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001674 int parse_client_hello_ret;
1675
Gilles Peskine449bd832023-01-11 14:50:10 +01001676 MBEDTLS_SSL_DEBUG_MSG(2, ("=> parse client hello"));
XiaokangQianed582dd2022-04-13 08:21:05 +00001677
Gilles Peskine449bd832023-01-11 14:50:10 +01001678 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_tls13_fetch_handshake_msg(
1679 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1680 &buf, &buflen));
XiaokangQianed582dd2022-04-13 08:21:05 +00001681
Gilles Peskine449bd832023-01-11 14:50:10 +01001682 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_parse_client_hello(ssl, buf,
1683 buf + buflen));
Jerry Yuf41553b2022-05-09 22:20:30 +08001684 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1685 * only SSL_CLIENT_HELLO_OK or
1686 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1687 * stage as negative error codes are handled
1688 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001689
Gilles Peskine449bd832023-01-11 14:50:10 +01001690 MBEDTLS_SSL_PROC_CHK(ssl_tls13_postprocess_client_hello(ssl));
Jerry Yu582dd062022-04-22 21:59:01 +08001691
Gilles Peskine449bd832023-01-11 14:50:10 +01001692 if (parse_client_hello_ret == SSL_CLIENT_HELLO_OK) {
1693 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_HELLO);
1694 } else {
1695 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST);
1696 }
XiaokangQianed582dd2022-04-13 08:21:05 +00001697
1698cleanup:
1699
Gilles Peskine449bd832023-01-11 14:50:10 +01001700 MBEDTLS_SSL_DEBUG_MSG(2, ("<= parse client hello"));
1701 return ret;
XiaokangQianed582dd2022-04-13 08:21:05 +00001702}
1703
1704/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001705 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001706 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001707MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001708static int ssl_tls13_prepare_server_hello(mbedtls_ssl_context *ssl)
Jerry Yuf4b27e42022-03-30 17:32:21 +08001709{
Jerry Yu637a3f12022-04-20 21:37:58 +08001710 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1711 unsigned char *server_randbytes =
Gilles Peskine449bd832023-01-11 14:50:10 +01001712 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
1713 if (ssl->conf->f_rng == NULL) {
1714 MBEDTLS_SSL_DEBUG_MSG(1, ("no RNG provided"));
1715 return MBEDTLS_ERR_SSL_NO_RNG;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001716 }
1717
Gilles Peskine449bd832023-01-11 14:50:10 +01001718 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng, server_randbytes,
1719 MBEDTLS_SERVER_HELLO_RANDOM_LEN)) != 0) {
1720 MBEDTLS_SSL_DEBUG_RET(1, "f_rng", ret);
1721 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001722 }
1723
Gilles Peskine449bd832023-01-11 14:50:10 +01001724 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes", server_randbytes,
1725 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001726
1727#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01001728 ssl->session_negotiate->start = time(NULL);
Jerry Yuf4b27e42022-03-30 17:32:21 +08001729#endif /* MBEDTLS_HAVE_TIME */
1730
Gilles Peskine449bd832023-01-11 14:50:10 +01001731 return ret;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001732}
1733
Jerry Yu3bf2c642022-03-30 22:02:12 +08001734/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001735 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001736 *
1737 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001738 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001739 * } SupportedVersions;
1740 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001741MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001742static int ssl_tls13_write_server_hello_supported_versions_ext(
Gilles Peskine449bd832023-01-11 14:50:10 +01001743 mbedtls_ssl_context *ssl,
1744 unsigned char *buf,
1745 unsigned char *end,
1746 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001747{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001748 *out_len = 0;
1749
Gilles Peskine449bd832023-01-11 14:50:10 +01001750 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, write selected version"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001751
1752 /* Check if we have space to write the extension:
1753 * - extension_type (2 bytes)
1754 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001755 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001756 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001757 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001758
Gilles Peskine449bd832023-01-11 14:50:10 +01001759 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001760
Gilles Peskine449bd832023-01-11 14:50:10 +01001761 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001762
Gilles Peskine449bd832023-01-11 14:50:10 +01001763 mbedtls_ssl_write_version(buf + 4,
1764 ssl->conf->transport,
1765 ssl->tls_version);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001766
Gilles Peskine449bd832023-01-11 14:50:10 +01001767 MBEDTLS_SSL_DEBUG_MSG(3, ("supported version: [%04x]",
1768 ssl->tls_version));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001769
Jerry Yu349a6132022-04-14 20:52:56 +08001770 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001771
Jerry Yub95dd362022-11-08 21:19:34 +08001772 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
Gilles Peskine449bd832023-01-11 14:50:10 +01001773 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS);
Jerry Yub95dd362022-11-08 21:19:34 +08001774
Gilles Peskine449bd832023-01-11 14:50:10 +01001775 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001776}
1777
Jerry Yud9436a12022-04-20 22:28:09 +08001778
Jerry Yu3bf2c642022-03-30 22:02:12 +08001779
1780/* Generate and export a single key share. For hybrid KEMs, this can
1781 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001782MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001783static int ssl_tls13_generate_and_write_key_share(mbedtls_ssl_context *ssl,
1784 uint16_t named_group,
1785 unsigned char *buf,
1786 unsigned char *end,
1787 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001788{
1789 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001790
1791 *out_len = 0;
1792
Jerry Yu89e103c2022-03-30 22:43:29 +08001793#if defined(MBEDTLS_ECDH_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01001794 if (mbedtls_ssl_tls13_named_group_is_ecdhe(named_group)) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001795 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
Gilles Peskine449bd832023-01-11 14:50:10 +01001796 ssl, named_group, buf, end, out_len);
1797 if (ret != 0) {
Jerry Yu89e103c2022-03-30 22:43:29 +08001798 MBEDTLS_SSL_DEBUG_RET(
1799 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
Gilles Peskine449bd832023-01-11 14:50:10 +01001800 ret);
1801 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001802 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001803 } else
Jerry Yu89e103c2022-03-30 22:43:29 +08001804#endif /* MBEDTLS_ECDH_C */
Gilles Peskine449bd832023-01-11 14:50:10 +01001805 if (0 /* Other kinds of KEMs */) {
1806 } else {
Jerry Yu955ddd72022-04-22 22:27:33 +08001807 ((void) ssl);
1808 ((void) named_group);
1809 ((void) buf);
1810 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001811 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1812 }
1813
Gilles Peskine449bd832023-01-11 14:50:10 +01001814 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001815}
1816
1817/*
1818 * ssl_tls13_write_key_share_ext
1819 *
1820 * Structure of key_share extension in ServerHello:
1821 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001822 * struct {
1823 * NamedGroup group;
1824 * opaque key_exchange<1..2^16-1>;
1825 * } KeyShareEntry;
1826 * struct {
1827 * KeyShareEntry server_share;
1828 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001829 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001830MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001831static int ssl_tls13_write_key_share_ext(mbedtls_ssl_context *ssl,
1832 unsigned char *buf,
1833 unsigned char *end,
1834 size_t *out_len)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001835{
Jerry Yu955ddd72022-04-22 22:27:33 +08001836 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001837 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001838 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001840 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001841
1842 *out_len = 0;
1843
Gilles Peskine449bd832023-01-11 14:50:10 +01001844 MBEDTLS_SSL_DEBUG_MSG(3, ("server hello, adding key share extension"));
Jerry Yu3bf2c642022-03-30 22:02:12 +08001845
Gilles Peskine449bd832023-01-11 14:50:10 +01001846 MBEDTLS_SSL_DEBUG_MSG(2, ("server hello, write selected_group: %s (%04x)",
1847 mbedtls_ssl_named_group_to_str(group),
1848 group));
Jerry Yu58af2332022-09-06 11:19:31 +08001849
Jerry Yu3bf2c642022-03-30 22:02:12 +08001850 /* Check if we have space for header and length fields:
1851 * - extension_type (2 bytes)
1852 * - extension_data_length (2 bytes)
1853 * - group (2 bytes)
1854 * - key_exchange_length (2 bytes)
1855 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001856 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 8);
1857 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, p, 0);
1858 MBEDTLS_PUT_UINT16_BE(group, server_share, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001859 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001860
Jerry Yu3bf2c642022-03-30 22:02:12 +08001861 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1862 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001863 ret = ssl_tls13_generate_and_write_key_share(
Gilles Peskine449bd832023-01-11 14:50:10 +01001864 ssl, group, server_share + 4, end, &key_exchange_length);
1865 if (ret != 0) {
1866 return ret;
1867 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001868 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001869
Gilles Peskine449bd832023-01-11 14:50:10 +01001870 MBEDTLS_PUT_UINT16_BE(key_exchange_length, server_share + 2, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001871
Gilles Peskine449bd832023-01-11 14:50:10 +01001872 MBEDTLS_PUT_UINT16_BE(p - server_share, buf, 2);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001873
Jerry Yu57d48412022-04-20 21:50:42 +08001874 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001875
Gilles Peskine449bd832023-01-11 14:50:10 +01001876 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001877
Gilles Peskine449bd832023-01-11 14:50:10 +01001878 return 0;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001879}
Jerry Yud9436a12022-04-20 22:28:09 +08001880
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001881MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001882static int ssl_tls13_write_hrr_key_share_ext(mbedtls_ssl_context *ssl,
1883 unsigned char *buf,
1884 unsigned char *end,
1885 size_t *out_len)
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001886{
1887 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1888 /* key_share Extension
1889 *
1890 * struct {
1891 * select (Handshake.msg_type) {
1892 * ...
1893 * case hello_retry_request:
1894 * NamedGroup selected_group;
1895 * ...
1896 * };
1897 * } KeyShare;
1898 */
1899
1900 *out_len = 0;
1901
Jerry Yub0ac10b2022-05-05 11:10:08 +08001902 /*
1903 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1904 * of the HRR is then to transmit a cookie to force the client to demonstrate
1905 * reachability at their apparent network address (primarily useful for DTLS).
1906 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001907 if (!mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
1908 return 0;
1909 }
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001910
1911 /* We should only send the key_share extension if the client's initial
1912 * key share was not acceptable. */
Gilles Peskine449bd832023-01-11 14:50:10 +01001913 if (ssl->handshake->offered_group_id != 0) {
1914 MBEDTLS_SSL_DEBUG_MSG(4, ("Skip key_share extension in HRR"));
1915 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001916 }
1917
Gilles Peskine449bd832023-01-11 14:50:10 +01001918 if (selected_group == 0) {
1919 MBEDTLS_SSL_DEBUG_MSG(1, ("no matching named group found"));
1920 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001921 }
1922
Jerry Yub0ac10b2022-05-05 11:10:08 +08001923 /* Check if we have enough space:
1924 * - extension_type (2 bytes)
1925 * - extension_data_length (2 bytes)
1926 * - selected_group (2 bytes)
1927 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001928 MBEDTLS_SSL_CHK_BUF_PTR(buf, end, 6);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001929
Gilles Peskine449bd832023-01-11 14:50:10 +01001930 MBEDTLS_PUT_UINT16_BE(MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0);
1931 MBEDTLS_PUT_UINT16_BE(2, buf, 2);
1932 MBEDTLS_PUT_UINT16_BE(selected_group, buf, 4);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001933
Gilles Peskine449bd832023-01-11 14:50:10 +01001934 MBEDTLS_SSL_DEBUG_MSG(3,
1935 ("HRR selected_group: %s (%x)",
1936 mbedtls_ssl_named_group_to_str(selected_group),
1937 selected_group));
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001938
1939 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001940
Gilles Peskine449bd832023-01-11 14:50:10 +01001941 mbedtls_ssl_tls13_set_hs_sent_ext_mask(ssl, MBEDTLS_TLS_EXT_KEY_SHARE);
Jerry Yub95dd362022-11-08 21:19:34 +08001942
Gilles Peskine449bd832023-01-11 14:50:10 +01001943 return 0;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001944}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001945
1946/*
1947 * Structure of ServerHello message:
1948 *
1949 * struct {
1950 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1951 * Random random;
1952 * opaque legacy_session_id_echo<0..32>;
1953 * CipherSuite cipher_suite;
1954 * uint8 legacy_compression_method = 0;
1955 * Extension extensions<6..2^16-1>;
1956 * } ServerHello;
1957 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001958MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01001959static int ssl_tls13_write_server_hello_body(mbedtls_ssl_context *ssl,
1960 unsigned char *buf,
1961 unsigned char *end,
1962 size_t *out_len,
1963 int is_hrr)
Jerry Yu56404d72022-03-30 17:36:13 +08001964{
Jerry Yu955ddd72022-04-22 22:27:33 +08001965 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001966 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001967 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001968 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969
1970 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08001971 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001972
Jerry Yucfc04b32022-04-21 09:31:58 +08001973 /* ...
1974 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1975 * ...
1976 * with ProtocolVersion defined as:
1977 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001978 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001979 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
1980 MBEDTLS_PUT_UINT16_BE(0x0303, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001981 p += 2;
1982
Jerry Yu1c3e6882022-04-20 21:23:40 +08001983 /* ...
1984 * Random random;
1985 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001986 * with Random defined as:
1987 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001988 */
Gilles Peskine449bd832023-01-11 14:50:10 +01001989 MBEDTLS_SSL_CHK_BUF_PTR(p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1990 if (is_hrr) {
1991 memcpy(p, mbedtls_ssl_tls13_hello_retry_request_magic,
1992 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
1993 } else {
1994 memcpy(p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
1995 MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001996 }
Gilles Peskine449bd832023-01-11 14:50:10 +01001997 MBEDTLS_SSL_DEBUG_BUF(3, "server hello, random bytes",
1998 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001999 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2000
Jerry Yucfc04b32022-04-21 09:31:58 +08002001 /* ...
2002 * opaque legacy_session_id_echo<0..32>;
2003 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002004 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002005 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1 + ssl->session_negotiate->id_len);
2006 *p++ = (unsigned char) ssl->session_negotiate->id_len;
2007 if (ssl->session_negotiate->id_len > 0) {
2008 memcpy(p, &ssl->session_negotiate->id[0],
2009 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002010 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002011
Gilles Peskine449bd832023-01-11 14:50:10 +01002012 MBEDTLS_SSL_DEBUG_BUF(3, "session id", ssl->session_negotiate->id,
2013 ssl->session_negotiate->id_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014 }
2015
Jerry Yucfc04b32022-04-21 09:31:58 +08002016 /* ...
2017 * CipherSuite cipher_suite;
2018 * ...
2019 * with CipherSuite defined as:
2020 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002021 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002022 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2023 MBEDTLS_PUT_UINT16_BE(ssl->session_negotiate->ciphersuite, p, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002024 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002025 MBEDTLS_SSL_DEBUG_MSG(3,
2026 ("server hello, chosen ciphersuite: %s ( id=%d )",
2027 mbedtls_ssl_get_ciphersuite_name(
2028 ssl->session_negotiate->ciphersuite),
2029 ssl->session_negotiate->ciphersuite));
Jerry Yu3bf2c642022-03-30 22:02:12 +08002030
Jerry Yucfc04b32022-04-21 09:31:58 +08002031 /* ...
2032 * uint8 legacy_compression_method = 0;
2033 * ...
2034 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002035 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 1);
Thomas Daubney31e03a82022-07-25 15:59:25 +01002036 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002037
Jerry Yucfc04b32022-04-21 09:31:58 +08002038 /* ...
2039 * Extension extensions<6..2^16-1>;
2040 * ...
2041 * struct {
2042 * ExtensionType extension_type; (2 bytes)
2043 * opaque extension_data<0..2^16-1>;
2044 * } Extension;
2045 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002046 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yud9436a12022-04-20 22:28:09 +08002047 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002048 p += 2;
2049
Gilles Peskine449bd832023-01-11 14:50:10 +01002050 if ((ret = ssl_tls13_write_server_hello_supported_versions_ext(
2051 ssl, p, end, &output_len)) != 0) {
Jerry Yu955ddd72022-04-22 22:27:33 +08002052 MBEDTLS_SSL_DEBUG_RET(
Gilles Peskine449bd832023-01-11 14:50:10 +01002053 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret);
2054 return ret;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002055 }
2056 p += output_len;
2057
Gilles Peskine449bd832023-01-11 14:50:10 +01002058 if (mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral(ssl)) {
2059 if (is_hrr) {
2060 ret = ssl_tls13_write_hrr_key_share_ext(ssl, p, end, &output_len);
2061 } else {
2062 ret = ssl_tls13_write_key_share_ext(ssl, p, end, &output_len);
2063 }
2064 if (ret != 0) {
2065 return ret;
2066 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 p += output_len;
2068 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002069
Ronald Cron41a443a2022-10-04 16:38:25 +02002070#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002071 if (!is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2072 ret = ssl_tls13_write_server_pre_shared_key_ext(ssl, p, end, &output_len);
2073 if (ret != 0) {
2074 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_server_pre_shared_key_ext",
2075 ret);
2076 return ret;
Jerry Yu032b15ce2022-07-11 06:10:03 +00002077 }
2078 p += output_len;
2079 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002080#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002081
Gilles Peskine449bd832023-01-11 14:50:10 +01002082 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083
Gilles Peskine449bd832023-01-11 14:50:10 +01002084 MBEDTLS_SSL_DEBUG_BUF(4, "server hello extensions",
2085 p_extensions_len, p - p_extensions_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002086
Jerry Yud9436a12022-04-20 22:28:09 +08002087 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002088
Gilles Peskine449bd832023-01-11 14:50:10 +01002089 MBEDTLS_SSL_DEBUG_BUF(3, "server hello", buf, *out_len);
Jerry Yu3bf2c642022-03-30 22:02:12 +08002090
Jerry Yu7de2ff02022-11-08 21:43:46 +08002091 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002092 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Gilles Peskine449bd832023-01-11 14:50:10 +01002093 MBEDTLS_SSL_HS_SERVER_HELLO,
2094 ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002095
Gilles Peskine449bd832023-01-11 14:50:10 +01002096 return ret;
Jerry Yu56404d72022-03-30 17:36:13 +08002097}
2098
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002099MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002100static int ssl_tls13_finalize_write_server_hello(mbedtls_ssl_context *ssl)
Jerry Yue110d252022-05-05 10:19:22 +08002101{
2102 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002103 ret = mbedtls_ssl_tls13_compute_handshake_transform(ssl);
2104 if (ret != 0) {
2105 MBEDTLS_SSL_DEBUG_RET(1,
2106 "mbedtls_ssl_tls13_compute_handshake_transform",
2107 ret);
2108 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002109 }
2110
Gilles Peskine449bd832023-01-11 14:50:10 +01002111 return ret;
Jerry Yue110d252022-05-05 10:19:22 +08002112}
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(mbedtls_ssl_context *ssl)
Jerry Yu5b64ae92022-03-30 17:15:02 +08002116{
Jerry Yu637a3f12022-04-20 21:37:58 +08002117 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002118 unsigned char *buf;
2119 size_t buf_len, msg_len;
2120
Gilles Peskine449bd832023-01-11 14:50:10 +01002121 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write server hello"));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002122
Gilles Peskine449bd832023-01-11 14:50:10 +01002123 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_server_hello(ssl));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002124
Gilles Peskine449bd832023-01-11 14:50:10 +01002125 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2126 MBEDTLS_SSL_HS_SERVER_HELLO, &buf,
2127 &buf_len));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002128
Gilles Peskine449bd832023-01-11 14:50:10 +01002129 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2130 buf + buf_len,
2131 &msg_len,
2132 0));
Jerry Yuf4b27e42022-03-30 17:32:21 +08002133
Jerry Yu3bf2c642022-03-30 22:02:12 +08002134 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002135 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yuf4b27e42022-03-30 17:32:21 +08002136
Gilles Peskine449bd832023-01-11 14:50:10 +01002137 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2138 ssl, buf_len, msg_len));
Jerry Yu637a3f12022-04-20 21:37:58 +08002139
Gilles Peskine449bd832023-01-11 14:50:10 +01002140 MBEDTLS_SSL_PROC_CHK(ssl_tls13_finalize_write_server_hello(ssl));
Jerry Yue110d252022-05-05 10:19:22 +08002141
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002142#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2143 /* The server sends a dummy change_cipher_spec record immediately
2144 * after its first handshake message. This may either be after
2145 * a ServerHello or a HelloRetryRequest.
2146 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002147 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002148 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002149#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002150 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002151#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002152
Jerry Yuf4b27e42022-03-30 17:32:21 +08002153cleanup:
2154
Gilles Peskine449bd832023-01-11 14:50:10 +01002155 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write server hello"));
2156 return ret;
Jerry Yu5b64ae92022-03-30 17:15:02 +08002157}
2158
Jerry Yu23d1a252022-05-12 18:08:59 +08002159
2160/*
2161 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2162 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002163MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002164static int ssl_tls13_prepare_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002165{
2166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Gilles Peskine449bd832023-01-11 14:50:10 +01002167 if (ssl->handshake->hello_retry_request_count > 0) {
2168 MBEDTLS_SSL_DEBUG_MSG(1, ("Too many HRRs"));
2169 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2170 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2171 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu23d1a252022-05-12 18:08:59 +08002172 }
2173
2174 /*
2175 * Create stateless transcript hash for HRR
2176 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002177 MBEDTLS_SSL_DEBUG_MSG(4, ("Reset transcript for HRR"));
2178 ret = mbedtls_ssl_reset_transcript_for_hrr(ssl);
2179 if (ret != 0) {
2180 MBEDTLS_SSL_DEBUG_RET(1, "mbedtls_ssl_reset_transcript_for_hrr", ret);
2181 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002182 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002183 mbedtls_ssl_session_reset_msg_layer(ssl, 0);
Jerry Yu23d1a252022-05-12 18:08:59 +08002184
Gilles Peskine449bd832023-01-11 14:50:10 +01002185 return 0;
Jerry Yu23d1a252022-05-12 18:08:59 +08002186}
2187
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002188MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002189static int ssl_tls13_write_hello_retry_request(mbedtls_ssl_context *ssl)
Jerry Yu23d1a252022-05-12 18:08:59 +08002190{
2191 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2192 unsigned char *buf;
2193 size_t buf_len, msg_len;
2194
Gilles Peskine449bd832023-01-11 14:50:10 +01002195 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write hello retry request"));
Jerry Yu23d1a252022-05-12 18:08:59 +08002196
Gilles Peskine449bd832023-01-11 14:50:10 +01002197 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_hello_retry_request(ssl));
Jerry Yu23d1a252022-05-12 18:08:59 +08002198
Gilles Peskine449bd832023-01-11 14:50:10 +01002199 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(
2200 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2201 &buf, &buf_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002202
Gilles Peskine449bd832023-01-11 14:50:10 +01002203 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_server_hello_body(ssl, buf,
2204 buf + buf_len,
2205 &msg_len,
2206 1));
Jerry Yu23d1a252022-05-12 18:08:59 +08002207 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002208 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len);
Jerry Yu23d1a252022-05-12 18:08:59 +08002209
2210
Gilles Peskine449bd832023-01-11 14:50:10 +01002211 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(ssl, buf_len,
2212 msg_len));
Jerry Yu23d1a252022-05-12 18:08:59 +08002213
2214 ssl->handshake->hello_retry_request_count++;
2215
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002216#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2217 /* The server sends a dummy change_cipher_spec record immediately
2218 * after its first handshake message. This may either be after
2219 * a ServerHello or a HelloRetryRequest.
2220 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002221 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002222 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002223#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002224 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002225#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002226
2227cleanup:
Gilles Peskine449bd832023-01-11 14:50:10 +01002228 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write hello retry request"));
2229 return ret;
Jerry Yu23d1a252022-05-12 18:08:59 +08002230}
2231
Jerry Yu5b64ae92022-03-30 17:15:02 +08002232/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002233 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2234 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002235
2236/*
2237 * struct {
2238 * Extension extensions<0..2 ^ 16 - 1>;
2239 * } EncryptedExtensions;
2240 *
2241 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002242MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002243static int ssl_tls13_write_encrypted_extensions_body(mbedtls_ssl_context *ssl,
2244 unsigned char *buf,
2245 unsigned char *end,
2246 size_t *out_len)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002247{
XiaokangQianacb39922022-06-17 10:18:48 +00002248 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002249 unsigned char *p = buf;
2250 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002251 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002252 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002253
Jerry Yu4d3841a2022-04-16 12:37:19 +08002254 *out_len = 0;
2255
Gilles Peskine449bd832023-01-11 14:50:10 +01002256 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
Jerry Yu8937eb42022-05-03 12:12:14 +08002257 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002258 p += 2;
2259
Jerry Yu8937eb42022-05-03 12:12:14 +08002260 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002261 ((void) ret);
2262 ((void) output_len);
2263
2264#if defined(MBEDTLS_SSL_ALPN)
Gilles Peskine449bd832023-01-11 14:50:10 +01002265 ret = mbedtls_ssl_write_alpn_ext(ssl, p, end, &output_len);
2266 if (ret != 0) {
2267 return ret;
2268 }
XiaokangQian95d5f542022-06-24 02:29:26 +00002269 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002270#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002271
Gilles Peskine449bd832023-01-11 14:50:10 +01002272 extensions_len = (p - p_extensions_len) - 2;
2273 MBEDTLS_PUT_UINT16_BE(extensions_len, p_extensions_len, 0);
Jerry Yu8937eb42022-05-03 12:12:14 +08002274
2275 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002276
Gilles Peskine449bd832023-01-11 14:50:10 +01002277 MBEDTLS_SSL_DEBUG_BUF(4, "encrypted extensions", buf, *out_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002278
Jerry Yu7de2ff02022-11-08 21:43:46 +08002279 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002280 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002281
Gilles Peskine449bd832023-01-11 14:50:10 +01002282 return 0;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002283}
2284
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002285MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002286static int ssl_tls13_write_encrypted_extensions(mbedtls_ssl_context *ssl)
Jerry Yu4d3841a2022-04-16 12:37:19 +08002287{
2288 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2289 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002290 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002291
Gilles Peskine449bd832023-01-11 14:50:10 +01002292 mbedtls_ssl_set_outbound_transform(ssl,
2293 ssl->handshake->transform_handshake);
Gabor Mezei54719122022-06-28 11:34:56 +02002294 MBEDTLS_SSL_DEBUG_MSG(
Gilles Peskine449bd832023-01-11 14:50:10 +01002295 3, ("switching to handshake transform for outbound data"));
Gabor Mezei54719122022-06-28 11:34:56 +02002296
Gilles Peskine449bd832023-01-11 14:50:10 +01002297 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write encrypted extensions"));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002298
Gilles Peskine449bd832023-01-11 14:50:10 +01002299 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2300 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf,
2301 &buf_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002302
Gilles Peskine449bd832023-01-11 14:50:10 +01002303 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_encrypted_extensions_body(
2304 ssl, buf, buf + buf_len, &msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002305
2306 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002307 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len);
Jerry Yu4d3841a2022-04-16 12:37:19 +08002308
Gilles Peskine449bd832023-01-11 14:50:10 +01002309 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2310 ssl, buf_len, msg_len));
Jerry Yu4d3841a2022-04-16 12:37:19 +08002311
Ronald Cron928cbd32022-10-04 16:14:26 +02002312#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Gilles Peskine449bd832023-01-11 14:50:10 +01002313 if (mbedtls_ssl_tls13_key_exchange_mode_with_psk(ssl)) {
2314 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2315 } else {
2316 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST);
2317 }
Jerry Yu8937eb42022-05-03 12:12:14 +08002318#else
Gilles Peskine449bd832023-01-11 14:50:10 +01002319 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
Jerry Yu8937eb42022-05-03 12:12:14 +08002320#endif
2321
Jerry Yu4d3841a2022-04-16 12:37:19 +08002322cleanup:
2323
Gilles Peskine449bd832023-01-11 14:50:10 +01002324 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write encrypted extensions"));
2325 return ret;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002326}
2327
Ronald Cron928cbd32022-10-04 16:14:26 +02002328#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002329#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2330#define SSL_CERTIFICATE_REQUEST_SKIP 1
2331/* Coordination:
2332 * Check whether a CertificateRequest message should be written.
2333 * Returns a negative code on failure, or
2334 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2335 * - SSL_CERTIFICATE_REQUEST_SKIP
2336 * indicating if the writing of the CertificateRequest
2337 * should be skipped or not.
2338 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002339MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002340static int ssl_tls13_certificate_request_coordinate(mbedtls_ssl_context *ssl)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002341{
2342 int authmode;
2343
XiaokangQian40a35232022-05-07 09:02:40 +00002344#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
Gilles Peskine449bd832023-01-11 14:50:10 +01002345 if (ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET) {
XiaokangQian40a35232022-05-07 09:02:40 +00002346 authmode = ssl->handshake->sni_authmode;
Gilles Peskine449bd832023-01-11 14:50:10 +01002347 } else
XiaokangQian40a35232022-05-07 09:02:40 +00002348#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002349 authmode = ssl->conf->authmode;
2350
Gilles Peskine449bd832023-01-11 14:50:10 +01002351 if (authmode == MBEDTLS_SSL_VERIFY_NONE) {
Ronald Croneac00ad2022-09-13 10:16:31 +02002352 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
Gilles Peskine449bd832023-01-11 14:50:10 +01002353 return SSL_CERTIFICATE_REQUEST_SKIP;
Ronald Croneac00ad2022-09-13 10:16:31 +02002354 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002355
XiaokangQianc3017f62022-05-13 05:55:41 +00002356 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002357
Gilles Peskine449bd832023-01-11 14:50:10 +01002358 return SSL_CERTIFICATE_REQUEST_SEND_REQUEST;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002359}
2360
XiaokangQiancec9ae62022-05-06 07:28:50 +00002361/*
2362 * struct {
2363 * opaque certificate_request_context<0..2^8-1>;
2364 * Extension extensions<2..2^16-1>;
2365 * } CertificateRequest;
2366 *
2367 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002368MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002369static int ssl_tls13_write_certificate_request_body(mbedtls_ssl_context *ssl,
2370 unsigned char *buf,
2371 const unsigned char *end,
2372 size_t *out_len)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002373{
2374 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2375 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002376 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002377 unsigned char *p_extensions_len;
2378
2379 *out_len = 0;
2380
2381 /* Check if we have enough space:
2382 * - certificate_request_context (1 byte)
2383 * - extensions length (2 bytes)
2384 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002385 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 3);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002386
2387 /*
2388 * Write certificate_request_context
2389 */
2390 /*
2391 * We use a zero length context for the normal handshake
2392 * messages. For post-authentication handshake messages
2393 * this request context would be set to a non-zero value.
2394 */
2395 *p++ = 0x0;
2396
2397 /*
2398 * Write extensions
2399 */
2400 /* The extensions must contain the signature_algorithms. */
2401 p_extensions_len = p;
2402 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002403 ret = mbedtls_ssl_write_sig_alg_ext(ssl, p, end, &output_len);
2404 if (ret != 0) {
2405 return ret;
2406 }
XiaokangQiancec9ae62022-05-06 07:28:50 +00002407
XiaokangQianec6efb92022-05-06 09:53:10 +00002408 p += output_len;
Gilles Peskine449bd832023-01-11 14:50:10 +01002409 MBEDTLS_PUT_UINT16_BE(p - p_extensions_len - 2, p_extensions_len, 0);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002410
2411 *out_len = p - buf;
2412
Jerry Yu7de2ff02022-11-08 21:43:46 +08002413 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002414 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002415
Gilles Peskine449bd832023-01-11 14:50:10 +01002416 return 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002417}
2418
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002419MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002420static int ssl_tls13_write_certificate_request(mbedtls_ssl_context *ssl)
XiaokangQiancec9ae62022-05-06 07:28:50 +00002421{
2422 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2423
Gilles Peskine449bd832023-01-11 14:50:10 +01002424 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002425
Gilles Peskine449bd832023-01-11 14:50:10 +01002426 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_certificate_request_coordinate(ssl));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002427
Gilles Peskine449bd832023-01-11 14:50:10 +01002428 if (ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST) {
XiaokangQiancec9ae62022-05-06 07:28:50 +00002429 unsigned char *buf;
2430 size_t buf_len, msg_len;
2431
Gilles Peskine449bd832023-01-11 14:50:10 +01002432 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2433 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2434 &buf, &buf_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002435
Gilles Peskine449bd832023-01-11 14:50:10 +01002436 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_certificate_request_body(
2437 ssl, buf, buf + buf_len, &msg_len));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002438
2439 mbedtls_ssl_add_hs_msg_to_checksum(
Gilles Peskine449bd832023-01-11 14:50:10 +01002440 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002441
Gilles Peskine449bd832023-01-11 14:50:10 +01002442 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2443 ssl, buf_len, msg_len));
2444 } else if (ret == SSL_CERTIFICATE_REQUEST_SKIP) {
2445 MBEDTLS_SSL_DEBUG_MSG(2, ("<= skip write certificate request"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002446 ret = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002447 } else {
2448 MBEDTLS_SSL_DEBUG_MSG(1, ("should never happen"));
XiaokangQiancec9ae62022-05-06 07:28:50 +00002449 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2450 goto cleanup;
2451 }
2452
Gilles Peskine449bd832023-01-11 14:50:10 +01002453 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_CERTIFICATE);
XiaokangQiancec9ae62022-05-06 07:28:50 +00002454cleanup:
2455
Gilles Peskine449bd832023-01-11 14:50:10 +01002456 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write certificate request"));
2457 return ret;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002458}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002459
Jerry Yu4d3841a2022-04-16 12:37:19 +08002460/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002461 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002462 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002463MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002464static int ssl_tls13_write_server_certificate(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002465{
Jerry Yu5a26f302022-05-10 20:46:40 +08002466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002467
2468#if defined(MBEDTLS_X509_CRT_PARSE_C)
Gilles Peskine449bd832023-01-11 14:50:10 +01002469 if ((ssl_tls13_pick_key_cert(ssl) != 0) ||
2470 mbedtls_ssl_own_cert(ssl) == NULL) {
2471 MBEDTLS_SSL_DEBUG_MSG(2, ("No certificate available."));
2472 MBEDTLS_SSL_PEND_FATAL_ALERT(MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2473 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2474 return MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
Jerry Yu5a26f302022-05-10 20:46:40 +08002475 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002476#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002477
Gilles Peskine449bd832023-01-11 14:50:10 +01002478 ret = mbedtls_ssl_tls13_write_certificate(ssl);
2479 if (ret != 0) {
2480 return ret;
2481 }
2482 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY);
2483 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002484}
2485
2486/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002487 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002488 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002489MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002490static int ssl_tls13_write_certificate_verify(mbedtls_ssl_context *ssl)
Jerry Yu83da34e2022-04-16 13:59:52 +08002491{
Gilles Peskine449bd832023-01-11 14:50:10 +01002492 int ret = mbedtls_ssl_tls13_write_certificate_verify(ssl);
2493 if (ret != 0) {
2494 return ret;
2495 }
2496 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_SERVER_FINISHED);
2497 return 0;
Jerry Yu83da34e2022-04-16 13:59:52 +08002498}
Ronald Cron928cbd32022-10-04 16:14:26 +02002499#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002500
2501/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002502 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002503 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002504MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002505static int ssl_tls13_write_server_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002506{
Jerry Yud6e253d2022-05-18 13:59:24 +08002507 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002508
Gilles Peskine449bd832023-01-11 14:50:10 +01002509 ret = mbedtls_ssl_tls13_write_finished_message(ssl);
2510 if (ret != 0) {
2511 return ret;
2512 }
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002513
Gilles Peskine449bd832023-01-11 14:50:10 +01002514 ret = mbedtls_ssl_tls13_compute_application_transform(ssl);
2515 if (ret != 0) {
Jerry Yue3d67cb2022-05-19 15:33:10 +08002516 MBEDTLS_SSL_PEND_FATAL_ALERT(
Gilles Peskine449bd832023-01-11 14:50:10 +01002517 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2518 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
2519 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002520 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002521
Gilles Peskine449bd832023-01-11 14:50:10 +01002522 MBEDTLS_SSL_DEBUG_MSG(1, ("Switch to handshake keys for inbound traffic"));
2523 mbedtls_ssl_set_inbound_transform(ssl, ssl->handshake->transform_handshake);
XiaokangQian189ded22022-05-10 08:12:17 +00002524
Gilles Peskine449bd832023-01-11 14:50:10 +01002525 if (ssl->handshake->certificate_request_sent) {
2526 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE);
2527 } else {
2528 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate"));
2529 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
2530 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002531 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002532
Gilles Peskine449bd832023-01-11 14:50:10 +01002533 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002534}
2535
2536/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002537 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002538 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002539MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002540static int ssl_tls13_process_client_finished(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002541{
Jerry Yud6e253d2022-05-18 13:59:24 +08002542 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2543
Gilles Peskine449bd832023-01-11 14:50:10 +01002544 ret = mbedtls_ssl_tls13_process_finished_message(ssl);
2545 if (ret != 0) {
2546 return ret;
Jerry Yue3d67cb2022-05-19 15:33:10 +08002547 }
2548
Gilles Peskine449bd832023-01-11 14:50:10 +01002549 ret = mbedtls_ssl_tls13_compute_resumption_master_secret(ssl);
2550 if (ret != 0) {
2551 MBEDTLS_SSL_DEBUG_RET(1,
2552 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret);
2553 }
2554
2555 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP);
2556 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002557}
2558
2559/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002560 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002561 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002562MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002563static int ssl_tls13_handshake_wrapup(mbedtls_ssl_context *ssl)
Jerry Yu69dd8d42022-04-16 12:51:26 +08002564{
Gilles Peskine449bd832023-01-11 14:50:10 +01002565 MBEDTLS_SSL_DEBUG_MSG(2, ("handshake: done"));
Jerry Yu03ed50b2022-04-16 17:13:30 +08002566
Gilles Peskine449bd832023-01-11 14:50:10 +01002567 mbedtls_ssl_tls13_handshake_wrapup(ssl);
Jerry Yue67bef42022-07-07 07:29:42 +00002568
2569#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Pengyu Lve6487fe2022-12-06 09:30:29 +08002570#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002571 /* Sent NewSessionTicket message only when client supports PSK */
Pengyu Lve6487fe2022-12-06 09:30:29 +08002572 if (!mbedtls_ssl_tls13_some_psk_enabled(ssl)) {
2573 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Pengyu Lvc7af2c42022-12-01 16:33:00 +08002574 } else
Jerry Yufca4d572022-07-21 10:37:48 +08002575#endif
Pengyu Lve6487fe2022-12-06 09:30:29 +08002576 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
2577#else
2578 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
2579#endif
Gilles Peskine449bd832023-01-11 14:50:10 +01002580 return 0;
Jerry Yu69dd8d42022-04-16 12:51:26 +08002581}
2582
2583/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002584 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002585 */
2586#define SSL_NEW_SESSION_TICKET_SKIP 0
2587#define SSL_NEW_SESSION_TICKET_WRITE 1
2588MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002589static int ssl_tls13_write_new_session_ticket_coordinate(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002590{
2591 /* Check whether the use of session tickets is enabled */
Gilles Peskine449bd832023-01-11 14:50:10 +01002592 if (ssl->conf->f_ticket_write == NULL) {
2593 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2594 " callback is not set"));
2595 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002596 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002597 if (ssl->conf->new_session_tickets_count == 0) {
2598 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: disabled,"
2599 " configured count is zero"));
2600 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yud0766ec2022-09-22 10:46:57 +08002601 }
2602
Gilles Peskine449bd832023-01-11 14:50:10 +01002603 if (ssl->handshake->new_session_tickets_count == 0) {
2604 MBEDTLS_SSL_DEBUG_MSG(2, ("NewSessionTicket: all tickets have "
2605 "been sent."));
2606 return SSL_NEW_SESSION_TICKET_SKIP;
Jerry Yue67bef42022-07-07 07:29:42 +00002607 }
2608
Gilles Peskine449bd832023-01-11 14:50:10 +01002609 return SSL_NEW_SESSION_TICKET_WRITE;
Jerry Yue67bef42022-07-07 07:29:42 +00002610}
2611
2612#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2613MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002614static int ssl_tls13_prepare_new_session_ticket(mbedtls_ssl_context *ssl,
2615 unsigned char *ticket_nonce,
2616 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002617{
2618 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2619 mbedtls_ssl_session *session = ssl->session;
2620 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2621 psa_algorithm_t psa_hash_alg;
2622 int hash_length;
2623
Gilles Peskine449bd832023-01-11 14:50:10 +01002624 MBEDTLS_SSL_DEBUG_MSG(2, ("=> prepare NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002625
2626#if defined(MBEDTLS_HAVE_TIME)
Gilles Peskine449bd832023-01-11 14:50:10 +01002627 session->start = mbedtls_time(NULL);
Jerry Yue67bef42022-07-07 07:29:42 +00002628#endif
2629
Pengyu Lv9f926952022-11-17 15:22:33 +08002630 /* Set ticket_flags depends on the advertised psk key exchange mode */
Pengyu Lv9eacb442022-12-09 14:39:19 +08002631 mbedtls_ssl_tls13_session_clear_ticket_flags(
2632 session, MBEDTLS_SSL_TLS1_3_TICKET_FLAGS_MASK);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002633#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Pengyu Lv9eacb442022-12-09 14:39:19 +08002634 mbedtls_ssl_tls13_session_set_ticket_flags(
2635 session, ssl->handshake->tls13_kex_modes);
Pengyu Lve6487fe2022-12-06 09:30:29 +08002636#endif
Pengyu Lv9f926952022-11-17 15:22:33 +08002637 MBEDTLS_SSL_DEBUG_TICKET_FLAGS(4, session->ticket_flags);
2638
Jerry Yue67bef42022-07-07 07:29:42 +00002639 /* Generate ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002640 if ((ret = ssl->conf->f_rng(ssl->conf->p_rng,
2641 (unsigned char *) &session->ticket_age_add,
2642 sizeof(session->ticket_age_add)) != 0)) {
2643 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_age_add", ret);
2644 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002645 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002646 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2647 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002648
2649 /* Generate ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002650 ret = ssl->conf->f_rng(ssl->conf->p_rng, ticket_nonce, ticket_nonce_size);
2651 if (ret != 0) {
2652 MBEDTLS_SSL_DEBUG_RET(1, "generate_ticket_nonce", ret);
2653 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002654 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002655 MBEDTLS_SSL_DEBUG_BUF(3, "ticket_nonce:",
2656 ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002657
2658 ciphersuite_info =
Gilles Peskine449bd832023-01-11 14:50:10 +01002659 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2660 psa_hash_alg = mbedtls_psa_translate_md(ciphersuite_info->mac);
2661 hash_length = PSA_HASH_LENGTH(psa_hash_alg);
2662 if (hash_length == -1 ||
2663 (size_t) hash_length > sizeof(session->resumption_key)) {
2664 return MBEDTLS_ERR_SSL_INTERNAL_ERROR;
Jerry Yufca4d572022-07-21 10:37:48 +08002665 }
2666
Jerry Yue67bef42022-07-07 07:29:42 +00002667 /* In this code the psk key length equals the length of the hash */
2668 session->resumption_key_len = hash_length;
2669 session->ciphersuite = ciphersuite_info->id;
2670
2671 /* Compute resumption key
2672 *
2673 * HKDF-Expand-Label( resumption_master_secret,
2674 * "resumption", ticket_nonce, Hash.length )
2675 */
2676 ret = mbedtls_ssl_tls13_hkdf_expand_label(
Gilles Peskine449bd832023-01-11 14:50:10 +01002677 psa_hash_alg,
2678 session->app_secrets.resumption_master_secret,
2679 hash_length,
2680 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN(resumption),
2681 ticket_nonce,
2682 ticket_nonce_size,
2683 session->resumption_key,
2684 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002685
Gilles Peskine449bd832023-01-11 14:50:10 +01002686 if (ret != 0) {
2687 MBEDTLS_SSL_DEBUG_RET(2,
2688 "Creating the ticket-resumed PSK failed",
2689 ret);
2690 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002691 }
Gilles Peskine449bd832023-01-11 14:50:10 +01002692 MBEDTLS_SSL_DEBUG_BUF(3, "Ticket-resumed PSK",
2693 session->resumption_key,
2694 session->resumption_key_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002695
Gilles Peskine449bd832023-01-11 14:50:10 +01002696 MBEDTLS_SSL_DEBUG_BUF(3, "resumption_master_secret",
2697 session->app_secrets.resumption_master_secret,
2698 hash_length);
Jerry Yue67bef42022-07-07 07:29:42 +00002699
Gilles Peskine449bd832023-01-11 14:50:10 +01002700 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002701}
2702
2703/* This function creates a NewSessionTicket message in the following format:
2704 *
2705 * struct {
2706 * uint32 ticket_lifetime;
2707 * uint32 ticket_age_add;
2708 * opaque ticket_nonce<0..255>;
2709 * opaque ticket<1..2^16-1>;
2710 * Extension extensions<0..2^16-2>;
2711 * } NewSessionTicket;
2712 *
2713 * The ticket inside the NewSessionTicket message is an encrypted container
2714 * carrying the necessary information so that the server is later able to
2715 * re-start the communication.
2716 *
2717 * The following fields are placed inside the ticket by the
2718 * f_ticket_write() function:
2719 *
2720 * - creation time (start)
2721 * - flags (flags)
2722 * - age add (ticket_age_add)
2723 * - key (key)
2724 * - key length (key_len)
2725 * - ciphersuite (ciphersuite)
2726 */
2727MBEDTLS_CHECK_RETURN_CRITICAL
Gilles Peskine449bd832023-01-11 14:50:10 +01002728static int ssl_tls13_write_new_session_ticket_body(mbedtls_ssl_context *ssl,
2729 unsigned char *buf,
2730 unsigned char *end,
2731 size_t *out_len,
2732 unsigned char *ticket_nonce,
2733 size_t ticket_nonce_size)
Jerry Yue67bef42022-07-07 07:29:42 +00002734{
2735 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2736 unsigned char *p = buf;
2737 mbedtls_ssl_session *session = ssl->session;
2738 size_t ticket_len;
2739 uint32_t ticket_lifetime;
2740
2741 *out_len = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002742 MBEDTLS_SSL_DEBUG_MSG(2, ("=> write NewSessionTicket msg"));
Jerry Yue67bef42022-07-07 07:29:42 +00002743
2744 /*
2745 * ticket_lifetime 4 bytes
2746 * ticket_age_add 4 bytes
2747 * ticket_nonce 1 + ticket_nonce_size bytes
2748 * ticket >=2 bytes
2749 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002750 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 4 + 4 + 1 + ticket_nonce_size + 2);
Jerry Yue67bef42022-07-07 07:29:42 +00002751
2752 /* Generate ticket and ticket_lifetime */
Gilles Peskine449bd832023-01-11 14:50:10 +01002753 ret = ssl->conf->f_ticket_write(ssl->conf->p_ticket,
2754 session,
2755 p + 9 + ticket_nonce_size + 2,
2756 end,
2757 &ticket_len,
2758 &ticket_lifetime);
2759 if (ret != 0) {
2760 MBEDTLS_SSL_DEBUG_RET(1, "write_ticket", ret);
2761 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002762 }
2763 /* RFC 8446 4.6.1
2764 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2765 * unsigned integer in network byte order from the time of ticket
2766 * issuance. Servers MUST NOT use any value greater than
2767 * 604800 seconds (7 days). The value of zero indicates that the
2768 * ticket should be discarded immediately. Clients MUST NOT cache
2769 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2770 * and MAY delete tickets earlier based on local policy. A server
2771 * MAY treat a ticket as valid for a shorter period of time than what
2772 * is stated in the ticket_lifetime.
2773 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002774 if (ticket_lifetime > 604800) {
Xiaokang Qian28af5012022-10-13 08:18:19 +00002775 ticket_lifetime = 604800;
Gilles Peskine449bd832023-01-11 14:50:10 +01002776 }
2777 MBEDTLS_PUT_UINT32_BE(ticket_lifetime, p, 0);
2778 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_lifetime: %u",
2779 (unsigned int) ticket_lifetime));
Jerry Yue67bef42022-07-07 07:29:42 +00002780
2781 /* Write ticket_age_add */
Gilles Peskine449bd832023-01-11 14:50:10 +01002782 MBEDTLS_PUT_UINT32_BE(session->ticket_age_add, p, 4);
2783 MBEDTLS_SSL_DEBUG_MSG(3, ("ticket_age_add: %u",
2784 (unsigned int) session->ticket_age_add));
Jerry Yue67bef42022-07-07 07:29:42 +00002785
2786 /* Write ticket_nonce */
Gilles Peskine449bd832023-01-11 14:50:10 +01002787 p[8] = (unsigned char) ticket_nonce_size;
2788 if (ticket_nonce_size > 0) {
2789 memcpy(p + 9, ticket_nonce, ticket_nonce_size);
Jerry Yue67bef42022-07-07 07:29:42 +00002790 }
2791 p += 9 + ticket_nonce_size;
2792
2793 /* Write ticket */
Gilles Peskine449bd832023-01-11 14:50:10 +01002794 MBEDTLS_PUT_UINT16_BE(ticket_len, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002795 p += 2;
Gilles Peskine449bd832023-01-11 14:50:10 +01002796 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", p, ticket_len);
Jerry Yue67bef42022-07-07 07:29:42 +00002797 p += ticket_len;
2798
2799 /* Ticket Extensions
2800 *
2801 * Note: We currently don't have any extensions.
2802 * Set length to zero.
2803 */
Jerry Yuedab6372022-10-31 14:37:31 +08002804 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2805
Gilles Peskine449bd832023-01-11 14:50:10 +01002806 MBEDTLS_SSL_CHK_BUF_PTR(p, end, 2);
2807 MBEDTLS_PUT_UINT16_BE(0, p, 0);
Jerry Yue67bef42022-07-07 07:29:42 +00002808 p += 2;
2809
2810 *out_len = p - buf;
Gilles Peskine449bd832023-01-11 14:50:10 +01002811 MBEDTLS_SSL_DEBUG_BUF(4, "ticket", buf, *out_len);
2812 MBEDTLS_SSL_DEBUG_MSG(2, ("<= write new session ticket"));
Jerry Yue67bef42022-07-07 07:29:42 +00002813
Jerry Yu7de2ff02022-11-08 21:43:46 +08002814 MBEDTLS_SSL_PRINT_EXTS(
Gilles Peskine449bd832023-01-11 14:50:10 +01002815 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions);
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002816
Gilles Peskine449bd832023-01-11 14:50:10 +01002817 return 0;
Jerry Yue67bef42022-07-07 07:29:42 +00002818}
2819
2820/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002821 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002822 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002823static int ssl_tls13_write_new_session_ticket(mbedtls_ssl_context *ssl)
Jerry Yue67bef42022-07-07 07:29:42 +00002824{
2825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2826
Gilles Peskine449bd832023-01-11 14:50:10 +01002827 MBEDTLS_SSL_PROC_CHK_NEG(ssl_tls13_write_new_session_ticket_coordinate(ssl));
Jerry Yue67bef42022-07-07 07:29:42 +00002828
Gilles Peskine449bd832023-01-11 14:50:10 +01002829 if (ret == SSL_NEW_SESSION_TICKET_WRITE) {
Jerry Yue67bef42022-07-07 07:29:42 +00002830 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2831 unsigned char *buf;
2832 size_t buf_len, msg_len;
2833
Gilles Peskine449bd832023-01-11 14:50:10 +01002834 MBEDTLS_SSL_PROC_CHK(ssl_tls13_prepare_new_session_ticket(
2835 ssl, ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002836
Gilles Peskine449bd832023-01-11 14:50:10 +01002837 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_start_handshake_msg(ssl,
2838 MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2839 &buf, &buf_len));
Jerry Yue67bef42022-07-07 07:29:42 +00002840
Gilles Peskine449bd832023-01-11 14:50:10 +01002841 MBEDTLS_SSL_PROC_CHK(ssl_tls13_write_new_session_ticket_body(
2842 ssl, buf, buf + buf_len, &msg_len,
2843 ticket_nonce, sizeof(ticket_nonce)));
Jerry Yue67bef42022-07-07 07:29:42 +00002844
Gilles Peskine449bd832023-01-11 14:50:10 +01002845 MBEDTLS_SSL_PROC_CHK(mbedtls_ssl_finish_handshake_msg(
2846 ssl, buf_len, msg_len));
Jerry Yufca4d572022-07-21 10:37:48 +08002847
Jerry Yu359e65f2022-09-22 23:47:43 +08002848 /* Limit session tickets count to one when resumption connection.
2849 *
2850 * See document of mbedtls_ssl_conf_new_session_tickets.
2851 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002852 if (ssl->handshake->resume == 1) {
Jerry Yu359e65f2022-09-22 23:47:43 +08002853 ssl->handshake->new_session_tickets_count = 0;
Gilles Peskine449bd832023-01-11 14:50:10 +01002854 } else {
Jerry Yu359e65f2022-09-22 23:47:43 +08002855 ssl->handshake->new_session_tickets_count--;
Gilles Peskine449bd832023-01-11 14:50:10 +01002856 }
Jerry Yub7e3fa72022-09-22 11:07:18 +08002857
Jerry Yua8d3c502022-10-30 14:51:23 +08002858 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002859 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH);
2860 } else {
2861 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
Jerry Yue67bef42022-07-07 07:29:42 +00002862 }
2863
Jerry Yue67bef42022-07-07 07:29:42 +00002864cleanup:
2865
Gilles Peskine449bd832023-01-11 14:50:10 +01002866 return ret;
Jerry Yue67bef42022-07-07 07:29:42 +00002867}
2868#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2869
2870/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002871 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002872 */
Gilles Peskine449bd832023-01-11 14:50:10 +01002873int mbedtls_ssl_tls13_handshake_server_step(mbedtls_ssl_context *ssl)
Jerry Yub9930e72021-08-06 17:11:51 +08002874{
XiaokangQian08037552022-04-20 07:16:41 +00002875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002876
Gilles Peskine449bd832023-01-11 14:50:10 +01002877 if (ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL) {
2878 return MBEDTLS_ERR_SSL_BAD_INPUT_DATA;
2879 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002880
Gilles Peskine449bd832023-01-11 14:50:10 +01002881 MBEDTLS_SSL_DEBUG_MSG(2, ("tls13 server state: %s(%d)",
2882 mbedtls_ssl_states_str(ssl->state),
2883 ssl->state));
Jerry Yu6e81b272021-09-27 11:16:17 +08002884
Gilles Peskine449bd832023-01-11 14:50:10 +01002885 switch (ssl->state) {
XiaokangQian7807f9f2022-02-15 10:04:37 +00002886 /* start state */
2887 case MBEDTLS_SSL_HELLO_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002888 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
XiaokangQian08037552022-04-20 07:16:41 +00002889 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002890 break;
2891
XiaokangQian7807f9f2022-02-15 10:04:37 +00002892 case MBEDTLS_SSL_CLIENT_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002893 ret = ssl_tls13_process_client_hello(ssl);
2894 if (ret != 0) {
2895 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_process_client_hello", ret);
2896 }
Jerry Yuf41553b2022-05-09 22:20:30 +08002897 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002898
Jerry Yuf41553b2022-05-09 22:20:30 +08002899 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002900 ret = ssl_tls13_write_hello_retry_request(ssl);
2901 if (ret != 0) {
2902 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_hello_retry_request", ret);
2903 return ret;
Jerry Yuf41553b2022-05-09 22:20:30 +08002904 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002905 break;
2906
Jerry Yu5b64ae92022-03-30 17:15:02 +08002907 case MBEDTLS_SSL_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002908 ret = ssl_tls13_write_server_hello(ssl);
Jerry Yu5b64ae92022-03-30 17:15:02 +08002909 break;
2910
Xiaofei Baicba64af2022-02-15 10:00:56 +00002911 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Gilles Peskine449bd832023-01-11 14:50:10 +01002912 ret = ssl_tls13_write_encrypted_extensions(ssl);
2913 if (ret != 0) {
2914 MBEDTLS_SSL_DEBUG_RET(1, "ssl_tls13_write_encrypted_extensions", ret);
2915 return ret;
Xiaofei Baicba64af2022-02-15 10:00:56 +00002916 }
Jerry Yu48330562022-05-06 21:35:44 +08002917 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002918
Ronald Cron928cbd32022-10-04 16:14:26 +02002919#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002920 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002921 ret = ssl_tls13_write_certificate_request(ssl);
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002922 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002923
Jerry Yu83da34e2022-04-16 13:59:52 +08002924 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002925 ret = ssl_tls13_write_server_certificate(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002926 break;
2927
2928 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002929 ret = ssl_tls13_write_certificate_verify(ssl);
Jerry Yu83da34e2022-04-16 13:59:52 +08002930 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002931#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002932
Gilles Peskine449bd832023-01-11 14:50:10 +01002933 /*
2934 * Injection of dummy-CCS's for middlebox compatibility
2935 */
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002936#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002937 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gilles Peskine449bd832023-01-11 14:50:10 +01002938 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2939 if (ret == 0) {
2940 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_CLIENT_HELLO);
2941 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002942 break;
2943
2944 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
Gilles Peskine449bd832023-01-11 14:50:10 +01002945 ret = mbedtls_ssl_tls13_write_change_cipher_spec(ssl);
2946 if (ret == 0) {
2947 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS);
2948 }
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002949 break;
2950#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2951
Jerry Yu69dd8d42022-04-16 12:51:26 +08002952 case MBEDTLS_SSL_SERVER_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002953 ret = ssl_tls13_write_server_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002954 break;
2955
2956 case MBEDTLS_SSL_CLIENT_FINISHED:
Gilles Peskine449bd832023-01-11 14:50:10 +01002957 ret = ssl_tls13_process_client_finished(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002958 break;
2959
Jerry Yu69dd8d42022-04-16 12:51:26 +08002960 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Gilles Peskine449bd832023-01-11 14:50:10 +01002961 ret = ssl_tls13_handshake_wrapup(ssl);
Jerry Yu69dd8d42022-04-16 12:51:26 +08002962 break;
2963
Ronald Cron766c0cd2022-10-18 12:17:11 +02002964#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00002965 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
Gilles Peskine449bd832023-01-11 14:50:10 +01002966 ret = mbedtls_ssl_tls13_process_certificate(ssl);
2967 if (ret == 0) {
2968 if (ssl->session_negotiate->peer_cert != NULL) {
Ronald Cron209cae92022-06-07 10:30:19 +02002969 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002970 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY);
2971 } else {
2972 MBEDTLS_SSL_DEBUG_MSG(2, ("skip parse certificate verify"));
Ronald Cron209cae92022-06-07 10:30:19 +02002973 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002974 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
Ronald Cron19385882022-06-15 16:26:13 +02002975 }
XiaokangQian6b916b12022-04-25 07:29:34 +00002976 }
2977 break;
2978
2979 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
Gilles Peskine449bd832023-01-11 14:50:10 +01002980 ret = mbedtls_ssl_tls13_process_certificate_verify(ssl);
2981 if (ret == 0) {
XiaokangQian6b916b12022-04-25 07:29:34 +00002982 mbedtls_ssl_handshake_set_state(
Gilles Peskine449bd832023-01-11 14:50:10 +01002983 ssl, MBEDTLS_SSL_CLIENT_FINISHED);
XiaokangQian6b916b12022-04-25 07:29:34 +00002984 }
2985 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02002986#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00002987
Jerry Yue67bef42022-07-07 07:29:42 +00002988#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08002989 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Gilles Peskine449bd832023-01-11 14:50:10 +01002990 ret = ssl_tls13_write_new_session_ticket(ssl);
2991 if (ret != 0) {
2992 MBEDTLS_SSL_DEBUG_RET(1,
2993 "ssl_tls13_write_new_session_ticket ",
2994 ret);
Jerry Yue67bef42022-07-07 07:29:42 +00002995 }
2996 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08002997 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00002998 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08002999 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003000 * as part of ssl_prepare_handshake_step.
3001 */
3002 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003003
Gilles Peskine449bd832023-01-11 14:50:10 +01003004 if (ssl->handshake->new_session_tickets_count == 0) {
3005 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_HANDSHAKE_OVER);
3006 } else {
3007 mbedtls_ssl_handshake_set_state(ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET);
3008 }
Jerry Yue67bef42022-07-07 07:29:42 +00003009 break;
3010
3011#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3012
XiaokangQian7807f9f2022-02-15 10:04:37 +00003013 default:
Gilles Peskine449bd832023-01-11 14:50:10 +01003014 MBEDTLS_SSL_DEBUG_MSG(1, ("invalid state %d", ssl->state));
3015 return MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00003016 }
3017
Gilles Peskine449bd832023-01-11 14:50:10 +01003018 return ret;
Jerry Yub9930e72021-08-06 17:11:51 +08003019}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003020
Jerry Yufb4b6472022-01-27 15:03:26 +08003021#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */