blob: 6591ecba0071491ac3086d44865e1f8c2c242a8f [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
XiaokangQian7807f9f2022-02-15 10:04:37 +000033#if defined(MBEDTLS_ECP_C)
34#include "mbedtls/ecp.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000035#endif /* MBEDTLS_ECP_C */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080036
XiaokangQiana9c58412022-02-17 09:41:26 +000037#if defined(MBEDTLS_PLATFORM_C)
38#include "mbedtls/platform.h"
39#else
40#include <stdlib.h>
41#define mbedtls_calloc calloc
42#define mbedtls_free free
43#endif /* MBEDTLS_PLATFORM_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +000044
Jerry Yu4d3841a2022-04-16 12:37:19 +080045#include "ssl_misc.h"
46#include "ssl_tls13_keys.h"
47#include "ssl_debug_helpers.h"
48
Jerry Yuf35ba382022-08-23 17:58:26 +080049
Jerry Yuc5a23a02022-08-25 10:51:44 +080050static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Jerry Yuf35ba382022-08-23 17:58:26 +080051 mbedtls_ssl_context *ssl,
Jerry Yuc5a23a02022-08-25 10:51:44 +080052 unsigned int cipher_suite )
Jerry Yuf35ba382022-08-23 17:58:26 +080053{
54 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
55 if( ! mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
56 return( NULL );
57
58 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
59 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
60 ssl->tls_version,
61 ssl->tls_version ) != 0 ) )
62 {
63 return( NULL );
64 }
65 return( ciphersuite_info );
66}
67
Jerry Yue19e3b92022-07-08 12:04:51 +000068#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
69/* From RFC 8446:
70 *
71 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
72 * struct {
73 * PskKeyExchangeMode ke_modes<1..255>;
74 * } PskKeyExchangeModes;
75 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080076MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue19e3b92022-07-08 12:04:51 +000077static int ssl_tls13_parse_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
78 const unsigned char *buf,
Jerry Yu299e31f2022-07-13 23:06:36 +080079 const unsigned char *end )
Jerry Yue19e3b92022-07-08 12:04:51 +000080{
Jerry Yu299e31f2022-07-13 23:06:36 +080081 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000082 size_t ke_modes_len;
83 int ke_modes = 0;
84
Jerry Yu854dd9e2022-07-15 14:28:27 +080085 /* Read ke_modes length (1 Byte) */
Jerry Yu299e31f2022-07-13 23:06:36 +080086 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
87 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000088 /* Currently, there are only two PSK modes, so even without looking
89 * at the content, something's wrong if the list has more than 2 items. */
90 if( ke_modes_len > 2 )
Jerry Yu299e31f2022-07-13 23:06:36 +080091 {
92 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
93 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +000094 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu299e31f2022-07-13 23:06:36 +080095 }
Jerry Yue19e3b92022-07-08 12:04:51 +000096
Jerry Yu299e31f2022-07-13 23:06:36 +080097 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ke_modes_len );
Jerry Yue19e3b92022-07-08 12:04:51 +000098
99 while( ke_modes_len-- != 0 )
100 {
Jerry Yu299e31f2022-07-13 23:06:36 +0800101 switch( *p++ )
Jerry Yue19e3b92022-07-08 12:04:51 +0000102 {
103 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
104 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
105 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK KEX MODE" ) );
106 break;
107 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
108 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
109 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK_EPHEMERAL KEX MODE" ) );
110 break;
111 default:
Jerry Yu299e31f2022-07-13 23:06:36 +0800112 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
113 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +0000114 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
115 }
116 }
117
118 ssl->handshake->tls13_kex_modes = ke_modes;
119 return( 0 );
120}
Jerry Yu1c105562022-07-10 06:32:38 +0000121
Jerry Yue9d4fc02022-08-20 19:21:15 +0800122#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
123#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800124
125#if defined(MBEDTLS_SSL_SESSION_TICKETS)
126
127MBEDTLS_CHECK_RETURN_CRITICAL
128static int ssl_tls13_offered_psks_check_identity_match_ticket(
129 mbedtls_ssl_context *ssl,
Jerry Yu95699e72022-08-21 19:22:23 +0800130 const unsigned char *identity,
131 size_t identity_len,
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800132 uint32_t obfuscated_ticket_age,
133 mbedtls_ssl_session *session )
Jerry Yu95699e72022-08-21 19:22:23 +0800134{
Jerry Yufd310eb2022-09-06 09:16:35 +0800135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800136 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800137#if defined(MBEDTLS_HAVE_TIME)
138 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800139 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800140 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800141#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800142
143 ((void) obfuscated_ticket_age);
144
145 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> check_identity_match_ticket" ) );
146
Jerry Yufd310eb2022-09-06 09:16:35 +0800147 /* Ticket parser is not configured, Skip */
148 if( ssl->conf->f_ticket_parse == NULL || identity_len == 0 )
Jerry Yu95699e72022-08-21 19:22:23 +0800149 return( 0 );
Jerry Yu95699e72022-08-21 19:22:23 +0800150
Jerry Yu4746b102022-09-13 11:11:48 +0800151 /* We create a copy of the encrypted ticket since the ticket parsing
152 * function is allowed to use its input buffer as an output buffer
153 * (in-place decryption). We do, however, need the original buffer for
154 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800155 */
156 ticket_buffer = mbedtls_calloc( 1, identity_len );
157 if( ticket_buffer == NULL )
158 {
159 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
160 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
161 }
162 memcpy( ticket_buffer, identity, identity_len );
163
164 if( ( ret = ssl->conf->f_ticket_parse( ssl->conf->p_ticket,
165 session,
166 ticket_buffer, identity_len ) ) != 0 )
167 {
168 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
169 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is not authentic" ) );
170 else if( ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED )
171 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is expired" ) );
172 else
173 MBEDTLS_SSL_DEBUG_RET( 1, "ticket_parse", ret );
174 }
175
176 /* We delete the temporary buffer */
177 mbedtls_free( ticket_buffer );
178
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800179 if( ret != 0 )
180 goto exit;
181
182 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
183#if defined(MBEDTLS_HAVE_TIME)
184 now = mbedtls_time( NULL );
185
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800186 if( now < session->start )
Jerry Yu95699e72022-08-21 19:22:23 +0800187 {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800188 MBEDTLS_SSL_DEBUG_MSG(
189 3, ( "Ticket expired: now=%" MBEDTLS_PRINTF_LONGLONG
190 ", start=%" MBEDTLS_PRINTF_LONGLONG,
191 (long long)now, (long long)session->start ) );
192 goto exit;
193 }
Jerry Yu95699e72022-08-21 19:22:23 +0800194
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800195 age_in_s = (uint64_t)( now - session->start );
Jerry Yu95699e72022-08-21 19:22:23 +0800196
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800197 /* RFC 8446 section 4.6.1
198 *
199 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
200 *
201 * RFC 8446 section 4.2.11.1
202 *
203 * Clients MUST NOT attempt to use tickets which have ages greater than
204 * the "ticket_lifetime" value which was provided with the ticket.
205 *
206 * For time being, the age MUST be less than 604800 seconds (7 days).
207 */
208 if( age_in_s > 604800 )
209 {
210 MBEDTLS_SSL_DEBUG_MSG(
211 3, ( "Ticket expired: Ticket age exceed limitation ticket_age=%lu",
212 (long unsigned int)age_in_s ) );
213 goto exit;
214 }
Jerry Yu95699e72022-08-21 19:22:23 +0800215
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800216 /* RFC 8446 section 4.2.10
217 *
218 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
219 * the ticket age for the selected PSK identity (computed by subtracting
220 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
221 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800223 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
224 * as the age units are different on the server (s) and in the
225 * client (ms) side. Add a -1000 ms tolerance window to take this
226 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800227 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800228 age_diff_in_ms = age_in_s * 1000;
229 age_diff_in_ms -= ( obfuscated_ticket_age - session->ticket_age_add );
230 if( age_diff_in_ms <= -1000 ||
231 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE )
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800232 {
233 MBEDTLS_SSL_DEBUG_MSG(
234 3, ( "Ticket expired: Ticket age outside tolerance window "
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800235 "( diff=%d )", (int)age_diff_in_ms ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800236 goto exit;
237 }
238
239 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800240
241#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800242
243exit:
244 if( ret != 0 )
245 mbedtls_ssl_session_free( session );
Jerry Yu95699e72022-08-21 19:22:23 +0800246
247 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= check_identity_match_ticket" ) );
248 return( ret );
249}
250#endif /* MBEDTLS_SSL_SESSION_TICKETS */
251
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800252MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000253static int ssl_tls13_offered_psks_check_identity_match(
254 mbedtls_ssl_context *ssl,
255 const unsigned char *identity,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800256 size_t identity_len,
Jerry Yu95699e72022-08-21 19:22:23 +0800257 uint32_t obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800258 int *psk_type,
259 mbedtls_ssl_session *session )
Jerry Yu1c105562022-07-10 06:32:38 +0000260{
Jerry Yu95699e72022-08-21 19:22:23 +0800261 ((void) session);
262 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800263 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800264
265 MBEDTLS_SSL_DEBUG_BUF( 4, "identity", identity, identity_len );
266 ssl->handshake->resume = 0;
267
Jerry Yu95699e72022-08-21 19:22:23 +0800268#if defined(MBEDTLS_SSL_SESSION_TICKETS)
269 if( ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800270 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800271 session ) == SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu95699e72022-08-21 19:22:23 +0800272 {
Jerry Yu95699e72022-08-21 19:22:23 +0800273 ssl->handshake->resume = 1;
274 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
275 mbedtls_ssl_set_hs_psk( ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800276 session->resumption_key,
277 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800278
279 MBEDTLS_SSL_DEBUG_BUF( 4, "Ticket-resumed PSK:",
Jerry Yu0a55cc62022-09-15 16:15:06 +0800280 session->resumption_key,
281 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800282 MBEDTLS_SSL_DEBUG_MSG( 4, ( "ticket: obfuscated_ticket_age: %u",
283 (unsigned)obfuscated_ticket_age ) );
284 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
285 }
286#endif /* MBEDTLS_SSL_SESSION_TICKETS */
287
Jerry Yu1c105562022-07-10 06:32:38 +0000288 /* Check identity with external configured function */
289 if( ssl->conf->f_psk != NULL )
290 {
291 if( ssl->conf->f_psk(
292 ssl->conf->p_psk, ssl, identity, identity_len ) == 0 )
293 {
294 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
295 }
296 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
297 }
298
Jerry Yu96a2e362022-07-21 15:11:34 +0800299 MBEDTLS_SSL_DEBUG_BUF( 5, "identity", identity, identity_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000300 /* Check identity with pre-configured psk */
Jerry Yu2f0abc92022-07-22 19:34:48 +0800301 if( ssl->conf->psk_identity != NULL &&
302 identity_len == ssl->conf->psk_identity_len &&
Jerry Yu1c105562022-07-10 06:32:38 +0000303 mbedtls_ct_memcmp( ssl->conf->psk_identity,
304 identity, identity_len ) == 0 )
305 {
306 mbedtls_ssl_set_hs_psk( ssl, ssl->conf->psk, ssl->conf->psk_len );
307 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
308 }
309
Jerry Yu1c105562022-07-10 06:32:38 +0000310 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
311}
312
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800313MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu96a2e362022-07-21 15:11:34 +0800314static int ssl_tls13_offered_psks_check_binder_match( mbedtls_ssl_context *ssl,
315 const unsigned char *binder,
Jerry Yue95c8af2022-07-26 15:48:20 +0800316 size_t binder_len,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800317 int psk_type,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800318 psa_algorithm_t psk_hash_alg )
Jerry Yu1c105562022-07-10 06:32:38 +0000319{
320 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800321
Jerry Yudaf375a2022-07-20 21:31:43 +0800322 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000323 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800324 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800325 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800326 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000327
Jerry Yu1c105562022-07-10 06:32:38 +0000328 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800329 ret = mbedtls_ssl_get_handshake_transcript(
330 ssl, mbedtls_hash_info_md_from_psa( psk_hash_alg ),
331 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000332 if( ret != 0 )
333 return( ret );
334
Jerry Yu40f37712022-07-26 16:58:57 +0800335 ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len );
Jerry Yu96a2e362022-07-21 15:11:34 +0800336 if( ret != 0 )
337 return( ret );
338
Jerry Yu29d9faa2022-08-23 17:52:45 +0800339 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psk_hash_alg,
Jerry Yu1c105562022-07-10 06:32:38 +0000340 psk, psk_len, psk_type,
341 transcript,
342 server_computed_binder );
Jerry Yu96a2e362022-07-21 15:11:34 +0800343#if defined(MBEDTLS_USE_PSA_CRYPTO)
344 mbedtls_free( (void*)psk );
345#endif
Jerry Yu1c105562022-07-10 06:32:38 +0000346 if( ret != 0 )
347 {
348 MBEDTLS_SSL_DEBUG_MSG( 1, ( "PSK binder calculation failed." ) );
349 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
350 }
351
352 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( computed ): ",
Jerry Yu2f0abc92022-07-22 19:34:48 +0800353 server_computed_binder, transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000354 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( received ): ", binder, binder_len );
355
356 if( mbedtls_ct_memcmp( server_computed_binder, binder, binder_len ) == 0 )
357 {
358 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
359 }
360
Jerry Yudaf375a2022-07-20 21:31:43 +0800361 mbedtls_platform_zeroize( server_computed_binder,
362 sizeof( server_computed_binder ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000363 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
364}
Jerry Yu96a2e362022-07-21 15:11:34 +0800365
Jerry Yu5725f1c2022-08-21 17:27:16 +0800366MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800367static int ssl_tls13_select_ciphersuite_for_psk(
368 mbedtls_ssl_context *ssl,
369 const unsigned char *cipher_suites,
370 const unsigned char *cipher_suites_end,
371 uint16_t *selected_ciphersuite,
372 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800373{
Jerry Yuf35ba382022-08-23 17:58:26 +0800374 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800375
Jerry Yu0baf9072022-08-25 11:21:04 +0800376 *selected_ciphersuite = 0;
377 *selected_ciphersuite_info = NULL;
378
Jerry Yuf35ba382022-08-23 17:58:26 +0800379 /* RFC 8446, page 55.
380 *
381 * For externally established PSKs, the Hash algorithm MUST be set when the
382 * PSK is established or default to SHA-256 if no such algorithm is defined.
383 *
384 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385
Jerry Yu5725f1c2022-08-21 17:27:16 +0800386 /*
387 * Search for a matching ciphersuite
388 */
Jerry Yu1e05b6d2022-08-31 10:35:52 +0800389 for ( const unsigned char *p = cipher_suites;
390 p < cipher_suites_end; p += 2 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800391 {
392 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800393 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800394
395 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +0800396 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
397 cipher_suite );
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800399 continue;
400
Jerry Yu5725f1c2022-08-21 17:27:16 +0800401 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
402 * Otherwise, client should reject.
403 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800404 if( psk_hash_alg == mbedtls_psa_translate_md( ciphersuite_info->mac ) )
405 {
406 *selected_ciphersuite = cipher_suite;
407 *selected_ciphersuite_info = ciphersuite_info;
408 return( 0 );
409 }
410 }
411 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No matched ciphersuite" ) );
412 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
413}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800414
Jerry Yu82534862022-08-30 10:42:33 +0800415#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800416MBEDTLS_CHECK_RETURN_CRITICAL
417static int ssl_tls13_select_ciphersuite_for_resumption(
418 mbedtls_ssl_context *ssl,
419 const unsigned char *cipher_suites,
420 const unsigned char *cipher_suites_end,
421 mbedtls_ssl_session *session,
422 uint16_t *selected_ciphersuite,
423 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
424{
Jerry Yu82534862022-08-30 10:42:33 +0800425
Jerry Yuf35ba382022-08-23 17:58:26 +0800426 *selected_ciphersuite = 0;
427 *selected_ciphersuite_info = NULL;
Jerry Yu82534862022-08-30 10:42:33 +0800428 for( const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2 )
429 {
430 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
431 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
432
433 if( cipher_suite != session->ciphersuite )
434 continue;
435
436 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
437 cipher_suite );
438 if( ciphersuite_info == NULL )
439 continue;
440
Jerry Yu4746b102022-09-13 11:11:48 +0800441 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800442 *selected_ciphersuite_info = ciphersuite_info;
443
444 return( 0 );
Jerry Yu82534862022-08-30 10:42:33 +0800445 }
446
447 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800448}
Jerry Yuf35ba382022-08-23 17:58:26 +0800449
Jerry Yu82534862022-08-30 10:42:33 +0800450MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4746b102022-09-13 11:11:48 +0800451static int ssl_tls13_session_copy_ticket( mbedtls_ssl_session *dst,
452 const mbedtls_ssl_session *src )
Jerry Yu82534862022-08-30 10:42:33 +0800453{
Jerry Yu82534862022-08-30 10:42:33 +0800454 dst->ticket_age_add = src->ticket_age_add;
455 dst->ticket_flags = src->ticket_flags;
456 dst->resumption_key_len = src->resumption_key_len;
457 if( src->resumption_key_len == 0 )
458 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
459 memcpy( dst->resumption_key, src->resumption_key, src->resumption_key_len );
Jerry Yu4746b102022-09-13 11:11:48 +0800460
Jerry Yu82534862022-08-30 10:42:33 +0800461 return( 0 );
462}
463#endif /* MBEDTLS_SSL_SESSION_TICKETS */
464
Jerry Yu1c105562022-07-10 06:32:38 +0000465/* Parser for pre_shared_key extension in client hello
466 * struct {
467 * opaque identity<1..2^16-1>;
468 * uint32 obfuscated_ticket_age;
469 * } PskIdentity;
470 *
471 * opaque PskBinderEntry<32..255>;
472 *
473 * struct {
474 * PskIdentity identities<7..2^16-1>;
475 * PskBinderEntry binders<33..2^16-1>;
476 * } OfferedPsks;
477 *
478 * struct {
479 * select (Handshake.msg_type) {
480 * case client_hello: OfferedPsks;
481 * ....
482 * };
483 * } PreSharedKeyExtension;
484 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800485MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yubb852022022-07-20 21:10:44 +0800486static int ssl_tls13_parse_pre_shared_key_ext( mbedtls_ssl_context *ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800487 const unsigned char *pre_shared_key_ext,
488 const unsigned char *pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800489 const unsigned char *ciphersuites,
490 const unsigned char *ciphersuites_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000491{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800492 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800493 const unsigned char *p_identity_len;
494 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000495 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800496 const unsigned char *binders;
497 const unsigned char *p_binder_len;
498 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000499 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800500 int matched_identity = -1;
501 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000502
Jerry Yu29d9faa2022-08-23 17:52:45 +0800503 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key extension",
504 pre_shared_key_ext,
505 pre_shared_key_ext_end - pre_shared_key_ext );
Jerry Yu1c105562022-07-10 06:32:38 +0000506
Jerry Yu96a2e362022-07-21 15:11:34 +0800507 /* identities_len 2 bytes
508 * identities_data >= 7 bytes
509 */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800510 MBEDTLS_SSL_CHK_BUF_READ_PTR( identities, pre_shared_key_ext_end, 7 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800511 identities_len = MBEDTLS_GET_UINT16_BE( identities, 0 );
512 p_identity_len = identities + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800513 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, pre_shared_key_ext_end,
514 identities_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800515 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000516
Jerry Yu96a2e362022-07-21 15:11:34 +0800517 /* binders_len 2 bytes
518 * binders >= 33 bytes
519 */
Jerry Yu568ec252022-07-22 21:27:34 +0800520 binders = identities_end;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800521 MBEDTLS_SSL_CHK_BUF_READ_PTR( binders, pre_shared_key_ext_end, 33 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800522 binders_len = MBEDTLS_GET_UINT16_BE( binders, 0 );
523 p_binder_len = binders + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800524 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, pre_shared_key_ext_end, binders_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800525 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000526
Jerry Yu29d9faa2022-08-23 17:52:45 +0800527 ssl->handshake->update_checksum( ssl, pre_shared_key_ext,
528 identities_end - pre_shared_key_ext );
Jerry Yu96a2e362022-07-21 15:11:34 +0800529
Jerry Yu568ec252022-07-22 21:27:34 +0800530 while( p_identity_len < identities_end && p_binder_len < binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000531 {
Jerry Yu1c105562022-07-10 06:32:38 +0000532 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800533 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800534 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800535 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800536 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800537 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800538 int psk_type;
539 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800540 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800541#if defined(MBEDTLS_SSL_SESSION_TICKETS)
542 mbedtls_ssl_session session;
Jerry Yu4746b102022-09-13 11:11:48 +0800543 mbedtls_ssl_session_init( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800544#endif
Jerry Yubb852022022-07-20 21:10:44 +0800545
Jerry Yu568ec252022-07-22 21:27:34 +0800546 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, identities_end, 2 + 1 + 4 );
547 identity_len = MBEDTLS_GET_UINT16_BE( p_identity_len, 0 );
548 identity = p_identity_len + 2;
549 MBEDTLS_SSL_CHK_BUF_READ_PTR( identity, identities_end, identity_len + 4 );
Jerry Yu82534862022-08-30 10:42:33 +0800550 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE( identity , identity_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800551 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000552
Jerry Yu568ec252022-07-22 21:27:34 +0800553 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, binders_end, 1 + 32 );
554 binder_len = *p_binder_len;
555 binder = p_binder_len + 1;
556 MBEDTLS_SSL_CHK_BUF_READ_PTR( binder, binders_end, binder_len );
557 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800558
Jerry Yu96a2e362022-07-21 15:11:34 +0800559 identity_id++;
560 if( matched_identity != -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000561 continue;
562
Jerry Yu96a2e362022-07-21 15:11:34 +0800563 ret = ssl_tls13_offered_psks_check_identity_match(
Jerry Yu82534862022-08-30 10:42:33 +0800564 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800565 &psk_type, &session );
Jerry Yue95c8af2022-07-26 15:48:20 +0800566 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800567 continue;
568
Jerry Yuf35ba382022-08-23 17:58:26 +0800569 MBEDTLS_SSL_DEBUG_MSG( 4, ( "found matched identity" ) );
Jerry Yu0baf9072022-08-25 11:21:04 +0800570 switch( psk_type )
571 {
572 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
573 ret = ssl_tls13_select_ciphersuite_for_psk(
574 ssl, ciphersuites, ciphersuites_end,
575 &cipher_suite, &ciphersuite_info );
576 break;
577 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800578#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800579 ret = ssl_tls13_select_ciphersuite_for_resumption(
Jerry Yu82534862022-08-30 10:42:33 +0800580 ssl, ciphersuites, ciphersuites_end, &session,
Jerry Yu0baf9072022-08-25 11:21:04 +0800581 &cipher_suite, &ciphersuite_info );
Jerry Yu4746b102022-09-13 11:11:48 +0800582 if( ret != 0 )
583 mbedtls_ssl_session_free( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800584#else
585 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
586#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800587 break;
588 default:
589 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
590 }
Jerry Yuf35ba382022-08-23 17:58:26 +0800591 if( ret != 0 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800592 {
Jerry Yuf35ba382022-08-23 17:58:26 +0800593 /* See below, no cipher_suite available, abort handshake */
594 MBEDTLS_SSL_PEND_FATAL_ALERT(
595 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
596 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
597 MBEDTLS_SSL_DEBUG_RET(
Jerry Yu0baf9072022-08-25 11:21:04 +0800598 2, "ssl_tls13_select_ciphersuite", ret );
Jerry Yuf35ba382022-08-23 17:58:26 +0800599 return( ret );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800600 }
601
Jerry Yu96a2e362022-07-21 15:11:34 +0800602 ret = ssl_tls13_offered_psks_check_binder_match(
Jerry Yu29d9faa2022-08-23 17:52:45 +0800603 ssl, binder, binder_len, psk_type,
604 mbedtls_psa_translate_md( ciphersuite_info->mac ) );
Jerry Yue9d4fc02022-08-20 19:21:15 +0800605 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800606 {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800607 /* For security reasons, the handshake should be aborted when we
608 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
609 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800610#if defined(MBEDTLS_SSL_SESSION_TICKETS)
611 mbedtls_ssl_session_free( &session );
612#endif
Jerry Yuc5a23a02022-08-25 10:51:44 +0800613 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Invalid binder." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800614 MBEDTLS_SSL_DEBUG_RET( 1,
615 "ssl_tls13_offered_psks_check_binder_match" , ret );
616 MBEDTLS_SSL_PEND_FATAL_ALERT(
617 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
618 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
619 return( ret );
620 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800621
622 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800623
624 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800625 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800626 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yue5834fd2022-08-29 20:16:09 +0800627 MBEDTLS_SSL_DEBUG_MSG( 2, ( "overwrite ciphersuite: %04x - %s",
628 cipher_suite, ciphersuite_info->name ) );
Jerry Yu82534862022-08-30 10:42:33 +0800629#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu82534862022-08-30 10:42:33 +0800630 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
631 {
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800632 ret = ssl_tls13_session_copy_ticket( ssl->session_negotiate,
633 &session );
Jerry Yu82534862022-08-30 10:42:33 +0800634 mbedtls_ssl_session_free( &session );
635 if( ret != 0 )
636 return( ret );
637 }
638#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000639 }
640
Jerry Yu568ec252022-07-22 21:27:34 +0800641 if( p_identity_len != identities_end || p_binder_len != binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000642 {
643 MBEDTLS_SSL_DEBUG_MSG( 3, ( "pre_shared_key extesion decode error" ) );
644 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
645 MBEDTLS_ERR_SSL_DECODE_ERROR );
646 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
647 }
648
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800649 /* Update the handshake transcript with the binder list. */
650 ssl->handshake->update_checksum( ssl,
651 identities_end,
652 (size_t)( binders_end - identities_end ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800653 if( matched_identity == -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000654 {
Jerry Yue9d4fc02022-08-20 19:21:15 +0800655 MBEDTLS_SSL_DEBUG_MSG( 3, ( "No matched PSK or ticket." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800656 return( MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY );
Jerry Yu1c105562022-07-10 06:32:38 +0000657 }
658
Jerry Yu96a2e362022-07-21 15:11:34 +0800659 ssl->handshake->selected_identity = (uint16_t)matched_identity;
660 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Pre shared key found" ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000661
Jerry Yu96a2e362022-07-21 15:11:34 +0800662 return( 0 );
Jerry Yu1c105562022-07-10 06:32:38 +0000663}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000664
665/*
666 * struct {
667 * select ( Handshake.msg_type ) {
668 * ....
669 * case server_hello:
670 * uint16 selected_identity;
671 * }
672 * } PreSharedKeyExtension;
673 */
Jerry Yubb852022022-07-20 21:10:44 +0800674static int ssl_tls13_write_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
675 unsigned char *buf,
676 unsigned char *end,
677 size_t *olen )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678{
679 unsigned char *p = (unsigned char*)buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000680
681 *olen = 0;
682
683#if defined(MBEDTLS_USE_PSA_CRYPTO)
684 if( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
685#else
686 if( ssl->handshake->psk == NULL )
687#endif
688 {
689 /* We shouldn't have called this extension writer unless we've
690 * chosen to use a PSK. */
691 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
692 }
693
694 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding pre_shared_key extension" ) );
695 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
696
Jerry Yu032b15ce2022-07-11 06:10:03 +0000697 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000698 MBEDTLS_PUT_UINT16_BE( 2, p, 2 );
699
Jerry Yu96a2e362022-07-21 15:11:34 +0800700 MBEDTLS_PUT_UINT16_BE( ssl->handshake->selected_identity, p, 4 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000701
702 *olen = 6;
703
Jerry Yu96a2e362022-07-21 15:11:34 +0800704 MBEDTLS_SSL_DEBUG_MSG( 4, ( "sent selected_identity: %u",
705 ssl->handshake->selected_identity ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000706
707 return( 0 );
708}
709
Jerry Yue19e3b92022-07-08 12:04:51 +0000710#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
711
XiaokangQian7807f9f2022-02-15 10:04:37 +0000712/* From RFC 8446:
713 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000714 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000715 * } SupportedVersions;
716 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200717MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
719 const unsigned char *buf,
720 const unsigned char *end )
721{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000722 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000723 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000724 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000725 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000726 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000727
728 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000729 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000730 p += 1;
731
XiaokangQian4080a7f2022-04-11 09:55:18 +0000732 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000733 versions_end = p + versions_len;
734 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000736 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000737 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000738 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000739
740 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000741 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742 {
743 tls13_supported = 1;
744 break;
745 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000746 }
747
XiaokangQianb67384d2022-04-19 00:02:38 +0000748 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000749 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000750 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
751
752 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
753 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
754 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
755 }
756
XiaokangQiande333912022-04-20 08:49:42 +0000757 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000758 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000759
XiaokangQian7807f9f2022-02-15 10:04:37 +0000760 return( 0 );
761}
762
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000763#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000764/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000765 *
766 * From RFC 8446:
767 * enum {
768 * ... (0xFFFF)
769 * } NamedGroup;
770 * struct {
771 * NamedGroup named_group_list<2..2^16-1>;
772 * } NamedGroupList;
773 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200774MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800775static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
776 const unsigned char *buf,
777 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000779 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000780 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000781 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000782
783 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000784 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000785 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000786 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000787 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000788 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000789 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790
XiaokangQian08037552022-04-20 07:16:41 +0000791 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000792 {
XiaokangQian08037552022-04-20 07:16:41 +0000793 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000794 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000795 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
796 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000797
Jerry Yuc1be19f2022-04-23 16:11:39 +0800798 MBEDTLS_SSL_DEBUG_MSG( 2,
799 ( "got named group: %s(%04x)",
800 mbedtls_ssl_named_group_to_str( named_group ),
801 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000802
803 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
804 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000805 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000806 {
XiaokangQian08037552022-04-20 07:16:41 +0000807 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808 }
809
Jerry Yuc1be19f2022-04-23 16:11:39 +0800810 MBEDTLS_SSL_DEBUG_MSG( 2,
811 ( "add named group %s(%04x) into received list.",
812 mbedtls_ssl_named_group_to_str( named_group ),
813 named_group ) );
814
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000815 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000816 }
817
818 return( 0 );
819
820}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000821#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000822
XiaokangQian08037552022-04-20 07:16:41 +0000823#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
824
XiaokangQian88408882022-04-02 10:15:03 +0000825#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000826/*
827 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000828 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000829 *
830 * Possible return values are:
831 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000832 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000833 * does not match a group supported by the server. A HelloRetryRequest will
834 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000835 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800836 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200837MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000838static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
839 const unsigned char *buf,
840 const unsigned char *end )
841{
XiaokangQianb67384d2022-04-19 00:02:38 +0000842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000843 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000844 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800845 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000846
847 /* From RFC 8446:
848 *
849 * struct {
850 * KeyShareEntry client_shares<0..2^16-1>;
851 * } KeyShareClientHello;
852 *
853 */
854
XiaokangQian7807f9f2022-02-15 10:04:37 +0000855 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000856 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000857 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000858 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000859
860 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000861 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000862
863 /* We try to find a suitable key share entry and copy it to the
864 * handshake context. Later, we have to find out whether we can do
865 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000866 * dismiss it and send a HelloRetryRequest message.
867 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000868
Jerry Yuc1be19f2022-04-23 16:11:39 +0800869 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000870 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000871 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800872 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800873 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000874
875 /*
876 * struct {
877 * NamedGroup group;
878 * opaque key_exchange<1..2^16-1>;
879 * } KeyShareEntry;
880 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000881 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000882 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800883 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
884 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800885 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000886 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
Jerry Yu086edc22022-05-05 10:50:38 +0800887 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000888
889 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000890 * for input validation purposes.
891 */
XiaokangQian060d8672022-04-21 09:24:56 +0000892 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800893 ! mbedtls_ssl_named_group_is_supported( group ) ||
894 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000895 {
896 continue;
897 }
XiaokangQian060d8672022-04-21 09:24:56 +0000898
XiaokangQian7807f9f2022-02-15 10:04:37 +0000899 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000900 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000901 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000902 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
903 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800904 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
905 mbedtls_ssl_named_group_to_str( group ),
906 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000907 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800908 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000909 if( ret != 0 )
910 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000911
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000912 }
913 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000914 {
915 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000916 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917 continue;
918 }
919
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000920 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000921 }
922
Jerry Yuc1be19f2022-04-23 16:11:39 +0800923
924 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000925 {
926 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000927 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000928 }
929 return( 0 );
930}
XiaokangQian88408882022-04-02 10:15:03 +0000931#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000933#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000934static void ssl_tls13_debug_print_client_hello_exts( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000935{
XiaokangQian3207a322022-02-23 03:15:27 +0000936 ((void) ssl);
937
XiaokangQian7807f9f2022-02-15 10:04:37 +0000938 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Supported Extensions:" ) );
XiaokangQianb67384d2022-04-19 00:02:38 +0000939 MBEDTLS_SSL_DEBUG_MSG( 3,
940 ( "- KEY_SHARE_EXTENSION ( %s )",
941 ( ( ssl->handshake->extensions_present
942 & MBEDTLS_SSL_EXT_KEY_SHARE ) > 0 ) ? "TRUE" : "FALSE" ) );
943 MBEDTLS_SSL_DEBUG_MSG( 3,
944 ( "- PSK_KEY_EXCHANGE_MODES_EXTENSION ( %s )",
945 ( ( ssl->handshake->extensions_present
946 & MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) > 0 ) ?
947 "TRUE" : "FALSE" ) );
948 MBEDTLS_SSL_DEBUG_MSG( 3,
949 ( "- PRE_SHARED_KEY_EXTENSION ( %s )",
950 ( ( ssl->handshake->extensions_present
951 & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) > 0 ) ? "TRUE" : "FALSE" ) );
952 MBEDTLS_SSL_DEBUG_MSG( 3,
953 ( "- SIGNATURE_ALGORITHM_EXTENSION ( %s )",
954 ( ( ssl->handshake->extensions_present
955 & MBEDTLS_SSL_EXT_SIG_ALG ) > 0 ) ? "TRUE" : "FALSE" ) );
956 MBEDTLS_SSL_DEBUG_MSG( 3,
957 ( "- SUPPORTED_GROUPS_EXTENSION ( %s )",
958 ( ( ssl->handshake->extensions_present
959 & MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ) >0 ) ?
960 "TRUE" : "FALSE" ) );
961 MBEDTLS_SSL_DEBUG_MSG( 3,
962 ( "- SUPPORTED_VERSION_EXTENSION ( %s )",
963 ( ( ssl->handshake->extensions_present
964 & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) > 0 ) ?
965 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000966#if defined ( MBEDTLS_SSL_SERVER_NAME_INDICATION )
XiaokangQianb67384d2022-04-19 00:02:38 +0000967 MBEDTLS_SSL_DEBUG_MSG( 3,
968 ( "- SERVERNAME_EXTENSION ( %s )",
969 ( ( ssl->handshake->extensions_present
970 & MBEDTLS_SSL_EXT_SERVERNAME ) > 0 ) ?
971 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000972#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianacb39922022-06-17 10:18:48 +0000973#if defined ( MBEDTLS_SSL_ALPN )
974 MBEDTLS_SSL_DEBUG_MSG( 3,
975 ( "- ALPN_EXTENSION ( %s )",
976 ( ( ssl->handshake->extensions_present
977 & MBEDTLS_SSL_EXT_ALPN ) > 0 ) ?
978 "TRUE" : "FALSE" ) );
979#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000980}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000981#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000982
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200983MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000984static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000985 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000986{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000987 int masked = ssl->handshake->extensions_present & exts_mask;
988 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000989}
990
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200991MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000992static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
993 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000994{
Jerry Yu77f01482022-07-11 07:03:24 +0000995 return( ssl_tls13_client_hello_has_exts(
996 ssl,
997 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
998 MBEDTLS_SSL_EXT_KEY_SHARE |
999 MBEDTLS_SSL_EXT_SIG_ALG ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001000}
1001
Jerry Yu77f01482022-07-11 07:03:24 +00001002#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1003MBEDTLS_CHECK_RETURN_CRITICAL
1004static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
1005 mbedtls_ssl_context *ssl )
1006{
1007 return( ssl_tls13_client_hello_has_exts(
1008 ssl,
1009 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
1010 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
1011}
1012
1013MBEDTLS_CHECK_RETURN_CRITICAL
1014static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
1015 mbedtls_ssl_context *ssl )
1016{
1017 return( ssl_tls13_client_hello_has_exts(
1018 ssl,
1019 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
1020 MBEDTLS_SSL_EXT_KEY_SHARE |
1021 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
1022 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
1023}
1024#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1025
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001026MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +00001027static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001028{
Jerry Yu77f01482022-07-11 07:03:24 +00001029 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
1030 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
1031}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001032
Jerry Yu77f01482022-07-11 07:03:24 +00001033MBEDTLS_CHECK_RETURN_CRITICAL
1034static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
1035{
1036#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1037 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
1038 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
1039 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
1040#else
1041 ((void) ssl);
1042 return( 0 );
1043#endif
1044}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001045
Jerry Yu77f01482022-07-11 07:03:24 +00001046MBEDTLS_CHECK_RETURN_CRITICAL
1047static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
1048{
1049#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1050 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
1051 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
1052 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
1053#else
1054 ((void) ssl);
1055 return( 0 );
1056#endif
1057}
1058
1059static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1060{
1061 /*
1062 * Determine the key exchange algorithm to use.
1063 * There are three types of key exchanges supported in TLS 1.3:
1064 * - (EC)DH with ECDSA,
1065 * - (EC)DH with PSK,
1066 * - plain PSK.
1067 *
1068 * The PSK-based key exchanges may additionally be used with 0-RTT.
1069 *
1070 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001071 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1072 * 2 ) Certificate Mode ( ephemeral )
1073 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001074 */
1075
1076 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1077
Jerry Yu77f01482022-07-11 07:03:24 +00001078 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1079 {
1080 ssl->handshake->key_exchange_mode =
1081 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1083 }
1084 else
1085 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1086 {
1087 ssl->handshake->key_exchange_mode =
1088 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1089 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1090 }
1091 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001092 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1093 {
1094 ssl->handshake->key_exchange_mode =
1095 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1096 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1097 }
1098 else
Jerry Yu77f01482022-07-11 07:03:24 +00001099 {
1100 MBEDTLS_SSL_DEBUG_MSG(
1101 1,
1102 ( "ClientHello message misses mandatory extensions." ) );
1103 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1104 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1105 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1106 }
1107
1108 return( 0 );
1109
XiaokangQian7807f9f2022-02-15 10:04:37 +00001110}
1111
XiaokangQian81802f42022-06-10 13:25:22 +00001112#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1113 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001114
1115#if defined(MBEDTLS_USE_PSA_CRYPTO)
1116static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1117{
1118 switch( sig_alg )
1119 {
1120 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1121 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1122 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1123 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1124 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1125 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1126 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1127 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1128 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1129 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1130 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1131 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1132 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001133 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001134 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001135 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001136 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001137 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001138 default:
1139 return( PSA_ALG_NONE );
1140 }
1141}
1142#endif /* MBEDTLS_USE_PSA_CRYPTO */
1143
XiaokangQian23c5be62022-06-07 02:04:34 +00001144/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001145 * Pick best ( private key, certificate chain ) pair based on the signature
1146 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001147 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001148MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001149static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001150{
XiaokangQianfb665a82022-06-15 03:57:21 +00001151 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001152 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001153
1154#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1155 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001156 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001157 else
1158#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001159 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001160
XiaokangQianfb665a82022-06-15 03:57:21 +00001161 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001162 {
1163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1164 return( -1 );
1165 }
1166
XiaokangQian81802f42022-06-10 13:25:22 +00001167 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001168 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001169 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1170 continue;
1171
1172 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1173 continue;
1174
XiaokangQianfb665a82022-06-15 03:57:21 +00001175 for( key_cert = key_cert_list; key_cert != NULL;
1176 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001177 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001178#if defined(MBEDTLS_USE_PSA_CRYPTO)
1179 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1180#endif /* MBEDTLS_USE_PSA_CRYPTO */
1181
XiaokangQianfb665a82022-06-15 03:57:21 +00001182 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1183 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001184
1185 /*
1186 * This avoids sending the client a cert it'll reject based on
1187 * keyUsage or other extensions.
1188 */
1189 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001190 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001191 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001192 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1193 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001194 {
1195 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001196 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001197 continue;
1198 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001199
Jerry Yucc539102022-06-27 16:27:35 +08001200 MBEDTLS_SSL_DEBUG_MSG( 3,
1201 ( "ssl_tls13_pick_key_cert:"
1202 "check signature algorithm %s [%04x]",
1203 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1204 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001205#if defined(MBEDTLS_USE_PSA_CRYPTO)
1206 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1207#endif /* MBEDTLS_USE_PSA_CRYPTO */
1208
Jerry Yufb526692022-06-19 11:22:49 +08001209 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001210 *sig_alg, &key_cert->cert->pk )
1211#if defined(MBEDTLS_USE_PSA_CRYPTO)
1212 && psa_alg != PSA_ALG_NONE &&
1213 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1214 PSA_KEY_USAGE_SIGN_HASH ) == 1
1215#endif /* MBEDTLS_USE_PSA_CRYPTO */
1216 )
XiaokangQian81802f42022-06-10 13:25:22 +00001217 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001218 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001219 MBEDTLS_SSL_DEBUG_MSG( 3,
1220 ( "ssl_tls13_pick_key_cert:"
1221 "selected signature algorithm"
1222 " %s [%04x]",
1223 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1224 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001225 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001226 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001227 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001228 return( 0 );
1229 }
XiaokangQian81802f42022-06-10 13:25:22 +00001230 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001231 }
1232
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001233 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1234 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001235 return( -1 );
1236}
XiaokangQian81802f42022-06-10 13:25:22 +00001237#endif /* MBEDTLS_X509_CRT_PARSE_C &&
1238 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001239
XiaokangQian4080a7f2022-04-11 09:55:18 +00001240/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001241 *
1242 * STATE HANDLING: ClientHello
1243 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001244 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001245 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001246 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001247 *
1248 * In this case, the server progresses to sending its ServerHello.
1249 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001250 * 2) The ClientHello was well-formed but didn't match the server's
1251 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001252 *
1253 * For example, the client might not have offered a key share which
1254 * the server supports, or the server might require a cookie.
1255 *
1256 * In this case, the server sends a HelloRetryRequest.
1257 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001258 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001259 *
1260 * In this case, we abort the handshake.
1261 *
1262 */
1263
1264/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001265 * Structure of this message:
1266 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001267 * uint16 ProtocolVersion;
1268 * opaque Random[32];
1269 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001270 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001271 * struct {
1272 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1273 * Random random;
1274 * opaque legacy_session_id<0..32>;
1275 * CipherSuite cipher_suites<2..2^16-2>;
1276 * opaque legacy_compression_methods<1..2^8-1>;
1277 * Extension extensions<8..2^16-1>;
1278 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001279 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001280
1281#define SSL_CLIENT_HELLO_OK 0
1282#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1283
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001284MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001285static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1286 const unsigned char *buf,
1287 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001288{
XiaokangQianb67384d2022-04-19 00:02:38 +00001289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1290 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001291 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001292 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001293 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001294 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001295 const unsigned char *extensions_end;
Jerry Yu49ca9282022-05-05 11:05:22 +08001296 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001297
Jerry Yu1c105562022-07-10 06:32:38 +00001298#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001299 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001300 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001301 const unsigned char *pre_shared_key_ext_end = NULL;
1302#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001303
1304 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1305
1306 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001307 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001309 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001310 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001311 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001312 * .. . .. ciphersuite list length ( 2 bytes )
1313 * .. . .. ciphersuite list
1314 * .. . .. compression alg. list length ( 1 byte )
1315 * .. . .. compression alg. list
1316 * .. . .. extensions length ( 2 bytes, optional )
1317 * .. . .. extensions ( optional )
1318 */
1319
XiaokangQianb67384d2022-04-19 00:02:38 +00001320 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001321 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1323 * read at least up to session id length without worrying.
1324 */
1325 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1326
1327 /* ...
1328 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1329 * ...
1330 * with ProtocolVersion defined as:
1331 * uint16 ProtocolVersion;
1332 */
XiaokangQiande333912022-04-20 08:49:42 +00001333 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1334 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001335 {
1336 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1337 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1338 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001339 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001340 }
1341 p += 2;
1342
1343 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001344 * Only support TLS 1.3 currently, temporarily set the version.
1345 */
XiaokangQiande333912022-04-20 08:49:42 +00001346 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001347
Jerry Yue67bef42022-07-07 07:29:42 +00001348#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1349 /* Store minor version for later use with ticket serialization. */
1350 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001351 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001352#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001353
Jerry Yuc1be19f2022-04-23 16:11:39 +08001354 /* ...
1355 * Random random;
1356 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001357 * with Random defined as:
1358 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001359 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001360 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001361 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001362
XiaokangQian08037552022-04-20 07:16:41 +00001363 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
1364 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001365
Jerry Yuc1be19f2022-04-23 16:11:39 +08001366 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001367 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001368 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001369 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001370 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001371 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001372
XiaokangQianb67384d2022-04-19 00:02:38 +00001373 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001374 {
1375 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1376 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1377 }
1378
XiaokangQian4080a7f2022-04-11 09:55:18 +00001379 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001380 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001381 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001382 /*
1383 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001384 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001385 */
1386 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001387
XiaokangQianed582dd2022-04-13 08:21:05 +00001388 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001389 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001390
XiaokangQian7807f9f2022-02-15 10:04:37 +00001391 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1392 p += 2;
1393
XiaokangQianb67384d2022-04-19 00:02:38 +00001394 /* Check we have enough data for the ciphersuite list, the legacy
1395 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001396 *
1397 * cipher_suites cipher_suites_len bytes
1398 * legacy_compression_methods 2 bytes
1399 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001400 */
1401 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001402
Jerry Yu24b8c812022-08-20 19:06:56 +08001403 /* ...
1404 * CipherSuite cipher_suites<2..2^16-2>;
1405 * ...
1406 * with CipherSuite defined as:
1407 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001408 */
Jerry Yu5725f1c2022-08-21 17:27:16 +08001409#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001410 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001411#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001412 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001413 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1414 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001415
1416 /*
1417 * Search for a matching ciphersuite
1418 */
XiaokangQian060d8672022-04-21 09:24:56 +00001419 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001420 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001421 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001422 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001423
XiaokangQiane8ff3502022-04-22 02:34:40 +00001424 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001425
XiaokangQiane8ff3502022-04-22 02:34:40 +00001426 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001427 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001428 ssl,cipher_suite );
1429 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001430 continue;
1431
Jerry Yu5725f1c2022-08-21 17:27:16 +08001432 ssl->session_negotiate->ciphersuite = cipher_suite;
1433 ssl->handshake->ciphersuite_info = ciphersuite_info;
1434 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001435 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001436 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001437 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001438
1439 if( ssl->handshake->ciphersuite_info == NULL )
1440 {
1441 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1442 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1443 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1444 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001445
XiaokangQian4080a7f2022-04-11 09:55:18 +00001446 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001447 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001448 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001449 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001450 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001451 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001452 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1453 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1454 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1455 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001456 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001457 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001458
Jerry Yuc1be19f2022-04-23 16:11:39 +08001459 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001460 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001461 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001462 * with Extension defined as:
1463 * struct {
1464 * ExtensionType extension_type;
1465 * opaque extension_data<0..2^16-1>;
1466 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001467 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001468 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001469 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001470 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001471 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001472
XiaokangQian4080a7f2022-04-11 09:55:18 +00001473 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474
1475 while( p < extensions_end )
1476 {
1477 unsigned int extension_type;
1478 size_t extension_data_len;
1479 const unsigned char *extension_data_end;
1480
Jerry Yu1c9247c2022-07-21 12:37:39 +08001481 /* RFC 8446, page 57
1482 *
1483 * The "pre_shared_key" extension MUST be the last extension in the
1484 * ClientHello (this facilitates implementation as described below).
1485 * Servers MUST check that it is the last extension and otherwise fail
1486 * the handshake with an "illegal_parameter" alert.
1487 */
1488 if( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY )
1489 {
1490 MBEDTLS_SSL_DEBUG_MSG(
1491 3, ( "pre_shared_key is not last extension." ) );
1492 MBEDTLS_SSL_PEND_FATAL_ALERT(
1493 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1494 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1495 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1496 }
1497
XiaokangQian318dc762022-04-20 09:43:51 +00001498 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001499 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1500 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1501 p += 4;
1502
1503 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1504 extension_data_end = p + extension_data_len;
1505
1506 switch( extension_type )
1507 {
XiaokangQian40a35232022-05-07 09:02:40 +00001508#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1509 case MBEDTLS_TLS_EXT_SERVERNAME:
1510 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001511 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1512 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001513 if( ret != 0 )
1514 {
1515 MBEDTLS_SSL_DEBUG_RET(
1516 1, "mbedtls_ssl_parse_servername_ext", ret );
1517 return( ret );
1518 }
1519 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SERVERNAME;
1520 break;
1521#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1522
XiaokangQianb67384d2022-04-19 00:02:38 +00001523#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001524 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1525 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1526
1527 /* Supported Groups Extension
1528 *
1529 * When sent by the client, the "supported_groups" extension
1530 * indicates the named groups which the client supports,
1531 * ordered from most preferred to least preferred.
1532 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001533 ret = ssl_tls13_parse_supported_groups_ext(
1534 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001535 if( ret != 0 )
1536 {
1537 MBEDTLS_SSL_DEBUG_RET( 1,
1538 "mbedtls_ssl_parse_supported_groups_ext", ret );
1539 return( ret );
1540 }
1541
1542 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
1543 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001544#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001545
XiaokangQian88408882022-04-02 10:15:03 +00001546#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001547 case MBEDTLS_TLS_EXT_KEY_SHARE:
1548 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1549
1550 /*
1551 * Key Share Extension
1552 *
1553 * When sent by the client, the "key_share" extension
1554 * contains the endpoint's cryptographic parameters for
1555 * ECDHE/DHE key establishment methods.
1556 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001557 ret = ssl_tls13_parse_key_shares_ext(
1558 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001559 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001560 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001561 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001562 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001563 }
1564
Jerry Yu582dd062022-04-22 21:59:01 +08001565 if( ret < 0 )
1566 {
1567 MBEDTLS_SSL_DEBUG_RET(
1568 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001569 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001570 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001571
1572 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
1573 break;
XiaokangQian88408882022-04-02 10:15:03 +00001574#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001575
1576 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1577 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1578
1579 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001580 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001581 if( ret != 0 )
1582 {
1583 MBEDTLS_SSL_DEBUG_RET( 1,
1584 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1585 return( ret );
1586 }
1587 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
1588 break;
1589
Jerry Yue19e3b92022-07-08 12:04:51 +00001590#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1591 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1592 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1593
1594 ret = ssl_tls13_parse_key_exchange_modes_ext(
1595 ssl, p, extension_data_end );
1596 if( ret != 0 )
1597 {
1598 MBEDTLS_SSL_DEBUG_RET(
1599 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1600 return( ret );
1601 }
1602
1603 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
1604 break;
1605#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1606
Jerry Yu1c105562022-07-10 06:32:38 +00001607 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1608 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001609 if( ( ssl->handshake->extensions_present &
1610 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) == 0 )
1611 {
1612 MBEDTLS_SSL_PEND_FATAL_ALERT(
1613 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1614 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1615 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1616 }
Jerry Yu1c9247c2022-07-21 12:37:39 +08001617#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001618 /* Delay processing of the PSK identity once we have
1619 * found out which algorithms to use. We keep a pointer
1620 * to the buffer and the size for later processing.
1621 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001622 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001623 pre_shared_key_ext_end = extension_data_end;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001624#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001625 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1626 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001627
XiaokangQianacb39922022-06-17 10:18:48 +00001628#if defined(MBEDTLS_SSL_ALPN)
1629 case MBEDTLS_TLS_EXT_ALPN:
1630 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1631
1632 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1633 if( ret != 0 )
1634 {
1635 MBEDTLS_SSL_DEBUG_RET(
1636 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1637 return( ret );
1638 }
1639 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_ALPN;
1640 break;
1641#endif /* MBEDTLS_SSL_ALPN */
1642
XiaokangQian7807f9f2022-02-15 10:04:37 +00001643#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1644 case MBEDTLS_TLS_EXT_SIG_ALG:
1645 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1646
Gabor Mezei078e8032022-04-27 21:17:56 +02001647 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001648 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001649 if( ret != 0 )
1650 {
1651 MBEDTLS_SSL_DEBUG_MSG( 1,
1652 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1653 ret ) );
1654 return( ret );
1655 }
1656 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
1657 break;
1658#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1659
1660 default:
1661 MBEDTLS_SSL_DEBUG_MSG( 3,
1662 ( "unknown extension found: %ud ( ignoring )",
1663 extension_type ) );
1664 }
1665
1666 p += extension_data_len;
1667 }
1668
Jerry Yu1c105562022-07-10 06:32:38 +00001669#if defined(MBEDTLS_DEBUG_C)
1670 /* List all the extensions we have received */
1671 ssl_tls13_debug_print_client_hello_exts( ssl );
1672#endif /* MBEDTLS_DEBUG_C */
1673
1674 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1675 MBEDTLS_SSL_HS_CLIENT_HELLO,
1676 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001677
Jerry Yu1c105562022-07-10 06:32:38 +00001678#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001679 /* Update checksum with either
1680 * - The entire content of the CH message, if no PSK extension is present
1681 * - The content up to but excluding the PSK extension, if present.
1682 */
Jerry Yu1c105562022-07-10 06:32:38 +00001683 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001684 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001685 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yuba9b6e92022-07-22 21:35:18 +08001686 ( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001687 {
1688 ssl->handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001689 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001690 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001691 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001692 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001693 cipher_suites,
1694 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001695 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001696 {
1697 ssl->handshake->extensions_present &= ~MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001698 }
1699 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001700 {
Jerry Yubb852022022-07-20 21:10:44 +08001701 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_tls13_parse_pre_shared_key_ext" ),
Jerry Yu1c105562022-07-10 06:32:38 +00001702 ret );
1703 return( ret );
1704 }
Jerry Yu1c105562022-07-10 06:32:38 +00001705 }
1706 else
1707#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1708 {
1709 ssl->handshake->update_checksum( ssl, buf, p - buf );
1710 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001711
Jerry Yuba9b6e92022-07-22 21:35:18 +08001712 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1713 if( ret < 0 )
1714 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001715
Jerry Yue5834fd2022-08-29 20:16:09 +08001716 mbedtls_ssl_optimize_checksum( ssl, ssl->handshake->ciphersuite_info );
1717
XiaokangQian75fe8c72022-06-15 09:42:45 +00001718 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1719}
1720
1721/* Update the handshake state machine */
1722
Ronald Cronce7d76e2022-07-08 18:56:49 +02001723MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001724static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1725{
1726 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1727
XiaokangQian7807f9f2022-02-15 10:04:37 +00001728 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001729 * Server certificate selection
1730 */
1731 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1732 {
1733 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1734 return( ret );
1735 }
1736#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1737 ssl->handshake->sni_name = NULL;
1738 ssl->handshake->sni_name_len = 0;
1739#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001740
XiaokangQian7807f9f2022-02-15 10:04:37 +00001741 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1742 if( ret != 0 )
1743 {
1744 MBEDTLS_SSL_DEBUG_RET( 1,
1745 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1746 return( ret );
1747 }
1748
XiaokangQian7807f9f2022-02-15 10:04:37 +00001749 return( 0 );
1750
1751}
1752
1753/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001754 * Main entry point from the state machine; orchestrates the otherfunctions.
1755 */
1756
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001757MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001758static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1759{
1760
XiaokangQian08037552022-04-20 07:16:41 +00001761 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001762 unsigned char* buf = NULL;
1763 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001764 int parse_client_hello_ret;
1765
XiaokangQianed582dd2022-04-13 08:21:05 +00001766 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1767
XiaokangQianed582dd2022-04-13 08:21:05 +00001768 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1769 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1770 &buf, &buflen ) );
1771
1772 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1773 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001774 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1775 * only SSL_CLIENT_HELLO_OK or
1776 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1777 * stage as negative error codes are handled
1778 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001779
XiaokangQiancfd925f2022-04-14 07:10:37 +00001780 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001781
Jerry Yu4ca91402022-05-09 15:50:57 +08001782 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1783 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1784 else
1785 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001786
1787cleanup:
1788
1789 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1790 return( ret );
1791}
1792
1793/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001794 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001795 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001796MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001797static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1798{
Jerry Yu637a3f12022-04-20 21:37:58 +08001799 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1800 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001801 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001802 if( ssl->conf->f_rng == NULL )
1803 {
1804 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1805 return( MBEDTLS_ERR_SSL_NO_RNG );
1806 }
1807
Jerry Yu637a3f12022-04-20 21:37:58 +08001808 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001809 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1810 {
1811 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1812 return( ret );
1813 }
1814
Jerry Yu637a3f12022-04-20 21:37:58 +08001815 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001816 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1817
1818#if defined(MBEDTLS_HAVE_TIME)
1819 ssl->session_negotiate->start = time( NULL );
1820#endif /* MBEDTLS_HAVE_TIME */
1821
1822 return( ret );
1823}
1824
Jerry Yu3bf2c642022-03-30 22:02:12 +08001825/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001826 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001827 *
1828 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001829 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001830 * } SupportedVersions;
1831 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001832MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001833static int ssl_tls13_write_server_hello_supported_versions_ext(
1834 mbedtls_ssl_context *ssl,
1835 unsigned char *buf,
1836 unsigned char *end,
1837 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001838{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 *out_len = 0;
1840
Jerry Yu955ddd72022-04-22 22:27:33 +08001841 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001842
1843 /* Check if we have space to write the extension:
1844 * - extension_type (2 bytes)
1845 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001846 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001847 */
Jerry Yu349a6132022-04-14 20:52:56 +08001848 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849
Jerry Yu349a6132022-04-14 20:52:56 +08001850 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001851
Jerry Yu349a6132022-04-14 20:52:56 +08001852 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853
Jerry Yu349a6132022-04-14 20:52:56 +08001854 mbedtls_ssl_write_version( buf + 4,
1855 ssl->conf->transport,
1856 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001857
1858 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1859 ssl->tls_version ) );
1860
Jerry Yu349a6132022-04-14 20:52:56 +08001861 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001862
1863 return( 0 );
1864}
1865
Jerry Yud9436a12022-04-20 22:28:09 +08001866
Jerry Yu3bf2c642022-03-30 22:02:12 +08001867
1868/* Generate and export a single key share. For hybrid KEMs, this can
1869 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001870MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001871static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1872 uint16_t named_group,
1873 unsigned char *buf,
1874 unsigned char *end,
1875 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001876{
1877 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001878
1879 *out_len = 0;
1880
Jerry Yu89e103c2022-03-30 22:43:29 +08001881#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1883 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001884 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1885 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001886 if( ret != 0 )
1887 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001888 MBEDTLS_SSL_DEBUG_RET(
1889 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1890 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001891 return( ret );
1892 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001893 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001894 else
1895#endif /* MBEDTLS_ECDH_C */
1896 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001897 {
1898 }
1899 else
1900 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001901 ((void) ssl);
1902 ((void) named_group);
1903 ((void) buf);
1904 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001905 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1906 }
1907
1908 return( ret );
1909}
1910
1911/*
1912 * ssl_tls13_write_key_share_ext
1913 *
1914 * Structure of key_share extension in ServerHello:
1915 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001916 * struct {
1917 * NamedGroup group;
1918 * opaque key_exchange<1..2^16-1>;
1919 * } KeyShareEntry;
1920 * struct {
1921 * KeyShareEntry server_share;
1922 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001923 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001924MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001925static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1926 unsigned char *buf,
1927 unsigned char *end,
1928 size_t *out_len )
1929{
Jerry Yu955ddd72022-04-22 22:27:33 +08001930 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001931 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001932 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001933 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001934 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001935
1936 *out_len = 0;
1937
1938 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1939
Jerry Yu58af2332022-09-06 11:19:31 +08001940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1941 mbedtls_ssl_named_group_to_str( group ),
1942 group ) );
1943
Jerry Yu3bf2c642022-03-30 22:02:12 +08001944 /* Check if we have space for header and length fields:
1945 * - extension_type (2 bytes)
1946 * - extension_data_length (2 bytes)
1947 * - group (2 bytes)
1948 * - key_exchange_length (2 bytes)
1949 */
1950 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001951 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1952 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001953 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001954
Jerry Yu3bf2c642022-03-30 22:02:12 +08001955 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1956 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001957 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001958 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001959 if( ret != 0 )
1960 return( ret );
1961 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001962
Jerry Yu955ddd72022-04-22 22:27:33 +08001963 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001964
Jerry Yu57d48412022-04-20 21:50:42 +08001965 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001966
Jerry Yu57d48412022-04-20 21:50:42 +08001967 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001968
Jerry Yu3bf2c642022-03-30 22:02:12 +08001969 return( 0 );
1970}
Jerry Yud9436a12022-04-20 22:28:09 +08001971
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001972MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001973static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1974 unsigned char *buf,
1975 unsigned char *end,
1976 size_t *out_len )
1977{
1978 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1979 /* key_share Extension
1980 *
1981 * struct {
1982 * select (Handshake.msg_type) {
1983 * ...
1984 * case hello_retry_request:
1985 * NamedGroup selected_group;
1986 * ...
1987 * };
1988 * } KeyShare;
1989 */
1990
1991 *out_len = 0;
1992
Jerry Yub0ac10b2022-05-05 11:10:08 +08001993 /*
1994 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1995 * of the HRR is then to transmit a cookie to force the client to demonstrate
1996 * reachability at their apparent network address (primarily useful for DTLS).
1997 */
Ronald Cron79907712022-07-20 17:05:29 +02001998 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001999 return( 0 );
2000
2001 /* We should only send the key_share extension if the client's initial
2002 * key share was not acceptable. */
2003 if( ssl->handshake->offered_group_id != 0 )
2004 {
2005 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
2006 return( 0 );
2007 }
2008
2009 if( selected_group == 0 )
2010 {
2011 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
2012 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2013 }
2014
Jerry Yub0ac10b2022-05-05 11:10:08 +08002015 /* Check if we have enough space:
2016 * - extension_type (2 bytes)
2017 * - extension_data_length (2 bytes)
2018 * - selected_group (2 bytes)
2019 */
Ronald Cron154d1b62022-06-01 15:33:26 +02002020 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002021
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002022 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002023 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002024 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
2025
2026 MBEDTLS_SSL_DEBUG_MSG( 3,
2027 ( "HRR selected_group: %s (%x)",
2028 mbedtls_ssl_named_group_to_str( selected_group ),
2029 selected_group ) );
2030
2031 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002032
Jerry Yub0ac10b2022-05-05 11:10:08 +08002033 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002034}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002035
2036/*
2037 * Structure of ServerHello message:
2038 *
2039 * struct {
2040 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2041 * Random random;
2042 * opaque legacy_session_id_echo<0..32>;
2043 * CipherSuite cipher_suite;
2044 * uint8 legacy_compression_method = 0;
2045 * Extension extensions<6..2^16-1>;
2046 * } ServerHello;
2047 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002048MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002050 unsigned char *buf,
2051 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002052 size_t *out_len,
2053 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002054{
Jerry Yu955ddd72022-04-22 22:27:33 +08002055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002056 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002057 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002058 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002059
2060 *out_len = 0;
2061
Jerry Yucfc04b32022-04-21 09:31:58 +08002062 /* ...
2063 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2064 * ...
2065 * with ProtocolVersion defined as:
2066 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 */
2068 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2069 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2070 p += 2;
2071
Jerry Yu1c3e6882022-04-20 21:23:40 +08002072 /* ...
2073 * Random random;
2074 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002075 * with Random defined as:
2076 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002077 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002078 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002079 if( is_hrr )
2080 {
2081 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002082 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002083 }
2084 else
2085 {
2086 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002087 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002088 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002089 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002090 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2091 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2092
Jerry Yucfc04b32022-04-21 09:31:58 +08002093 /* ...
2094 * opaque legacy_session_id_echo<0..32>;
2095 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002096 */
2097 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2098 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2099 if( ssl->session_negotiate->id_len > 0 )
2100 {
2101 memcpy( p, &ssl->session_negotiate->id[0],
2102 ssl->session_negotiate->id_len );
2103 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002104
Jerry Yu3bf2c642022-03-30 22:02:12 +08002105 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2106 ssl->session_negotiate->id_len );
2107 }
2108
Jerry Yucfc04b32022-04-21 09:31:58 +08002109 /* ...
2110 * CipherSuite cipher_suite;
2111 * ...
2112 * with CipherSuite defined as:
2113 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002114 */
2115 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2116 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2117 p += 2;
2118 MBEDTLS_SSL_DEBUG_MSG( 3,
2119 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2120 mbedtls_ssl_get_ciphersuite_name(
2121 ssl->session_negotiate->ciphersuite ),
2122 ssl->session_negotiate->ciphersuite ) );
2123
Jerry Yucfc04b32022-04-21 09:31:58 +08002124 /* ...
2125 * uint8 legacy_compression_method = 0;
2126 * ...
2127 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002128 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002129 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002130
Jerry Yucfc04b32022-04-21 09:31:58 +08002131 /* ...
2132 * Extension extensions<6..2^16-1>;
2133 * ...
2134 * struct {
2135 * ExtensionType extension_type; (2 bytes)
2136 * opaque extension_data<0..2^16-1>;
2137 * } Extension;
2138 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002139 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002140 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002141 p += 2;
2142
Jerry Yue74e04a2022-04-21 09:23:16 +08002143 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002144 ssl, p, end, &output_len ) ) != 0 )
2145 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002146 MBEDTLS_SSL_DEBUG_RET(
2147 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002148 return( ret );
2149 }
2150 p += output_len;
2151
Jerry Yu56acc942022-07-30 23:02:36 +08002152 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002153 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002154 if( is_hrr )
2155 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2156 else
2157 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002158 if( ret != 0 )
2159 return( ret );
2160 p += output_len;
2161 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002162
Jerry Yu032b15ce2022-07-11 06:10:03 +00002163#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002164 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002165 {
Jerry Yubb852022022-07-20 21:10:44 +08002166 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002167 if( ret != 0 )
2168 {
Jerry Yubb852022022-07-20 21:10:44 +08002169 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002170 ret );
2171 return( ret );
2172 }
2173 p += output_len;
2174 }
2175#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
2176
Jerry Yud9436a12022-04-20 22:28:09 +08002177 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002178
Jerry Yud9436a12022-04-20 22:28:09 +08002179 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2180 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002181
Jerry Yud9436a12022-04-20 22:28:09 +08002182 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002183
Jerry Yud9436a12022-04-20 22:28:09 +08002184 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002185
2186 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002187}
2188
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002189MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002190static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2191{
2192 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002193 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002194 if( ret != 0 )
2195 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002196 MBEDTLS_SSL_DEBUG_RET( 1,
2197 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002198 ret );
2199 return( ret );
2200 }
2201
Jerry Yue110d252022-05-05 10:19:22 +08002202 return( ret );
2203}
2204
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002205MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002206static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2207{
Jerry Yu637a3f12022-04-20 21:37:58 +08002208 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002209 unsigned char *buf;
2210 size_t buf_len, msg_len;
2211
2212 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2213
Jerry Yuf4b27e42022-03-30 17:32:21 +08002214 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2215
Jerry Yu3bf2c642022-03-30 22:02:12 +08002216 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002217 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2218
Jerry Yu3bf2c642022-03-30 22:02:12 +08002219 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2220 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002221 &msg_len,
2222 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002223
Jerry Yu3bf2c642022-03-30 22:02:12 +08002224 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002225 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2226
Jerry Yu3bf2c642022-03-30 22:02:12 +08002227 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002228 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002229
Jerry Yue110d252022-05-05 10:19:22 +08002230 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2231
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002232#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2233 /* The server sends a dummy change_cipher_spec record immediately
2234 * after its first handshake message. This may either be after
2235 * a ServerHello or a HelloRetryRequest.
2236 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002237 mbedtls_ssl_handshake_set_state(
2238 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002239#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002240 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002241#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002242
Jerry Yuf4b27e42022-03-30 17:32:21 +08002243cleanup:
2244
2245 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2246 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002247}
2248
Jerry Yu23d1a252022-05-12 18:08:59 +08002249
2250/*
2251 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2252 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002253MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002254static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002255{
2256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2257 if( ssl->handshake->hello_retry_request_count > 0 )
2258 {
2259 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2260 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2261 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2262 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2263 }
2264
2265 /*
2266 * Create stateless transcript hash for HRR
2267 */
2268 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2269 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2270 if( ret != 0 )
2271 {
2272 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2273 return( ret );
2274 }
2275 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2276
2277 return( 0 );
2278}
2279
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002280MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002281static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2282{
2283 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2284 unsigned char *buf;
2285 size_t buf_len, msg_len;
2286
2287 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2288
Ronald Cron7b840462022-06-01 17:05:53 +02002289 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002290
2291 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2292 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2293 &buf, &buf_len ) );
2294
2295 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2296 buf + buf_len,
2297 &msg_len,
2298 1 ) );
2299 mbedtls_ssl_add_hs_msg_to_checksum(
2300 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2301
2302
2303 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2304 msg_len ) );
2305
2306 ssl->handshake->hello_retry_request_count++;
2307
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002308#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2309 /* The server sends a dummy change_cipher_spec record immediately
2310 * after its first handshake message. This may either be after
2311 * a ServerHello or a HelloRetryRequest.
2312 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002313 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002314 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002315#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002316 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002317#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002318
2319cleanup:
2320 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2321 return( ret );
2322}
2323
Jerry Yu5b64ae92022-03-30 17:15:02 +08002324/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002325 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2326 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002327
2328/*
2329 * struct {
2330 * Extension extensions<0..2 ^ 16 - 1>;
2331 * } EncryptedExtensions;
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_body( mbedtls_ssl_context *ssl,
2336 unsigned char *buf,
2337 unsigned char *end,
2338 size_t *out_len )
2339{
XiaokangQianacb39922022-06-17 10:18:48 +00002340 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002341 unsigned char *p = buf;
2342 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002343 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002344 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002345
Jerry Yu4d3841a2022-04-16 12:37:19 +08002346 *out_len = 0;
2347
2348 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002349 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002350 p += 2;
2351
Jerry Yu8937eb42022-05-03 12:12:14 +08002352 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002353 ((void) ret);
2354 ((void) output_len);
2355
2356#if defined(MBEDTLS_SSL_ALPN)
2357 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2358 if( ret != 0 )
2359 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002360 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002361#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002362
Jerry Yu8937eb42022-05-03 12:12:14 +08002363 extensions_len = ( p - p_extensions_len ) - 2;
2364 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2365
2366 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002367
2368 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2369
2370 return( 0 );
2371}
2372
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002373MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002374static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2375{
2376 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2377 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002378 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002379
Gabor Mezei54719122022-06-28 11:34:56 +02002380 mbedtls_ssl_set_outbound_transform( ssl,
2381 ssl->handshake->transform_handshake );
2382 MBEDTLS_SSL_DEBUG_MSG(
2383 3, ( "switching to handshake transform for outbound data" ) );
2384
Jerry Yuab452cc2022-04-28 15:27:08 +08002385 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002386
Jerry Yu4d3841a2022-04-16 12:37:19 +08002387 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2388 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2389
2390 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2391 ssl, buf, buf + buf_len, &msg_len ) );
2392
2393 mbedtls_ssl_add_hs_msg_to_checksum(
2394 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2395
Jerry Yu4d3841a2022-04-16 12:37:19 +08002396 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2397 ssl, buf_len, msg_len ) );
2398
Jerry Yu8937eb42022-05-03 12:12:14 +08002399#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002400 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002401 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2402 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002403 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002404#else
2405 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2406#endif
2407
Jerry Yu4d3841a2022-04-16 12:37:19 +08002408cleanup:
2409
Jerry Yuab452cc2022-04-28 15:27:08 +08002410 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002411 return( ret );
2412}
2413
XiaokangQiancec9ae62022-05-06 07:28:50 +00002414#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002415#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2416#define SSL_CERTIFICATE_REQUEST_SKIP 1
2417/* Coordination:
2418 * Check whether a CertificateRequest message should be written.
2419 * Returns a negative code on failure, or
2420 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2421 * - SSL_CERTIFICATE_REQUEST_SKIP
2422 * indicating if the writing of the CertificateRequest
2423 * should be skipped or not.
2424 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002425MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002426static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2427{
2428 int authmode;
2429
XiaokangQian40a35232022-05-07 09:02:40 +00002430#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2431 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2432 authmode = ssl->handshake->sni_authmode;
2433 else
2434#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002435 authmode = ssl->conf->authmode;
2436
2437 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
2438 return( SSL_CERTIFICATE_REQUEST_SKIP );
2439
XiaokangQianc3017f62022-05-13 05:55:41 +00002440 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002441
XiaokangQiana987e1d2022-05-07 01:25:58 +00002442 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2443}
2444
XiaokangQiancec9ae62022-05-06 07:28:50 +00002445/*
2446 * struct {
2447 * opaque certificate_request_context<0..2^8-1>;
2448 * Extension extensions<2..2^16-1>;
2449 * } CertificateRequest;
2450 *
2451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002452MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002453static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2454 unsigned char *buf,
2455 const unsigned char *end,
2456 size_t *out_len )
2457{
2458 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2459 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002460 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002461 unsigned char *p_extensions_len;
2462
2463 *out_len = 0;
2464
2465 /* Check if we have enough space:
2466 * - certificate_request_context (1 byte)
2467 * - extensions length (2 bytes)
2468 */
2469 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2470
2471 /*
2472 * Write certificate_request_context
2473 */
2474 /*
2475 * We use a zero length context for the normal handshake
2476 * messages. For post-authentication handshake messages
2477 * this request context would be set to a non-zero value.
2478 */
2479 *p++ = 0x0;
2480
2481 /*
2482 * Write extensions
2483 */
2484 /* The extensions must contain the signature_algorithms. */
2485 p_extensions_len = p;
2486 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002487 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002488 if( ret != 0 )
2489 return( ret );
2490
XiaokangQianec6efb92022-05-06 09:53:10 +00002491 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002492 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002493
2494 *out_len = p - buf;
2495
2496 return( 0 );
2497}
2498
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002499MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002500static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2501{
2502 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2503
2504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2505
2506 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2507
2508 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2509 {
2510 unsigned char *buf;
2511 size_t buf_len, msg_len;
2512
2513 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2514 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2515
2516 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2517 ssl, buf, buf + buf_len, &msg_len ) );
2518
2519 mbedtls_ssl_add_hs_msg_to_checksum(
2520 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2521
2522 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2523 ssl, buf_len, msg_len ) );
2524 }
2525 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2526 {
2527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2528 ret = 0;
2529 }
2530 else
2531 {
2532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2533 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2534 goto cleanup;
2535 }
2536
2537 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2538cleanup:
2539
2540 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2541 return( ret );
2542}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002543
Jerry Yu4d3841a2022-04-16 12:37:19 +08002544/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002545 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002546 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002547MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002548static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002549{
Jerry Yu5a26f302022-05-10 20:46:40 +08002550 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002551
2552#if defined(MBEDTLS_X509_CRT_PARSE_C)
2553 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2554 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002555 {
Jerry Yub89125b2022-05-13 15:45:49 +08002556 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002557 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2558 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002559 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002560 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002561#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002562
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002563 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2564 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002565 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002566 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2567 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002568}
2569
2570/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002571 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002572 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002573MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002574static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002575{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002576 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002577 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002578 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002579 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2580 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002581}
Jerry Yu5a26f302022-05-10 20:46:40 +08002582#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002583
2584/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002585 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002586 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002587MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002588static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002589{
Jerry Yud6e253d2022-05-18 13:59:24 +08002590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002591
2592 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2593 if( ret != 0 )
2594 return( ret );
2595
Jerry Yue3d67cb2022-05-19 15:33:10 +08002596 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2597 if( ret != 0 )
2598 {
2599 MBEDTLS_SSL_PEND_FATAL_ALERT(
2600 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2601 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2602 return( ret );
2603 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002604
Ronald Cron63dc4632022-05-31 14:41:53 +02002605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2606 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002607
Ronald Cron63dc4632022-05-31 14:41:53 +02002608 if( ssl->handshake->certificate_request_sent )
2609 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002610 else
Ronald Cron19385882022-06-15 16:26:13 +02002611 {
2612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2613 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002614 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002615 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002616
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002617 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002618}
2619
2620/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002621 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002622 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002623MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002624static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002625{
Jerry Yud6e253d2022-05-18 13:59:24 +08002626 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2627
Jerry Yuff226982022-04-16 16:52:57 +08002628 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2629 if( ret != 0 )
2630 return( ret );
2631
Jerry Yu466dda82022-09-13 11:20:20 +08002632 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002633 if( ret != 0 )
2634 {
2635 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002636 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002637 }
2638
Jerry Yu03ed50b2022-04-16 17:13:30 +08002639 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002640 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002641}
2642
2643/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002644 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002645 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002646MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002647static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002648{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002649 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2650
Jerry Yu03ed50b2022-04-16 17:13:30 +08002651 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002652
2653#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002654 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2655#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002656 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002657#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002658 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002659}
2660
2661/*
Jerry Yue67bef42022-07-07 07:29:42 +00002662 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2663 */
2664#define SSL_NEW_SESSION_TICKET_SKIP 0
2665#define SSL_NEW_SESSION_TICKET_WRITE 1
2666MBEDTLS_CHECK_RETURN_CRITICAL
2667static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2668{
2669 /* Check whether the use of session tickets is enabled */
2670 if( ssl->conf->f_ticket_write == NULL )
2671 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002672 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2673 " callback is not set" ) );
2674 return( SSL_NEW_SESSION_TICKET_SKIP );
2675 }
2676 if( ssl->conf->new_session_tickets_count == 0 )
2677 {
2678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2679 " configured count is zero" ) );
2680 return( SSL_NEW_SESSION_TICKET_SKIP );
2681 }
2682
2683 if( ssl->handshake->new_session_tickets_count == 0 )
2684 {
2685 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2686 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002687 return( SSL_NEW_SESSION_TICKET_SKIP );
2688 }
2689
Jerry Yue67bef42022-07-07 07:29:42 +00002690 return( SSL_NEW_SESSION_TICKET_WRITE );
2691}
2692
2693#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2694MBEDTLS_CHECK_RETURN_CRITICAL
2695static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2696 unsigned char *ticket_nonce,
2697 size_t ticket_nonce_size )
2698{
2699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2700 mbedtls_ssl_session *session = ssl->session;
2701 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2702 psa_algorithm_t psa_hash_alg;
2703 int hash_length;
2704
2705 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2706
2707#if defined(MBEDTLS_HAVE_TIME)
2708 session->start = mbedtls_time( NULL );
2709#endif
2710
2711 /* Generate ticket_age_add */
2712 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002713 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002714 sizeof( session->ticket_age_add ) ) != 0 ) )
2715 {
2716 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2717 return( ret );
2718 }
2719 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002720 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002721
2722 /* Generate ticket_nonce */
2723 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2724 if( ret != 0 )
2725 {
2726 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2727 return( ret );
2728 }
2729 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2730 ticket_nonce, ticket_nonce_size );
2731
2732 ciphersuite_info =
2733 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2734 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2735 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002736 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002737 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002738 {
Jerry Yue67bef42022-07-07 07:29:42 +00002739 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002740 }
2741
Jerry Yue67bef42022-07-07 07:29:42 +00002742 /* In this code the psk key length equals the length of the hash */
2743 session->resumption_key_len = hash_length;
2744 session->ciphersuite = ciphersuite_info->id;
2745
2746 /* Compute resumption key
2747 *
2748 * HKDF-Expand-Label( resumption_master_secret,
2749 * "resumption", ticket_nonce, Hash.length )
2750 */
2751 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2752 psa_hash_alg,
2753 session->app_secrets.resumption_master_secret,
2754 hash_length,
2755 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2756 ticket_nonce,
2757 ticket_nonce_size,
2758 session->resumption_key,
2759 hash_length );
2760
2761 if( ret != 0 )
2762 {
2763 MBEDTLS_SSL_DEBUG_RET( 2,
2764 "Creating the ticket-resumed PSK failed",
2765 ret );
2766 return ( ret );
2767 }
2768 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2769 session->resumption_key,
2770 session->resumption_key_len );
2771
2772 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2773 session->app_secrets.resumption_master_secret,
2774 hash_length );
2775
2776 return( 0 );
2777}
2778
2779/* This function creates a NewSessionTicket message in the following format:
2780 *
2781 * struct {
2782 * uint32 ticket_lifetime;
2783 * uint32 ticket_age_add;
2784 * opaque ticket_nonce<0..255>;
2785 * opaque ticket<1..2^16-1>;
2786 * Extension extensions<0..2^16-2>;
2787 * } NewSessionTicket;
2788 *
2789 * The ticket inside the NewSessionTicket message is an encrypted container
2790 * carrying the necessary information so that the server is later able to
2791 * re-start the communication.
2792 *
2793 * The following fields are placed inside the ticket by the
2794 * f_ticket_write() function:
2795 *
2796 * - creation time (start)
2797 * - flags (flags)
2798 * - age add (ticket_age_add)
2799 * - key (key)
2800 * - key length (key_len)
2801 * - ciphersuite (ciphersuite)
2802 */
2803MBEDTLS_CHECK_RETURN_CRITICAL
2804static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2805 unsigned char *buf,
2806 unsigned char *end,
2807 size_t *out_len,
2808 unsigned char *ticket_nonce,
2809 size_t ticket_nonce_size )
2810{
2811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2812 unsigned char *p = buf;
2813 mbedtls_ssl_session *session = ssl->session;
2814 size_t ticket_len;
2815 uint32_t ticket_lifetime;
2816
2817 *out_len = 0;
2818 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2819
2820 /*
2821 * ticket_lifetime 4 bytes
2822 * ticket_age_add 4 bytes
2823 * ticket_nonce 1 + ticket_nonce_size bytes
2824 * ticket >=2 bytes
2825 */
2826 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2827
2828 /* Generate ticket and ticket_lifetime */
2829 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2830 session,
2831 p + 9 + ticket_nonce_size + 2,
2832 end,
2833 &ticket_len,
2834 &ticket_lifetime);
2835 if( ret != 0 )
2836 {
2837 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2838 return( ret );
2839 }
2840 /* RFC 8446 4.6.1
2841 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2842 * unsigned integer in network byte order from the time of ticket
2843 * issuance. Servers MUST NOT use any value greater than
2844 * 604800 seconds (7 days). The value of zero indicates that the
2845 * ticket should be discarded immediately. Clients MUST NOT cache
2846 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2847 * and MAY delete tickets earlier based on local policy. A server
2848 * MAY treat a ticket as valid for a shorter period of time than what
2849 * is stated in the ticket_lifetime.
2850 */
2851 ticket_lifetime %= 604800;
2852 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2853 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2854 ( unsigned int )ticket_lifetime ) );
2855
2856 /* Write ticket_age_add */
2857 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2858 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2859 ( unsigned int )session->ticket_age_add ) );
2860
2861 /* Write ticket_nonce */
2862 p[8] = ( unsigned char )ticket_nonce_size;
2863 if( ticket_nonce_size > 0 )
2864 {
2865 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2866 }
2867 p += 9 + ticket_nonce_size;
2868
2869 /* Write ticket */
2870 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2871 p += 2;
2872 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2873 p += ticket_len;
2874
2875 /* Ticket Extensions
2876 *
2877 * Note: We currently don't have any extensions.
2878 * Set length to zero.
2879 */
2880 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2881 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2882 p += 2;
2883
2884 *out_len = p - buf;
2885 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2887
2888 return( 0 );
2889}
2890
2891/*
2892 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2893 */
2894static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2895{
2896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2897
2898 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2899
2900 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2901 {
2902 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2903 unsigned char *buf;
2904 size_t buf_len, msg_len;
2905
2906 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2907 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2908
2909 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2910 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2911
2912 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2913 ssl, buf, buf + buf_len, &msg_len,
2914 ticket_nonce, sizeof( ticket_nonce ) ) );
2915
Jerry Yue67bef42022-07-07 07:29:42 +00002916 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2917 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002918
Jerry Yu359e65f2022-09-22 23:47:43 +08002919 /* Limit session tickets count to one when resumption connection.
2920 *
2921 * See document of mbedtls_ssl_conf_new_session_tickets.
2922 */
2923 if( ssl->handshake->resume == 1 )
2924 ssl->handshake->new_session_tickets_count = 0;
2925 else
2926 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002927
Jerry Yufca4d572022-07-21 10:37:48 +08002928 mbedtls_ssl_handshake_set_state( ssl,
2929 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002930 }
2931 else
2932 {
2933 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2934 }
2935
Jerry Yue67bef42022-07-07 07:29:42 +00002936cleanup:
2937
2938 return( ret );
2939}
2940#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2941
2942/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002943 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002944 */
Jerry Yu27561932021-08-27 17:07:38 +08002945int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002946{
XiaokangQian08037552022-04-20 07:16:41 +00002947 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002948
2949 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2951
Jerry Yue3b34122021-09-28 17:53:35 +08002952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2953 mbedtls_ssl_states_str( ssl->state ),
2954 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002955
XiaokangQian7807f9f2022-02-15 10:04:37 +00002956 switch( ssl->state )
2957 {
2958 /* start state */
2959 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002960 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002961 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002962 break;
2963
XiaokangQian7807f9f2022-02-15 10:04:37 +00002964 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002965 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002966 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002967 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002968 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002969
Jerry Yuf41553b2022-05-09 22:20:30 +08002970 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2971 ret = ssl_tls13_write_hello_retry_request( ssl );
2972 if( ret != 0 )
2973 {
2974 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2975 return( ret );
2976 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002977 break;
2978
Jerry Yu5b64ae92022-03-30 17:15:02 +08002979 case MBEDTLS_SSL_SERVER_HELLO:
2980 ret = ssl_tls13_write_server_hello( ssl );
2981 break;
2982
Xiaofei Baicba64af2022-02-15 10:00:56 +00002983 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002984 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002985 if( ret != 0 )
2986 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002987 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2988 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002989 }
Jerry Yu48330562022-05-06 21:35:44 +08002990 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002991
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002992#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2993 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002994 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002995 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002996
Jerry Yu83da34e2022-04-16 13:59:52 +08002997 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2998 ret = ssl_tls13_write_server_certificate( ssl );
2999 break;
3000
3001 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
3002 ret = ssl_tls13_write_certificate_verify( ssl );
3003 break;
Jerry Yu5a26f302022-05-10 20:46:40 +08003004#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003005
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003006 /*
3007 * Injection of dummy-CCS's for middlebox compatibility
3008 */
3009#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003010 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003011 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
3012 if( ret == 0 )
3013 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
3014 break;
3015
3016 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
3017 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
3018 if( ret == 0 )
3019 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
3020 break;
3021#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3022
Jerry Yu69dd8d42022-04-16 12:51:26 +08003023 case MBEDTLS_SSL_SERVER_FINISHED:
3024 ret = ssl_tls13_write_server_finished( ssl );
3025 break;
3026
3027 case MBEDTLS_SSL_CLIENT_FINISHED:
3028 ret = ssl_tls13_process_client_finished( ssl );
3029 break;
3030
Jerry Yu69dd8d42022-04-16 12:51:26 +08003031 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3032 ret = ssl_tls13_handshake_wrapup( ssl );
3033 break;
3034
XiaokangQian6b916b12022-04-25 07:29:34 +00003035 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3036 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003037 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003038 {
Ronald Cron209cae92022-06-07 10:30:19 +02003039 if( ssl->session_negotiate->peer_cert != NULL )
3040 {
3041 mbedtls_ssl_handshake_set_state(
3042 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3043 }
3044 else
Ronald Cron19385882022-06-15 16:26:13 +02003045 {
3046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003047 mbedtls_ssl_handshake_set_state(
3048 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003049 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003050 }
3051 break;
3052
3053 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3054 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3055 if( ret == 0 )
3056 {
3057 mbedtls_ssl_handshake_set_state(
3058 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3059 }
3060 break;
3061
Jerry Yue67bef42022-07-07 07:29:42 +00003062#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3063 case MBEDTLS_SSL_NEW_SESSION_TICKET:
3064 ret = ssl_tls13_write_new_session_ticket( ssl );
3065 if( ret != 0 )
3066 {
3067 MBEDTLS_SSL_DEBUG_RET( 1,
3068 "ssl_tls13_write_new_session_ticket ",
3069 ret );
3070 }
3071 break;
3072 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
3073 /* This state is necessary to do the flush of the New Session
3074 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
3075 * as part of ssl_prepare_handshake_step.
3076 */
3077 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003078
Jerry Yud0766ec2022-09-22 10:46:57 +08003079 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003080 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3081 else
3082 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003083 break;
3084
3085#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3086
XiaokangQian7807f9f2022-02-15 10:04:37 +00003087 default:
3088 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003089 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003090 }
3091
3092 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003093}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003094
Jerry Yufb4b6472022-01-27 15:03:26 +08003095#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */