blob: f61c634b261d708441cbc02a025fb57f2253124e [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
David Horstmann21b89762022-10-06 18:34:28 +0100683 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684#if defined(MBEDTLS_USE_PSA_CRYPTO)
David Horstmann21b89762022-10-06 18:34:28 +0100685 not_using_psk = ( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000686#else
David Horstmann21b89762022-10-06 18:34:28 +0100687 not_using_psk = ( ssl->handshake->psk == NULL );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000688#endif
David Horstmann21b89762022-10-06 18:34:28 +0100689 if( not_using_psk )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000690 {
691 /* We shouldn't have called this extension writer unless we've
692 * chosen to use a PSK. */
693 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
694 }
695
696 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding pre_shared_key extension" ) );
697 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
698
Jerry Yu032b15ce2022-07-11 06:10:03 +0000699 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000700 MBEDTLS_PUT_UINT16_BE( 2, p, 2 );
701
Jerry Yu96a2e362022-07-21 15:11:34 +0800702 MBEDTLS_PUT_UINT16_BE( ssl->handshake->selected_identity, p, 4 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000703
704 *olen = 6;
705
Jerry Yu96a2e362022-07-21 15:11:34 +0800706 MBEDTLS_SSL_DEBUG_MSG( 4, ( "sent selected_identity: %u",
707 ssl->handshake->selected_identity ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000708
709 return( 0 );
710}
711
Jerry Yue19e3b92022-07-08 12:04:51 +0000712#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
713
XiaokangQian7807f9f2022-02-15 10:04:37 +0000714/* From RFC 8446:
715 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000716 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000717 * } SupportedVersions;
718 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200719MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000720static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
721 const unsigned char *buf,
722 const unsigned char *end )
723{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000724 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000725 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000726 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000727 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000728 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000729
730 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000731 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000732 p += 1;
733
XiaokangQian4080a7f2022-04-11 09:55:18 +0000734 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000735 versions_end = p + versions_len;
736 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000738 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000739 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000740 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000741
742 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000743 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000744 {
745 tls13_supported = 1;
746 break;
747 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000748 }
749
XiaokangQianb67384d2022-04-19 00:02:38 +0000750 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000751 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000752 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
753
754 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
755 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
756 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
757 }
758
XiaokangQiande333912022-04-20 08:49:42 +0000759 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000760 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000761
XiaokangQian7807f9f2022-02-15 10:04:37 +0000762 return( 0 );
763}
764
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000765#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000766/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000767 *
768 * From RFC 8446:
769 * enum {
770 * ... (0xFFFF)
771 * } NamedGroup;
772 * struct {
773 * NamedGroup named_group_list<2..2^16-1>;
774 * } NamedGroupList;
775 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200776MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800777static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
778 const unsigned char *buf,
779 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000781 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000782 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000783 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784
785 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000786 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000787 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000789 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000790 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000791 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000792
XiaokangQian08037552022-04-20 07:16:41 +0000793 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000794 {
XiaokangQian08037552022-04-20 07:16:41 +0000795 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000796 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000797 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
798 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000799
Jerry Yuc1be19f2022-04-23 16:11:39 +0800800 MBEDTLS_SSL_DEBUG_MSG( 2,
801 ( "got named group: %s(%04x)",
802 mbedtls_ssl_named_group_to_str( named_group ),
803 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000804
805 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
806 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000807 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000808 {
XiaokangQian08037552022-04-20 07:16:41 +0000809 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000810 }
811
Jerry Yuc1be19f2022-04-23 16:11:39 +0800812 MBEDTLS_SSL_DEBUG_MSG( 2,
813 ( "add named group %s(%04x) into received list.",
814 mbedtls_ssl_named_group_to_str( named_group ),
815 named_group ) );
816
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000817 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818 }
819
820 return( 0 );
821
822}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000823#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000824
XiaokangQian08037552022-04-20 07:16:41 +0000825#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
826
XiaokangQian88408882022-04-02 10:15:03 +0000827#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000828/*
829 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000830 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831 *
832 * Possible return values are:
833 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000834 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000835 * does not match a group supported by the server. A HelloRetryRequest will
836 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000837 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800838 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200839MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000840static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
841 const unsigned char *buf,
842 const unsigned char *end )
843{
XiaokangQianb67384d2022-04-19 00:02:38 +0000844 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000845 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000846 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800847 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000848
849 /* From RFC 8446:
850 *
851 * struct {
852 * KeyShareEntry client_shares<0..2^16-1>;
853 * } KeyShareClientHello;
854 *
855 */
856
XiaokangQian7807f9f2022-02-15 10:04:37 +0000857 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000858 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000859 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000860 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000861
862 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000863 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864
865 /* We try to find a suitable key share entry and copy it to the
866 * handshake context. Later, we have to find out whether we can do
867 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000868 * dismiss it and send a HelloRetryRequest message.
869 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000870
Jerry Yuc1be19f2022-04-23 16:11:39 +0800871 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000872 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000873 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800874 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800875 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000876
877 /*
878 * struct {
879 * NamedGroup group;
880 * opaque key_exchange<1..2^16-1>;
881 * } KeyShareEntry;
882 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000883 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000884 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800885 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
886 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800887 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000888 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
Jerry Yu086edc22022-05-05 10:50:38 +0800889 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000890
891 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000892 * for input validation purposes.
893 */
XiaokangQian060d8672022-04-21 09:24:56 +0000894 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800895 ! mbedtls_ssl_named_group_is_supported( group ) ||
896 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000897 {
898 continue;
899 }
XiaokangQian060d8672022-04-21 09:24:56 +0000900
XiaokangQian7807f9f2022-02-15 10:04:37 +0000901 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000902 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000903 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000904 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
905 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800906 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
907 mbedtls_ssl_named_group_to_str( group ),
908 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000909 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800910 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000911 if( ret != 0 )
912 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000913
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000914 }
915 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000916 {
917 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000918 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000919 continue;
920 }
921
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000922 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923 }
924
Jerry Yuc1be19f2022-04-23 16:11:39 +0800925
926 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000927 {
928 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000929 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000930 }
931 return( 0 );
932}
XiaokangQian88408882022-04-02 10:15:03 +0000933#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000934
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000935#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000936static void ssl_tls13_debug_print_client_hello_exts( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937{
XiaokangQian3207a322022-02-23 03:15:27 +0000938 ((void) ssl);
939
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Supported Extensions:" ) );
XiaokangQianb67384d2022-04-19 00:02:38 +0000941 MBEDTLS_SSL_DEBUG_MSG( 3,
942 ( "- KEY_SHARE_EXTENSION ( %s )",
943 ( ( ssl->handshake->extensions_present
944 & MBEDTLS_SSL_EXT_KEY_SHARE ) > 0 ) ? "TRUE" : "FALSE" ) );
945 MBEDTLS_SSL_DEBUG_MSG( 3,
946 ( "- PSK_KEY_EXCHANGE_MODES_EXTENSION ( %s )",
947 ( ( ssl->handshake->extensions_present
948 & MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) > 0 ) ?
949 "TRUE" : "FALSE" ) );
950 MBEDTLS_SSL_DEBUG_MSG( 3,
951 ( "- PRE_SHARED_KEY_EXTENSION ( %s )",
952 ( ( ssl->handshake->extensions_present
953 & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) > 0 ) ? "TRUE" : "FALSE" ) );
954 MBEDTLS_SSL_DEBUG_MSG( 3,
955 ( "- SIGNATURE_ALGORITHM_EXTENSION ( %s )",
956 ( ( ssl->handshake->extensions_present
957 & MBEDTLS_SSL_EXT_SIG_ALG ) > 0 ) ? "TRUE" : "FALSE" ) );
958 MBEDTLS_SSL_DEBUG_MSG( 3,
959 ( "- SUPPORTED_GROUPS_EXTENSION ( %s )",
960 ( ( ssl->handshake->extensions_present
961 & MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ) >0 ) ?
962 "TRUE" : "FALSE" ) );
963 MBEDTLS_SSL_DEBUG_MSG( 3,
964 ( "- SUPPORTED_VERSION_EXTENSION ( %s )",
965 ( ( ssl->handshake->extensions_present
966 & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) > 0 ) ?
967 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000968#if defined ( MBEDTLS_SSL_SERVER_NAME_INDICATION )
XiaokangQianb67384d2022-04-19 00:02:38 +0000969 MBEDTLS_SSL_DEBUG_MSG( 3,
970 ( "- SERVERNAME_EXTENSION ( %s )",
971 ( ( ssl->handshake->extensions_present
972 & MBEDTLS_SSL_EXT_SERVERNAME ) > 0 ) ?
973 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000974#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianacb39922022-06-17 10:18:48 +0000975#if defined ( MBEDTLS_SSL_ALPN )
976 MBEDTLS_SSL_DEBUG_MSG( 3,
977 ( "- ALPN_EXTENSION ( %s )",
978 ( ( ssl->handshake->extensions_present
979 & MBEDTLS_SSL_EXT_ALPN ) > 0 ) ?
980 "TRUE" : "FALSE" ) );
981#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000982}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000983#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000984
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200985MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000986static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000987 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000988{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000989 int masked = ssl->handshake->extensions_present & exts_mask;
990 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000991}
992
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200993MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000994static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
995 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000996{
Jerry Yu77f01482022-07-11 07:03:24 +0000997 return( ssl_tls13_client_hello_has_exts(
998 ssl,
999 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
1000 MBEDTLS_SSL_EXT_KEY_SHARE |
1001 MBEDTLS_SSL_EXT_SIG_ALG ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001002}
1003
Jerry Yu77f01482022-07-11 07:03:24 +00001004#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1005MBEDTLS_CHECK_RETURN_CRITICAL
1006static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
1007 mbedtls_ssl_context *ssl )
1008{
1009 return( ssl_tls13_client_hello_has_exts(
1010 ssl,
1011 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
1012 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
1013}
1014
1015MBEDTLS_CHECK_RETURN_CRITICAL
1016static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
1017 mbedtls_ssl_context *ssl )
1018{
1019 return( ssl_tls13_client_hello_has_exts(
1020 ssl,
1021 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
1022 MBEDTLS_SSL_EXT_KEY_SHARE |
1023 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
1024 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
1025}
1026#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1027
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001028MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +00001029static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001030{
Jerry Yu77f01482022-07-11 07:03:24 +00001031 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
1032 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
1033}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001034
Jerry Yu77f01482022-07-11 07:03:24 +00001035MBEDTLS_CHECK_RETURN_CRITICAL
1036static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
1037{
1038#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1039 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
1040 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
1041 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
1042#else
1043 ((void) ssl);
1044 return( 0 );
1045#endif
1046}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001047
Jerry Yu77f01482022-07-11 07:03:24 +00001048MBEDTLS_CHECK_RETURN_CRITICAL
1049static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
1050{
1051#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1052 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
1053 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
1054 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
1055#else
1056 ((void) ssl);
1057 return( 0 );
1058#endif
1059}
1060
1061static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1062{
1063 /*
1064 * Determine the key exchange algorithm to use.
1065 * There are three types of key exchanges supported in TLS 1.3:
1066 * - (EC)DH with ECDSA,
1067 * - (EC)DH with PSK,
1068 * - plain PSK.
1069 *
1070 * The PSK-based key exchanges may additionally be used with 0-RTT.
1071 *
1072 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001073 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1074 * 2 ) Certificate Mode ( ephemeral )
1075 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001076 */
1077
1078 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1079
Jerry Yu77f01482022-07-11 07:03:24 +00001080 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1081 {
1082 ssl->handshake->key_exchange_mode =
1083 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1084 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1085 }
1086 else
1087 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1088 {
1089 ssl->handshake->key_exchange_mode =
1090 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1091 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1092 }
1093 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001094 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1095 {
1096 ssl->handshake->key_exchange_mode =
1097 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1098 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1099 }
1100 else
Jerry Yu77f01482022-07-11 07:03:24 +00001101 {
1102 MBEDTLS_SSL_DEBUG_MSG(
1103 1,
1104 ( "ClientHello message misses mandatory extensions." ) );
1105 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1106 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1107 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1108 }
1109
1110 return( 0 );
1111
XiaokangQian7807f9f2022-02-15 10:04:37 +00001112}
1113
XiaokangQian81802f42022-06-10 13:25:22 +00001114#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
1115 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001116
1117#if defined(MBEDTLS_USE_PSA_CRYPTO)
1118static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1119{
1120 switch( sig_alg )
1121 {
1122 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1123 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1124 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1125 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1126 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1127 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1128 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1129 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1130 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1131 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1132 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1133 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1134 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001135 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001136 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001137 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001138 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001139 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001140 default:
1141 return( PSA_ALG_NONE );
1142 }
1143}
1144#endif /* MBEDTLS_USE_PSA_CRYPTO */
1145
XiaokangQian23c5be62022-06-07 02:04:34 +00001146/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001147 * Pick best ( private key, certificate chain ) pair based on the signature
1148 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001149 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001150MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001151static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001152{
XiaokangQianfb665a82022-06-15 03:57:21 +00001153 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001154 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001155
1156#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1157 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001158 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001159 else
1160#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001161 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001162
XiaokangQianfb665a82022-06-15 03:57:21 +00001163 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001164 {
1165 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1166 return( -1 );
1167 }
1168
XiaokangQian81802f42022-06-10 13:25:22 +00001169 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001170 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001171 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1172 continue;
1173
1174 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1175 continue;
1176
XiaokangQianfb665a82022-06-15 03:57:21 +00001177 for( key_cert = key_cert_list; key_cert != NULL;
1178 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001179 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001180#if defined(MBEDTLS_USE_PSA_CRYPTO)
1181 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1182#endif /* MBEDTLS_USE_PSA_CRYPTO */
1183
XiaokangQianfb665a82022-06-15 03:57:21 +00001184 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1185 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001186
1187 /*
1188 * This avoids sending the client a cert it'll reject based on
1189 * keyUsage or other extensions.
1190 */
1191 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001192 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001193 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001194 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1195 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001196 {
1197 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001198 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001199 continue;
1200 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001201
Jerry Yucc539102022-06-27 16:27:35 +08001202 MBEDTLS_SSL_DEBUG_MSG( 3,
1203 ( "ssl_tls13_pick_key_cert:"
1204 "check signature algorithm %s [%04x]",
1205 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1206 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001207#if defined(MBEDTLS_USE_PSA_CRYPTO)
1208 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1209#endif /* MBEDTLS_USE_PSA_CRYPTO */
1210
Jerry Yufb526692022-06-19 11:22:49 +08001211 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001212 *sig_alg, &key_cert->cert->pk )
1213#if defined(MBEDTLS_USE_PSA_CRYPTO)
1214 && psa_alg != PSA_ALG_NONE &&
1215 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1216 PSA_KEY_USAGE_SIGN_HASH ) == 1
1217#endif /* MBEDTLS_USE_PSA_CRYPTO */
1218 )
XiaokangQian81802f42022-06-10 13:25:22 +00001219 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001220 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001221 MBEDTLS_SSL_DEBUG_MSG( 3,
1222 ( "ssl_tls13_pick_key_cert:"
1223 "selected signature algorithm"
1224 " %s [%04x]",
1225 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1226 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001227 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001228 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001229 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001230 return( 0 );
1231 }
XiaokangQian81802f42022-06-10 13:25:22 +00001232 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001233 }
1234
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001235 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1236 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001237 return( -1 );
1238}
XiaokangQian81802f42022-06-10 13:25:22 +00001239#endif /* MBEDTLS_X509_CRT_PARSE_C &&
1240 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001241
XiaokangQian4080a7f2022-04-11 09:55:18 +00001242/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001243 *
1244 * STATE HANDLING: ClientHello
1245 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001246 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001247 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001248 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001249 *
1250 * In this case, the server progresses to sending its ServerHello.
1251 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001252 * 2) The ClientHello was well-formed but didn't match the server's
1253 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001254 *
1255 * For example, the client might not have offered a key share which
1256 * the server supports, or the server might require a cookie.
1257 *
1258 * In this case, the server sends a HelloRetryRequest.
1259 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001260 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001261 *
1262 * In this case, we abort the handshake.
1263 *
1264 */
1265
1266/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001267 * Structure of this message:
1268 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001269 * uint16 ProtocolVersion;
1270 * opaque Random[32];
1271 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001272 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001273 * struct {
1274 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1275 * Random random;
1276 * opaque legacy_session_id<0..32>;
1277 * CipherSuite cipher_suites<2..2^16-2>;
1278 * opaque legacy_compression_methods<1..2^8-1>;
1279 * Extension extensions<8..2^16-1>;
1280 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001281 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001282
1283#define SSL_CLIENT_HELLO_OK 0
1284#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001286MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001287static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1288 const unsigned char *buf,
1289 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001290{
XiaokangQianb67384d2022-04-19 00:02:38 +00001291 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1292 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001293 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001294 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001295 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001296 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001297 const unsigned char *extensions_end;
Jerry Yu49ca9282022-05-05 11:05:22 +08001298 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001299
Jerry Yu1c105562022-07-10 06:32:38 +00001300#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001301 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001302 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001303 const unsigned char *pre_shared_key_ext_end = NULL;
1304#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001305
1306 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1307
1308 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001309 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001310 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001311 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001312 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001314 * .. . .. ciphersuite list length ( 2 bytes )
1315 * .. . .. ciphersuite list
1316 * .. . .. compression alg. list length ( 1 byte )
1317 * .. . .. compression alg. list
1318 * .. . .. extensions length ( 2 bytes, optional )
1319 * .. . .. extensions ( optional )
1320 */
1321
XiaokangQianb67384d2022-04-19 00:02:38 +00001322 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001323 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001324 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1325 * read at least up to session id length without worrying.
1326 */
1327 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1328
1329 /* ...
1330 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1331 * ...
1332 * with ProtocolVersion defined as:
1333 * uint16 ProtocolVersion;
1334 */
XiaokangQiande333912022-04-20 08:49:42 +00001335 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1336 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337 {
1338 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1339 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1340 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001341 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001342 }
1343 p += 2;
1344
1345 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001346 * Only support TLS 1.3 currently, temporarily set the version.
1347 */
XiaokangQiande333912022-04-20 08:49:42 +00001348 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001349
Jerry Yue67bef42022-07-07 07:29:42 +00001350#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1351 /* Store minor version for later use with ticket serialization. */
1352 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001353 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001354#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001355
Jerry Yuc1be19f2022-04-23 16:11:39 +08001356 /* ...
1357 * Random random;
1358 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001359 * with Random defined as:
1360 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001361 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001362 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001363 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001364
XiaokangQian08037552022-04-20 07:16:41 +00001365 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
1366 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001367
Jerry Yuc1be19f2022-04-23 16:11:39 +08001368 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001369 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001370 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001371 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001372 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001373 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001374
XiaokangQianb67384d2022-04-19 00:02:38 +00001375 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001376 {
1377 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1378 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1379 }
1380
XiaokangQian4080a7f2022-04-11 09:55:18 +00001381 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001382 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001383 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001384 /*
1385 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001386 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001387 */
1388 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001389
XiaokangQianed582dd2022-04-13 08:21:05 +00001390 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001391 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001392
XiaokangQian7807f9f2022-02-15 10:04:37 +00001393 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1394 p += 2;
1395
XiaokangQianb67384d2022-04-19 00:02:38 +00001396 /* Check we have enough data for the ciphersuite list, the legacy
1397 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001398 *
1399 * cipher_suites cipher_suites_len bytes
1400 * legacy_compression_methods 2 bytes
1401 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001402 */
1403 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001404
Jerry Yu24b8c812022-08-20 19:06:56 +08001405 /* ...
1406 * CipherSuite cipher_suites<2..2^16-2>;
1407 * ...
1408 * with CipherSuite defined as:
1409 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001410 */
Jerry Yu5725f1c2022-08-21 17:27:16 +08001411#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001412 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001413#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001414 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001415 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1416 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001417
1418 /*
1419 * Search for a matching ciphersuite
1420 */
XiaokangQian060d8672022-04-21 09:24:56 +00001421 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001422 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001423 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001424 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001425
XiaokangQiane8ff3502022-04-22 02:34:40 +00001426 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001427
XiaokangQiane8ff3502022-04-22 02:34:40 +00001428 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001429 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001430 ssl,cipher_suite );
1431 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001432 continue;
1433
Jerry Yu5725f1c2022-08-21 17:27:16 +08001434 ssl->session_negotiate->ciphersuite = cipher_suite;
1435 ssl->handshake->ciphersuite_info = ciphersuite_info;
1436 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001437 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001438 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001439 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001440
1441 if( ssl->handshake->ciphersuite_info == NULL )
1442 {
1443 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1444 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1445 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1446 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001447
XiaokangQian4080a7f2022-04-11 09:55:18 +00001448 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001449 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001450 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001451 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001452 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001453 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1455 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1456 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1457 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001458 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001459 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001460
Jerry Yuc1be19f2022-04-23 16:11:39 +08001461 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001462 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001463 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001464 * with Extension defined as:
1465 * struct {
1466 * ExtensionType extension_type;
1467 * opaque extension_data<0..2^16-1>;
1468 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001469 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001470 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001471 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001472 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001473 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474
XiaokangQian4080a7f2022-04-11 09:55:18 +00001475 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001476
1477 while( p < extensions_end )
1478 {
1479 unsigned int extension_type;
1480 size_t extension_data_len;
1481 const unsigned char *extension_data_end;
1482
Jerry Yu1c9247c2022-07-21 12:37:39 +08001483 /* RFC 8446, page 57
1484 *
1485 * The "pre_shared_key" extension MUST be the last extension in the
1486 * ClientHello (this facilitates implementation as described below).
1487 * Servers MUST check that it is the last extension and otherwise fail
1488 * the handshake with an "illegal_parameter" alert.
1489 */
1490 if( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY )
1491 {
1492 MBEDTLS_SSL_DEBUG_MSG(
1493 3, ( "pre_shared_key is not last extension." ) );
1494 MBEDTLS_SSL_PEND_FATAL_ALERT(
1495 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1496 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1497 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1498 }
1499
XiaokangQian318dc762022-04-20 09:43:51 +00001500 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001501 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1502 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1503 p += 4;
1504
1505 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1506 extension_data_end = p + extension_data_len;
1507
1508 switch( extension_type )
1509 {
XiaokangQian40a35232022-05-07 09:02:40 +00001510#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1511 case MBEDTLS_TLS_EXT_SERVERNAME:
1512 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001513 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1514 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001515 if( ret != 0 )
1516 {
1517 MBEDTLS_SSL_DEBUG_RET(
1518 1, "mbedtls_ssl_parse_servername_ext", ret );
1519 return( ret );
1520 }
1521 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SERVERNAME;
1522 break;
1523#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1524
XiaokangQianb67384d2022-04-19 00:02:38 +00001525#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001526 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1527 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1528
1529 /* Supported Groups Extension
1530 *
1531 * When sent by the client, the "supported_groups" extension
1532 * indicates the named groups which the client supports,
1533 * ordered from most preferred to least preferred.
1534 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001535 ret = ssl_tls13_parse_supported_groups_ext(
1536 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001537 if( ret != 0 )
1538 {
1539 MBEDTLS_SSL_DEBUG_RET( 1,
1540 "mbedtls_ssl_parse_supported_groups_ext", ret );
1541 return( ret );
1542 }
1543
1544 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
1545 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001546#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001547
XiaokangQian88408882022-04-02 10:15:03 +00001548#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001549 case MBEDTLS_TLS_EXT_KEY_SHARE:
1550 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1551
1552 /*
1553 * Key Share Extension
1554 *
1555 * When sent by the client, the "key_share" extension
1556 * contains the endpoint's cryptographic parameters for
1557 * ECDHE/DHE key establishment methods.
1558 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001559 ret = ssl_tls13_parse_key_shares_ext(
1560 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001561 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001562 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001563 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001564 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001565 }
1566
Jerry Yu582dd062022-04-22 21:59:01 +08001567 if( ret < 0 )
1568 {
1569 MBEDTLS_SSL_DEBUG_RET(
1570 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001571 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001572 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001573
1574 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
1575 break;
XiaokangQian88408882022-04-02 10:15:03 +00001576#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001577
1578 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1579 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1580
1581 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001582 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001583 if( ret != 0 )
1584 {
1585 MBEDTLS_SSL_DEBUG_RET( 1,
1586 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1587 return( ret );
1588 }
1589 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
1590 break;
1591
Jerry Yue19e3b92022-07-08 12:04:51 +00001592#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1593 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1594 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1595
1596 ret = ssl_tls13_parse_key_exchange_modes_ext(
1597 ssl, p, extension_data_end );
1598 if( ret != 0 )
1599 {
1600 MBEDTLS_SSL_DEBUG_RET(
1601 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1602 return( ret );
1603 }
1604
1605 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
1606 break;
1607#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1608
Jerry Yu1c105562022-07-10 06:32:38 +00001609 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1610 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001611 if( ( ssl->handshake->extensions_present &
1612 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) == 0 )
1613 {
1614 MBEDTLS_SSL_PEND_FATAL_ALERT(
1615 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1616 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1617 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1618 }
Jerry Yu1c9247c2022-07-21 12:37:39 +08001619#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001620 /* Delay processing of the PSK identity once we have
1621 * found out which algorithms to use. We keep a pointer
1622 * to the buffer and the size for later processing.
1623 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001624 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001625 pre_shared_key_ext_end = extension_data_end;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001626#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001627 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1628 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001629
XiaokangQianacb39922022-06-17 10:18:48 +00001630#if defined(MBEDTLS_SSL_ALPN)
1631 case MBEDTLS_TLS_EXT_ALPN:
1632 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1633
1634 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1635 if( ret != 0 )
1636 {
1637 MBEDTLS_SSL_DEBUG_RET(
1638 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1639 return( ret );
1640 }
1641 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_ALPN;
1642 break;
1643#endif /* MBEDTLS_SSL_ALPN */
1644
XiaokangQian7807f9f2022-02-15 10:04:37 +00001645#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1646 case MBEDTLS_TLS_EXT_SIG_ALG:
1647 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1648
Gabor Mezei078e8032022-04-27 21:17:56 +02001649 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001650 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001651 if( ret != 0 )
1652 {
1653 MBEDTLS_SSL_DEBUG_MSG( 1,
1654 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1655 ret ) );
1656 return( ret );
1657 }
1658 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
1659 break;
1660#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1661
1662 default:
1663 MBEDTLS_SSL_DEBUG_MSG( 3,
1664 ( "unknown extension found: %ud ( ignoring )",
1665 extension_type ) );
1666 }
1667
1668 p += extension_data_len;
1669 }
1670
Jerry Yu1c105562022-07-10 06:32:38 +00001671#if defined(MBEDTLS_DEBUG_C)
1672 /* List all the extensions we have received */
1673 ssl_tls13_debug_print_client_hello_exts( ssl );
1674#endif /* MBEDTLS_DEBUG_C */
1675
1676 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1677 MBEDTLS_SSL_HS_CLIENT_HELLO,
1678 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001679
Jerry Yu1c105562022-07-10 06:32:38 +00001680#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001681 /* Update checksum with either
1682 * - The entire content of the CH message, if no PSK extension is present
1683 * - The content up to but excluding the PSK extension, if present.
1684 */
Jerry Yu1c105562022-07-10 06:32:38 +00001685 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001686 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001687 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yuba9b6e92022-07-22 21:35:18 +08001688 ( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001689 {
1690 ssl->handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001691 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001692 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001693 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001694 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001695 cipher_suites,
1696 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001697 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001698 {
1699 ssl->handshake->extensions_present &= ~MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001700 }
1701 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001702 {
Jerry Yubb852022022-07-20 21:10:44 +08001703 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_tls13_parse_pre_shared_key_ext" ),
Jerry Yu1c105562022-07-10 06:32:38 +00001704 ret );
1705 return( ret );
1706 }
Jerry Yu1c105562022-07-10 06:32:38 +00001707 }
1708 else
1709#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1710 {
1711 ssl->handshake->update_checksum( ssl, buf, p - buf );
1712 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001713
Jerry Yuba9b6e92022-07-22 21:35:18 +08001714 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1715 if( ret < 0 )
1716 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001717
Jerry Yue5834fd2022-08-29 20:16:09 +08001718 mbedtls_ssl_optimize_checksum( ssl, ssl->handshake->ciphersuite_info );
1719
XiaokangQian75fe8c72022-06-15 09:42:45 +00001720 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1721}
1722
1723/* Update the handshake state machine */
1724
Ronald Cronce7d76e2022-07-08 18:56:49 +02001725MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001726static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1727{
1728 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1729
XiaokangQian7807f9f2022-02-15 10:04:37 +00001730 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001731 * Server certificate selection
1732 */
1733 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1734 {
1735 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1736 return( ret );
1737 }
1738#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1739 ssl->handshake->sni_name = NULL;
1740 ssl->handshake->sni_name_len = 0;
1741#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001742
XiaokangQian7807f9f2022-02-15 10:04:37 +00001743 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1744 if( ret != 0 )
1745 {
1746 MBEDTLS_SSL_DEBUG_RET( 1,
1747 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1748 return( ret );
1749 }
1750
XiaokangQian7807f9f2022-02-15 10:04:37 +00001751 return( 0 );
1752
1753}
1754
1755/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001756 * Main entry point from the state machine; orchestrates the otherfunctions.
1757 */
1758
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001759MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001760static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1761{
1762
XiaokangQian08037552022-04-20 07:16:41 +00001763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001764 unsigned char* buf = NULL;
1765 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001766 int parse_client_hello_ret;
1767
XiaokangQianed582dd2022-04-13 08:21:05 +00001768 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1769
XiaokangQianed582dd2022-04-13 08:21:05 +00001770 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1771 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1772 &buf, &buflen ) );
1773
1774 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1775 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001776 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1777 * only SSL_CLIENT_HELLO_OK or
1778 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1779 * stage as negative error codes are handled
1780 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001781
XiaokangQiancfd925f2022-04-14 07:10:37 +00001782 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001783
Jerry Yu4ca91402022-05-09 15:50:57 +08001784 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1785 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1786 else
1787 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001788
1789cleanup:
1790
1791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1792 return( ret );
1793}
1794
1795/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001796 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001797 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001798MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001799static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1800{
Jerry Yu637a3f12022-04-20 21:37:58 +08001801 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1802 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001804 if( ssl->conf->f_rng == NULL )
1805 {
1806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1807 return( MBEDTLS_ERR_SSL_NO_RNG );
1808 }
1809
Jerry Yu637a3f12022-04-20 21:37:58 +08001810 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001811 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1812 {
1813 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1814 return( ret );
1815 }
1816
Jerry Yu637a3f12022-04-20 21:37:58 +08001817 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001818 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1819
1820#if defined(MBEDTLS_HAVE_TIME)
1821 ssl->session_negotiate->start = time( NULL );
1822#endif /* MBEDTLS_HAVE_TIME */
1823
1824 return( ret );
1825}
1826
Jerry Yu3bf2c642022-03-30 22:02:12 +08001827/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001828 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001829 *
1830 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001831 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001832 * } SupportedVersions;
1833 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001834MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001835static int ssl_tls13_write_server_hello_supported_versions_ext(
1836 mbedtls_ssl_context *ssl,
1837 unsigned char *buf,
1838 unsigned char *end,
1839 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001840{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001841 *out_len = 0;
1842
Jerry Yu955ddd72022-04-22 22:27:33 +08001843 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001844
1845 /* Check if we have space to write the extension:
1846 * - extension_type (2 bytes)
1847 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001848 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849 */
Jerry Yu349a6132022-04-14 20:52:56 +08001850 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001851
Jerry Yu349a6132022-04-14 20:52:56 +08001852 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853
Jerry Yu349a6132022-04-14 20:52:56 +08001854 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001855
Jerry Yu349a6132022-04-14 20:52:56 +08001856 mbedtls_ssl_write_version( buf + 4,
1857 ssl->conf->transport,
1858 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001859
1860 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1861 ssl->tls_version ) );
1862
Jerry Yu349a6132022-04-14 20:52:56 +08001863 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001864
1865 return( 0 );
1866}
1867
Jerry Yud9436a12022-04-20 22:28:09 +08001868
Jerry Yu3bf2c642022-03-30 22:02:12 +08001869
1870/* Generate and export a single key share. For hybrid KEMs, this can
1871 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001872MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001873static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1874 uint16_t named_group,
1875 unsigned char *buf,
1876 unsigned char *end,
1877 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001878{
1879 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001880
1881 *out_len = 0;
1882
Jerry Yu89e103c2022-03-30 22:43:29 +08001883#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001884 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1885 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001886 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1887 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001888 if( ret != 0 )
1889 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001890 MBEDTLS_SSL_DEBUG_RET(
1891 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1892 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001893 return( ret );
1894 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001895 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001896 else
1897#endif /* MBEDTLS_ECDH_C */
1898 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001899 {
1900 }
1901 else
1902 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001903 ((void) ssl);
1904 ((void) named_group);
1905 ((void) buf);
1906 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001907 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1908 }
1909
1910 return( ret );
1911}
1912
1913/*
1914 * ssl_tls13_write_key_share_ext
1915 *
1916 * Structure of key_share extension in ServerHello:
1917 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001918 * struct {
1919 * NamedGroup group;
1920 * opaque key_exchange<1..2^16-1>;
1921 * } KeyShareEntry;
1922 * struct {
1923 * KeyShareEntry server_share;
1924 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001925 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001926MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001927static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1928 unsigned char *buf,
1929 unsigned char *end,
1930 size_t *out_len )
1931{
Jerry Yu955ddd72022-04-22 22:27:33 +08001932 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001933 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001934 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001935 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001936 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001937
1938 *out_len = 0;
1939
1940 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1941
Jerry Yu58af2332022-09-06 11:19:31 +08001942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1943 mbedtls_ssl_named_group_to_str( group ),
1944 group ) );
1945
Jerry Yu3bf2c642022-03-30 22:02:12 +08001946 /* Check if we have space for header and length fields:
1947 * - extension_type (2 bytes)
1948 * - extension_data_length (2 bytes)
1949 * - group (2 bytes)
1950 * - key_exchange_length (2 bytes)
1951 */
1952 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001953 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1954 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001955 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001956
Jerry Yu3bf2c642022-03-30 22:02:12 +08001957 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1958 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001959 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001960 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001961 if( ret != 0 )
1962 return( ret );
1963 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001964
Jerry Yu955ddd72022-04-22 22:27:33 +08001965 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001966
Jerry Yu57d48412022-04-20 21:50:42 +08001967 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001968
Jerry Yu57d48412022-04-20 21:50:42 +08001969 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001970
Jerry Yu3bf2c642022-03-30 22:02:12 +08001971 return( 0 );
1972}
Jerry Yud9436a12022-04-20 22:28:09 +08001973
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001974MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001975static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1976 unsigned char *buf,
1977 unsigned char *end,
1978 size_t *out_len )
1979{
1980 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1981 /* key_share Extension
1982 *
1983 * struct {
1984 * select (Handshake.msg_type) {
1985 * ...
1986 * case hello_retry_request:
1987 * NamedGroup selected_group;
1988 * ...
1989 * };
1990 * } KeyShare;
1991 */
1992
1993 *out_len = 0;
1994
Jerry Yub0ac10b2022-05-05 11:10:08 +08001995 /*
1996 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1997 * of the HRR is then to transmit a cookie to force the client to demonstrate
1998 * reachability at their apparent network address (primarily useful for DTLS).
1999 */
Ronald Cron79907712022-07-20 17:05:29 +02002000 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002001 return( 0 );
2002
2003 /* We should only send the key_share extension if the client's initial
2004 * key share was not acceptable. */
2005 if( ssl->handshake->offered_group_id != 0 )
2006 {
2007 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
2008 return( 0 );
2009 }
2010
2011 if( selected_group == 0 )
2012 {
2013 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
2014 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2015 }
2016
Jerry Yub0ac10b2022-05-05 11:10:08 +08002017 /* Check if we have enough space:
2018 * - extension_type (2 bytes)
2019 * - extension_data_length (2 bytes)
2020 * - selected_group (2 bytes)
2021 */
Ronald Cron154d1b62022-06-01 15:33:26 +02002022 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002023
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002024 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002025 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002026 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
2027
2028 MBEDTLS_SSL_DEBUG_MSG( 3,
2029 ( "HRR selected_group: %s (%x)",
2030 mbedtls_ssl_named_group_to_str( selected_group ),
2031 selected_group ) );
2032
2033 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002034
Jerry Yub0ac10b2022-05-05 11:10:08 +08002035 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002036}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002037
2038/*
2039 * Structure of ServerHello message:
2040 *
2041 * struct {
2042 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2043 * Random random;
2044 * opaque legacy_session_id_echo<0..32>;
2045 * CipherSuite cipher_suite;
2046 * uint8 legacy_compression_method = 0;
2047 * Extension extensions<6..2^16-1>;
2048 * } ServerHello;
2049 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002050MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002052 unsigned char *buf,
2053 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002054 size_t *out_len,
2055 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002056{
Jerry Yu955ddd72022-04-22 22:27:33 +08002057 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002059 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002060 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002061
2062 *out_len = 0;
2063
Jerry Yucfc04b32022-04-21 09:31:58 +08002064 /* ...
2065 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2066 * ...
2067 * with ProtocolVersion defined as:
2068 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002069 */
2070 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2071 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2072 p += 2;
2073
Jerry Yu1c3e6882022-04-20 21:23:40 +08002074 /* ...
2075 * Random random;
2076 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002077 * with Random defined as:
2078 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002079 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002080 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002081 if( is_hrr )
2082 {
2083 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002084 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002085 }
2086 else
2087 {
2088 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002089 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002090 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002091 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2093 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2094
Jerry Yucfc04b32022-04-21 09:31:58 +08002095 /* ...
2096 * opaque legacy_session_id_echo<0..32>;
2097 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002098 */
2099 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2100 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2101 if( ssl->session_negotiate->id_len > 0 )
2102 {
2103 memcpy( p, &ssl->session_negotiate->id[0],
2104 ssl->session_negotiate->id_len );
2105 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002106
Jerry Yu3bf2c642022-03-30 22:02:12 +08002107 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2108 ssl->session_negotiate->id_len );
2109 }
2110
Jerry Yucfc04b32022-04-21 09:31:58 +08002111 /* ...
2112 * CipherSuite cipher_suite;
2113 * ...
2114 * with CipherSuite defined as:
2115 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002116 */
2117 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2118 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2119 p += 2;
2120 MBEDTLS_SSL_DEBUG_MSG( 3,
2121 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2122 mbedtls_ssl_get_ciphersuite_name(
2123 ssl->session_negotiate->ciphersuite ),
2124 ssl->session_negotiate->ciphersuite ) );
2125
Jerry Yucfc04b32022-04-21 09:31:58 +08002126 /* ...
2127 * uint8 legacy_compression_method = 0;
2128 * ...
2129 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002130 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002131 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002132
Jerry Yucfc04b32022-04-21 09:31:58 +08002133 /* ...
2134 * Extension extensions<6..2^16-1>;
2135 * ...
2136 * struct {
2137 * ExtensionType extension_type; (2 bytes)
2138 * opaque extension_data<0..2^16-1>;
2139 * } Extension;
2140 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002141 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002142 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002143 p += 2;
2144
Jerry Yue74e04a2022-04-21 09:23:16 +08002145 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002146 ssl, p, end, &output_len ) ) != 0 )
2147 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002148 MBEDTLS_SSL_DEBUG_RET(
2149 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002150 return( ret );
2151 }
2152 p += output_len;
2153
Jerry Yu56acc942022-07-30 23:02:36 +08002154 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002155 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002156 if( is_hrr )
2157 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2158 else
2159 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002160 if( ret != 0 )
2161 return( ret );
2162 p += output_len;
2163 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002164
Jerry Yu032b15ce2022-07-11 06:10:03 +00002165#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002166 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002167 {
Jerry Yubb852022022-07-20 21:10:44 +08002168 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002169 if( ret != 0 )
2170 {
Jerry Yubb852022022-07-20 21:10:44 +08002171 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002172 ret );
2173 return( ret );
2174 }
2175 p += output_len;
2176 }
2177#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
2178
Jerry Yud9436a12022-04-20 22:28:09 +08002179 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002180
Jerry Yud9436a12022-04-20 22:28:09 +08002181 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2182 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002183
Jerry Yud9436a12022-04-20 22:28:09 +08002184 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002185
Jerry Yud9436a12022-04-20 22:28:09 +08002186 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002187
2188 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002189}
2190
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002191MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002192static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2193{
2194 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002195 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002196 if( ret != 0 )
2197 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002198 MBEDTLS_SSL_DEBUG_RET( 1,
2199 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002200 ret );
2201 return( ret );
2202 }
2203
Jerry Yue110d252022-05-05 10:19:22 +08002204 return( ret );
2205}
2206
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002207MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002208static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2209{
Jerry Yu637a3f12022-04-20 21:37:58 +08002210 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002211 unsigned char *buf;
2212 size_t buf_len, msg_len;
2213
2214 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2215
Jerry Yuf4b27e42022-03-30 17:32:21 +08002216 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2217
Jerry Yu3bf2c642022-03-30 22:02:12 +08002218 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002219 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2220
Jerry Yu3bf2c642022-03-30 22:02:12 +08002221 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2222 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002223 &msg_len,
2224 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002225
Jerry Yu3bf2c642022-03-30 22:02:12 +08002226 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002227 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2228
Jerry Yu3bf2c642022-03-30 22:02:12 +08002229 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002230 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002231
Jerry Yue110d252022-05-05 10:19:22 +08002232 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2233
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002234#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2235 /* The server sends a dummy change_cipher_spec record immediately
2236 * after its first handshake message. This may either be after
2237 * a ServerHello or a HelloRetryRequest.
2238 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002239 mbedtls_ssl_handshake_set_state(
2240 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002241#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002242 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002243#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002244
Jerry Yuf4b27e42022-03-30 17:32:21 +08002245cleanup:
2246
2247 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2248 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002249}
2250
Jerry Yu23d1a252022-05-12 18:08:59 +08002251
2252/*
2253 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2254 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002255MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002256static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002257{
2258 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2259 if( ssl->handshake->hello_retry_request_count > 0 )
2260 {
2261 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2262 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2263 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2264 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2265 }
2266
2267 /*
2268 * Create stateless transcript hash for HRR
2269 */
2270 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2271 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2272 if( ret != 0 )
2273 {
2274 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2275 return( ret );
2276 }
2277 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2278
2279 return( 0 );
2280}
2281
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002282MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002283static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2284{
2285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2286 unsigned char *buf;
2287 size_t buf_len, msg_len;
2288
2289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2290
Ronald Cron7b840462022-06-01 17:05:53 +02002291 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002292
2293 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2294 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2295 &buf, &buf_len ) );
2296
2297 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2298 buf + buf_len,
2299 &msg_len,
2300 1 ) );
2301 mbedtls_ssl_add_hs_msg_to_checksum(
2302 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2303
2304
2305 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2306 msg_len ) );
2307
2308 ssl->handshake->hello_retry_request_count++;
2309
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002310#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2311 /* The server sends a dummy change_cipher_spec record immediately
2312 * after its first handshake message. This may either be after
2313 * a ServerHello or a HelloRetryRequest.
2314 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002315 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002316 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002317#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002318 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002319#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002320
2321cleanup:
2322 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2323 return( ret );
2324}
2325
Jerry Yu5b64ae92022-03-30 17:15:02 +08002326/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002327 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2328 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002329
2330/*
2331 * struct {
2332 * Extension extensions<0..2 ^ 16 - 1>;
2333 * } EncryptedExtensions;
2334 *
2335 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002336MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002337static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2338 unsigned char *buf,
2339 unsigned char *end,
2340 size_t *out_len )
2341{
XiaokangQianacb39922022-06-17 10:18:48 +00002342 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002343 unsigned char *p = buf;
2344 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002345 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002346 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002347
Jerry Yu4d3841a2022-04-16 12:37:19 +08002348 *out_len = 0;
2349
2350 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002351 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002352 p += 2;
2353
Jerry Yu8937eb42022-05-03 12:12:14 +08002354 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002355 ((void) ret);
2356 ((void) output_len);
2357
2358#if defined(MBEDTLS_SSL_ALPN)
2359 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2360 if( ret != 0 )
2361 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002362 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002363#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002364
Jerry Yu8937eb42022-05-03 12:12:14 +08002365 extensions_len = ( p - p_extensions_len ) - 2;
2366 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2367
2368 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002369
2370 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2371
2372 return( 0 );
2373}
2374
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002375MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002376static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2377{
2378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2379 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002380 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002381
Gabor Mezei54719122022-06-28 11:34:56 +02002382 mbedtls_ssl_set_outbound_transform( ssl,
2383 ssl->handshake->transform_handshake );
2384 MBEDTLS_SSL_DEBUG_MSG(
2385 3, ( "switching to handshake transform for outbound data" ) );
2386
Jerry Yuab452cc2022-04-28 15:27:08 +08002387 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002388
Jerry Yu4d3841a2022-04-16 12:37:19 +08002389 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2390 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2391
2392 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2393 ssl, buf, buf + buf_len, &msg_len ) );
2394
2395 mbedtls_ssl_add_hs_msg_to_checksum(
2396 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2397
Jerry Yu4d3841a2022-04-16 12:37:19 +08002398 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2399 ssl, buf_len, msg_len ) );
2400
Jerry Yu8937eb42022-05-03 12:12:14 +08002401#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002402 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002403 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2404 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002405 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002406#else
2407 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2408#endif
2409
Jerry Yu4d3841a2022-04-16 12:37:19 +08002410cleanup:
2411
Jerry Yuab452cc2022-04-28 15:27:08 +08002412 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002413 return( ret );
2414}
2415
XiaokangQiancec9ae62022-05-06 07:28:50 +00002416#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002417#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2418#define SSL_CERTIFICATE_REQUEST_SKIP 1
2419/* Coordination:
2420 * Check whether a CertificateRequest message should be written.
2421 * Returns a negative code on failure, or
2422 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2423 * - SSL_CERTIFICATE_REQUEST_SKIP
2424 * indicating if the writing of the CertificateRequest
2425 * should be skipped or not.
2426 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002427MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002428static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2429{
2430 int authmode;
2431
XiaokangQian40a35232022-05-07 09:02:40 +00002432#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2433 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2434 authmode = ssl->handshake->sni_authmode;
2435 else
2436#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002437 authmode = ssl->conf->authmode;
2438
2439 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
2440 return( SSL_CERTIFICATE_REQUEST_SKIP );
2441
XiaokangQianc3017f62022-05-13 05:55:41 +00002442 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002443
XiaokangQiana987e1d2022-05-07 01:25:58 +00002444 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2445}
2446
XiaokangQiancec9ae62022-05-06 07:28:50 +00002447/*
2448 * struct {
2449 * opaque certificate_request_context<0..2^8-1>;
2450 * Extension extensions<2..2^16-1>;
2451 * } CertificateRequest;
2452 *
2453 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002454MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002455static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2456 unsigned char *buf,
2457 const unsigned char *end,
2458 size_t *out_len )
2459{
2460 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2461 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002462 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002463 unsigned char *p_extensions_len;
2464
2465 *out_len = 0;
2466
2467 /* Check if we have enough space:
2468 * - certificate_request_context (1 byte)
2469 * - extensions length (2 bytes)
2470 */
2471 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2472
2473 /*
2474 * Write certificate_request_context
2475 */
2476 /*
2477 * We use a zero length context for the normal handshake
2478 * messages. For post-authentication handshake messages
2479 * this request context would be set to a non-zero value.
2480 */
2481 *p++ = 0x0;
2482
2483 /*
2484 * Write extensions
2485 */
2486 /* The extensions must contain the signature_algorithms. */
2487 p_extensions_len = p;
2488 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002489 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002490 if( ret != 0 )
2491 return( ret );
2492
XiaokangQianec6efb92022-05-06 09:53:10 +00002493 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002494 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002495
2496 *out_len = p - buf;
2497
2498 return( 0 );
2499}
2500
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002501MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002502static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2503{
2504 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2505
2506 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2507
2508 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2509
2510 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2511 {
2512 unsigned char *buf;
2513 size_t buf_len, msg_len;
2514
2515 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2516 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2517
2518 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2519 ssl, buf, buf + buf_len, &msg_len ) );
2520
2521 mbedtls_ssl_add_hs_msg_to_checksum(
2522 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2523
2524 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2525 ssl, buf_len, msg_len ) );
2526 }
2527 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2528 {
2529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2530 ret = 0;
2531 }
2532 else
2533 {
2534 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2535 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2536 goto cleanup;
2537 }
2538
2539 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2540cleanup:
2541
2542 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2543 return( ret );
2544}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002545
Jerry Yu4d3841a2022-04-16 12:37:19 +08002546/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002547 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002548 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002549MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002550static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002551{
Jerry Yu5a26f302022-05-10 20:46:40 +08002552 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002553
2554#if defined(MBEDTLS_X509_CRT_PARSE_C)
2555 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2556 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002557 {
Jerry Yub89125b2022-05-13 15:45:49 +08002558 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002559 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2560 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002561 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002562 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002563#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002564
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002565 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2566 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002567 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002568 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2569 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002570}
2571
2572/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002573 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002574 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002575MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002576static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002577{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002578 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002579 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002580 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002581 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2582 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002583}
Jerry Yu5a26f302022-05-10 20:46:40 +08002584#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002585
2586/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002587 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002588 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002589MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002590static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002591{
Jerry Yud6e253d2022-05-18 13:59:24 +08002592 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002593
2594 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2595 if( ret != 0 )
2596 return( ret );
2597
Jerry Yue3d67cb2022-05-19 15:33:10 +08002598 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2599 if( ret != 0 )
2600 {
2601 MBEDTLS_SSL_PEND_FATAL_ALERT(
2602 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2603 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2604 return( ret );
2605 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002606
Ronald Cron63dc4632022-05-31 14:41:53 +02002607 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2608 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002609
Ronald Cron63dc4632022-05-31 14:41:53 +02002610 if( ssl->handshake->certificate_request_sent )
2611 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002612 else
Ronald Cron19385882022-06-15 16:26:13 +02002613 {
2614 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2615 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002616 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002617 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002618
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002619 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002620}
2621
2622/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002623 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002624 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002625MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002626static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002627{
Jerry Yud6e253d2022-05-18 13:59:24 +08002628 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2629
Jerry Yuff226982022-04-16 16:52:57 +08002630 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2631 if( ret != 0 )
2632 return( ret );
2633
Jerry Yu466dda82022-09-13 11:20:20 +08002634 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002635 if( ret != 0 )
2636 {
2637 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002638 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002639 }
2640
Jerry Yu03ed50b2022-04-16 17:13:30 +08002641 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002642 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002643}
2644
2645/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002646 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002647 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002648MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002649static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002650{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2652
Jerry Yu03ed50b2022-04-16 17:13:30 +08002653 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002654
2655#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002656 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2657#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002658 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002659#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002660 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002661}
2662
2663/*
Jerry Yue67bef42022-07-07 07:29:42 +00002664 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2665 */
2666#define SSL_NEW_SESSION_TICKET_SKIP 0
2667#define SSL_NEW_SESSION_TICKET_WRITE 1
2668MBEDTLS_CHECK_RETURN_CRITICAL
2669static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2670{
2671 /* Check whether the use of session tickets is enabled */
2672 if( ssl->conf->f_ticket_write == NULL )
2673 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002674 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2675 " callback is not set" ) );
2676 return( SSL_NEW_SESSION_TICKET_SKIP );
2677 }
2678 if( ssl->conf->new_session_tickets_count == 0 )
2679 {
2680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2681 " configured count is zero" ) );
2682 return( SSL_NEW_SESSION_TICKET_SKIP );
2683 }
2684
2685 if( ssl->handshake->new_session_tickets_count == 0 )
2686 {
2687 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2688 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002689 return( SSL_NEW_SESSION_TICKET_SKIP );
2690 }
2691
Jerry Yue67bef42022-07-07 07:29:42 +00002692 return( SSL_NEW_SESSION_TICKET_WRITE );
2693}
2694
2695#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2696MBEDTLS_CHECK_RETURN_CRITICAL
2697static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2698 unsigned char *ticket_nonce,
2699 size_t ticket_nonce_size )
2700{
2701 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2702 mbedtls_ssl_session *session = ssl->session;
2703 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2704 psa_algorithm_t psa_hash_alg;
2705 int hash_length;
2706
2707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2708
2709#if defined(MBEDTLS_HAVE_TIME)
2710 session->start = mbedtls_time( NULL );
2711#endif
2712
2713 /* Generate ticket_age_add */
2714 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002715 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002716 sizeof( session->ticket_age_add ) ) != 0 ) )
2717 {
2718 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2719 return( ret );
2720 }
2721 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002722 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002723
2724 /* Generate ticket_nonce */
2725 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2726 if( ret != 0 )
2727 {
2728 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2729 return( ret );
2730 }
2731 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2732 ticket_nonce, ticket_nonce_size );
2733
2734 ciphersuite_info =
2735 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2736 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2737 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002738 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002739 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002740 {
Jerry Yue67bef42022-07-07 07:29:42 +00002741 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002742 }
2743
Jerry Yue67bef42022-07-07 07:29:42 +00002744 /* In this code the psk key length equals the length of the hash */
2745 session->resumption_key_len = hash_length;
2746 session->ciphersuite = ciphersuite_info->id;
2747
2748 /* Compute resumption key
2749 *
2750 * HKDF-Expand-Label( resumption_master_secret,
2751 * "resumption", ticket_nonce, Hash.length )
2752 */
2753 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2754 psa_hash_alg,
2755 session->app_secrets.resumption_master_secret,
2756 hash_length,
2757 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2758 ticket_nonce,
2759 ticket_nonce_size,
2760 session->resumption_key,
2761 hash_length );
2762
2763 if( ret != 0 )
2764 {
2765 MBEDTLS_SSL_DEBUG_RET( 2,
2766 "Creating the ticket-resumed PSK failed",
2767 ret );
2768 return ( ret );
2769 }
2770 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2771 session->resumption_key,
2772 session->resumption_key_len );
2773
2774 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2775 session->app_secrets.resumption_master_secret,
2776 hash_length );
2777
2778 return( 0 );
2779}
2780
2781/* This function creates a NewSessionTicket message in the following format:
2782 *
2783 * struct {
2784 * uint32 ticket_lifetime;
2785 * uint32 ticket_age_add;
2786 * opaque ticket_nonce<0..255>;
2787 * opaque ticket<1..2^16-1>;
2788 * Extension extensions<0..2^16-2>;
2789 * } NewSessionTicket;
2790 *
2791 * The ticket inside the NewSessionTicket message is an encrypted container
2792 * carrying the necessary information so that the server is later able to
2793 * re-start the communication.
2794 *
2795 * The following fields are placed inside the ticket by the
2796 * f_ticket_write() function:
2797 *
2798 * - creation time (start)
2799 * - flags (flags)
2800 * - age add (ticket_age_add)
2801 * - key (key)
2802 * - key length (key_len)
2803 * - ciphersuite (ciphersuite)
2804 */
2805MBEDTLS_CHECK_RETURN_CRITICAL
2806static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2807 unsigned char *buf,
2808 unsigned char *end,
2809 size_t *out_len,
2810 unsigned char *ticket_nonce,
2811 size_t ticket_nonce_size )
2812{
2813 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2814 unsigned char *p = buf;
2815 mbedtls_ssl_session *session = ssl->session;
2816 size_t ticket_len;
2817 uint32_t ticket_lifetime;
2818
2819 *out_len = 0;
2820 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2821
2822 /*
2823 * ticket_lifetime 4 bytes
2824 * ticket_age_add 4 bytes
2825 * ticket_nonce 1 + ticket_nonce_size bytes
2826 * ticket >=2 bytes
2827 */
2828 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2829
2830 /* Generate ticket and ticket_lifetime */
2831 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2832 session,
2833 p + 9 + ticket_nonce_size + 2,
2834 end,
2835 &ticket_len,
2836 &ticket_lifetime);
2837 if( ret != 0 )
2838 {
2839 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2840 return( ret );
2841 }
2842 /* RFC 8446 4.6.1
2843 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2844 * unsigned integer in network byte order from the time of ticket
2845 * issuance. Servers MUST NOT use any value greater than
2846 * 604800 seconds (7 days). The value of zero indicates that the
2847 * ticket should be discarded immediately. Clients MUST NOT cache
2848 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2849 * and MAY delete tickets earlier based on local policy. A server
2850 * MAY treat a ticket as valid for a shorter period of time than what
2851 * is stated in the ticket_lifetime.
2852 */
2853 ticket_lifetime %= 604800;
2854 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2855 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2856 ( unsigned int )ticket_lifetime ) );
2857
2858 /* Write ticket_age_add */
2859 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2860 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2861 ( unsigned int )session->ticket_age_add ) );
2862
2863 /* Write ticket_nonce */
2864 p[8] = ( unsigned char )ticket_nonce_size;
2865 if( ticket_nonce_size > 0 )
2866 {
2867 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2868 }
2869 p += 9 + ticket_nonce_size;
2870
2871 /* Write ticket */
2872 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2873 p += 2;
2874 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2875 p += ticket_len;
2876
2877 /* Ticket Extensions
2878 *
2879 * Note: We currently don't have any extensions.
2880 * Set length to zero.
2881 */
2882 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2883 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2884 p += 2;
2885
2886 *out_len = p - buf;
2887 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2888 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2889
2890 return( 0 );
2891}
2892
2893/*
2894 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2895 */
2896static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2897{
2898 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2899
2900 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2901
2902 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2903 {
2904 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2905 unsigned char *buf;
2906 size_t buf_len, msg_len;
2907
2908 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2909 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2910
2911 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2912 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2913
2914 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2915 ssl, buf, buf + buf_len, &msg_len,
2916 ticket_nonce, sizeof( ticket_nonce ) ) );
2917
Jerry Yue67bef42022-07-07 07:29:42 +00002918 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2919 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002920
Jerry Yu359e65f2022-09-22 23:47:43 +08002921 /* Limit session tickets count to one when resumption connection.
2922 *
2923 * See document of mbedtls_ssl_conf_new_session_tickets.
2924 */
2925 if( ssl->handshake->resume == 1 )
2926 ssl->handshake->new_session_tickets_count = 0;
2927 else
2928 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002929
Jerry Yufca4d572022-07-21 10:37:48 +08002930 mbedtls_ssl_handshake_set_state( ssl,
2931 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002932 }
2933 else
2934 {
2935 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2936 }
2937
Jerry Yue67bef42022-07-07 07:29:42 +00002938cleanup:
2939
2940 return( ret );
2941}
2942#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2943
2944/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002945 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002946 */
Jerry Yu27561932021-08-27 17:07:38 +08002947int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002948{
XiaokangQian08037552022-04-20 07:16:41 +00002949 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002950
2951 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2952 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2953
Jerry Yue3b34122021-09-28 17:53:35 +08002954 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2955 mbedtls_ssl_states_str( ssl->state ),
2956 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002957
XiaokangQian7807f9f2022-02-15 10:04:37 +00002958 switch( ssl->state )
2959 {
2960 /* start state */
2961 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002962 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002963 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002964 break;
2965
XiaokangQian7807f9f2022-02-15 10:04:37 +00002966 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002967 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002968 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002969 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002970 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002971
Jerry Yuf41553b2022-05-09 22:20:30 +08002972 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2973 ret = ssl_tls13_write_hello_retry_request( ssl );
2974 if( ret != 0 )
2975 {
2976 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2977 return( ret );
2978 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002979 break;
2980
Jerry Yu5b64ae92022-03-30 17:15:02 +08002981 case MBEDTLS_SSL_SERVER_HELLO:
2982 ret = ssl_tls13_write_server_hello( ssl );
2983 break;
2984
Xiaofei Baicba64af2022-02-15 10:00:56 +00002985 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002986 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002987 if( ret != 0 )
2988 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002989 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2990 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002991 }
Jerry Yu48330562022-05-06 21:35:44 +08002992 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002993
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002994#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2995 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002996 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002997 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002998
Jerry Yu83da34e2022-04-16 13:59:52 +08002999 case MBEDTLS_SSL_SERVER_CERTIFICATE:
3000 ret = ssl_tls13_write_server_certificate( ssl );
3001 break;
3002
3003 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
3004 ret = ssl_tls13_write_certificate_verify( ssl );
3005 break;
Jerry Yu5a26f302022-05-10 20:46:40 +08003006#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003007
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003008 /*
3009 * Injection of dummy-CCS's for middlebox compatibility
3010 */
3011#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003012 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003013 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
3014 if( ret == 0 )
3015 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
3016 break;
3017
3018 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
3019 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
3020 if( ret == 0 )
3021 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
3022 break;
3023#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3024
Jerry Yu69dd8d42022-04-16 12:51:26 +08003025 case MBEDTLS_SSL_SERVER_FINISHED:
3026 ret = ssl_tls13_write_server_finished( ssl );
3027 break;
3028
3029 case MBEDTLS_SSL_CLIENT_FINISHED:
3030 ret = ssl_tls13_process_client_finished( ssl );
3031 break;
3032
Jerry Yu69dd8d42022-04-16 12:51:26 +08003033 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3034 ret = ssl_tls13_handshake_wrapup( ssl );
3035 break;
3036
XiaokangQian6b916b12022-04-25 07:29:34 +00003037 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3038 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003039 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003040 {
Ronald Cron209cae92022-06-07 10:30:19 +02003041 if( ssl->session_negotiate->peer_cert != NULL )
3042 {
3043 mbedtls_ssl_handshake_set_state(
3044 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3045 }
3046 else
Ronald Cron19385882022-06-15 16:26:13 +02003047 {
3048 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003049 mbedtls_ssl_handshake_set_state(
3050 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003051 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003052 }
3053 break;
3054
3055 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3056 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3057 if( ret == 0 )
3058 {
3059 mbedtls_ssl_handshake_set_state(
3060 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3061 }
3062 break;
3063
Jerry Yue67bef42022-07-07 07:29:42 +00003064#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3065 case MBEDTLS_SSL_NEW_SESSION_TICKET:
3066 ret = ssl_tls13_write_new_session_ticket( ssl );
3067 if( ret != 0 )
3068 {
3069 MBEDTLS_SSL_DEBUG_RET( 1,
3070 "ssl_tls13_write_new_session_ticket ",
3071 ret );
3072 }
3073 break;
3074 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
3075 /* This state is necessary to do the flush of the New Session
3076 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
3077 * as part of ssl_prepare_handshake_step.
3078 */
3079 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003080
Jerry Yud0766ec2022-09-22 10:46:57 +08003081 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003082 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3083 else
3084 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003085 break;
3086
3087#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3088
XiaokangQian7807f9f2022-02-15 10:04:37 +00003089 default:
3090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003091 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003092 }
3093
3094 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003095}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003096
Jerry Yufb4b6472022-01-27 15:03:26 +08003097#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */