blob: 685e10ba1510723f1a53e60b5a45845bdfab6d87 [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.
18*/
19
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(
Jerry Yuf35ba382022-08-23 17:58:26 +080035 mbedtls_ssl_context *ssl,
Jerry Yuc5a23a02022-08-25 10:51:44 +080036 unsigned int cipher_suite )
Jerry Yuf35ba382022-08-23 17:58:26 +080037{
38 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
39 if( ! mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
40 return( NULL );
41
42 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
43 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
44 ssl->tls_version,
45 ssl->tls_version ) != 0 ) )
46 {
47 return( NULL );
48 }
49 return( ciphersuite_info );
50}
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
Jerry Yue19e3b92022-07-08 12:04:51 +000061static int ssl_tls13_parse_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
62 const unsigned char *buf,
Jerry Yu299e31f2022-07-13 23:06:36 +080063 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) */
Jerry Yu299e31f2022-07-13 23:06:36 +080070 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
71 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. */
74 if( ke_modes_len > 2 )
Jerry Yu299e31f2022-07-13 23:06:36 +080075 {
76 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
77 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +000078 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu299e31f2022-07-13 23:06:36 +080079 }
Jerry Yue19e3b92022-07-08 12:04:51 +000080
Jerry Yu299e31f2022-07-13 23:06:36 +080081 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ke_modes_len );
Jerry Yue19e3b92022-07-08 12:04:51 +000082
83 while( ke_modes_len-- != 0 )
84 {
Jerry Yu299e31f2022-07-13 23:06:36 +080085 switch( *p++ )
Jerry Yue19e3b92022-07-08 12:04:51 +000086 {
87 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
88 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
89 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK KEX MODE" ) );
90 break;
91 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
92 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
93 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK_EPHEMERAL KEX MODE" ) );
94 break;
95 default:
Jerry Yu299e31f2022-07-13 23:06:36 +080096 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
97 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +000098 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
99 }
100 }
101
102 ssl->handshake->tls13_kex_modes = ke_modes;
103 return( 0 );
104}
Jerry Yu1c105562022-07-10 06:32:38 +0000105
Jerry Yue9d4fc02022-08-20 19:21:15 +0800106#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
107#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800108
109#if defined(MBEDTLS_SSL_SESSION_TICKETS)
110
111MBEDTLS_CHECK_RETURN_CRITICAL
112static int ssl_tls13_offered_psks_check_identity_match_ticket(
113 mbedtls_ssl_context *ssl,
Jerry Yu95699e72022-08-21 19:22:23 +0800114 const unsigned char *identity,
115 size_t identity_len,
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800116 uint32_t obfuscated_ticket_age,
117 mbedtls_ssl_session *session )
Jerry Yu95699e72022-08-21 19:22:23 +0800118{
Jerry Yufd310eb2022-09-06 09:16:35 +0800119 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800120 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800121#if defined(MBEDTLS_HAVE_TIME)
122 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800123 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800124 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800125#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800126
127 ((void) obfuscated_ticket_age);
128
129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> check_identity_match_ticket" ) );
130
Jerry Yufd310eb2022-09-06 09:16:35 +0800131 /* Ticket parser is not configured, Skip */
132 if( ssl->conf->f_ticket_parse == NULL || identity_len == 0 )
Jerry Yu95699e72022-08-21 19:22:23 +0800133 return( 0 );
Jerry Yu95699e72022-08-21 19:22:23 +0800134
Jerry Yu4746b102022-09-13 11:11:48 +0800135 /* We create a copy of the encrypted ticket since the ticket parsing
136 * function is allowed to use its input buffer as an output buffer
137 * (in-place decryption). We do, however, need the original buffer for
138 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800139 */
140 ticket_buffer = mbedtls_calloc( 1, identity_len );
141 if( ticket_buffer == NULL )
142 {
143 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
144 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
145 }
146 memcpy( ticket_buffer, identity, identity_len );
147
148 if( ( ret = ssl->conf->f_ticket_parse( ssl->conf->p_ticket,
149 session,
150 ticket_buffer, identity_len ) ) != 0 )
151 {
152 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
153 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is not authentic" ) );
154 else if( ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED )
155 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is expired" ) );
156 else
157 MBEDTLS_SSL_DEBUG_RET( 1, "ticket_parse", ret );
158 }
159
160 /* We delete the temporary buffer */
161 mbedtls_free( ticket_buffer );
162
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800163 if( ret != 0 )
164 goto exit;
165
166 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
167#if defined(MBEDTLS_HAVE_TIME)
168 now = mbedtls_time( NULL );
169
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800170 if( now < session->start )
Jerry Yu95699e72022-08-21 19:22:23 +0800171 {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800172 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu03aa1742022-10-10 21:48:37 +0800173 3, ( "Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
Jerry Yua99cbfa2022-10-08 11:17:14 +0800174 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
175 (long long)now, (long long)session->start ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800176 goto exit;
177 }
Jerry Yu95699e72022-08-21 19:22:23 +0800178
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800179 age_in_s = (uint64_t)( now - session->start );
Jerry Yu95699e72022-08-21 19:22:23 +0800180
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800181 /* RFC 8446 section 4.6.1
182 *
183 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
184 *
185 * RFC 8446 section 4.2.11.1
186 *
187 * Clients MUST NOT attempt to use tickets which have ages greater than
188 * the "ticket_lifetime" value which was provided with the ticket.
189 *
190 * For time being, the age MUST be less than 604800 seconds (7 days).
191 */
192 if( age_in_s > 604800 )
193 {
194 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuc2bfaf02022-10-11 15:55:52 +0800195 3, ( "Ticket age exceeds limitation ticket_age=%lu",
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800196 (long unsigned int)age_in_s ) );
197 goto exit;
198 }
Jerry Yu95699e72022-08-21 19:22:23 +0800199
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800200 /* RFC 8446 section 4.2.10
201 *
202 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
203 * the ticket age for the selected PSK identity (computed by subtracting
204 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
205 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800206 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800207 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
208 * as the age units are different on the server (s) and in the
209 * client (ms) side. Add a -1000 ms tolerance window to take this
210 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800211 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800212 age_diff_in_ms = age_in_s * 1000;
213 age_diff_in_ms -= ( obfuscated_ticket_age - session->ticket_age_add );
214 if( age_diff_in_ms <= -1000 ||
215 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE )
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800216 {
217 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu03aa1742022-10-10 21:48:37 +0800218 3, ( "Ticket age outside tolerance window ( diff=%d )",
219 (int)age_diff_in_ms ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800220 goto exit;
221 }
222
223 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800224
225#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800226
227exit:
228 if( ret != 0 )
229 mbedtls_ssl_session_free( session );
Jerry Yu95699e72022-08-21 19:22:23 +0800230
231 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= check_identity_match_ticket" ) );
232 return( ret );
233}
234#endif /* MBEDTLS_SSL_SESSION_TICKETS */
235
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800236MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000237static int ssl_tls13_offered_psks_check_identity_match(
238 mbedtls_ssl_context *ssl,
239 const unsigned char *identity,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800240 size_t identity_len,
Jerry Yu95699e72022-08-21 19:22:23 +0800241 uint32_t obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800242 int *psk_type,
243 mbedtls_ssl_session *session )
Jerry Yu1c105562022-07-10 06:32:38 +0000244{
Jerry Yu95699e72022-08-21 19:22:23 +0800245 ((void) session);
246 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800247 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800248
249 MBEDTLS_SSL_DEBUG_BUF( 4, "identity", identity, identity_len );
250 ssl->handshake->resume = 0;
251
Jerry Yu95699e72022-08-21 19:22:23 +0800252#if defined(MBEDTLS_SSL_SESSION_TICKETS)
253 if( ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800254 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800255 session ) == SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu95699e72022-08-21 19:22:23 +0800256 {
Jerry Yu95699e72022-08-21 19:22:23 +0800257 ssl->handshake->resume = 1;
258 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
259 mbedtls_ssl_set_hs_psk( ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800260 session->resumption_key,
261 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800262
263 MBEDTLS_SSL_DEBUG_BUF( 4, "Ticket-resumed PSK:",
Jerry Yu0a55cc62022-09-15 16:15:06 +0800264 session->resumption_key,
265 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800266 MBEDTLS_SSL_DEBUG_MSG( 4, ( "ticket: obfuscated_ticket_age: %u",
267 (unsigned)obfuscated_ticket_age ) );
268 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
269 }
270#endif /* MBEDTLS_SSL_SESSION_TICKETS */
271
Jerry Yu1c105562022-07-10 06:32:38 +0000272 /* Check identity with external configured function */
273 if( ssl->conf->f_psk != NULL )
274 {
275 if( ssl->conf->f_psk(
276 ssl->conf->p_psk, ssl, identity, identity_len ) == 0 )
277 {
278 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
279 }
280 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
281 }
282
Jerry Yu96a2e362022-07-21 15:11:34 +0800283 MBEDTLS_SSL_DEBUG_BUF( 5, "identity", identity, identity_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000284 /* Check identity with pre-configured psk */
Jerry Yu2f0abc92022-07-22 19:34:48 +0800285 if( ssl->conf->psk_identity != NULL &&
286 identity_len == ssl->conf->psk_identity_len &&
Jerry Yu1c105562022-07-10 06:32:38 +0000287 mbedtls_ct_memcmp( ssl->conf->psk_identity,
288 identity, identity_len ) == 0 )
289 {
290 mbedtls_ssl_set_hs_psk( ssl, ssl->conf->psk, ssl->conf->psk_len );
291 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
292 }
293
Jerry Yu1c105562022-07-10 06:32:38 +0000294 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
295}
296
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800297MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu96a2e362022-07-21 15:11:34 +0800298static int ssl_tls13_offered_psks_check_binder_match( mbedtls_ssl_context *ssl,
299 const unsigned char *binder,
Jerry Yue95c8af2022-07-26 15:48:20 +0800300 size_t binder_len,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800301 int psk_type,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800302 psa_algorithm_t psk_hash_alg )
Jerry Yu1c105562022-07-10 06:32:38 +0000303{
304 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800305
Jerry Yudaf375a2022-07-20 21:31:43 +0800306 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000307 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800308 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800309 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800310 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000311
Jerry Yu1c105562022-07-10 06:32:38 +0000312 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800313 ret = mbedtls_ssl_get_handshake_transcript(
314 ssl, mbedtls_hash_info_md_from_psa( psk_hash_alg ),
315 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000316 if( ret != 0 )
317 return( ret );
318
Jerry Yu40f37712022-07-26 16:58:57 +0800319 ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len );
Jerry Yu96a2e362022-07-21 15:11:34 +0800320 if( ret != 0 )
321 return( ret );
322
Jerry Yu29d9faa2022-08-23 17:52:45 +0800323 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psk_hash_alg,
Jerry Yu1c105562022-07-10 06:32:38 +0000324 psk, psk_len, psk_type,
325 transcript,
326 server_computed_binder );
Jerry Yu96a2e362022-07-21 15:11:34 +0800327#if defined(MBEDTLS_USE_PSA_CRYPTO)
328 mbedtls_free( (void*)psk );
329#endif
Jerry Yu1c105562022-07-10 06:32:38 +0000330 if( ret != 0 )
331 {
332 MBEDTLS_SSL_DEBUG_MSG( 1, ( "PSK binder calculation failed." ) );
333 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
334 }
335
336 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( computed ): ",
Jerry Yu2f0abc92022-07-22 19:34:48 +0800337 server_computed_binder, transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000338 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( received ): ", binder, binder_len );
339
340 if( mbedtls_ct_memcmp( server_computed_binder, binder, binder_len ) == 0 )
341 {
342 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
343 }
344
Jerry Yudaf375a2022-07-20 21:31:43 +0800345 mbedtls_platform_zeroize( server_computed_binder,
346 sizeof( server_computed_binder ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000347 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
348}
Jerry Yu96a2e362022-07-21 15:11:34 +0800349
Jerry Yu5725f1c2022-08-21 17:27:16 +0800350MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800351static int ssl_tls13_select_ciphersuite_for_psk(
352 mbedtls_ssl_context *ssl,
353 const unsigned char *cipher_suites,
354 const unsigned char *cipher_suites_end,
355 uint16_t *selected_ciphersuite,
356 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800357{
Jerry Yuf35ba382022-08-23 17:58:26 +0800358 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800359
Jerry Yu0baf9072022-08-25 11:21:04 +0800360 *selected_ciphersuite = 0;
361 *selected_ciphersuite_info = NULL;
362
Jerry Yuf35ba382022-08-23 17:58:26 +0800363 /* RFC 8446, page 55.
364 *
365 * For externally established PSKs, the Hash algorithm MUST be set when the
366 * PSK is established or default to SHA-256 if no such algorithm is defined.
367 *
368 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800369
Jerry Yu5725f1c2022-08-21 17:27:16 +0800370 /*
371 * Search for a matching ciphersuite
372 */
Jerry Yu1e05b6d2022-08-31 10:35:52 +0800373 for ( const unsigned char *p = cipher_suites;
374 p < cipher_suites_end; p += 2 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800375 {
376 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800377 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800378
379 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +0800380 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
381 cipher_suite );
Jerry Yuf35ba382022-08-23 17:58:26 +0800382 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800383 continue;
384
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
386 * Otherwise, client should reject.
387 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800388 if( psk_hash_alg == mbedtls_psa_translate_md( ciphersuite_info->mac ) )
389 {
390 *selected_ciphersuite = cipher_suite;
391 *selected_ciphersuite_info = ciphersuite_info;
392 return( 0 );
393 }
394 }
395 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No matched ciphersuite" ) );
396 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
397}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800398
Jerry Yu82534862022-08-30 10:42:33 +0800399#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800400MBEDTLS_CHECK_RETURN_CRITICAL
401static int ssl_tls13_select_ciphersuite_for_resumption(
402 mbedtls_ssl_context *ssl,
403 const unsigned char *cipher_suites,
404 const unsigned char *cipher_suites_end,
405 mbedtls_ssl_session *session,
406 uint16_t *selected_ciphersuite,
407 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
408{
Jerry Yu82534862022-08-30 10:42:33 +0800409
Jerry Yuf35ba382022-08-23 17:58:26 +0800410 *selected_ciphersuite = 0;
411 *selected_ciphersuite_info = NULL;
Jerry Yu82534862022-08-30 10:42:33 +0800412 for( const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2 )
413 {
414 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
415 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
416
417 if( cipher_suite != session->ciphersuite )
418 continue;
419
420 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
421 cipher_suite );
422 if( ciphersuite_info == NULL )
423 continue;
424
Jerry Yu4746b102022-09-13 11:11:48 +0800425 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800426 *selected_ciphersuite_info = ciphersuite_info;
427
428 return( 0 );
Jerry Yu82534862022-08-30 10:42:33 +0800429 }
430
431 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800432}
Jerry Yuf35ba382022-08-23 17:58:26 +0800433
Jerry Yu82534862022-08-30 10:42:33 +0800434MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4746b102022-09-13 11:11:48 +0800435static int ssl_tls13_session_copy_ticket( mbedtls_ssl_session *dst,
436 const mbedtls_ssl_session *src )
Jerry Yu82534862022-08-30 10:42:33 +0800437{
Jerry Yu82534862022-08-30 10:42:33 +0800438 dst->ticket_age_add = src->ticket_age_add;
439 dst->ticket_flags = src->ticket_flags;
440 dst->resumption_key_len = src->resumption_key_len;
441 if( src->resumption_key_len == 0 )
442 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
443 memcpy( dst->resumption_key, src->resumption_key, src->resumption_key_len );
Jerry Yu4746b102022-09-13 11:11:48 +0800444
Jerry Yu82534862022-08-30 10:42:33 +0800445 return( 0 );
446}
447#endif /* MBEDTLS_SSL_SESSION_TICKETS */
448
Jerry Yu1c105562022-07-10 06:32:38 +0000449/* Parser for pre_shared_key extension in client hello
450 * struct {
451 * opaque identity<1..2^16-1>;
452 * uint32 obfuscated_ticket_age;
453 * } PskIdentity;
454 *
455 * opaque PskBinderEntry<32..255>;
456 *
457 * struct {
458 * PskIdentity identities<7..2^16-1>;
459 * PskBinderEntry binders<33..2^16-1>;
460 * } OfferedPsks;
461 *
462 * struct {
463 * select (Handshake.msg_type) {
464 * case client_hello: OfferedPsks;
465 * ....
466 * };
467 * } PreSharedKeyExtension;
468 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800469MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yubb852022022-07-20 21:10:44 +0800470static int ssl_tls13_parse_pre_shared_key_ext( mbedtls_ssl_context *ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800471 const unsigned char *pre_shared_key_ext,
472 const unsigned char *pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800473 const unsigned char *ciphersuites,
474 const unsigned char *ciphersuites_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000475{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800476 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800477 const unsigned char *p_identity_len;
478 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000479 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800480 const unsigned char *binders;
481 const unsigned char *p_binder_len;
482 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000483 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800484 int matched_identity = -1;
485 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000486
Jerry Yu29d9faa2022-08-23 17:52:45 +0800487 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key extension",
488 pre_shared_key_ext,
489 pre_shared_key_ext_end - pre_shared_key_ext );
Jerry Yu1c105562022-07-10 06:32:38 +0000490
Jerry Yu96a2e362022-07-21 15:11:34 +0800491 /* identities_len 2 bytes
492 * identities_data >= 7 bytes
493 */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800494 MBEDTLS_SSL_CHK_BUF_READ_PTR( identities, pre_shared_key_ext_end, 7 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800495 identities_len = MBEDTLS_GET_UINT16_BE( identities, 0 );
496 p_identity_len = identities + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800497 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, pre_shared_key_ext_end,
498 identities_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800499 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000500
Jerry Yu96a2e362022-07-21 15:11:34 +0800501 /* binders_len 2 bytes
502 * binders >= 33 bytes
503 */
Jerry Yu568ec252022-07-22 21:27:34 +0800504 binders = identities_end;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800505 MBEDTLS_SSL_CHK_BUF_READ_PTR( binders, pre_shared_key_ext_end, 33 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800506 binders_len = MBEDTLS_GET_UINT16_BE( binders, 0 );
507 p_binder_len = binders + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800508 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, pre_shared_key_ext_end, binders_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800509 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000510
Jerry Yu29d9faa2022-08-23 17:52:45 +0800511 ssl->handshake->update_checksum( ssl, pre_shared_key_ext,
512 identities_end - pre_shared_key_ext );
Jerry Yu96a2e362022-07-21 15:11:34 +0800513
Jerry Yu568ec252022-07-22 21:27:34 +0800514 while( p_identity_len < identities_end && p_binder_len < binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000515 {
Jerry Yu1c105562022-07-10 06:32:38 +0000516 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800517 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800518 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800519 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800520 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800521 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800522 int psk_type;
523 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800524 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800525#if defined(MBEDTLS_SSL_SESSION_TICKETS)
526 mbedtls_ssl_session session;
Jerry Yu4746b102022-09-13 11:11:48 +0800527 mbedtls_ssl_session_init( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800528#endif
Jerry Yubb852022022-07-20 21:10:44 +0800529
Jerry Yu568ec252022-07-22 21:27:34 +0800530 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, identities_end, 2 + 1 + 4 );
531 identity_len = MBEDTLS_GET_UINT16_BE( p_identity_len, 0 );
532 identity = p_identity_len + 2;
533 MBEDTLS_SSL_CHK_BUF_READ_PTR( identity, identities_end, identity_len + 4 );
Jerry Yu82534862022-08-30 10:42:33 +0800534 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE( identity , identity_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800535 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000536
Jerry Yu568ec252022-07-22 21:27:34 +0800537 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, binders_end, 1 + 32 );
538 binder_len = *p_binder_len;
539 binder = p_binder_len + 1;
540 MBEDTLS_SSL_CHK_BUF_READ_PTR( binder, binders_end, binder_len );
541 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800542
Jerry Yu96a2e362022-07-21 15:11:34 +0800543 identity_id++;
544 if( matched_identity != -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000545 continue;
546
Jerry Yu96a2e362022-07-21 15:11:34 +0800547 ret = ssl_tls13_offered_psks_check_identity_match(
Jerry Yu82534862022-08-30 10:42:33 +0800548 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800549 &psk_type, &session );
Jerry Yue95c8af2022-07-26 15:48:20 +0800550 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800551 continue;
552
Jerry Yuf35ba382022-08-23 17:58:26 +0800553 MBEDTLS_SSL_DEBUG_MSG( 4, ( "found matched identity" ) );
Jerry Yu0baf9072022-08-25 11:21:04 +0800554 switch( psk_type )
555 {
556 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
557 ret = ssl_tls13_select_ciphersuite_for_psk(
558 ssl, ciphersuites, ciphersuites_end,
559 &cipher_suite, &ciphersuite_info );
560 break;
561 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800562#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800563 ret = ssl_tls13_select_ciphersuite_for_resumption(
Jerry Yu82534862022-08-30 10:42:33 +0800564 ssl, ciphersuites, ciphersuites_end, &session,
Jerry Yu0baf9072022-08-25 11:21:04 +0800565 &cipher_suite, &ciphersuite_info );
Jerry Yu4746b102022-09-13 11:11:48 +0800566 if( ret != 0 )
567 mbedtls_ssl_session_free( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800568#else
569 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
570#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800571 break;
572 default:
573 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
574 }
Jerry Yuf35ba382022-08-23 17:58:26 +0800575 if( ret != 0 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800576 {
Jerry Yuf35ba382022-08-23 17:58:26 +0800577 /* See below, no cipher_suite available, abort handshake */
578 MBEDTLS_SSL_PEND_FATAL_ALERT(
579 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
580 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
581 MBEDTLS_SSL_DEBUG_RET(
Jerry Yu0baf9072022-08-25 11:21:04 +0800582 2, "ssl_tls13_select_ciphersuite", ret );
Jerry Yuf35ba382022-08-23 17:58:26 +0800583 return( ret );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800584 }
585
Jerry Yu96a2e362022-07-21 15:11:34 +0800586 ret = ssl_tls13_offered_psks_check_binder_match(
Jerry Yu29d9faa2022-08-23 17:52:45 +0800587 ssl, binder, binder_len, psk_type,
588 mbedtls_psa_translate_md( ciphersuite_info->mac ) );
Jerry Yue9d4fc02022-08-20 19:21:15 +0800589 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800590 {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800591 /* For security reasons, the handshake should be aborted when we
592 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
593 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800594#if defined(MBEDTLS_SSL_SESSION_TICKETS)
595 mbedtls_ssl_session_free( &session );
596#endif
Jerry Yuc5a23a02022-08-25 10:51:44 +0800597 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Invalid binder." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800598 MBEDTLS_SSL_DEBUG_RET( 1,
599 "ssl_tls13_offered_psks_check_binder_match" , ret );
600 MBEDTLS_SSL_PEND_FATAL_ALERT(
601 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
602 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
603 return( ret );
604 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800605
606 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800607
608 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800609 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800610 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yue5834fd2022-08-29 20:16:09 +0800611 MBEDTLS_SSL_DEBUG_MSG( 2, ( "overwrite ciphersuite: %04x - %s",
612 cipher_suite, ciphersuite_info->name ) );
Jerry Yu82534862022-08-30 10:42:33 +0800613#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu82534862022-08-30 10:42:33 +0800614 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
615 {
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800616 ret = ssl_tls13_session_copy_ticket( ssl->session_negotiate,
617 &session );
Jerry Yu82534862022-08-30 10:42:33 +0800618 mbedtls_ssl_session_free( &session );
619 if( ret != 0 )
620 return( ret );
621 }
622#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000623 }
624
Jerry Yu568ec252022-07-22 21:27:34 +0800625 if( p_identity_len != identities_end || p_binder_len != binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000626 {
Tom Cosgrove1797b052022-12-04 17:19:59 +0000627 MBEDTLS_SSL_DEBUG_MSG( 3, ( "pre_shared_key extension decode error" ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000628 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
629 MBEDTLS_ERR_SSL_DECODE_ERROR );
630 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
631 }
632
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800633 /* Update the handshake transcript with the binder list. */
634 ssl->handshake->update_checksum( ssl,
635 identities_end,
636 (size_t)( binders_end - identities_end ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800637 if( matched_identity == -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000638 {
Jerry Yue9d4fc02022-08-20 19:21:15 +0800639 MBEDTLS_SSL_DEBUG_MSG( 3, ( "No matched PSK or ticket." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800640 return( MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY );
Jerry Yu1c105562022-07-10 06:32:38 +0000641 }
642
Jerry Yu96a2e362022-07-21 15:11:34 +0800643 ssl->handshake->selected_identity = (uint16_t)matched_identity;
644 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Pre shared key found" ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000645
Jerry Yu96a2e362022-07-21 15:11:34 +0800646 return( 0 );
Jerry Yu1c105562022-07-10 06:32:38 +0000647}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000648
649/*
650 * struct {
651 * select ( Handshake.msg_type ) {
652 * ....
653 * case server_hello:
654 * uint16 selected_identity;
655 * }
656 * } PreSharedKeyExtension;
657 */
Jerry Yubb852022022-07-20 21:10:44 +0800658static int ssl_tls13_write_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
659 unsigned char *buf,
660 unsigned char *end,
661 size_t *olen )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000662{
663 unsigned char *p = (unsigned char*)buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000664
665 *olen = 0;
666
David Horstmann21b89762022-10-06 18:34:28 +0100667 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000668#if defined(MBEDTLS_USE_PSA_CRYPTO)
David Horstmann21b89762022-10-06 18:34:28 +0100669 not_using_psk = ( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000670#else
David Horstmann21b89762022-10-06 18:34:28 +0100671 not_using_psk = ( ssl->handshake->psk == NULL );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672#endif
David Horstmann21b89762022-10-06 18:34:28 +0100673 if( not_using_psk )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000674 {
675 /* We shouldn't have called this extension writer unless we've
676 * chosen to use a PSK. */
677 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
678 }
679
680 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding pre_shared_key extension" ) );
681 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
682
Jerry Yu032b15ce2022-07-11 06:10:03 +0000683 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684 MBEDTLS_PUT_UINT16_BE( 2, p, 2 );
685
Jerry Yu96a2e362022-07-21 15:11:34 +0800686 MBEDTLS_PUT_UINT16_BE( ssl->handshake->selected_identity, p, 4 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000687
688 *olen = 6;
689
Jerry Yu96a2e362022-07-21 15:11:34 +0800690 MBEDTLS_SSL_DEBUG_MSG( 4, ( "sent selected_identity: %u",
691 ssl->handshake->selected_identity ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000692
Jerry Yub95dd362022-11-08 21:19:34 +0800693 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY );
694
Jerry Yu032b15ce2022-07-11 06:10:03 +0000695 return( 0 );
696}
697
Ronald Cron41a443a2022-10-04 16:38:25 +0200698#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000699
XiaokangQian7807f9f2022-02-15 10:04:37 +0000700/* From RFC 8446:
701 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000702 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000703 * } SupportedVersions;
704 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200705MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000706static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
707 const unsigned char *buf,
708 const unsigned char *end )
709{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000710 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000711 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000712 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000713 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000714 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000715
716 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000717 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718 p += 1;
719
XiaokangQian4080a7f2022-04-11 09:55:18 +0000720 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000721 versions_end = p + versions_len;
722 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000723 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000724 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000725 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000726 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000727
728 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000729 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000730 {
731 tls13_supported = 1;
732 break;
733 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000734 }
735
XiaokangQianb67384d2022-04-19 00:02:38 +0000736 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
739
740 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
741 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
742 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
743 }
744
XiaokangQiande333912022-04-20 08:49:42 +0000745 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000746 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000747
XiaokangQian7807f9f2022-02-15 10:04:37 +0000748 return( 0 );
749}
750
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000751#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000752/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753 *
754 * From RFC 8446:
755 * enum {
756 * ... (0xFFFF)
757 * } NamedGroup;
758 * struct {
759 * NamedGroup named_group_list<2..2^16-1>;
760 * } NamedGroupList;
761 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200762MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800763static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
764 const unsigned char *buf,
765 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000766{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000767 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000768 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000769 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000770
771 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000772 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000773 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000774 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000775 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000776 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000777 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778
XiaokangQian08037552022-04-20 07:16:41 +0000779 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780 {
XiaokangQian08037552022-04-20 07:16:41 +0000781 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000782 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000783 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
784 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000785
Jerry Yuc1be19f2022-04-23 16:11:39 +0800786 MBEDTLS_SSL_DEBUG_MSG( 2,
787 ( "got named group: %s(%04x)",
788 mbedtls_ssl_named_group_to_str( named_group ),
789 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000790
791 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
792 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000793 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000794 {
XiaokangQian08037552022-04-20 07:16:41 +0000795 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000796 }
797
Jerry Yuc1be19f2022-04-23 16:11:39 +0800798 MBEDTLS_SSL_DEBUG_MSG( 2,
799 ( "add named group %s(%04x) into received list.",
800 mbedtls_ssl_named_group_to_str( named_group ),
801 named_group ) );
802
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000803 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804 }
805
806 return( 0 );
807
808}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000809#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000810
XiaokangQian08037552022-04-20 07:16:41 +0000811#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
812
XiaokangQian88408882022-04-02 10:15:03 +0000813#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814/*
815 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000816 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000817 *
818 * Possible return values are:
819 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000820 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000821 * does not match a group supported by the server. A HelloRetryRequest will
822 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000823 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800824 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200825MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000826static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
827 const unsigned char *buf,
828 const unsigned char *end )
829{
XiaokangQianb67384d2022-04-19 00:02:38 +0000830 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000832 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800833 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000834
835 /* From RFC 8446:
836 *
837 * struct {
838 * KeyShareEntry client_shares<0..2^16-1>;
839 * } KeyShareClientHello;
840 *
841 */
842
XiaokangQian7807f9f2022-02-15 10:04:37 +0000843 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000844 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000845 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000846 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000847
848 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000849 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000850
851 /* We try to find a suitable key share entry and copy it to the
852 * handshake context. Later, we have to find out whether we can do
853 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000854 * dismiss it and send a HelloRetryRequest message.
855 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000856
Jerry Yuc1be19f2022-04-23 16:11:39 +0800857 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000858 {
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 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000869 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000870 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800871 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
872 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800873 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000874 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 */
XiaokangQian060d8672022-04-21 09:24:56 +0000880 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800881 ! mbedtls_ssl_named_group_is_supported( group ) ||
882 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000883 {
884 continue;
885 }
XiaokangQian060d8672022-04-21 09:24:56 +0000886
XiaokangQian7807f9f2022-02-15 10:04:37 +0000887 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000888 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000889 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000890 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
891 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
893 mbedtls_ssl_named_group_to_str( group ),
894 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000895 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800896 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000897 if( ret != 0 )
898 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000899
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000900 }
901 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000902 {
903 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000904 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000905 continue;
906 }
907
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000908 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000909 }
910
Jerry Yuc1be19f2022-04-23 16:11:39 +0800911
912 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000913 {
914 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000915 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000916 }
917 return( 0 );
918}
XiaokangQian88408882022-04-02 10:15:03 +0000919#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000920
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200921MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000922static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000923 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000924{
Jerry Yu0c354a22022-08-29 15:25:36 +0800925 int masked = ssl->handshake->received_extensions & exts_mask;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000926 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000927}
928
Jerry Yue5991322022-11-07 14:03:44 +0800929#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200930MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000931static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
932 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000933{
Jerry Yu77f01482022-07-11 07:03:24 +0000934 return( ssl_tls13_client_hello_has_exts(
935 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800936 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) |
937 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) |
938 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000939}
Jerry Yue5991322022-11-07 14:03:44 +0800940#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000941
Jerry Yue5991322022-11-07 14:03:44 +0800942#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000943MBEDTLS_CHECK_RETURN_CRITICAL
944static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
945 mbedtls_ssl_context *ssl )
946{
947 return( ssl_tls13_client_hello_has_exts(
948 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800949 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) |
950 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) );
Jerry Yu77f01482022-07-11 07:03:24 +0000951}
Jerry Yue5991322022-11-07 14:03:44 +0800952#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000953
Jerry Yue5991322022-11-07 14:03:44 +0800954#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000955MBEDTLS_CHECK_RETURN_CRITICAL
956static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
957 mbedtls_ssl_context *ssl )
958{
959 return( ssl_tls13_client_hello_has_exts(
960 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800961 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) |
962 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) |
963 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) |
964 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) );
Jerry Yu77f01482022-07-11 07:03:24 +0000965}
Jerry Yue5991322022-11-07 14:03:44 +0800966#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000967
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200968MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000969static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000970{
Jerry Yue5991322022-11-07 14:03:44 +0800971#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000972 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
973 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
Jerry Yue5991322022-11-07 14:03:44 +0800974#else
975 ((void) ssl);
976 return( 0 );
977#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000978}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000979
Jerry Yu77f01482022-07-11 07:03:24 +0000980MBEDTLS_CHECK_RETURN_CRITICAL
981static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
982{
Jerry Yue5991322022-11-07 14:03:44 +0800983#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000984 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
985 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
986 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
987#else
988 ((void) ssl);
989 return( 0 );
990#endif
991}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000992
Jerry Yu77f01482022-07-11 07:03:24 +0000993MBEDTLS_CHECK_RETURN_CRITICAL
994static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
995{
Jerry Yue5991322022-11-07 14:03:44 +0800996#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000997 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
998 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
999 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
1000#else
1001 ((void) ssl);
1002 return( 0 );
1003#endif
1004}
1005
1006static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1007{
1008 /*
1009 * Determine the key exchange algorithm to use.
1010 * There are three types of key exchanges supported in TLS 1.3:
1011 * - (EC)DH with ECDSA,
1012 * - (EC)DH with PSK,
1013 * - plain PSK.
1014 *
1015 * The PSK-based key exchanges may additionally be used with 0-RTT.
1016 *
1017 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001018 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1019 * 2 ) Certificate Mode ( ephemeral )
1020 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001021 */
1022
1023 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1024
Jerry Yu77f01482022-07-11 07:03:24 +00001025 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1026 {
1027 ssl->handshake->key_exchange_mode =
1028 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1029 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1030 }
1031 else
1032 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1033 {
1034 ssl->handshake->key_exchange_mode =
1035 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1036 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1037 }
1038 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001039 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1040 {
1041 ssl->handshake->key_exchange_mode =
1042 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1043 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1044 }
1045 else
Jerry Yu77f01482022-07-11 07:03:24 +00001046 {
1047 MBEDTLS_SSL_DEBUG_MSG(
1048 1,
1049 ( "ClientHello message misses mandatory extensions." ) );
1050 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1051 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1052 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1053 }
1054
1055 return( 0 );
1056
XiaokangQian7807f9f2022-02-15 10:04:37 +00001057}
1058
XiaokangQian81802f42022-06-10 13:25:22 +00001059#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001060 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001061
1062#if defined(MBEDTLS_USE_PSA_CRYPTO)
1063static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1064{
1065 switch( sig_alg )
1066 {
1067 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1068 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1069 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1070 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1071 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1072 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1073 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1074 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1075 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1076 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1077 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1078 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1079 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001080 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001081 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001082 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001083 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001084 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001085 default:
1086 return( PSA_ALG_NONE );
1087 }
1088}
1089#endif /* MBEDTLS_USE_PSA_CRYPTO */
1090
XiaokangQian23c5be62022-06-07 02:04:34 +00001091/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001092 * Pick best ( private key, certificate chain ) pair based on the signature
1093 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001094 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001095MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001096static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001097{
XiaokangQianfb665a82022-06-15 03:57:21 +00001098 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001099 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001100
1101#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1102 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001103 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001104 else
1105#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001106 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001107
XiaokangQianfb665a82022-06-15 03:57:21 +00001108 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001109 {
1110 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1111 return( -1 );
1112 }
1113
XiaokangQian81802f42022-06-10 13:25:22 +00001114 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001115 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001116 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1117 continue;
1118
1119 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1120 continue;
1121
XiaokangQianfb665a82022-06-15 03:57:21 +00001122 for( key_cert = key_cert_list; key_cert != NULL;
1123 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001124 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001125#if defined(MBEDTLS_USE_PSA_CRYPTO)
1126 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1127#endif /* MBEDTLS_USE_PSA_CRYPTO */
1128
XiaokangQianfb665a82022-06-15 03:57:21 +00001129 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1130 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001131
1132 /*
1133 * This avoids sending the client a cert it'll reject based on
1134 * keyUsage or other extensions.
1135 */
1136 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001137 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001138 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001139 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1140 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001141 {
1142 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001143 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001144 continue;
1145 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001146
Jerry Yucc539102022-06-27 16:27:35 +08001147 MBEDTLS_SSL_DEBUG_MSG( 3,
1148 ( "ssl_tls13_pick_key_cert:"
1149 "check signature algorithm %s [%04x]",
1150 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1151 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001152#if defined(MBEDTLS_USE_PSA_CRYPTO)
1153 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1154#endif /* MBEDTLS_USE_PSA_CRYPTO */
1155
Jerry Yufb526692022-06-19 11:22:49 +08001156 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001157 *sig_alg, &key_cert->cert->pk )
1158#if defined(MBEDTLS_USE_PSA_CRYPTO)
1159 && psa_alg != PSA_ALG_NONE &&
1160 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1161 PSA_KEY_USAGE_SIGN_HASH ) == 1
1162#endif /* MBEDTLS_USE_PSA_CRYPTO */
1163 )
XiaokangQian81802f42022-06-10 13:25:22 +00001164 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001165 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001166 MBEDTLS_SSL_DEBUG_MSG( 3,
1167 ( "ssl_tls13_pick_key_cert:"
1168 "selected signature algorithm"
1169 " %s [%04x]",
1170 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1171 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001172 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001173 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001174 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001175 return( 0 );
1176 }
XiaokangQian81802f42022-06-10 13:25:22 +00001177 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001178 }
1179
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001180 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1181 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001182 return( -1 );
1183}
XiaokangQian81802f42022-06-10 13:25:22 +00001184#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001185 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001186
XiaokangQian4080a7f2022-04-11 09:55:18 +00001187/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001188 *
1189 * STATE HANDLING: ClientHello
1190 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001191 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001192 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001193 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001194 *
1195 * In this case, the server progresses to sending its ServerHello.
1196 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001197 * 2) The ClientHello was well-formed but didn't match the server's
1198 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001199 *
1200 * For example, the client might not have offered a key share which
1201 * the server supports, or the server might require a cookie.
1202 *
1203 * In this case, the server sends a HelloRetryRequest.
1204 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001205 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001206 *
1207 * In this case, we abort the handshake.
1208 *
1209 */
1210
1211/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001212 * Structure of this message:
1213 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001214 * uint16 ProtocolVersion;
1215 * opaque Random[32];
1216 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001217 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001218 * struct {
1219 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1220 * Random random;
1221 * opaque legacy_session_id<0..32>;
1222 * CipherSuite cipher_suites<2..2^16-2>;
1223 * opaque legacy_compression_methods<1..2^8-1>;
1224 * Extension extensions<8..2^16-1>;
1225 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001226 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001227
1228#define SSL_CLIENT_HELLO_OK 0
1229#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1230
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001231MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001232static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1233 const unsigned char *buf,
1234 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001235{
XiaokangQianb67384d2022-04-19 00:02:38 +00001236 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1237 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001238 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001239 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001240 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001241 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001242 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001243 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001244 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001245
Ronald Cron41a443a2022-10-04 16:38:25 +02001246#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001247 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001248 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001249 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001250#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001251
XiaokangQian7807f9f2022-02-15 10:04:37 +00001252 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001253 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001254 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001255 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001256 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258 * .. . .. ciphersuite list length ( 2 bytes )
1259 * .. . .. ciphersuite list
1260 * .. . .. compression alg. list length ( 1 byte )
1261 * .. . .. compression alg. list
1262 * .. . .. extensions length ( 2 bytes, optional )
1263 * .. . .. extensions ( optional )
1264 */
1265
XiaokangQianb67384d2022-04-19 00:02:38 +00001266 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001267 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001268 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1269 * read at least up to session id length without worrying.
1270 */
1271 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1272
1273 /* ...
1274 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1275 * ...
1276 * with ProtocolVersion defined as:
1277 * uint16 ProtocolVersion;
1278 */
XiaokangQiande333912022-04-20 08:49:42 +00001279 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1280 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001281 {
1282 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1283 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1284 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001285 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001286 }
1287 p += 2;
1288
1289 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001290 * Only support TLS 1.3 currently, temporarily set the version.
1291 */
XiaokangQiande333912022-04-20 08:49:42 +00001292 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001293
Jerry Yue67bef42022-07-07 07:29:42 +00001294#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1295 /* Store minor version for later use with ticket serialization. */
1296 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001297 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001298#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001299
Jerry Yuc1be19f2022-04-23 16:11:39 +08001300 /* ...
1301 * Random random;
1302 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001303 * with Random defined as:
1304 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001305 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001306 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001307 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001309 memcpy( &handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian08037552022-04-20 07:16:41 +00001310 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001311
Jerry Yuc1be19f2022-04-23 16:11:39 +08001312 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001313 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001314 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001315 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001316 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001317 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318
XiaokangQianb67384d2022-04-19 00:02:38 +00001319 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320 {
1321 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1322 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1323 }
1324
XiaokangQian4080a7f2022-04-11 09:55:18 +00001325 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001326 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001327 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001328 /*
1329 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001330 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001331 */
1332 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001333
XiaokangQianed582dd2022-04-13 08:21:05 +00001334 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001335 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001336
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1338 p += 2;
1339
XiaokangQianb67384d2022-04-19 00:02:38 +00001340 /* Check we have enough data for the ciphersuite list, the legacy
1341 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001342 *
1343 * cipher_suites cipher_suites_len bytes
1344 * legacy_compression_methods 2 bytes
1345 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001346 */
1347 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001348
Jerry Yu24b8c812022-08-20 19:06:56 +08001349 /* ...
1350 * CipherSuite cipher_suites<2..2^16-2>;
1351 * ...
1352 * with CipherSuite defined as:
1353 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001354 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001355#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001356 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001357#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001358 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001359 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1360 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001361
1362 /*
1363 * Search for a matching ciphersuite
1364 */
XiaokangQian060d8672022-04-21 09:24:56 +00001365 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001366 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001367 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001368 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001369
XiaokangQiane8ff3502022-04-22 02:34:40 +00001370 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001371
XiaokangQiane8ff3502022-04-22 02:34:40 +00001372 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001373 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001374 ssl,cipher_suite );
1375 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001376 continue;
1377
Jerry Yu5725f1c2022-08-21 17:27:16 +08001378 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001379 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001380 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001381 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001382 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001383 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001384
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001385 if( handshake->ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001386 {
1387 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1388 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1389 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1390 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001391
XiaokangQian4080a7f2022-04-11 09:55:18 +00001392 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001393 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001394 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001395 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001396 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001397 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001398 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1399 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1400 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1401 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001402 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001403 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001404
Jerry Yuc1be19f2022-04-23 16:11:39 +08001405 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001406 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001407 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001408 * with Extension defined as:
1409 * struct {
1410 * ExtensionType extension_type;
1411 * opaque extension_data<0..2^16-1>;
1412 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001413 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001414 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001415 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001416 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001417 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001418
XiaokangQian4080a7f2022-04-11 09:55:18 +00001419 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001420
Jerry Yu63a459c2022-10-31 13:38:40 +08001421 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001422
XiaokangQian7807f9f2022-02-15 10:04:37 +00001423 while( p < extensions_end )
1424 {
1425 unsigned int extension_type;
1426 size_t extension_data_len;
1427 const unsigned char *extension_data_end;
1428
Jerry Yu0c354a22022-08-29 15:25:36 +08001429 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001430 *
1431 * The "pre_shared_key" extension MUST be the last extension in the
1432 * ClientHello (this facilitates implementation as described below).
1433 * Servers MUST check that it is the last extension and otherwise fail
1434 * the handshake with an "illegal_parameter" alert.
1435 */
Jerry Yu63a459c2022-10-31 13:38:40 +08001436 if( handshake->received_extensions & MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) )
Jerry Yu1c9247c2022-07-21 12:37:39 +08001437 {
1438 MBEDTLS_SSL_DEBUG_MSG(
1439 3, ( "pre_shared_key is not last extension." ) );
1440 MBEDTLS_SSL_PEND_FATAL_ALERT(
1441 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Jerry Yuc437ee32022-11-08 21:04:15 +08001442 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1443 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu1c9247c2022-07-21 12:37:39 +08001444 }
1445
XiaokangQian318dc762022-04-20 09:43:51 +00001446 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001447 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1448 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1449 p += 4;
1450
1451 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1452 extension_data_end = p + extension_data_len;
1453
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001454 ret = mbedtls_ssl_tls13_check_received_extension(
Jerry Yu0c354a22022-08-29 15:25:36 +08001455 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1456 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH );
1457 if( ret != 0 )
1458 return( ret );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001459
XiaokangQian7807f9f2022-02-15 10:04:37 +00001460 switch( extension_type )
1461 {
XiaokangQian40a35232022-05-07 09:02:40 +00001462#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1463 case MBEDTLS_TLS_EXT_SERVERNAME:
1464 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001465 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1466 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001467 if( ret != 0 )
1468 {
1469 MBEDTLS_SSL_DEBUG_RET(
1470 1, "mbedtls_ssl_parse_servername_ext", ret );
1471 return( ret );
1472 }
XiaokangQian40a35232022-05-07 09:02:40 +00001473 break;
1474#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1475
XiaokangQianb67384d2022-04-19 00:02:38 +00001476#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001477 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1478 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1479
1480 /* Supported Groups Extension
1481 *
1482 * When sent by the client, the "supported_groups" extension
1483 * indicates the named groups which the client supports,
1484 * ordered from most preferred to least preferred.
1485 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001486 ret = ssl_tls13_parse_supported_groups_ext(
1487 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001488 if( ret != 0 )
1489 {
1490 MBEDTLS_SSL_DEBUG_RET( 1,
1491 "mbedtls_ssl_parse_supported_groups_ext", ret );
1492 return( ret );
1493 }
1494
XiaokangQian7807f9f2022-02-15 10:04:37 +00001495 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001496#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001497
XiaokangQian88408882022-04-02 10:15:03 +00001498#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001499 case MBEDTLS_TLS_EXT_KEY_SHARE:
1500 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1501
1502 /*
1503 * Key Share Extension
1504 *
1505 * When sent by the client, the "key_share" extension
1506 * contains the endpoint's cryptographic parameters for
1507 * ECDHE/DHE key establishment methods.
1508 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001509 ret = ssl_tls13_parse_key_shares_ext(
1510 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001511 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001512 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001513 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001514 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001515 }
1516
Jerry Yu582dd062022-04-22 21:59:01 +08001517 if( ret < 0 )
1518 {
1519 MBEDTLS_SSL_DEBUG_RET(
1520 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001521 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001522 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001523
XiaokangQian7807f9f2022-02-15 10:04:37 +00001524 break;
XiaokangQian88408882022-04-02 10:15:03 +00001525#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001526
1527 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1528 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1529
1530 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001531 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001532 if( ret != 0 )
1533 {
1534 MBEDTLS_SSL_DEBUG_RET( 1,
1535 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1536 return( ret );
1537 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001538 break;
1539
Ronald Cron41a443a2022-10-04 16:38:25 +02001540#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001541 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1542 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1543
1544 ret = ssl_tls13_parse_key_exchange_modes_ext(
1545 ssl, p, extension_data_end );
1546 if( ret != 0 )
1547 {
1548 MBEDTLS_SSL_DEBUG_RET(
1549 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1550 return( ret );
1551 }
1552
Jerry Yue19e3b92022-07-08 12:04:51 +00001553 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001554#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001555
Jerry Yu1c105562022-07-10 06:32:38 +00001556 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1557 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001558 if( ( handshake->received_extensions &
Jerry Yu63a459c2022-10-31 13:38:40 +08001559 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) == 0 )
Jerry Yu13ab81d2022-07-22 23:17:11 +08001560 {
1561 MBEDTLS_SSL_PEND_FATAL_ALERT(
1562 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001563 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1564 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001565 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001566#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001567 /* Delay processing of the PSK identity once we have
1568 * found out which algorithms to use. We keep a pointer
1569 * to the buffer and the size for later processing.
1570 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001571 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001572 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001573#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001574 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001575
XiaokangQianacb39922022-06-17 10:18:48 +00001576#if defined(MBEDTLS_SSL_ALPN)
1577 case MBEDTLS_TLS_EXT_ALPN:
1578 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1579
1580 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1581 if( ret != 0 )
1582 {
1583 MBEDTLS_SSL_DEBUG_RET(
1584 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1585 return( ret );
1586 }
XiaokangQianacb39922022-06-17 10:18:48 +00001587 break;
1588#endif /* MBEDTLS_SSL_ALPN */
1589
Ronald Cron928cbd32022-10-04 16:14:26 +02001590#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001591 case MBEDTLS_TLS_EXT_SIG_ALG:
1592 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1593
Gabor Mezei078e8032022-04-27 21:17:56 +02001594 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001595 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001596 if( ret != 0 )
1597 {
1598 MBEDTLS_SSL_DEBUG_MSG( 1,
1599 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1600 ret ) );
1601 return( ret );
1602 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001603 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001604#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001605
1606 default:
Jerry Yu79aa7212022-11-08 21:30:21 +08001607 MBEDTLS_SSL_PRINT_EXT(
Jerry Yu63a459c2022-10-31 13:38:40 +08001608 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1609 extension_type, "( ignored )" );
Jerry Yu0c354a22022-08-29 15:25:36 +08001610 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001611 }
1612
1613 p += extension_data_len;
1614 }
1615
Jerry Yu7de2ff02022-11-08 21:43:46 +08001616 MBEDTLS_SSL_PRINT_EXTS( 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
Jerry Yu97be6a92022-11-09 22:43:31 +08001617 handshake->received_extensions );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001618
Jerry Yu1c105562022-07-10 06:32:38 +00001619 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1620 MBEDTLS_SSL_HS_CLIENT_HELLO,
1621 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001622
Ronald Cron41a443a2022-10-04 16:38:25 +02001623#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001624 /* Update checksum with either
1625 * - The entire content of the CH message, if no PSK extension is present
1626 * - The content up to but excluding the PSK extension, if present.
1627 */
Jerry Yu1c105562022-07-10 06:32:38 +00001628 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001629 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001630 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yu63a459c2022-10-31 13:38:40 +08001631 ( handshake->received_extensions & MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001632 {
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001633 handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001634 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001635 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001636 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001637 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001638 cipher_suites,
1639 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001640 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001641 {
Jerry Yu63a459c2022-10-31 13:38:40 +08001642 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY );
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001643 }
1644 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001645 {
Jerry Yu63a459c2022-10-31 13:38:40 +08001646 MBEDTLS_SSL_DEBUG_RET(
1647 1, "ssl_tls13_parse_pre_shared_key_ext" , ret );
Jerry Yu1c105562022-07-10 06:32:38 +00001648 return( ret );
1649 }
Jerry Yu1c105562022-07-10 06:32:38 +00001650 }
1651 else
Ronald Cron41a443a2022-10-04 16:38:25 +02001652#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001653 {
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001654 handshake->update_checksum( ssl, buf, p - buf );
Jerry Yu1c105562022-07-10 06:32:38 +00001655 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001656
Jerry Yuba9b6e92022-07-22 21:35:18 +08001657 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1658 if( ret < 0 )
1659 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001660
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001661 mbedtls_ssl_optimize_checksum( ssl, handshake->ciphersuite_info );
Jerry Yue5834fd2022-08-29 20:16:09 +08001662
XiaokangQian75fe8c72022-06-15 09:42:45 +00001663 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1664}
1665
1666/* Update the handshake state machine */
1667
Ronald Cronce7d76e2022-07-08 18:56:49 +02001668MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001669static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1670{
1671 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1672
XiaokangQian7807f9f2022-02-15 10:04:37 +00001673 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001674 * Server certificate selection
1675 */
1676 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1677 {
1678 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1679 return( ret );
1680 }
1681#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1682 ssl->handshake->sni_name = NULL;
1683 ssl->handshake->sni_name_len = 0;
1684#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001685
XiaokangQian7807f9f2022-02-15 10:04:37 +00001686 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1687 if( ret != 0 )
1688 {
1689 MBEDTLS_SSL_DEBUG_RET( 1,
1690 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1691 return( ret );
1692 }
1693
XiaokangQian7807f9f2022-02-15 10:04:37 +00001694 return( 0 );
1695
1696}
1697
1698/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001699 * Main entry point from the state machine; orchestrates the otherfunctions.
1700 */
1701
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001702MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001703static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1704{
1705
XiaokangQian08037552022-04-20 07:16:41 +00001706 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001707 unsigned char* buf = NULL;
1708 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001709 int parse_client_hello_ret;
1710
XiaokangQianed582dd2022-04-13 08:21:05 +00001711 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1712
XiaokangQianed582dd2022-04-13 08:21:05 +00001713 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1714 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1715 &buf, &buflen ) );
1716
1717 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1718 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001719 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1720 * only SSL_CLIENT_HELLO_OK or
1721 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1722 * stage as negative error codes are handled
1723 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001724
XiaokangQiancfd925f2022-04-14 07:10:37 +00001725 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001726
Jerry Yu4ca91402022-05-09 15:50:57 +08001727 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1728 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1729 else
1730 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001731
1732cleanup:
1733
1734 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1735 return( ret );
1736}
1737
1738/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001739 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001740 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001741MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001742static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1743{
Jerry Yu637a3f12022-04-20 21:37:58 +08001744 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1745 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001746 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001747 if( ssl->conf->f_rng == NULL )
1748 {
1749 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1750 return( MBEDTLS_ERR_SSL_NO_RNG );
1751 }
1752
Jerry Yu637a3f12022-04-20 21:37:58 +08001753 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001754 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1755 {
1756 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1757 return( ret );
1758 }
1759
Jerry Yu637a3f12022-04-20 21:37:58 +08001760 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001761 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1762
1763#if defined(MBEDTLS_HAVE_TIME)
1764 ssl->session_negotiate->start = time( NULL );
1765#endif /* MBEDTLS_HAVE_TIME */
1766
1767 return( ret );
1768}
1769
Jerry Yu3bf2c642022-03-30 22:02:12 +08001770/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001771 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001772 *
1773 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001774 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001775 * } SupportedVersions;
1776 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001777MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001778static int ssl_tls13_write_server_hello_supported_versions_ext(
1779 mbedtls_ssl_context *ssl,
1780 unsigned char *buf,
1781 unsigned char *end,
1782 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001783{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001784 *out_len = 0;
1785
Jerry Yu955ddd72022-04-22 22:27:33 +08001786 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001787
1788 /* Check if we have space to write the extension:
1789 * - extension_type (2 bytes)
1790 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001791 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001792 */
Jerry Yu349a6132022-04-14 20:52:56 +08001793 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001794
Jerry Yu349a6132022-04-14 20:52:56 +08001795 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001796
Jerry Yu349a6132022-04-14 20:52:56 +08001797 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001798
Jerry Yu349a6132022-04-14 20:52:56 +08001799 mbedtls_ssl_write_version( buf + 4,
1800 ssl->conf->transport,
1801 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001802
1803 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1804 ssl->tls_version ) );
1805
Jerry Yu349a6132022-04-14 20:52:56 +08001806 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001807
Jerry Yub95dd362022-11-08 21:19:34 +08001808 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
1809 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS );
1810
Jerry Yu3bf2c642022-03-30 22:02:12 +08001811 return( 0 );
1812}
1813
Jerry Yud9436a12022-04-20 22:28:09 +08001814
Jerry Yu3bf2c642022-03-30 22:02:12 +08001815
1816/* Generate and export a single key share. For hybrid KEMs, this can
1817 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001818MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001819static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1820 uint16_t named_group,
1821 unsigned char *buf,
1822 unsigned char *end,
1823 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001824{
1825 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001826
1827 *out_len = 0;
1828
Jerry Yu89e103c2022-03-30 22:43:29 +08001829#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001830 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1831 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001832 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1833 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001834 if( ret != 0 )
1835 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001836 MBEDTLS_SSL_DEBUG_RET(
1837 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1838 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 return( ret );
1840 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001841 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001842 else
1843#endif /* MBEDTLS_ECDH_C */
1844 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001845 {
1846 }
1847 else
1848 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001849 ((void) ssl);
1850 ((void) named_group);
1851 ((void) buf);
1852 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1854 }
1855
1856 return( ret );
1857}
1858
1859/*
1860 * ssl_tls13_write_key_share_ext
1861 *
1862 * Structure of key_share extension in ServerHello:
1863 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001864 * struct {
1865 * NamedGroup group;
1866 * opaque key_exchange<1..2^16-1>;
1867 * } KeyShareEntry;
1868 * struct {
1869 * KeyShareEntry server_share;
1870 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001871 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001872MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001873static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1874 unsigned char *buf,
1875 unsigned char *end,
1876 size_t *out_len )
1877{
Jerry Yu955ddd72022-04-22 22:27:33 +08001878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001879 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001880 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001881 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883
1884 *out_len = 0;
1885
1886 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1887
Jerry Yu58af2332022-09-06 11:19:31 +08001888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1889 mbedtls_ssl_named_group_to_str( group ),
1890 group ) );
1891
Jerry Yu3bf2c642022-03-30 22:02:12 +08001892 /* Check if we have space for header and length fields:
1893 * - extension_type (2 bytes)
1894 * - extension_data_length (2 bytes)
1895 * - group (2 bytes)
1896 * - key_exchange_length (2 bytes)
1897 */
1898 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001899 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1900 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001901 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001902
Jerry Yu3bf2c642022-03-30 22:02:12 +08001903 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1904 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001905 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001906 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001907 if( ret != 0 )
1908 return( ret );
1909 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001910
Jerry Yu955ddd72022-04-22 22:27:33 +08001911 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001912
Jerry Yu57d48412022-04-20 21:50:42 +08001913 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001914
Jerry Yu57d48412022-04-20 21:50:42 +08001915 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001916
Jerry Yub95dd362022-11-08 21:19:34 +08001917 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_KEY_SHARE );
1918
Jerry Yu3bf2c642022-03-30 22:02:12 +08001919 return( 0 );
1920}
Jerry Yud9436a12022-04-20 22:28:09 +08001921
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001922MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001923static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1924 unsigned char *buf,
1925 unsigned char *end,
1926 size_t *out_len )
1927{
1928 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1929 /* key_share Extension
1930 *
1931 * struct {
1932 * select (Handshake.msg_type) {
1933 * ...
1934 * case hello_retry_request:
1935 * NamedGroup selected_group;
1936 * ...
1937 * };
1938 * } KeyShare;
1939 */
1940
1941 *out_len = 0;
1942
Jerry Yub0ac10b2022-05-05 11:10:08 +08001943 /*
1944 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1945 * of the HRR is then to transmit a cookie to force the client to demonstrate
1946 * reachability at their apparent network address (primarily useful for DTLS).
1947 */
Ronald Cron79907712022-07-20 17:05:29 +02001948 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001949 return( 0 );
1950
1951 /* We should only send the key_share extension if the client's initial
1952 * key share was not acceptable. */
1953 if( ssl->handshake->offered_group_id != 0 )
1954 {
1955 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
1956 return( 0 );
1957 }
1958
1959 if( selected_group == 0 )
1960 {
1961 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
1962 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1963 }
1964
Jerry Yub0ac10b2022-05-05 11:10:08 +08001965 /* Check if we have enough space:
1966 * - extension_type (2 bytes)
1967 * - extension_data_length (2 bytes)
1968 * - selected_group (2 bytes)
1969 */
Ronald Cron154d1b62022-06-01 15:33:26 +02001970 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001971
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001972 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001973 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001974 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
1975
1976 MBEDTLS_SSL_DEBUG_MSG( 3,
1977 ( "HRR selected_group: %s (%x)",
1978 mbedtls_ssl_named_group_to_str( selected_group ),
1979 selected_group ) );
1980
1981 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001982
Jerry Yub95dd362022-11-08 21:19:34 +08001983 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_KEY_SHARE );
1984
Jerry Yub0ac10b2022-05-05 11:10:08 +08001985 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001986}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001987
1988/*
1989 * Structure of ServerHello message:
1990 *
1991 * struct {
1992 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1993 * Random random;
1994 * opaque legacy_session_id_echo<0..32>;
1995 * CipherSuite cipher_suite;
1996 * uint8 legacy_compression_method = 0;
1997 * Extension extensions<6..2^16-1>;
1998 * } ServerHello;
1999 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002000MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002001static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002002 unsigned char *buf,
2003 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002004 size_t *out_len,
2005 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002006{
Jerry Yu955ddd72022-04-22 22:27:33 +08002007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002008 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002009 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002010 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002011
2012 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002013 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014
Jerry Yucfc04b32022-04-21 09:31:58 +08002015 /* ...
2016 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2017 * ...
2018 * with ProtocolVersion defined as:
2019 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002020 */
2021 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2022 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2023 p += 2;
2024
Jerry Yu1c3e6882022-04-20 21:23:40 +08002025 /* ...
2026 * Random random;
2027 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002028 * with Random defined as:
2029 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002030 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002031 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002032 if( is_hrr )
2033 {
2034 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002035 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002036 }
2037 else
2038 {
2039 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002040 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002041 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002042 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002043 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2044 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2045
Jerry Yucfc04b32022-04-21 09:31:58 +08002046 /* ...
2047 * opaque legacy_session_id_echo<0..32>;
2048 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 */
2050 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2051 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2052 if( ssl->session_negotiate->id_len > 0 )
2053 {
2054 memcpy( p, &ssl->session_negotiate->id[0],
2055 ssl->session_negotiate->id_len );
2056 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002057
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2059 ssl->session_negotiate->id_len );
2060 }
2061
Jerry Yucfc04b32022-04-21 09:31:58 +08002062 /* ...
2063 * CipherSuite cipher_suite;
2064 * ...
2065 * with CipherSuite defined as:
2066 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 */
2068 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2069 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2070 p += 2;
2071 MBEDTLS_SSL_DEBUG_MSG( 3,
2072 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2073 mbedtls_ssl_get_ciphersuite_name(
2074 ssl->session_negotiate->ciphersuite ),
2075 ssl->session_negotiate->ciphersuite ) );
2076
Jerry Yucfc04b32022-04-21 09:31:58 +08002077 /* ...
2078 * uint8 legacy_compression_method = 0;
2079 * ...
2080 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002081 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002082 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083
Jerry Yucfc04b32022-04-21 09:31:58 +08002084 /* ...
2085 * Extension extensions<6..2^16-1>;
2086 * ...
2087 * struct {
2088 * ExtensionType extension_type; (2 bytes)
2089 * opaque extension_data<0..2^16-1>;
2090 * } Extension;
2091 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002093 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002094 p += 2;
2095
Jerry Yue74e04a2022-04-21 09:23:16 +08002096 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002097 ssl, p, end, &output_len ) ) != 0 )
2098 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002099 MBEDTLS_SSL_DEBUG_RET(
2100 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101 return( ret );
2102 }
2103 p += output_len;
2104
Jerry Yu56acc942022-07-30 23:02:36 +08002105 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002106 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002107 if( is_hrr )
2108 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2109 else
2110 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002111 if( ret != 0 )
2112 return( ret );
2113 p += output_len;
2114 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002115
Ronald Cron41a443a2022-10-04 16:38:25 +02002116#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002117 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002118 {
Jerry Yubb852022022-07-20 21:10:44 +08002119 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002120 if( ret != 0 )
2121 {
Jerry Yubb852022022-07-20 21:10:44 +08002122 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002123 ret );
2124 return( ret );
2125 }
2126 p += output_len;
2127 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002128#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002129
Jerry Yud9436a12022-04-20 22:28:09 +08002130 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002131
Jerry Yud9436a12022-04-20 22:28:09 +08002132 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2133 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002134
Jerry Yud9436a12022-04-20 22:28:09 +08002135 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002136
Jerry Yud9436a12022-04-20 22:28:09 +08002137 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002138
Jerry Yu7de2ff02022-11-08 21:43:46 +08002139 MBEDTLS_SSL_PRINT_EXTS(
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002140 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
Jerry Yu7de2ff02022-11-08 21:43:46 +08002141 MBEDTLS_SSL_HS_SERVER_HELLO,
2142 ssl->handshake->sent_extensions );
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002143
Jerry Yu3bf2c642022-03-30 22:02:12 +08002144 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002145}
2146
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002147MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002148static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2149{
2150 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002151 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002152 if( ret != 0 )
2153 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002154 MBEDTLS_SSL_DEBUG_RET( 1,
2155 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002156 ret );
2157 return( ret );
2158 }
2159
Jerry Yue110d252022-05-05 10:19:22 +08002160 return( ret );
2161}
2162
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002163MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002164static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2165{
Jerry Yu637a3f12022-04-20 21:37:58 +08002166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002167 unsigned char *buf;
2168 size_t buf_len, msg_len;
2169
2170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2171
Jerry Yuf4b27e42022-03-30 17:32:21 +08002172 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2173
Jerry Yu3bf2c642022-03-30 22:02:12 +08002174 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002175 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2176
Jerry Yu3bf2c642022-03-30 22:02:12 +08002177 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2178 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002179 &msg_len,
2180 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002181
Jerry Yu3bf2c642022-03-30 22:02:12 +08002182 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002183 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2184
Jerry Yu3bf2c642022-03-30 22:02:12 +08002185 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002186 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002187
Jerry Yue110d252022-05-05 10:19:22 +08002188 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2189
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002190#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2191 /* The server sends a dummy change_cipher_spec record immediately
2192 * after its first handshake message. This may either be after
2193 * a ServerHello or a HelloRetryRequest.
2194 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002195 mbedtls_ssl_handshake_set_state(
2196 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002197#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002198 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002199#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002200
Jerry Yuf4b27e42022-03-30 17:32:21 +08002201cleanup:
2202
2203 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2204 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002205}
2206
Jerry Yu23d1a252022-05-12 18:08:59 +08002207
2208/*
2209 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2210 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002211MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002212static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002213{
2214 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2215 if( ssl->handshake->hello_retry_request_count > 0 )
2216 {
2217 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2218 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2219 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2220 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2221 }
2222
2223 /*
2224 * Create stateless transcript hash for HRR
2225 */
2226 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2227 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2228 if( ret != 0 )
2229 {
2230 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2231 return( ret );
2232 }
2233 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2234
2235 return( 0 );
2236}
2237
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002238MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002239static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2240{
2241 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2242 unsigned char *buf;
2243 size_t buf_len, msg_len;
2244
2245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2246
Ronald Cron7b840462022-06-01 17:05:53 +02002247 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002248
2249 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2250 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2251 &buf, &buf_len ) );
2252
2253 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2254 buf + buf_len,
2255 &msg_len,
2256 1 ) );
2257 mbedtls_ssl_add_hs_msg_to_checksum(
2258 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2259
2260
2261 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2262 msg_len ) );
2263
2264 ssl->handshake->hello_retry_request_count++;
2265
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002266#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2267 /* The server sends a dummy change_cipher_spec record immediately
2268 * after its first handshake message. This may either be after
2269 * a ServerHello or a HelloRetryRequest.
2270 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002271 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002272 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002273#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002274 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002275#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002276
2277cleanup:
2278 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2279 return( ret );
2280}
2281
Jerry Yu5b64ae92022-03-30 17:15:02 +08002282/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002283 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2284 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002285
2286/*
2287 * struct {
2288 * Extension extensions<0..2 ^ 16 - 1>;
2289 * } EncryptedExtensions;
2290 *
2291 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002292MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002293static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2294 unsigned char *buf,
2295 unsigned char *end,
2296 size_t *out_len )
2297{
XiaokangQianacb39922022-06-17 10:18:48 +00002298 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002299 unsigned char *p = buf;
2300 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002301 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002302 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002303
Jerry Yu4d3841a2022-04-16 12:37:19 +08002304 *out_len = 0;
2305
2306 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002307 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002308 p += 2;
2309
Jerry Yu8937eb42022-05-03 12:12:14 +08002310 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002311 ((void) ret);
2312 ((void) output_len);
2313
2314#if defined(MBEDTLS_SSL_ALPN)
2315 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2316 if( ret != 0 )
2317 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002318 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002319#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002320
Jerry Yu8937eb42022-05-03 12:12:14 +08002321 extensions_len = ( p - p_extensions_len ) - 2;
2322 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2323
2324 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002325
2326 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2327
Jerry Yu7de2ff02022-11-08 21:43:46 +08002328 MBEDTLS_SSL_PRINT_EXTS(
2329 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, ssl->handshake->sent_extensions );
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002330
Jerry Yu4d3841a2022-04-16 12:37:19 +08002331 return( 0 );
2332}
2333
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002334MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002335static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2336{
2337 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2338 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002339 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002340
Gabor Mezei54719122022-06-28 11:34:56 +02002341 mbedtls_ssl_set_outbound_transform( ssl,
2342 ssl->handshake->transform_handshake );
2343 MBEDTLS_SSL_DEBUG_MSG(
2344 3, ( "switching to handshake transform for outbound data" ) );
2345
Jerry Yuab452cc2022-04-28 15:27:08 +08002346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002347
Jerry Yu4d3841a2022-04-16 12:37:19 +08002348 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2349 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2350
2351 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2352 ssl, buf, buf + buf_len, &msg_len ) );
2353
2354 mbedtls_ssl_add_hs_msg_to_checksum(
2355 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2356
Jerry Yu4d3841a2022-04-16 12:37:19 +08002357 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2358 ssl, buf_len, msg_len ) );
2359
Ronald Cron928cbd32022-10-04 16:14:26 +02002360#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002361 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002362 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2363 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002364 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002365#else
2366 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2367#endif
2368
Jerry Yu4d3841a2022-04-16 12:37:19 +08002369cleanup:
2370
Jerry Yuab452cc2022-04-28 15:27:08 +08002371 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002372 return( ret );
2373}
2374
Ronald Cron928cbd32022-10-04 16:14:26 +02002375#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002376#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2377#define SSL_CERTIFICATE_REQUEST_SKIP 1
2378/* Coordination:
2379 * Check whether a CertificateRequest message should be written.
2380 * Returns a negative code on failure, or
2381 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2382 * - SSL_CERTIFICATE_REQUEST_SKIP
2383 * indicating if the writing of the CertificateRequest
2384 * should be skipped or not.
2385 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002386MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002387static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2388{
2389 int authmode;
2390
XiaokangQian40a35232022-05-07 09:02:40 +00002391#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2392 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2393 authmode = ssl->handshake->sni_authmode;
2394 else
2395#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002396 authmode = ssl->conf->authmode;
2397
2398 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
Ronald Croneac00ad2022-09-13 10:16:31 +02002399 {
2400 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002401 return( SSL_CERTIFICATE_REQUEST_SKIP );
Ronald Croneac00ad2022-09-13 10:16:31 +02002402 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002403
XiaokangQianc3017f62022-05-13 05:55:41 +00002404 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002405
XiaokangQiana987e1d2022-05-07 01:25:58 +00002406 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2407}
2408
XiaokangQiancec9ae62022-05-06 07:28:50 +00002409/*
2410 * struct {
2411 * opaque certificate_request_context<0..2^8-1>;
2412 * Extension extensions<2..2^16-1>;
2413 * } CertificateRequest;
2414 *
2415 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002416MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002417static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2418 unsigned char *buf,
2419 const unsigned char *end,
2420 size_t *out_len )
2421{
2422 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2423 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002424 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002425 unsigned char *p_extensions_len;
2426
2427 *out_len = 0;
2428
2429 /* Check if we have enough space:
2430 * - certificate_request_context (1 byte)
2431 * - extensions length (2 bytes)
2432 */
2433 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2434
2435 /*
2436 * Write certificate_request_context
2437 */
2438 /*
2439 * We use a zero length context for the normal handshake
2440 * messages. For post-authentication handshake messages
2441 * this request context would be set to a non-zero value.
2442 */
2443 *p++ = 0x0;
2444
2445 /*
2446 * Write extensions
2447 */
2448 /* The extensions must contain the signature_algorithms. */
2449 p_extensions_len = p;
2450 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002451 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002452 if( ret != 0 )
2453 return( ret );
2454
XiaokangQianec6efb92022-05-06 09:53:10 +00002455 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002456 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002457
2458 *out_len = p - buf;
2459
Jerry Yu7de2ff02022-11-08 21:43:46 +08002460 MBEDTLS_SSL_PRINT_EXTS(
2461 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, ssl->handshake->sent_extensions );
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002462
XiaokangQiancec9ae62022-05-06 07:28:50 +00002463 return( 0 );
2464}
2465
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002466MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002467static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2468{
2469 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2470
2471 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2472
2473 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2474
2475 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2476 {
2477 unsigned char *buf;
2478 size_t buf_len, msg_len;
2479
2480 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2481 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2482
2483 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2484 ssl, buf, buf + buf_len, &msg_len ) );
2485
2486 mbedtls_ssl_add_hs_msg_to_checksum(
2487 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2488
2489 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2490 ssl, buf_len, msg_len ) );
2491 }
2492 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2493 {
2494 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2495 ret = 0;
2496 }
2497 else
2498 {
2499 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2500 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2501 goto cleanup;
2502 }
2503
2504 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2505cleanup:
2506
2507 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2508 return( ret );
2509}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002510
Jerry Yu4d3841a2022-04-16 12:37:19 +08002511/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002512 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002513 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002514MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002515static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002516{
Jerry Yu5a26f302022-05-10 20:46:40 +08002517 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002518
2519#if defined(MBEDTLS_X509_CRT_PARSE_C)
2520 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2521 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002522 {
Jerry Yub89125b2022-05-13 15:45:49 +08002523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002524 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2525 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002526 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002527 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002528#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002529
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002530 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2531 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002532 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002533 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2534 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002535}
2536
2537/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002538 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002539 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002540MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002541static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002542{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002543 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002544 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002545 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002546 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2547 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002548}
Ronald Cron928cbd32022-10-04 16:14:26 +02002549#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002550
2551/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002552 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002553 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002554MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002555static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002556{
Jerry Yud6e253d2022-05-18 13:59:24 +08002557 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002558
2559 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2560 if( ret != 0 )
2561 return( ret );
2562
Jerry Yue3d67cb2022-05-19 15:33:10 +08002563 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2564 if( ret != 0 )
2565 {
2566 MBEDTLS_SSL_PEND_FATAL_ALERT(
2567 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2568 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2569 return( ret );
2570 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002571
Ronald Cron63dc4632022-05-31 14:41:53 +02002572 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2573 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002574
Ronald Cron63dc4632022-05-31 14:41:53 +02002575 if( ssl->handshake->certificate_request_sent )
2576 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002577 else
Ronald Cron19385882022-06-15 16:26:13 +02002578 {
2579 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2580 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002581 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002582 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002583
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002584 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002585}
2586
2587/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002588 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002589 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002590MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002591static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002592{
Jerry Yud6e253d2022-05-18 13:59:24 +08002593 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2594
Jerry Yuff226982022-04-16 16:52:57 +08002595 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2596 if( ret != 0 )
2597 return( ret );
2598
Jerry Yu466dda82022-09-13 11:20:20 +08002599 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002600 if( ret != 0 )
2601 {
2602 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002603 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002604 }
2605
Jerry Yu03ed50b2022-04-16 17:13:30 +08002606 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002607 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002608}
2609
2610/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002611 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002612 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002613MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002614static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002615{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002616 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2617
Jerry Yu03ed50b2022-04-16 17:13:30 +08002618 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002619
2620#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08002621 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET );
Jerry Yufca4d572022-07-21 10:37:48 +08002622#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002623 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002624#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002625 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002626}
2627
2628/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002629 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002630 */
2631#define SSL_NEW_SESSION_TICKET_SKIP 0
2632#define SSL_NEW_SESSION_TICKET_WRITE 1
2633MBEDTLS_CHECK_RETURN_CRITICAL
2634static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2635{
2636 /* Check whether the use of session tickets is enabled */
2637 if( ssl->conf->f_ticket_write == NULL )
2638 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002639 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2640 " callback is not set" ) );
2641 return( SSL_NEW_SESSION_TICKET_SKIP );
2642 }
2643 if( ssl->conf->new_session_tickets_count == 0 )
2644 {
2645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2646 " configured count is zero" ) );
2647 return( SSL_NEW_SESSION_TICKET_SKIP );
2648 }
2649
2650 if( ssl->handshake->new_session_tickets_count == 0 )
2651 {
2652 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2653 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002654 return( SSL_NEW_SESSION_TICKET_SKIP );
2655 }
2656
Jerry Yue67bef42022-07-07 07:29:42 +00002657 return( SSL_NEW_SESSION_TICKET_WRITE );
2658}
2659
2660#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2661MBEDTLS_CHECK_RETURN_CRITICAL
2662static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2663 unsigned char *ticket_nonce,
2664 size_t ticket_nonce_size )
2665{
2666 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2667 mbedtls_ssl_session *session = ssl->session;
2668 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2669 psa_algorithm_t psa_hash_alg;
2670 int hash_length;
2671
2672 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2673
2674#if defined(MBEDTLS_HAVE_TIME)
2675 session->start = mbedtls_time( NULL );
2676#endif
2677
2678 /* Generate ticket_age_add */
2679 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002680 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002681 sizeof( session->ticket_age_add ) ) != 0 ) )
2682 {
2683 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2684 return( ret );
2685 }
2686 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002687 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002688
2689 /* Generate ticket_nonce */
2690 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2691 if( ret != 0 )
2692 {
2693 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2694 return( ret );
2695 }
2696 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2697 ticket_nonce, ticket_nonce_size );
2698
2699 ciphersuite_info =
2700 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2701 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2702 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002703 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002704 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002705 {
Jerry Yue67bef42022-07-07 07:29:42 +00002706 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002707 }
2708
Jerry Yue67bef42022-07-07 07:29:42 +00002709 /* In this code the psk key length equals the length of the hash */
2710 session->resumption_key_len = hash_length;
2711 session->ciphersuite = ciphersuite_info->id;
2712
2713 /* Compute resumption key
2714 *
2715 * HKDF-Expand-Label( resumption_master_secret,
2716 * "resumption", ticket_nonce, Hash.length )
2717 */
2718 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2719 psa_hash_alg,
2720 session->app_secrets.resumption_master_secret,
2721 hash_length,
2722 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2723 ticket_nonce,
2724 ticket_nonce_size,
2725 session->resumption_key,
2726 hash_length );
2727
2728 if( ret != 0 )
2729 {
2730 MBEDTLS_SSL_DEBUG_RET( 2,
2731 "Creating the ticket-resumed PSK failed",
2732 ret );
2733 return ( ret );
2734 }
2735 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2736 session->resumption_key,
2737 session->resumption_key_len );
2738
2739 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2740 session->app_secrets.resumption_master_secret,
2741 hash_length );
2742
2743 return( 0 );
2744}
2745
2746/* This function creates a NewSessionTicket message in the following format:
2747 *
2748 * struct {
2749 * uint32 ticket_lifetime;
2750 * uint32 ticket_age_add;
2751 * opaque ticket_nonce<0..255>;
2752 * opaque ticket<1..2^16-1>;
2753 * Extension extensions<0..2^16-2>;
2754 * } NewSessionTicket;
2755 *
2756 * The ticket inside the NewSessionTicket message is an encrypted container
2757 * carrying the necessary information so that the server is later able to
2758 * re-start the communication.
2759 *
2760 * The following fields are placed inside the ticket by the
2761 * f_ticket_write() function:
2762 *
2763 * - creation time (start)
2764 * - flags (flags)
2765 * - age add (ticket_age_add)
2766 * - key (key)
2767 * - key length (key_len)
2768 * - ciphersuite (ciphersuite)
2769 */
2770MBEDTLS_CHECK_RETURN_CRITICAL
2771static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2772 unsigned char *buf,
2773 unsigned char *end,
2774 size_t *out_len,
2775 unsigned char *ticket_nonce,
2776 size_t ticket_nonce_size )
2777{
2778 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2779 unsigned char *p = buf;
2780 mbedtls_ssl_session *session = ssl->session;
2781 size_t ticket_len;
2782 uint32_t ticket_lifetime;
2783
2784 *out_len = 0;
2785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2786
2787 /*
2788 * ticket_lifetime 4 bytes
2789 * ticket_age_add 4 bytes
2790 * ticket_nonce 1 + ticket_nonce_size bytes
2791 * ticket >=2 bytes
2792 */
2793 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2794
2795 /* Generate ticket and ticket_lifetime */
2796 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2797 session,
2798 p + 9 + ticket_nonce_size + 2,
2799 end,
2800 &ticket_len,
2801 &ticket_lifetime);
2802 if( ret != 0 )
2803 {
2804 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2805 return( ret );
2806 }
2807 /* RFC 8446 4.6.1
2808 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2809 * unsigned integer in network byte order from the time of ticket
2810 * issuance. Servers MUST NOT use any value greater than
2811 * 604800 seconds (7 days). The value of zero indicates that the
2812 * ticket should be discarded immediately. Clients MUST NOT cache
2813 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2814 * and MAY delete tickets earlier based on local policy. A server
2815 * MAY treat a ticket as valid for a shorter period of time than what
2816 * is stated in the ticket_lifetime.
2817 */
Xiaokang Qian28af5012022-10-13 08:18:19 +00002818 if( ticket_lifetime > 604800 )
2819 ticket_lifetime = 604800;
Jerry Yue67bef42022-07-07 07:29:42 +00002820 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2821 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2822 ( unsigned int )ticket_lifetime ) );
2823
2824 /* Write ticket_age_add */
2825 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2826 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2827 ( unsigned int )session->ticket_age_add ) );
2828
2829 /* Write ticket_nonce */
2830 p[8] = ( unsigned char )ticket_nonce_size;
2831 if( ticket_nonce_size > 0 )
2832 {
2833 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2834 }
2835 p += 9 + ticket_nonce_size;
2836
2837 /* Write ticket */
2838 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2839 p += 2;
2840 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2841 p += ticket_len;
2842
2843 /* Ticket Extensions
2844 *
2845 * Note: We currently don't have any extensions.
2846 * Set length to zero.
2847 */
Jerry Yuedab6372022-10-31 14:37:31 +08002848 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2849
Jerry Yue67bef42022-07-07 07:29:42 +00002850 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2851 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2852 p += 2;
2853
2854 *out_len = p - buf;
2855 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2856 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2857
Jerry Yu7de2ff02022-11-08 21:43:46 +08002858 MBEDTLS_SSL_PRINT_EXTS(
2859 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET, ssl->handshake->sent_extensions );
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002860
Jerry Yue67bef42022-07-07 07:29:42 +00002861 return( 0 );
2862}
2863
2864/*
Jerry Yua8d3c502022-10-30 14:51:23 +08002865 * Handler for MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00002866 */
2867static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2868{
2869 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2870
2871 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2872
2873 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2874 {
2875 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2876 unsigned char *buf;
2877 size_t buf_len, msg_len;
2878
2879 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2880 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2881
2882 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2883 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2884
2885 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2886 ssl, buf, buf + buf_len, &msg_len,
2887 ticket_nonce, sizeof( ticket_nonce ) ) );
2888
Jerry Yue67bef42022-07-07 07:29:42 +00002889 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2890 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002891
Jerry Yu359e65f2022-09-22 23:47:43 +08002892 /* Limit session tickets count to one when resumption connection.
2893 *
2894 * See document of mbedtls_ssl_conf_new_session_tickets.
2895 */
2896 if( ssl->handshake->resume == 1 )
2897 ssl->handshake->new_session_tickets_count = 0;
2898 else
2899 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002900
Jerry Yua8d3c502022-10-30 14:51:23 +08002901 mbedtls_ssl_handshake_set_state(
2902 ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002903 }
2904 else
2905 {
2906 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2907 }
2908
Jerry Yue67bef42022-07-07 07:29:42 +00002909cleanup:
2910
2911 return( ret );
2912}
2913#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2914
2915/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002916 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002917 */
Jerry Yu27561932021-08-27 17:07:38 +08002918int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002919{
XiaokangQian08037552022-04-20 07:16:41 +00002920 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002921
2922 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2923 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2924
Jerry Yue3b34122021-09-28 17:53:35 +08002925 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2926 mbedtls_ssl_states_str( ssl->state ),
2927 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002928
XiaokangQian7807f9f2022-02-15 10:04:37 +00002929 switch( ssl->state )
2930 {
2931 /* start state */
2932 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002933 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002934 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002935 break;
2936
XiaokangQian7807f9f2022-02-15 10:04:37 +00002937 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002938 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002939 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002940 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002941 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002942
Jerry Yuf41553b2022-05-09 22:20:30 +08002943 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2944 ret = ssl_tls13_write_hello_retry_request( ssl );
2945 if( ret != 0 )
2946 {
2947 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2948 return( ret );
2949 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002950 break;
2951
Jerry Yu5b64ae92022-03-30 17:15:02 +08002952 case MBEDTLS_SSL_SERVER_HELLO:
2953 ret = ssl_tls13_write_server_hello( ssl );
2954 break;
2955
Xiaofei Baicba64af2022-02-15 10:00:56 +00002956 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002957 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002958 if( ret != 0 )
2959 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002960 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2961 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002962 }
Jerry Yu48330562022-05-06 21:35:44 +08002963 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002964
Ronald Cron928cbd32022-10-04 16:14:26 +02002965#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002966 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002967 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002968 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002969
Jerry Yu83da34e2022-04-16 13:59:52 +08002970 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2971 ret = ssl_tls13_write_server_certificate( ssl );
2972 break;
2973
2974 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
2975 ret = ssl_tls13_write_certificate_verify( ssl );
2976 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002977#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002978
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002979 /*
2980 * Injection of dummy-CCS's for middlebox compatibility
2981 */
2982#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002983 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002984 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2985 if( ret == 0 )
2986 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2987 break;
2988
2989 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
2990 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2991 if( ret == 0 )
2992 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2993 break;
2994#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2995
Jerry Yu69dd8d42022-04-16 12:51:26 +08002996 case MBEDTLS_SSL_SERVER_FINISHED:
2997 ret = ssl_tls13_write_server_finished( ssl );
2998 break;
2999
3000 case MBEDTLS_SSL_CLIENT_FINISHED:
3001 ret = ssl_tls13_process_client_finished( ssl );
3002 break;
3003
Jerry Yu69dd8d42022-04-16 12:51:26 +08003004 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3005 ret = ssl_tls13_handshake_wrapup( ssl );
3006 break;
3007
Ronald Cron766c0cd2022-10-18 12:17:11 +02003008#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003009 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3010 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003011 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003012 {
Ronald Cron209cae92022-06-07 10:30:19 +02003013 if( ssl->session_negotiate->peer_cert != NULL )
3014 {
3015 mbedtls_ssl_handshake_set_state(
3016 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3017 }
3018 else
Ronald Cron19385882022-06-15 16:26:13 +02003019 {
3020 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003021 mbedtls_ssl_handshake_set_state(
3022 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003023 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003024 }
3025 break;
3026
3027 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3028 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3029 if( ret == 0 )
3030 {
3031 mbedtls_ssl_handshake_set_state(
3032 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3033 }
3034 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003035#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003036
Jerry Yue67bef42022-07-07 07:29:42 +00003037#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua8d3c502022-10-30 14:51:23 +08003038 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET:
Jerry Yue67bef42022-07-07 07:29:42 +00003039 ret = ssl_tls13_write_new_session_ticket( ssl );
3040 if( ret != 0 )
3041 {
3042 MBEDTLS_SSL_DEBUG_RET( 1,
3043 "ssl_tls13_write_new_session_ticket ",
3044 ret );
3045 }
3046 break;
Jerry Yua8d3c502022-10-30 14:51:23 +08003047 case MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET_FLUSH:
Jerry Yue67bef42022-07-07 07:29:42 +00003048 /* This state is necessary to do the flush of the New Session
Jerry Yua8d3c502022-10-30 14:51:23 +08003049 * Ticket message written in MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET
Jerry Yue67bef42022-07-07 07:29:42 +00003050 * as part of ssl_prepare_handshake_step.
3051 */
3052 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003053
Jerry Yud0766ec2022-09-22 10:46:57 +08003054 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003055 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3056 else
Jerry Yua8d3c502022-10-30 14:51:23 +08003057 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_TLS1_3_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003058 break;
3059
3060#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3061
XiaokangQian7807f9f2022-02-15 10:04:37 +00003062 default:
3063 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003064 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003065 }
3066
3067 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003068}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003069
Jerry Yufb4b6472022-01-27 15:03:26 +08003070#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */