blob: 051afa2705a22ddd9d1187932065b3b281fcb1ea [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#include "mbedtls/platform.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000038
Jerry Yu4d3841a2022-04-16 12:37:19 +080039#include "ssl_misc.h"
40#include "ssl_tls13_keys.h"
41#include "ssl_debug_helpers.h"
42
Jerry Yuf35ba382022-08-23 17:58:26 +080043
Jerry Yuc5a23a02022-08-25 10:51:44 +080044static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Jerry Yuf35ba382022-08-23 17:58:26 +080045 mbedtls_ssl_context *ssl,
Jerry Yuc5a23a02022-08-25 10:51:44 +080046 unsigned int cipher_suite )
Jerry Yuf35ba382022-08-23 17:58:26 +080047{
48 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
49 if( ! mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
50 return( NULL );
51
52 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
53 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
54 ssl->tls_version,
55 ssl->tls_version ) != 0 ) )
56 {
57 return( NULL );
58 }
59 return( ciphersuite_info );
60}
61
Ronald Cron41a443a2022-10-04 16:38:25 +020062#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000063/* From RFC 8446:
64 *
65 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
66 * struct {
67 * PskKeyExchangeMode ke_modes<1..255>;
68 * } PskKeyExchangeModes;
69 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080070MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue19e3b92022-07-08 12:04:51 +000071static int ssl_tls13_parse_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
72 const unsigned char *buf,
Jerry Yu299e31f2022-07-13 23:06:36 +080073 const unsigned char *end )
Jerry Yue19e3b92022-07-08 12:04:51 +000074{
Jerry Yu299e31f2022-07-13 23:06:36 +080075 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000076 size_t ke_modes_len;
77 int ke_modes = 0;
78
Jerry Yu854dd9e2022-07-15 14:28:27 +080079 /* Read ke_modes length (1 Byte) */
Jerry Yu299e31f2022-07-13 23:06:36 +080080 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
81 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000082 /* Currently, there are only two PSK modes, so even without looking
83 * at the content, something's wrong if the list has more than 2 items. */
84 if( ke_modes_len > 2 )
Jerry Yu299e31f2022-07-13 23:06:36 +080085 {
86 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
87 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +000088 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu299e31f2022-07-13 23:06:36 +080089 }
Jerry Yue19e3b92022-07-08 12:04:51 +000090
Jerry Yu299e31f2022-07-13 23:06:36 +080091 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ke_modes_len );
Jerry Yue19e3b92022-07-08 12:04:51 +000092
93 while( ke_modes_len-- != 0 )
94 {
Jerry Yu299e31f2022-07-13 23:06:36 +080095 switch( *p++ )
Jerry Yue19e3b92022-07-08 12:04:51 +000096 {
97 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
98 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
99 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK KEX MODE" ) );
100 break;
101 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
102 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK_EPHEMERAL KEX MODE" ) );
104 break;
105 default:
Jerry Yu299e31f2022-07-13 23:06:36 +0800106 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
107 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +0000108 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
109 }
110 }
111
112 ssl->handshake->tls13_kex_modes = ke_modes;
113 return( 0 );
114}
Jerry Yu1c105562022-07-10 06:32:38 +0000115
Jerry Yue9d4fc02022-08-20 19:21:15 +0800116#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
117#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800118
119#if defined(MBEDTLS_SSL_SESSION_TICKETS)
120
121MBEDTLS_CHECK_RETURN_CRITICAL
122static int ssl_tls13_offered_psks_check_identity_match_ticket(
123 mbedtls_ssl_context *ssl,
Jerry Yu95699e72022-08-21 19:22:23 +0800124 const unsigned char *identity,
125 size_t identity_len,
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800126 uint32_t obfuscated_ticket_age,
127 mbedtls_ssl_session *session )
Jerry Yu95699e72022-08-21 19:22:23 +0800128{
Jerry Yufd310eb2022-09-06 09:16:35 +0800129 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800130 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800131#if defined(MBEDTLS_HAVE_TIME)
132 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800133 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800134 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800135#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800136
137 ((void) obfuscated_ticket_age);
138
139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> check_identity_match_ticket" ) );
140
Jerry Yufd310eb2022-09-06 09:16:35 +0800141 /* Ticket parser is not configured, Skip */
142 if( ssl->conf->f_ticket_parse == NULL || identity_len == 0 )
Jerry Yu95699e72022-08-21 19:22:23 +0800143 return( 0 );
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Jerry Yu4746b102022-09-13 11:11:48 +0800145 /* We create a copy of the encrypted ticket since the ticket parsing
146 * function is allowed to use its input buffer as an output buffer
147 * (in-place decryption). We do, however, need the original buffer for
148 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800149 */
150 ticket_buffer = mbedtls_calloc( 1, identity_len );
151 if( ticket_buffer == NULL )
152 {
153 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
154 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
155 }
156 memcpy( ticket_buffer, identity, identity_len );
157
158 if( ( ret = ssl->conf->f_ticket_parse( ssl->conf->p_ticket,
159 session,
160 ticket_buffer, identity_len ) ) != 0 )
161 {
162 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is not authentic" ) );
164 else if( ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED )
165 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is expired" ) );
166 else
167 MBEDTLS_SSL_DEBUG_RET( 1, "ticket_parse", ret );
168 }
169
170 /* We delete the temporary buffer */
171 mbedtls_free( ticket_buffer );
172
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800173 if( ret != 0 )
174 goto exit;
175
176 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
177#if defined(MBEDTLS_HAVE_TIME)
178 now = mbedtls_time( NULL );
179
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800180 if( now < session->start )
Jerry Yu95699e72022-08-21 19:22:23 +0800181 {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800182 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu03aa1742022-10-10 21:48:37 +0800183 3, ( "Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
Jerry Yua99cbfa2022-10-08 11:17:14 +0800184 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
185 (long long)now, (long long)session->start ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800186 goto exit;
187 }
Jerry Yu95699e72022-08-21 19:22:23 +0800188
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800189 age_in_s = (uint64_t)( now - session->start );
Jerry Yu95699e72022-08-21 19:22:23 +0800190
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800191 /* RFC 8446 section 4.6.1
192 *
193 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
194 *
195 * RFC 8446 section 4.2.11.1
196 *
197 * Clients MUST NOT attempt to use tickets which have ages greater than
198 * the "ticket_lifetime" value which was provided with the ticket.
199 *
200 * For time being, the age MUST be less than 604800 seconds (7 days).
201 */
202 if( age_in_s > 604800 )
203 {
204 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuc2bfaf02022-10-11 15:55:52 +0800205 3, ( "Ticket age exceeds limitation ticket_age=%lu",
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800206 (long unsigned int)age_in_s ) );
207 goto exit;
208 }
Jerry Yu95699e72022-08-21 19:22:23 +0800209
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 /* RFC 8446 section 4.2.10
211 *
212 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
213 * the ticket age for the selected PSK identity (computed by subtracting
214 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
215 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800216 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800217 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
218 * as the age units are different on the server (s) and in the
219 * client (ms) side. Add a -1000 ms tolerance window to take this
220 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800221 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 age_diff_in_ms = age_in_s * 1000;
223 age_diff_in_ms -= ( obfuscated_ticket_age - session->ticket_age_add );
224 if( age_diff_in_ms <= -1000 ||
225 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE )
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800226 {
227 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu03aa1742022-10-10 21:48:37 +0800228 3, ( "Ticket age outside tolerance window ( diff=%d )",
229 (int)age_diff_in_ms ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800230 goto exit;
231 }
232
233 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800234
235#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800236
237exit:
238 if( ret != 0 )
239 mbedtls_ssl_session_free( session );
Jerry Yu95699e72022-08-21 19:22:23 +0800240
241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= check_identity_match_ticket" ) );
242 return( ret );
243}
244#endif /* MBEDTLS_SSL_SESSION_TICKETS */
245
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800246MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000247static int ssl_tls13_offered_psks_check_identity_match(
248 mbedtls_ssl_context *ssl,
249 const unsigned char *identity,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800250 size_t identity_len,
Jerry Yu95699e72022-08-21 19:22:23 +0800251 uint32_t obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800252 int *psk_type,
253 mbedtls_ssl_session *session )
Jerry Yu1c105562022-07-10 06:32:38 +0000254{
Jerry Yu95699e72022-08-21 19:22:23 +0800255 ((void) session);
256 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800257 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800258
259 MBEDTLS_SSL_DEBUG_BUF( 4, "identity", identity, identity_len );
260 ssl->handshake->resume = 0;
261
Jerry Yu95699e72022-08-21 19:22:23 +0800262#if defined(MBEDTLS_SSL_SESSION_TICKETS)
263 if( ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800264 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800265 session ) == SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu95699e72022-08-21 19:22:23 +0800266 {
Jerry Yu95699e72022-08-21 19:22:23 +0800267 ssl->handshake->resume = 1;
268 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
269 mbedtls_ssl_set_hs_psk( ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800270 session->resumption_key,
271 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800272
273 MBEDTLS_SSL_DEBUG_BUF( 4, "Ticket-resumed PSK:",
Jerry Yu0a55cc62022-09-15 16:15:06 +0800274 session->resumption_key,
275 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800276 MBEDTLS_SSL_DEBUG_MSG( 4, ( "ticket: obfuscated_ticket_age: %u",
277 (unsigned)obfuscated_ticket_age ) );
278 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
279 }
280#endif /* MBEDTLS_SSL_SESSION_TICKETS */
281
Jerry Yu1c105562022-07-10 06:32:38 +0000282 /* Check identity with external configured function */
283 if( ssl->conf->f_psk != NULL )
284 {
285 if( ssl->conf->f_psk(
286 ssl->conf->p_psk, ssl, identity, identity_len ) == 0 )
287 {
288 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
289 }
290 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
291 }
292
Jerry Yu96a2e362022-07-21 15:11:34 +0800293 MBEDTLS_SSL_DEBUG_BUF( 5, "identity", identity, identity_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000294 /* Check identity with pre-configured psk */
Jerry Yu2f0abc92022-07-22 19:34:48 +0800295 if( ssl->conf->psk_identity != NULL &&
296 identity_len == ssl->conf->psk_identity_len &&
Jerry Yu1c105562022-07-10 06:32:38 +0000297 mbedtls_ct_memcmp( ssl->conf->psk_identity,
298 identity, identity_len ) == 0 )
299 {
300 mbedtls_ssl_set_hs_psk( ssl, ssl->conf->psk, ssl->conf->psk_len );
301 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
302 }
303
Jerry Yu1c105562022-07-10 06:32:38 +0000304 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
305}
306
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800307MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu96a2e362022-07-21 15:11:34 +0800308static int ssl_tls13_offered_psks_check_binder_match( mbedtls_ssl_context *ssl,
309 const unsigned char *binder,
Jerry Yue95c8af2022-07-26 15:48:20 +0800310 size_t binder_len,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800311 int psk_type,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800312 psa_algorithm_t psk_hash_alg )
Jerry Yu1c105562022-07-10 06:32:38 +0000313{
314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800315
Jerry Yudaf375a2022-07-20 21:31:43 +0800316 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000317 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800318 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800319 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800320 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000321
Jerry Yu1c105562022-07-10 06:32:38 +0000322 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800323 ret = mbedtls_ssl_get_handshake_transcript(
324 ssl, mbedtls_hash_info_md_from_psa( psk_hash_alg ),
325 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000326 if( ret != 0 )
327 return( ret );
328
Jerry Yu40f37712022-07-26 16:58:57 +0800329 ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len );
Jerry Yu96a2e362022-07-21 15:11:34 +0800330 if( ret != 0 )
331 return( ret );
332
Jerry Yu29d9faa2022-08-23 17:52:45 +0800333 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psk_hash_alg,
Jerry Yu1c105562022-07-10 06:32:38 +0000334 psk, psk_len, psk_type,
335 transcript,
336 server_computed_binder );
Jerry Yu96a2e362022-07-21 15:11:34 +0800337#if defined(MBEDTLS_USE_PSA_CRYPTO)
338 mbedtls_free( (void*)psk );
339#endif
Jerry Yu1c105562022-07-10 06:32:38 +0000340 if( ret != 0 )
341 {
342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "PSK binder calculation failed." ) );
343 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
344 }
345
346 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( computed ): ",
Jerry Yu2f0abc92022-07-22 19:34:48 +0800347 server_computed_binder, transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000348 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( received ): ", binder, binder_len );
349
350 if( mbedtls_ct_memcmp( server_computed_binder, binder, binder_len ) == 0 )
351 {
352 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
353 }
354
Jerry Yudaf375a2022-07-20 21:31:43 +0800355 mbedtls_platform_zeroize( server_computed_binder,
356 sizeof( server_computed_binder ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000357 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
358}
Jerry Yu96a2e362022-07-21 15:11:34 +0800359
Jerry Yu5725f1c2022-08-21 17:27:16 +0800360MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800361static int ssl_tls13_select_ciphersuite_for_psk(
362 mbedtls_ssl_context *ssl,
363 const unsigned char *cipher_suites,
364 const unsigned char *cipher_suites_end,
365 uint16_t *selected_ciphersuite,
366 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800367{
Jerry Yuf35ba382022-08-23 17:58:26 +0800368 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800369
Jerry Yu0baf9072022-08-25 11:21:04 +0800370 *selected_ciphersuite = 0;
371 *selected_ciphersuite_info = NULL;
372
Jerry Yuf35ba382022-08-23 17:58:26 +0800373 /* RFC 8446, page 55.
374 *
375 * For externally established PSKs, the Hash algorithm MUST be set when the
376 * PSK is established or default to SHA-256 if no such algorithm is defined.
377 *
378 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379
Jerry Yu5725f1c2022-08-21 17:27:16 +0800380 /*
381 * Search for a matching ciphersuite
382 */
Jerry Yu1e05b6d2022-08-31 10:35:52 +0800383 for ( const unsigned char *p = cipher_suites;
384 p < cipher_suites_end; p += 2 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385 {
386 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800387 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800388
389 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +0800390 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
391 cipher_suite );
Jerry Yuf35ba382022-08-23 17:58:26 +0800392 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800393 continue;
394
Jerry Yu5725f1c2022-08-21 17:27:16 +0800395 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
396 * Otherwise, client should reject.
397 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 if( psk_hash_alg == mbedtls_psa_translate_md( ciphersuite_info->mac ) )
399 {
400 *selected_ciphersuite = cipher_suite;
401 *selected_ciphersuite_info = ciphersuite_info;
402 return( 0 );
403 }
404 }
405 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No matched ciphersuite" ) );
406 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
407}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800408
Jerry Yu82534862022-08-30 10:42:33 +0800409#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800410MBEDTLS_CHECK_RETURN_CRITICAL
411static int ssl_tls13_select_ciphersuite_for_resumption(
412 mbedtls_ssl_context *ssl,
413 const unsigned char *cipher_suites,
414 const unsigned char *cipher_suites_end,
415 mbedtls_ssl_session *session,
416 uint16_t *selected_ciphersuite,
417 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
418{
Jerry Yu82534862022-08-30 10:42:33 +0800419
Jerry Yuf35ba382022-08-23 17:58:26 +0800420 *selected_ciphersuite = 0;
421 *selected_ciphersuite_info = NULL;
Jerry Yu82534862022-08-30 10:42:33 +0800422 for( const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2 )
423 {
424 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
425 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
426
427 if( cipher_suite != session->ciphersuite )
428 continue;
429
430 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
431 cipher_suite );
432 if( ciphersuite_info == NULL )
433 continue;
434
Jerry Yu4746b102022-09-13 11:11:48 +0800435 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800436 *selected_ciphersuite_info = ciphersuite_info;
437
438 return( 0 );
Jerry Yu82534862022-08-30 10:42:33 +0800439 }
440
441 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800442}
Jerry Yuf35ba382022-08-23 17:58:26 +0800443
Jerry Yu82534862022-08-30 10:42:33 +0800444MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4746b102022-09-13 11:11:48 +0800445static int ssl_tls13_session_copy_ticket( mbedtls_ssl_session *dst,
446 const mbedtls_ssl_session *src )
Jerry Yu82534862022-08-30 10:42:33 +0800447{
Jerry Yu82534862022-08-30 10:42:33 +0800448 dst->ticket_age_add = src->ticket_age_add;
449 dst->ticket_flags = src->ticket_flags;
450 dst->resumption_key_len = src->resumption_key_len;
451 if( src->resumption_key_len == 0 )
452 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
453 memcpy( dst->resumption_key, src->resumption_key, src->resumption_key_len );
Jerry Yu4746b102022-09-13 11:11:48 +0800454
Jerry Yu82534862022-08-30 10:42:33 +0800455 return( 0 );
456}
457#endif /* MBEDTLS_SSL_SESSION_TICKETS */
458
Jerry Yu1c105562022-07-10 06:32:38 +0000459/* Parser for pre_shared_key extension in client hello
460 * struct {
461 * opaque identity<1..2^16-1>;
462 * uint32 obfuscated_ticket_age;
463 * } PskIdentity;
464 *
465 * opaque PskBinderEntry<32..255>;
466 *
467 * struct {
468 * PskIdentity identities<7..2^16-1>;
469 * PskBinderEntry binders<33..2^16-1>;
470 * } OfferedPsks;
471 *
472 * struct {
473 * select (Handshake.msg_type) {
474 * case client_hello: OfferedPsks;
475 * ....
476 * };
477 * } PreSharedKeyExtension;
478 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800479MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yubb852022022-07-20 21:10:44 +0800480static int ssl_tls13_parse_pre_shared_key_ext( mbedtls_ssl_context *ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800481 const unsigned char *pre_shared_key_ext,
482 const unsigned char *pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800483 const unsigned char *ciphersuites,
484 const unsigned char *ciphersuites_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000485{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800486 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800487 const unsigned char *p_identity_len;
488 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000489 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800490 const unsigned char *binders;
491 const unsigned char *p_binder_len;
492 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000493 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800494 int matched_identity = -1;
495 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000496
Jerry Yu29d9faa2022-08-23 17:52:45 +0800497 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key extension",
498 pre_shared_key_ext,
499 pre_shared_key_ext_end - pre_shared_key_ext );
Jerry Yu1c105562022-07-10 06:32:38 +0000500
Jerry Yu96a2e362022-07-21 15:11:34 +0800501 /* identities_len 2 bytes
502 * identities_data >= 7 bytes
503 */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800504 MBEDTLS_SSL_CHK_BUF_READ_PTR( identities, pre_shared_key_ext_end, 7 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800505 identities_len = MBEDTLS_GET_UINT16_BE( identities, 0 );
506 p_identity_len = identities + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800507 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, pre_shared_key_ext_end,
508 identities_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800509 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000510
Jerry Yu96a2e362022-07-21 15:11:34 +0800511 /* binders_len 2 bytes
512 * binders >= 33 bytes
513 */
Jerry Yu568ec252022-07-22 21:27:34 +0800514 binders = identities_end;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800515 MBEDTLS_SSL_CHK_BUF_READ_PTR( binders, pre_shared_key_ext_end, 33 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800516 binders_len = MBEDTLS_GET_UINT16_BE( binders, 0 );
517 p_binder_len = binders + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800518 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, pre_shared_key_ext_end, binders_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800519 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000520
Jerry Yu29d9faa2022-08-23 17:52:45 +0800521 ssl->handshake->update_checksum( ssl, pre_shared_key_ext,
522 identities_end - pre_shared_key_ext );
Jerry Yu96a2e362022-07-21 15:11:34 +0800523
Jerry Yu568ec252022-07-22 21:27:34 +0800524 while( p_identity_len < identities_end && p_binder_len < binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000525 {
Jerry Yu1c105562022-07-10 06:32:38 +0000526 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800527 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800528 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800529 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800530 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800532 int psk_type;
533 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800534 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800535#if defined(MBEDTLS_SSL_SESSION_TICKETS)
536 mbedtls_ssl_session session;
Jerry Yu4746b102022-09-13 11:11:48 +0800537 mbedtls_ssl_session_init( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800538#endif
Jerry Yubb852022022-07-20 21:10:44 +0800539
Jerry Yu568ec252022-07-22 21:27:34 +0800540 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, identities_end, 2 + 1 + 4 );
541 identity_len = MBEDTLS_GET_UINT16_BE( p_identity_len, 0 );
542 identity = p_identity_len + 2;
543 MBEDTLS_SSL_CHK_BUF_READ_PTR( identity, identities_end, identity_len + 4 );
Jerry Yu82534862022-08-30 10:42:33 +0800544 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE( identity , identity_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800545 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000546
Jerry Yu568ec252022-07-22 21:27:34 +0800547 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, binders_end, 1 + 32 );
548 binder_len = *p_binder_len;
549 binder = p_binder_len + 1;
550 MBEDTLS_SSL_CHK_BUF_READ_PTR( binder, binders_end, binder_len );
551 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800552
Jerry Yu96a2e362022-07-21 15:11:34 +0800553 identity_id++;
554 if( matched_identity != -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000555 continue;
556
Jerry Yu96a2e362022-07-21 15:11:34 +0800557 ret = ssl_tls13_offered_psks_check_identity_match(
Jerry Yu82534862022-08-30 10:42:33 +0800558 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800559 &psk_type, &session );
Jerry Yue95c8af2022-07-26 15:48:20 +0800560 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800561 continue;
562
Jerry Yuf35ba382022-08-23 17:58:26 +0800563 MBEDTLS_SSL_DEBUG_MSG( 4, ( "found matched identity" ) );
Jerry Yu0baf9072022-08-25 11:21:04 +0800564 switch( psk_type )
565 {
566 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
567 ret = ssl_tls13_select_ciphersuite_for_psk(
568 ssl, ciphersuites, ciphersuites_end,
569 &cipher_suite, &ciphersuite_info );
570 break;
571 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800572#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800573 ret = ssl_tls13_select_ciphersuite_for_resumption(
Jerry Yu82534862022-08-30 10:42:33 +0800574 ssl, ciphersuites, ciphersuites_end, &session,
Jerry Yu0baf9072022-08-25 11:21:04 +0800575 &cipher_suite, &ciphersuite_info );
Jerry Yu4746b102022-09-13 11:11:48 +0800576 if( ret != 0 )
577 mbedtls_ssl_session_free( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800578#else
579 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
580#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800581 break;
582 default:
583 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
584 }
Jerry Yuf35ba382022-08-23 17:58:26 +0800585 if( ret != 0 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800586 {
Jerry Yuf35ba382022-08-23 17:58:26 +0800587 /* See below, no cipher_suite available, abort handshake */
588 MBEDTLS_SSL_PEND_FATAL_ALERT(
589 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
590 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
591 MBEDTLS_SSL_DEBUG_RET(
Jerry Yu0baf9072022-08-25 11:21:04 +0800592 2, "ssl_tls13_select_ciphersuite", ret );
Jerry Yuf35ba382022-08-23 17:58:26 +0800593 return( ret );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800594 }
595
Jerry Yu96a2e362022-07-21 15:11:34 +0800596 ret = ssl_tls13_offered_psks_check_binder_match(
Jerry Yu29d9faa2022-08-23 17:52:45 +0800597 ssl, binder, binder_len, psk_type,
598 mbedtls_psa_translate_md( ciphersuite_info->mac ) );
Jerry Yue9d4fc02022-08-20 19:21:15 +0800599 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800600 {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800601 /* For security reasons, the handshake should be aborted when we
602 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
603 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800604#if defined(MBEDTLS_SSL_SESSION_TICKETS)
605 mbedtls_ssl_session_free( &session );
606#endif
Jerry Yuc5a23a02022-08-25 10:51:44 +0800607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Invalid binder." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800608 MBEDTLS_SSL_DEBUG_RET( 1,
609 "ssl_tls13_offered_psks_check_binder_match" , ret );
610 MBEDTLS_SSL_PEND_FATAL_ALERT(
611 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
612 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
613 return( ret );
614 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800615
616 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800617
618 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800619 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800620 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yue5834fd2022-08-29 20:16:09 +0800621 MBEDTLS_SSL_DEBUG_MSG( 2, ( "overwrite ciphersuite: %04x - %s",
622 cipher_suite, ciphersuite_info->name ) );
Jerry Yu82534862022-08-30 10:42:33 +0800623#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu82534862022-08-30 10:42:33 +0800624 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
625 {
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800626 ret = ssl_tls13_session_copy_ticket( ssl->session_negotiate,
627 &session );
Jerry Yu82534862022-08-30 10:42:33 +0800628 mbedtls_ssl_session_free( &session );
629 if( ret != 0 )
630 return( ret );
631 }
632#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000633 }
634
Jerry Yu568ec252022-07-22 21:27:34 +0800635 if( p_identity_len != identities_end || p_binder_len != binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000636 {
637 MBEDTLS_SSL_DEBUG_MSG( 3, ( "pre_shared_key extesion decode error" ) );
638 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
639 MBEDTLS_ERR_SSL_DECODE_ERROR );
640 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
641 }
642
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800643 /* Update the handshake transcript with the binder list. */
644 ssl->handshake->update_checksum( ssl,
645 identities_end,
646 (size_t)( binders_end - identities_end ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800647 if( matched_identity == -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000648 {
Jerry Yue9d4fc02022-08-20 19:21:15 +0800649 MBEDTLS_SSL_DEBUG_MSG( 3, ( "No matched PSK or ticket." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800650 return( MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY );
Jerry Yu1c105562022-07-10 06:32:38 +0000651 }
652
Jerry Yu96a2e362022-07-21 15:11:34 +0800653 ssl->handshake->selected_identity = (uint16_t)matched_identity;
654 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Pre shared key found" ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000655
Jerry Yu96a2e362022-07-21 15:11:34 +0800656 return( 0 );
Jerry Yu1c105562022-07-10 06:32:38 +0000657}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000658
659/*
660 * struct {
661 * select ( Handshake.msg_type ) {
662 * ....
663 * case server_hello:
664 * uint16 selected_identity;
665 * }
666 * } PreSharedKeyExtension;
667 */
Jerry Yubb852022022-07-20 21:10:44 +0800668static int ssl_tls13_write_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
669 unsigned char *buf,
670 unsigned char *end,
671 size_t *olen )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672{
673 unsigned char *p = (unsigned char*)buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000674
675 *olen = 0;
676
David Horstmann21b89762022-10-06 18:34:28 +0100677 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678#if defined(MBEDTLS_USE_PSA_CRYPTO)
David Horstmann21b89762022-10-06 18:34:28 +0100679 not_using_psk = ( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000680#else
David Horstmann21b89762022-10-06 18:34:28 +0100681 not_using_psk = ( ssl->handshake->psk == NULL );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000682#endif
David Horstmann21b89762022-10-06 18:34:28 +0100683 if( not_using_psk )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684 {
685 /* We shouldn't have called this extension writer unless we've
686 * chosen to use a PSK. */
687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
688 }
689
690 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding pre_shared_key extension" ) );
691 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
692
Jerry Yu032b15ce2022-07-11 06:10:03 +0000693 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694 MBEDTLS_PUT_UINT16_BE( 2, p, 2 );
695
Jerry Yu96a2e362022-07-21 15:11:34 +0800696 MBEDTLS_PUT_UINT16_BE( ssl->handshake->selected_identity, p, 4 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000697
698 *olen = 6;
699
Jerry Yu96a2e362022-07-21 15:11:34 +0800700 MBEDTLS_SSL_DEBUG_MSG( 4, ( "sent selected_identity: %u",
701 ssl->handshake->selected_identity ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702
Jerry Yub95dd362022-11-08 21:19:34 +0800703 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_PRE_SHARED_KEY );
704
Jerry Yu032b15ce2022-07-11 06:10:03 +0000705 return( 0 );
706}
707
Ronald Cron41a443a2022-10-04 16:38:25 +0200708#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000709
XiaokangQian7807f9f2022-02-15 10:04:37 +0000710/* From RFC 8446:
711 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000712 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000713 * } SupportedVersions;
714 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200715MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000716static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
717 const unsigned char *buf,
718 const unsigned char *end )
719{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000720 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000721 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000722 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000723 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000724 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000725
726 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000727 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000728 p += 1;
729
XiaokangQian4080a7f2022-04-11 09:55:18 +0000730 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000731 versions_end = p + versions_len;
732 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000733 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000734 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000735 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000736 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000737
738 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000739 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000740 {
741 tls13_supported = 1;
742 break;
743 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000744 }
745
XiaokangQianb67384d2022-04-19 00:02:38 +0000746 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000747 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000748 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
749
750 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
751 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
752 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
753 }
754
XiaokangQiande333912022-04-20 08:49:42 +0000755 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000756 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000757
XiaokangQian7807f9f2022-02-15 10:04:37 +0000758 return( 0 );
759}
760
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000761#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000762/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000763 *
764 * From RFC 8446:
765 * enum {
766 * ... (0xFFFF)
767 * } NamedGroup;
768 * struct {
769 * NamedGroup named_group_list<2..2^16-1>;
770 * } NamedGroupList;
771 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200772MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800773static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
774 const unsigned char *buf,
775 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000777 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000778 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000779 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000780
781 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000782 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000783 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000784 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000785 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000786 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000787 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788
XiaokangQian08037552022-04-20 07:16:41 +0000789 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000790 {
XiaokangQian08037552022-04-20 07:16:41 +0000791 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000792 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000793 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
794 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000795
Jerry Yuc1be19f2022-04-23 16:11:39 +0800796 MBEDTLS_SSL_DEBUG_MSG( 2,
797 ( "got named group: %s(%04x)",
798 mbedtls_ssl_named_group_to_str( named_group ),
799 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000800
801 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
802 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000803 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804 {
XiaokangQian08037552022-04-20 07:16:41 +0000805 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000806 }
807
Jerry Yuc1be19f2022-04-23 16:11:39 +0800808 MBEDTLS_SSL_DEBUG_MSG( 2,
809 ( "add named group %s(%04x) into received list.",
810 mbedtls_ssl_named_group_to_str( named_group ),
811 named_group ) );
812
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000813 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000814 }
815
816 return( 0 );
817
818}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000819#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000820
XiaokangQian08037552022-04-20 07:16:41 +0000821#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
822
XiaokangQian88408882022-04-02 10:15:03 +0000823#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000824/*
825 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000826 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000827 *
828 * Possible return values are:
829 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000830 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000831 * does not match a group supported by the server. A HelloRetryRequest will
832 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000833 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800834 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200835MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000836static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
837 const unsigned char *buf,
838 const unsigned char *end )
839{
XiaokangQianb67384d2022-04-19 00:02:38 +0000840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000841 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000842 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800843 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000844
845 /* From RFC 8446:
846 *
847 * struct {
848 * KeyShareEntry client_shares<0..2^16-1>;
849 * } KeyShareClientHello;
850 *
851 */
852
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000854 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000855 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000856 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000857
858 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000859 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000860
861 /* We try to find a suitable key share entry and copy it to the
862 * handshake context. Later, we have to find out whether we can do
863 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000864 * dismiss it and send a HelloRetryRequest message.
865 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000866
Jerry Yuc1be19f2022-04-23 16:11:39 +0800867 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000868 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000869 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800870 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800871 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000872
873 /*
874 * struct {
875 * NamedGroup group;
876 * opaque key_exchange<1..2^16-1>;
877 * } KeyShareEntry;
878 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000879 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000880 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800881 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
882 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800883 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000884 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
Jerry Yu086edc22022-05-05 10:50:38 +0800885 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000886
887 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000888 * for input validation purposes.
889 */
XiaokangQian060d8672022-04-21 09:24:56 +0000890 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800891 ! mbedtls_ssl_named_group_is_supported( group ) ||
892 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000893 {
894 continue;
895 }
XiaokangQian060d8672022-04-21 09:24:56 +0000896
XiaokangQian7807f9f2022-02-15 10:04:37 +0000897 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000898 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000899 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000900 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
901 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800902 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
903 mbedtls_ssl_named_group_to_str( group ),
904 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000905 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800906 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000907 if( ret != 0 )
908 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000909
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000910 }
911 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000912 {
913 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000914 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000915 continue;
916 }
917
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000918 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000919 }
920
Jerry Yuc1be19f2022-04-23 16:11:39 +0800921
922 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000923 {
924 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000925 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000926 }
927 return( 0 );
928}
XiaokangQian88408882022-04-02 10:15:03 +0000929#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000930
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200931MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000932static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000933 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000934{
Jerry Yu0c354a22022-08-29 15:25:36 +0800935 int masked = ssl->handshake->received_extensions & exts_mask;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000936 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000937}
938
Jerry Yue5991322022-11-07 14:03:44 +0800939#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200940MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000941static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
942 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000943{
Jerry Yu77f01482022-07-11 07:03:24 +0000944 return( ssl_tls13_client_hello_has_exts(
945 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800946 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) |
947 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) |
948 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000949}
Jerry Yue5991322022-11-07 14:03:44 +0800950#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000951
Jerry Yue5991322022-11-07 14:03:44 +0800952#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000953MBEDTLS_CHECK_RETURN_CRITICAL
954static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
955 mbedtls_ssl_context *ssl )
956{
957 return( ssl_tls13_client_hello_has_exts(
958 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800959 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) |
960 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) );
Jerry Yu77f01482022-07-11 07:03:24 +0000961}
Jerry Yue5991322022-11-07 14:03:44 +0800962#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000963
Jerry Yue5991322022-11-07 14:03:44 +0800964#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000965MBEDTLS_CHECK_RETURN_CRITICAL
966static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
967 mbedtls_ssl_context *ssl )
968{
969 return( ssl_tls13_client_hello_has_exts(
970 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800971 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) |
972 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) |
973 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) |
974 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) );
Jerry Yu77f01482022-07-11 07:03:24 +0000975}
Jerry Yue5991322022-11-07 14:03:44 +0800976#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000977
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200978MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000979static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000980{
Jerry Yue5991322022-11-07 14:03:44 +0800981#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000982 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
983 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
Jerry Yue5991322022-11-07 14:03:44 +0800984#else
985 ((void) ssl);
986 return( 0 );
987#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000988}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000989
Jerry Yu77f01482022-07-11 07:03:24 +0000990MBEDTLS_CHECK_RETURN_CRITICAL
991static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
992{
Jerry Yue5991322022-11-07 14:03:44 +0800993#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000994 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
995 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
996 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
997#else
998 ((void) ssl);
999 return( 0 );
1000#endif
1001}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001002
Jerry Yu77f01482022-07-11 07:03:24 +00001003MBEDTLS_CHECK_RETURN_CRITICAL
1004static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
1005{
Jerry Yue5991322022-11-07 14:03:44 +08001006#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001007 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
1008 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
1009 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
1010#else
1011 ((void) ssl);
1012 return( 0 );
1013#endif
1014}
1015
1016static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1017{
1018 /*
1019 * Determine the key exchange algorithm to use.
1020 * There are three types of key exchanges supported in TLS 1.3:
1021 * - (EC)DH with ECDSA,
1022 * - (EC)DH with PSK,
1023 * - plain PSK.
1024 *
1025 * The PSK-based key exchanges may additionally be used with 0-RTT.
1026 *
1027 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001028 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1029 * 2 ) Certificate Mode ( ephemeral )
1030 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001031 */
1032
1033 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1034
Jerry Yu77f01482022-07-11 07:03:24 +00001035 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1036 {
1037 ssl->handshake->key_exchange_mode =
1038 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1039 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1040 }
1041 else
1042 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1043 {
1044 ssl->handshake->key_exchange_mode =
1045 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1046 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1047 }
1048 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001049 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1050 {
1051 ssl->handshake->key_exchange_mode =
1052 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1053 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1054 }
1055 else
Jerry Yu77f01482022-07-11 07:03:24 +00001056 {
1057 MBEDTLS_SSL_DEBUG_MSG(
1058 1,
1059 ( "ClientHello message misses mandatory extensions." ) );
1060 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1061 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1062 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1063 }
1064
1065 return( 0 );
1066
XiaokangQian7807f9f2022-02-15 10:04:37 +00001067}
1068
XiaokangQian81802f42022-06-10 13:25:22 +00001069#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001070 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001071
1072#if defined(MBEDTLS_USE_PSA_CRYPTO)
1073static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1074{
1075 switch( sig_alg )
1076 {
1077 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1078 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1079 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1080 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1081 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1082 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1083 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1084 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1085 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1086 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1087 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1088 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1089 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001090 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001092 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001094 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001095 default:
1096 return( PSA_ALG_NONE );
1097 }
1098}
1099#endif /* MBEDTLS_USE_PSA_CRYPTO */
1100
XiaokangQian23c5be62022-06-07 02:04:34 +00001101/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001102 * Pick best ( private key, certificate chain ) pair based on the signature
1103 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001104 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001105MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001106static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001107{
XiaokangQianfb665a82022-06-15 03:57:21 +00001108 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001109 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001110
1111#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1112 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001113 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001114 else
1115#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001116 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001117
XiaokangQianfb665a82022-06-15 03:57:21 +00001118 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001119 {
1120 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1121 return( -1 );
1122 }
1123
XiaokangQian81802f42022-06-10 13:25:22 +00001124 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001125 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001126 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1127 continue;
1128
1129 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1130 continue;
1131
XiaokangQianfb665a82022-06-15 03:57:21 +00001132 for( key_cert = key_cert_list; key_cert != NULL;
1133 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001134 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001135#if defined(MBEDTLS_USE_PSA_CRYPTO)
1136 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1137#endif /* MBEDTLS_USE_PSA_CRYPTO */
1138
XiaokangQianfb665a82022-06-15 03:57:21 +00001139 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1140 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001141
1142 /*
1143 * This avoids sending the client a cert it'll reject based on
1144 * keyUsage or other extensions.
1145 */
1146 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001147 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001148 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001149 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1150 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001151 {
1152 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001153 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001154 continue;
1155 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001156
Jerry Yucc539102022-06-27 16:27:35 +08001157 MBEDTLS_SSL_DEBUG_MSG( 3,
1158 ( "ssl_tls13_pick_key_cert:"
1159 "check signature algorithm %s [%04x]",
1160 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1161 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001162#if defined(MBEDTLS_USE_PSA_CRYPTO)
1163 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1164#endif /* MBEDTLS_USE_PSA_CRYPTO */
1165
Jerry Yufb526692022-06-19 11:22:49 +08001166 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001167 *sig_alg, &key_cert->cert->pk )
1168#if defined(MBEDTLS_USE_PSA_CRYPTO)
1169 && psa_alg != PSA_ALG_NONE &&
1170 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1171 PSA_KEY_USAGE_SIGN_HASH ) == 1
1172#endif /* MBEDTLS_USE_PSA_CRYPTO */
1173 )
XiaokangQian81802f42022-06-10 13:25:22 +00001174 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001175 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001176 MBEDTLS_SSL_DEBUG_MSG( 3,
1177 ( "ssl_tls13_pick_key_cert:"
1178 "selected signature algorithm"
1179 " %s [%04x]",
1180 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1181 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001182 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001183 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001184 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001185 return( 0 );
1186 }
XiaokangQian81802f42022-06-10 13:25:22 +00001187 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001188 }
1189
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001190 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1191 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001192 return( -1 );
1193}
XiaokangQian81802f42022-06-10 13:25:22 +00001194#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001195 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001196
XiaokangQian4080a7f2022-04-11 09:55:18 +00001197/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001198 *
1199 * STATE HANDLING: ClientHello
1200 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001201 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001202 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001203 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001204 *
1205 * In this case, the server progresses to sending its ServerHello.
1206 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001207 * 2) The ClientHello was well-formed but didn't match the server's
1208 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001209 *
1210 * For example, the client might not have offered a key share which
1211 * the server supports, or the server might require a cookie.
1212 *
1213 * In this case, the server sends a HelloRetryRequest.
1214 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001215 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001216 *
1217 * In this case, we abort the handshake.
1218 *
1219 */
1220
1221/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001222 * Structure of this message:
1223 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001224 * uint16 ProtocolVersion;
1225 * opaque Random[32];
1226 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001227 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001228 * struct {
1229 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1230 * Random random;
1231 * opaque legacy_session_id<0..32>;
1232 * CipherSuite cipher_suites<2..2^16-2>;
1233 * opaque legacy_compression_methods<1..2^8-1>;
1234 * Extension extensions<8..2^16-1>;
1235 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001236 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001237
1238#define SSL_CLIENT_HELLO_OK 0
1239#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1240
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001241MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001242static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1243 const unsigned char *buf,
1244 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001245{
XiaokangQianb67384d2022-04-19 00:02:38 +00001246 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1247 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001248 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001249 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001250 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001251 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001252 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001253 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001254 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001255
Ronald Cron41a443a2022-10-04 16:38:25 +02001256#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001257 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001258 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001259 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001260#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001261
XiaokangQian7807f9f2022-02-15 10:04:37 +00001262 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001263 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001264 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001265 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001266 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001267 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001268 * .. . .. ciphersuite list length ( 2 bytes )
1269 * .. . .. ciphersuite list
1270 * .. . .. compression alg. list length ( 1 byte )
1271 * .. . .. compression alg. list
1272 * .. . .. extensions length ( 2 bytes, optional )
1273 * .. . .. extensions ( optional )
1274 */
1275
XiaokangQianb67384d2022-04-19 00:02:38 +00001276 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001277 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001278 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1279 * read at least up to session id length without worrying.
1280 */
1281 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1282
1283 /* ...
1284 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1285 * ...
1286 * with ProtocolVersion defined as:
1287 * uint16 ProtocolVersion;
1288 */
XiaokangQiande333912022-04-20 08:49:42 +00001289 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1290 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291 {
1292 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1293 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1294 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001295 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001296 }
1297 p += 2;
1298
1299 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001300 * Only support TLS 1.3 currently, temporarily set the version.
1301 */
XiaokangQiande333912022-04-20 08:49:42 +00001302 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001303
Jerry Yue67bef42022-07-07 07:29:42 +00001304#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1305 /* Store minor version for later use with ticket serialization. */
1306 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001307 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001308#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001309
Jerry Yuc1be19f2022-04-23 16:11:39 +08001310 /* ...
1311 * Random random;
1312 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001313 * with Random defined as:
1314 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001315 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001316 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001317 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001319 memcpy( &handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian08037552022-04-20 07:16:41 +00001320 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001321
Jerry Yuc1be19f2022-04-23 16:11:39 +08001322 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001323 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001324 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001325 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001326 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001327 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001328
XiaokangQianb67384d2022-04-19 00:02:38 +00001329 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330 {
1331 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1332 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1333 }
1334
XiaokangQian4080a7f2022-04-11 09:55:18 +00001335 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001336 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001337 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001338 /*
1339 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001340 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001341 */
1342 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001343
XiaokangQianed582dd2022-04-13 08:21:05 +00001344 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001345 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001346
XiaokangQian7807f9f2022-02-15 10:04:37 +00001347 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1348 p += 2;
1349
XiaokangQianb67384d2022-04-19 00:02:38 +00001350 /* Check we have enough data for the ciphersuite list, the legacy
1351 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001352 *
1353 * cipher_suites cipher_suites_len bytes
1354 * legacy_compression_methods 2 bytes
1355 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001356 */
1357 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001358
Jerry Yu24b8c812022-08-20 19:06:56 +08001359 /* ...
1360 * CipherSuite cipher_suites<2..2^16-2>;
1361 * ...
1362 * with CipherSuite defined as:
1363 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001364 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001365#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001366 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001367#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001368 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001369 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1370 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001371
1372 /*
1373 * Search for a matching ciphersuite
1374 */
XiaokangQian060d8672022-04-21 09:24:56 +00001375 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001376 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001377 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001378 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001379
XiaokangQiane8ff3502022-04-22 02:34:40 +00001380 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001381
XiaokangQiane8ff3502022-04-22 02:34:40 +00001382 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001383 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001384 ssl,cipher_suite );
1385 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001386 continue;
1387
Jerry Yu5725f1c2022-08-21 17:27:16 +08001388 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001389 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001390 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001391 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001392 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001393 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001394
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001395 if( handshake->ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001396 {
1397 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1398 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1399 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1400 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001401
XiaokangQian4080a7f2022-04-11 09:55:18 +00001402 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001403 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001404 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001405 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001406 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001407 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001408 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1409 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1410 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1411 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001412 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001413 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001414
Jerry Yuc1be19f2022-04-23 16:11:39 +08001415 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001416 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001417 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001418 * with Extension defined as:
1419 * struct {
1420 * ExtensionType extension_type;
1421 * opaque extension_data<0..2^16-1>;
1422 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001423 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001424 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001425 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001426 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001427 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001428
XiaokangQian4080a7f2022-04-11 09:55:18 +00001429 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001430
Jerry Yu63a459c2022-10-31 13:38:40 +08001431 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001432
XiaokangQian7807f9f2022-02-15 10:04:37 +00001433 while( p < extensions_end )
1434 {
1435 unsigned int extension_type;
1436 size_t extension_data_len;
1437 const unsigned char *extension_data_end;
1438
Jerry Yu0c354a22022-08-29 15:25:36 +08001439 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001440 *
1441 * The "pre_shared_key" extension MUST be the last extension in the
1442 * ClientHello (this facilitates implementation as described below).
1443 * Servers MUST check that it is the last extension and otherwise fail
1444 * the handshake with an "illegal_parameter" alert.
1445 */
Jerry Yu63a459c2022-10-31 13:38:40 +08001446 if( handshake->received_extensions & MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) )
Jerry Yu1c9247c2022-07-21 12:37:39 +08001447 {
1448 MBEDTLS_SSL_DEBUG_MSG(
1449 3, ( "pre_shared_key is not last extension." ) );
1450 MBEDTLS_SSL_PEND_FATAL_ALERT(
1451 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Jerry Yuc437ee32022-11-08 21:04:15 +08001452 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1453 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu1c9247c2022-07-21 12:37:39 +08001454 }
1455
XiaokangQian318dc762022-04-20 09:43:51 +00001456 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001457 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1458 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1459 p += 4;
1460
1461 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1462 extension_data_end = p + extension_data_len;
1463
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001464 ret = mbedtls_ssl_tls13_check_received_extension(
Jerry Yu0c354a22022-08-29 15:25:36 +08001465 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1466 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH );
1467 if( ret != 0 )
1468 return( ret );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001469
XiaokangQian7807f9f2022-02-15 10:04:37 +00001470 switch( extension_type )
1471 {
XiaokangQian40a35232022-05-07 09:02:40 +00001472#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1473 case MBEDTLS_TLS_EXT_SERVERNAME:
1474 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001475 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1476 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001477 if( ret != 0 )
1478 {
1479 MBEDTLS_SSL_DEBUG_RET(
1480 1, "mbedtls_ssl_parse_servername_ext", ret );
1481 return( ret );
1482 }
XiaokangQian40a35232022-05-07 09:02:40 +00001483 break;
1484#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1485
XiaokangQianb67384d2022-04-19 00:02:38 +00001486#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001487 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1488 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1489
1490 /* Supported Groups Extension
1491 *
1492 * When sent by the client, the "supported_groups" extension
1493 * indicates the named groups which the client supports,
1494 * ordered from most preferred to least preferred.
1495 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001496 ret = ssl_tls13_parse_supported_groups_ext(
1497 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001498 if( ret != 0 )
1499 {
1500 MBEDTLS_SSL_DEBUG_RET( 1,
1501 "mbedtls_ssl_parse_supported_groups_ext", ret );
1502 return( ret );
1503 }
1504
XiaokangQian7807f9f2022-02-15 10:04:37 +00001505 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001506#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001507
XiaokangQian88408882022-04-02 10:15:03 +00001508#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001509 case MBEDTLS_TLS_EXT_KEY_SHARE:
1510 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1511
1512 /*
1513 * Key Share Extension
1514 *
1515 * When sent by the client, the "key_share" extension
1516 * contains the endpoint's cryptographic parameters for
1517 * ECDHE/DHE key establishment methods.
1518 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001519 ret = ssl_tls13_parse_key_shares_ext(
1520 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001521 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001522 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001524 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001525 }
1526
Jerry Yu582dd062022-04-22 21:59:01 +08001527 if( ret < 0 )
1528 {
1529 MBEDTLS_SSL_DEBUG_RET(
1530 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001531 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001532 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001533
XiaokangQian7807f9f2022-02-15 10:04:37 +00001534 break;
XiaokangQian88408882022-04-02 10:15:03 +00001535#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001536
1537 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1538 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1539
1540 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001541 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001542 if( ret != 0 )
1543 {
1544 MBEDTLS_SSL_DEBUG_RET( 1,
1545 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1546 return( ret );
1547 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001548 break;
1549
Ronald Cron41a443a2022-10-04 16:38:25 +02001550#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001551 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1552 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1553
1554 ret = ssl_tls13_parse_key_exchange_modes_ext(
1555 ssl, p, extension_data_end );
1556 if( ret != 0 )
1557 {
1558 MBEDTLS_SSL_DEBUG_RET(
1559 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1560 return( ret );
1561 }
1562
Jerry Yue19e3b92022-07-08 12:04:51 +00001563 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001564#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001565
Jerry Yu1c105562022-07-10 06:32:38 +00001566 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1567 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001568 if( ( handshake->received_extensions &
Jerry Yu63a459c2022-10-31 13:38:40 +08001569 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) == 0 )
Jerry Yu13ab81d2022-07-22 23:17:11 +08001570 {
1571 MBEDTLS_SSL_PEND_FATAL_ALERT(
1572 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001573 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1574 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001575 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001576#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001577 /* Delay processing of the PSK identity once we have
1578 * found out which algorithms to use. We keep a pointer
1579 * to the buffer and the size for later processing.
1580 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001581 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001582 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001583#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001584 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001585
XiaokangQianacb39922022-06-17 10:18:48 +00001586#if defined(MBEDTLS_SSL_ALPN)
1587 case MBEDTLS_TLS_EXT_ALPN:
1588 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1589
1590 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1591 if( ret != 0 )
1592 {
1593 MBEDTLS_SSL_DEBUG_RET(
1594 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1595 return( ret );
1596 }
XiaokangQianacb39922022-06-17 10:18:48 +00001597 break;
1598#endif /* MBEDTLS_SSL_ALPN */
1599
Ronald Cron928cbd32022-10-04 16:14:26 +02001600#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001601 case MBEDTLS_TLS_EXT_SIG_ALG:
1602 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1603
Gabor Mezei078e8032022-04-27 21:17:56 +02001604 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001605 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001606 if( ret != 0 )
1607 {
1608 MBEDTLS_SSL_DEBUG_MSG( 1,
1609 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1610 ret ) );
1611 return( ret );
1612 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001613 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001614#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001615
1616 default:
Jerry Yu63a459c2022-10-31 13:38:40 +08001617 MBEDTLS_SSL_PRINT_EXT_TYPE(
1618 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1619 extension_type, "( ignored )" );
Jerry Yu0c354a22022-08-29 15:25:36 +08001620 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001621 }
1622
1623 p += extension_data_len;
1624 }
1625
Jerry Yu63a459c2022-10-31 13:38:40 +08001626 MBEDTLS_SSL_PRINT_RECEIVED_EXTS( 3, MBEDTLS_SSL_HS_CLIENT_HELLO );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001627
Jerry Yu1c105562022-07-10 06:32:38 +00001628 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1629 MBEDTLS_SSL_HS_CLIENT_HELLO,
1630 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001631
Ronald Cron41a443a2022-10-04 16:38:25 +02001632#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001633 /* Update checksum with either
1634 * - The entire content of the CH message, if no PSK extension is present
1635 * - The content up to but excluding the PSK extension, if present.
1636 */
Jerry Yu1c105562022-07-10 06:32:38 +00001637 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001638 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001639 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yu63a459c2022-10-31 13:38:40 +08001640 ( handshake->received_extensions & MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001641 {
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001642 handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001643 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001644 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001645 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001646 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001647 cipher_suites,
1648 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001649 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001650 {
Jerry Yu63a459c2022-10-31 13:38:40 +08001651 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY );
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001652 }
1653 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001654 {
Jerry Yu63a459c2022-10-31 13:38:40 +08001655 MBEDTLS_SSL_DEBUG_RET(
1656 1, "ssl_tls13_parse_pre_shared_key_ext" , ret );
Jerry Yu1c105562022-07-10 06:32:38 +00001657 return( ret );
1658 }
Jerry Yu1c105562022-07-10 06:32:38 +00001659 }
1660 else
Ronald Cron41a443a2022-10-04 16:38:25 +02001661#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001662 {
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001663 handshake->update_checksum( ssl, buf, p - buf );
Jerry Yu1c105562022-07-10 06:32:38 +00001664 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001665
Jerry Yuba9b6e92022-07-22 21:35:18 +08001666 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1667 if( ret < 0 )
1668 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001669
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001670 mbedtls_ssl_optimize_checksum( ssl, handshake->ciphersuite_info );
Jerry Yue5834fd2022-08-29 20:16:09 +08001671
XiaokangQian75fe8c72022-06-15 09:42:45 +00001672 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1673}
1674
1675/* Update the handshake state machine */
1676
Ronald Cronce7d76e2022-07-08 18:56:49 +02001677MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001678static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1679{
1680 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1681
XiaokangQian7807f9f2022-02-15 10:04:37 +00001682 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001683 * Server certificate selection
1684 */
1685 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1686 {
1687 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1688 return( ret );
1689 }
1690#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1691 ssl->handshake->sni_name = NULL;
1692 ssl->handshake->sni_name_len = 0;
1693#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001694
XiaokangQian7807f9f2022-02-15 10:04:37 +00001695 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1696 if( ret != 0 )
1697 {
1698 MBEDTLS_SSL_DEBUG_RET( 1,
1699 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1700 return( ret );
1701 }
1702
XiaokangQian7807f9f2022-02-15 10:04:37 +00001703 return( 0 );
1704
1705}
1706
1707/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001708 * Main entry point from the state machine; orchestrates the otherfunctions.
1709 */
1710
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001711MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001712static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1713{
1714
XiaokangQian08037552022-04-20 07:16:41 +00001715 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001716 unsigned char* buf = NULL;
1717 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001718 int parse_client_hello_ret;
1719
XiaokangQianed582dd2022-04-13 08:21:05 +00001720 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1721
XiaokangQianed582dd2022-04-13 08:21:05 +00001722 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1723 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1724 &buf, &buflen ) );
1725
1726 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1727 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001728 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1729 * only SSL_CLIENT_HELLO_OK or
1730 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1731 * stage as negative error codes are handled
1732 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001733
XiaokangQiancfd925f2022-04-14 07:10:37 +00001734 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001735
Jerry Yu4ca91402022-05-09 15:50:57 +08001736 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1737 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1738 else
1739 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001740
1741cleanup:
1742
1743 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1744 return( ret );
1745}
1746
1747/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001748 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001749 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001750MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001751static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1752{
Jerry Yu637a3f12022-04-20 21:37:58 +08001753 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1754 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001755 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001756 if( ssl->conf->f_rng == NULL )
1757 {
1758 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1759 return( MBEDTLS_ERR_SSL_NO_RNG );
1760 }
1761
Jerry Yu637a3f12022-04-20 21:37:58 +08001762 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001763 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1764 {
1765 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1766 return( ret );
1767 }
1768
Jerry Yu637a3f12022-04-20 21:37:58 +08001769 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001770 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1771
1772#if defined(MBEDTLS_HAVE_TIME)
1773 ssl->session_negotiate->start = time( NULL );
1774#endif /* MBEDTLS_HAVE_TIME */
1775
1776 return( ret );
1777}
1778
Jerry Yu3bf2c642022-03-30 22:02:12 +08001779/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001780 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001781 *
1782 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001783 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001784 * } SupportedVersions;
1785 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001786MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001787static int ssl_tls13_write_server_hello_supported_versions_ext(
1788 mbedtls_ssl_context *ssl,
1789 unsigned char *buf,
1790 unsigned char *end,
1791 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001792{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001793 *out_len = 0;
1794
Jerry Yu955ddd72022-04-22 22:27:33 +08001795 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001796
1797 /* Check if we have space to write the extension:
1798 * - extension_type (2 bytes)
1799 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001800 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001801 */
Jerry Yu349a6132022-04-14 20:52:56 +08001802 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803
Jerry Yu349a6132022-04-14 20:52:56 +08001804 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001805
Jerry Yu349a6132022-04-14 20:52:56 +08001806 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001807
Jerry Yu349a6132022-04-14 20:52:56 +08001808 mbedtls_ssl_write_version( buf + 4,
1809 ssl->conf->transport,
1810 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001811
1812 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1813 ssl->tls_version ) );
1814
Jerry Yu349a6132022-04-14 20:52:56 +08001815 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001816
Jerry Yub95dd362022-11-08 21:19:34 +08001817 mbedtls_ssl_tls13_set_hs_sent_ext_mask(
1818 ssl, MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS );
1819
Jerry Yu3bf2c642022-03-30 22:02:12 +08001820 return( 0 );
1821}
1822
Jerry Yud9436a12022-04-20 22:28:09 +08001823
Jerry Yu3bf2c642022-03-30 22:02:12 +08001824
1825/* Generate and export a single key share. For hybrid KEMs, this can
1826 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001827MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001828static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1829 uint16_t named_group,
1830 unsigned char *buf,
1831 unsigned char *end,
1832 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001833{
1834 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001835
1836 *out_len = 0;
1837
Jerry Yu89e103c2022-03-30 22:43:29 +08001838#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001839 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1840 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001841 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1842 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843 if( ret != 0 )
1844 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001845 MBEDTLS_SSL_DEBUG_RET(
1846 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1847 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001848 return( ret );
1849 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001850 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001851 else
1852#endif /* MBEDTLS_ECDH_C */
1853 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001854 {
1855 }
1856 else
1857 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001858 ((void) ssl);
1859 ((void) named_group);
1860 ((void) buf);
1861 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001862 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1863 }
1864
1865 return( ret );
1866}
1867
1868/*
1869 * ssl_tls13_write_key_share_ext
1870 *
1871 * Structure of key_share extension in ServerHello:
1872 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001873 * struct {
1874 * NamedGroup group;
1875 * opaque key_exchange<1..2^16-1>;
1876 * } KeyShareEntry;
1877 * struct {
1878 * KeyShareEntry server_share;
1879 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001880 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001881MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1883 unsigned char *buf,
1884 unsigned char *end,
1885 size_t *out_len )
1886{
Jerry Yu955ddd72022-04-22 22:27:33 +08001887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001888 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001889 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001890 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001891 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001892
1893 *out_len = 0;
1894
1895 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1896
Jerry Yu58af2332022-09-06 11:19:31 +08001897 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1898 mbedtls_ssl_named_group_to_str( group ),
1899 group ) );
1900
Jerry Yu3bf2c642022-03-30 22:02:12 +08001901 /* Check if we have space for header and length fields:
1902 * - extension_type (2 bytes)
1903 * - extension_data_length (2 bytes)
1904 * - group (2 bytes)
1905 * - key_exchange_length (2 bytes)
1906 */
1907 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001908 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1909 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001910 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001911
Jerry Yu3bf2c642022-03-30 22:02:12 +08001912 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1913 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001914 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001915 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001916 if( ret != 0 )
1917 return( ret );
1918 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001919
Jerry Yu955ddd72022-04-22 22:27:33 +08001920 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001921
Jerry Yu57d48412022-04-20 21:50:42 +08001922 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001923
Jerry Yu57d48412022-04-20 21:50:42 +08001924 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001925
Jerry Yub95dd362022-11-08 21:19:34 +08001926 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_KEY_SHARE );
1927
Jerry Yu3bf2c642022-03-30 22:02:12 +08001928 return( 0 );
1929}
Jerry Yud9436a12022-04-20 22:28:09 +08001930
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001931MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001932static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1933 unsigned char *buf,
1934 unsigned char *end,
1935 size_t *out_len )
1936{
1937 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1938 /* key_share Extension
1939 *
1940 * struct {
1941 * select (Handshake.msg_type) {
1942 * ...
1943 * case hello_retry_request:
1944 * NamedGroup selected_group;
1945 * ...
1946 * };
1947 * } KeyShare;
1948 */
1949
1950 *out_len = 0;
1951
Jerry Yub0ac10b2022-05-05 11:10:08 +08001952 /*
1953 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1954 * of the HRR is then to transmit a cookie to force the client to demonstrate
1955 * reachability at their apparent network address (primarily useful for DTLS).
1956 */
Ronald Cron79907712022-07-20 17:05:29 +02001957 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001958 return( 0 );
1959
1960 /* We should only send the key_share extension if the client's initial
1961 * key share was not acceptable. */
1962 if( ssl->handshake->offered_group_id != 0 )
1963 {
1964 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
1965 return( 0 );
1966 }
1967
1968 if( selected_group == 0 )
1969 {
1970 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
1971 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1972 }
1973
Jerry Yub0ac10b2022-05-05 11:10:08 +08001974 /* Check if we have enough space:
1975 * - extension_type (2 bytes)
1976 * - extension_data_length (2 bytes)
1977 * - selected_group (2 bytes)
1978 */
Ronald Cron154d1b62022-06-01 15:33:26 +02001979 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001980
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001981 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001982 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001983 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
1984
1985 MBEDTLS_SSL_DEBUG_MSG( 3,
1986 ( "HRR selected_group: %s (%x)",
1987 mbedtls_ssl_named_group_to_str( selected_group ),
1988 selected_group ) );
1989
1990 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001991
Jerry Yub95dd362022-11-08 21:19:34 +08001992 mbedtls_ssl_tls13_set_hs_sent_ext_mask( ssl, MBEDTLS_TLS_EXT_KEY_SHARE );
1993
Jerry Yub0ac10b2022-05-05 11:10:08 +08001994 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001995}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001996
1997/*
1998 * Structure of ServerHello message:
1999 *
2000 * struct {
2001 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2002 * Random random;
2003 * opaque legacy_session_id_echo<0..32>;
2004 * CipherSuite cipher_suite;
2005 * uint8 legacy_compression_method = 0;
2006 * Extension extensions<6..2^16-1>;
2007 * } ServerHello;
2008 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002009MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002010static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002011 unsigned char *buf,
2012 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002013 size_t *out_len,
2014 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002015{
Jerry Yu955ddd72022-04-22 22:27:33 +08002016 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002017 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002018 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002019 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002020
2021 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002022 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002023
Jerry Yucfc04b32022-04-21 09:31:58 +08002024 /* ...
2025 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2026 * ...
2027 * with ProtocolVersion defined as:
2028 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002029 */
2030 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2031 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2032 p += 2;
2033
Jerry Yu1c3e6882022-04-20 21:23:40 +08002034 /* ...
2035 * Random random;
2036 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002037 * with Random defined as:
2038 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002039 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002040 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002041 if( is_hrr )
2042 {
2043 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002044 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002045 }
2046 else
2047 {
2048 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002049 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002050 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002051 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002052 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2053 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2054
Jerry Yucfc04b32022-04-21 09:31:58 +08002055 /* ...
2056 * opaque legacy_session_id_echo<0..32>;
2057 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058 */
2059 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2060 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2061 if( ssl->session_negotiate->id_len > 0 )
2062 {
2063 memcpy( p, &ssl->session_negotiate->id[0],
2064 ssl->session_negotiate->id_len );
2065 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002066
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2068 ssl->session_negotiate->id_len );
2069 }
2070
Jerry Yucfc04b32022-04-21 09:31:58 +08002071 /* ...
2072 * CipherSuite cipher_suite;
2073 * ...
2074 * with CipherSuite defined as:
2075 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002076 */
2077 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2078 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2079 p += 2;
2080 MBEDTLS_SSL_DEBUG_MSG( 3,
2081 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2082 mbedtls_ssl_get_ciphersuite_name(
2083 ssl->session_negotiate->ciphersuite ),
2084 ssl->session_negotiate->ciphersuite ) );
2085
Jerry Yucfc04b32022-04-21 09:31:58 +08002086 /* ...
2087 * uint8 legacy_compression_method = 0;
2088 * ...
2089 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002090 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002091 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092
Jerry Yucfc04b32022-04-21 09:31:58 +08002093 /* ...
2094 * Extension extensions<6..2^16-1>;
2095 * ...
2096 * struct {
2097 * ExtensionType extension_type; (2 bytes)
2098 * opaque extension_data<0..2^16-1>;
2099 * } Extension;
2100 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002102 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002103 p += 2;
2104
Jerry Yue74e04a2022-04-21 09:23:16 +08002105 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002106 ssl, p, end, &output_len ) ) != 0 )
2107 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002108 MBEDTLS_SSL_DEBUG_RET(
2109 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002110 return( ret );
2111 }
2112 p += output_len;
2113
Jerry Yu56acc942022-07-30 23:02:36 +08002114 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002115 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002116 if( is_hrr )
2117 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2118 else
2119 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002120 if( ret != 0 )
2121 return( ret );
2122 p += output_len;
2123 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002124
Ronald Cron41a443a2022-10-04 16:38:25 +02002125#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002126 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002127 {
Jerry Yubb852022022-07-20 21:10:44 +08002128 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002129 if( ret != 0 )
2130 {
Jerry Yubb852022022-07-20 21:10:44 +08002131 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002132 ret );
2133 return( ret );
2134 }
2135 p += output_len;
2136 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002137#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002138
Jerry Yud9436a12022-04-20 22:28:09 +08002139 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002140
Jerry Yud9436a12022-04-20 22:28:09 +08002141 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2142 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002143
Jerry Yud9436a12022-04-20 22:28:09 +08002144 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002145
Jerry Yud9436a12022-04-20 22:28:09 +08002146 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002147
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002148 MBEDTLS_SSL_PRINT_SENT_EXTS(
2149 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
2150 MBEDTLS_SSL_HS_SERVER_HELLO );
2151
Jerry Yu3bf2c642022-03-30 22:02:12 +08002152 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002153}
2154
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002155MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002156static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2157{
2158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002159 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002160 if( ret != 0 )
2161 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002162 MBEDTLS_SSL_DEBUG_RET( 1,
2163 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002164 ret );
2165 return( ret );
2166 }
2167
Jerry Yue110d252022-05-05 10:19:22 +08002168 return( ret );
2169}
2170
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002171MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002172static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2173{
Jerry Yu637a3f12022-04-20 21:37:58 +08002174 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002175 unsigned char *buf;
2176 size_t buf_len, msg_len;
2177
2178 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2179
Jerry Yuf4b27e42022-03-30 17:32:21 +08002180 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2181
Jerry Yu3bf2c642022-03-30 22:02:12 +08002182 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002183 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2184
Jerry Yu3bf2c642022-03-30 22:02:12 +08002185 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2186 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002187 &msg_len,
2188 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002189
Jerry Yu3bf2c642022-03-30 22:02:12 +08002190 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002191 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2192
Jerry Yu3bf2c642022-03-30 22:02:12 +08002193 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002194 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002195
Jerry Yue110d252022-05-05 10:19:22 +08002196 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2197
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002198#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2199 /* The server sends a dummy change_cipher_spec record immediately
2200 * after its first handshake message. This may either be after
2201 * a ServerHello or a HelloRetryRequest.
2202 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002203 mbedtls_ssl_handshake_set_state(
2204 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002205#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002206 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002207#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002208
Jerry Yuf4b27e42022-03-30 17:32:21 +08002209cleanup:
2210
2211 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2212 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002213}
2214
Jerry Yu23d1a252022-05-12 18:08:59 +08002215
2216/*
2217 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2218 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002219MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002220static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002221{
2222 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2223 if( ssl->handshake->hello_retry_request_count > 0 )
2224 {
2225 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2226 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2227 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2228 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2229 }
2230
2231 /*
2232 * Create stateless transcript hash for HRR
2233 */
2234 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2235 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2236 if( ret != 0 )
2237 {
2238 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2239 return( ret );
2240 }
2241 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2242
2243 return( 0 );
2244}
2245
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002246MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002247static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2248{
2249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2250 unsigned char *buf;
2251 size_t buf_len, msg_len;
2252
2253 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2254
Ronald Cron7b840462022-06-01 17:05:53 +02002255 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002256
2257 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2258 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2259 &buf, &buf_len ) );
2260
2261 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2262 buf + buf_len,
2263 &msg_len,
2264 1 ) );
2265 mbedtls_ssl_add_hs_msg_to_checksum(
2266 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2267
2268
2269 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2270 msg_len ) );
2271
2272 ssl->handshake->hello_retry_request_count++;
2273
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002274#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2275 /* The server sends a dummy change_cipher_spec record immediately
2276 * after its first handshake message. This may either be after
2277 * a ServerHello or a HelloRetryRequest.
2278 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002279 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002280 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002281#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002282 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002283#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002284
2285cleanup:
2286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2287 return( ret );
2288}
2289
Jerry Yu5b64ae92022-03-30 17:15:02 +08002290/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002291 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2292 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002293
2294/*
2295 * struct {
2296 * Extension extensions<0..2 ^ 16 - 1>;
2297 * } EncryptedExtensions;
2298 *
2299 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002300MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002301static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2302 unsigned char *buf,
2303 unsigned char *end,
2304 size_t *out_len )
2305{
XiaokangQianacb39922022-06-17 10:18:48 +00002306 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002307 unsigned char *p = buf;
2308 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002309 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002310 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002311
Jerry Yu4d3841a2022-04-16 12:37:19 +08002312 *out_len = 0;
2313
2314 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002315 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002316 p += 2;
2317
Jerry Yu8937eb42022-05-03 12:12:14 +08002318 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002319 ((void) ret);
2320 ((void) output_len);
2321
2322#if defined(MBEDTLS_SSL_ALPN)
2323 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2324 if( ret != 0 )
2325 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002326 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002327#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002328
Jerry Yu8937eb42022-05-03 12:12:14 +08002329 extensions_len = ( p - p_extensions_len ) - 2;
2330 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2331
2332 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002333
2334 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2335
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002336 MBEDTLS_SSL_PRINT_SENT_EXTS( 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS );
2337
Jerry Yu4d3841a2022-04-16 12:37:19 +08002338 return( 0 );
2339}
2340
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002341MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002342static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2343{
2344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2345 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002346 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002347
Gabor Mezei54719122022-06-28 11:34:56 +02002348 mbedtls_ssl_set_outbound_transform( ssl,
2349 ssl->handshake->transform_handshake );
2350 MBEDTLS_SSL_DEBUG_MSG(
2351 3, ( "switching to handshake transform for outbound data" ) );
2352
Jerry Yuab452cc2022-04-28 15:27:08 +08002353 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002354
Jerry Yu4d3841a2022-04-16 12:37:19 +08002355 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2356 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2357
2358 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2359 ssl, buf, buf + buf_len, &msg_len ) );
2360
2361 mbedtls_ssl_add_hs_msg_to_checksum(
2362 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2363
Jerry Yu4d3841a2022-04-16 12:37:19 +08002364 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2365 ssl, buf_len, msg_len ) );
2366
Ronald Cron928cbd32022-10-04 16:14:26 +02002367#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002368 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002369 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2370 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002371 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002372#else
2373 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2374#endif
2375
Jerry Yu4d3841a2022-04-16 12:37:19 +08002376cleanup:
2377
Jerry Yuab452cc2022-04-28 15:27:08 +08002378 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002379 return( ret );
2380}
2381
Ronald Cron928cbd32022-10-04 16:14:26 +02002382#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002383#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2384#define SSL_CERTIFICATE_REQUEST_SKIP 1
2385/* Coordination:
2386 * Check whether a CertificateRequest message should be written.
2387 * Returns a negative code on failure, or
2388 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2389 * - SSL_CERTIFICATE_REQUEST_SKIP
2390 * indicating if the writing of the CertificateRequest
2391 * should be skipped or not.
2392 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002393MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002394static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2395{
2396 int authmode;
2397
XiaokangQian40a35232022-05-07 09:02:40 +00002398#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2399 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2400 authmode = ssl->handshake->sni_authmode;
2401 else
2402#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002403 authmode = ssl->conf->authmode;
2404
2405 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
Ronald Croneac00ad2022-09-13 10:16:31 +02002406 {
2407 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002408 return( SSL_CERTIFICATE_REQUEST_SKIP );
Ronald Croneac00ad2022-09-13 10:16:31 +02002409 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002410
XiaokangQianc3017f62022-05-13 05:55:41 +00002411 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002412
XiaokangQiana987e1d2022-05-07 01:25:58 +00002413 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2414}
2415
XiaokangQiancec9ae62022-05-06 07:28:50 +00002416/*
2417 * struct {
2418 * opaque certificate_request_context<0..2^8-1>;
2419 * Extension extensions<2..2^16-1>;
2420 * } CertificateRequest;
2421 *
2422 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002423MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002424static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2425 unsigned char *buf,
2426 const unsigned char *end,
2427 size_t *out_len )
2428{
2429 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2430 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002431 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002432 unsigned char *p_extensions_len;
2433
2434 *out_len = 0;
2435
2436 /* Check if we have enough space:
2437 * - certificate_request_context (1 byte)
2438 * - extensions length (2 bytes)
2439 */
2440 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2441
2442 /*
2443 * Write certificate_request_context
2444 */
2445 /*
2446 * We use a zero length context for the normal handshake
2447 * messages. For post-authentication handshake messages
2448 * this request context would be set to a non-zero value.
2449 */
2450 *p++ = 0x0;
2451
2452 /*
2453 * Write extensions
2454 */
2455 /* The extensions must contain the signature_algorithms. */
2456 p_extensions_len = p;
2457 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002458 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002459 if( ret != 0 )
2460 return( ret );
2461
XiaokangQianec6efb92022-05-06 09:53:10 +00002462 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002463 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002464
2465 *out_len = p - buf;
2466
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002467 MBEDTLS_SSL_PRINT_SENT_EXTS( 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST );
2468
XiaokangQiancec9ae62022-05-06 07:28:50 +00002469 return( 0 );
2470}
2471
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002472MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002473static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2474{
2475 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2476
2477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2478
2479 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2480
2481 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2482 {
2483 unsigned char *buf;
2484 size_t buf_len, msg_len;
2485
2486 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2487 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2488
2489 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2490 ssl, buf, buf + buf_len, &msg_len ) );
2491
2492 mbedtls_ssl_add_hs_msg_to_checksum(
2493 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2494
2495 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2496 ssl, buf_len, msg_len ) );
2497 }
2498 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2499 {
2500 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2501 ret = 0;
2502 }
2503 else
2504 {
2505 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2506 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2507 goto cleanup;
2508 }
2509
2510 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2511cleanup:
2512
2513 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2514 return( ret );
2515}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002516
Jerry Yu4d3841a2022-04-16 12:37:19 +08002517/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002518 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002519 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002520MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002521static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002522{
Jerry Yu5a26f302022-05-10 20:46:40 +08002523 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002524
2525#if defined(MBEDTLS_X509_CRT_PARSE_C)
2526 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2527 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002528 {
Jerry Yub89125b2022-05-13 15:45:49 +08002529 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002530 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2531 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002532 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002533 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002534#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002535
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002536 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2537 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002538 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002539 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2540 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002541}
2542
2543/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002544 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002545 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002546MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002547static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002548{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002549 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002550 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002551 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002552 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2553 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002554}
Ronald Cron928cbd32022-10-04 16:14:26 +02002555#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002556
2557/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002558 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002559 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002560MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002561static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002562{
Jerry Yud6e253d2022-05-18 13:59:24 +08002563 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002564
2565 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2566 if( ret != 0 )
2567 return( ret );
2568
Jerry Yue3d67cb2022-05-19 15:33:10 +08002569 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2570 if( ret != 0 )
2571 {
2572 MBEDTLS_SSL_PEND_FATAL_ALERT(
2573 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2574 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2575 return( ret );
2576 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002577
Ronald Cron63dc4632022-05-31 14:41:53 +02002578 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2579 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002580
Ronald Cron63dc4632022-05-31 14:41:53 +02002581 if( ssl->handshake->certificate_request_sent )
2582 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002583 else
Ronald Cron19385882022-06-15 16:26:13 +02002584 {
2585 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2586 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002587 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002588 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002589
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002590 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002591}
2592
2593/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002594 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002595 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002596MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002597static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002598{
Jerry Yud6e253d2022-05-18 13:59:24 +08002599 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2600
Jerry Yuff226982022-04-16 16:52:57 +08002601 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2602 if( ret != 0 )
2603 return( ret );
2604
Jerry Yu466dda82022-09-13 11:20:20 +08002605 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002606 if( ret != 0 )
2607 {
2608 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002609 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002610 }
2611
Jerry Yu03ed50b2022-04-16 17:13:30 +08002612 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002613 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002614}
2615
2616/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002617 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002618 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002619MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002620static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002621{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002622 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2623
Jerry Yu03ed50b2022-04-16 17:13:30 +08002624 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002625
2626#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002627 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2628#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002629 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002630#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002631 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002632}
2633
2634/*
Jerry Yue67bef42022-07-07 07:29:42 +00002635 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2636 */
2637#define SSL_NEW_SESSION_TICKET_SKIP 0
2638#define SSL_NEW_SESSION_TICKET_WRITE 1
2639MBEDTLS_CHECK_RETURN_CRITICAL
2640static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2641{
2642 /* Check whether the use of session tickets is enabled */
2643 if( ssl->conf->f_ticket_write == NULL )
2644 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002645 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2646 " callback is not set" ) );
2647 return( SSL_NEW_SESSION_TICKET_SKIP );
2648 }
2649 if( ssl->conf->new_session_tickets_count == 0 )
2650 {
2651 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2652 " configured count is zero" ) );
2653 return( SSL_NEW_SESSION_TICKET_SKIP );
2654 }
2655
2656 if( ssl->handshake->new_session_tickets_count == 0 )
2657 {
2658 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2659 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002660 return( SSL_NEW_SESSION_TICKET_SKIP );
2661 }
2662
Jerry Yue67bef42022-07-07 07:29:42 +00002663 return( SSL_NEW_SESSION_TICKET_WRITE );
2664}
2665
2666#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2667MBEDTLS_CHECK_RETURN_CRITICAL
2668static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2669 unsigned char *ticket_nonce,
2670 size_t ticket_nonce_size )
2671{
2672 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2673 mbedtls_ssl_session *session = ssl->session;
2674 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2675 psa_algorithm_t psa_hash_alg;
2676 int hash_length;
2677
2678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2679
2680#if defined(MBEDTLS_HAVE_TIME)
2681 session->start = mbedtls_time( NULL );
2682#endif
2683
2684 /* Generate ticket_age_add */
2685 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002686 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002687 sizeof( session->ticket_age_add ) ) != 0 ) )
2688 {
2689 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2690 return( ret );
2691 }
2692 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002693 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002694
2695 /* Generate ticket_nonce */
2696 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2697 if( ret != 0 )
2698 {
2699 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2700 return( ret );
2701 }
2702 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2703 ticket_nonce, ticket_nonce_size );
2704
2705 ciphersuite_info =
2706 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2707 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2708 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002709 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002710 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002711 {
Jerry Yue67bef42022-07-07 07:29:42 +00002712 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002713 }
2714
Jerry Yue67bef42022-07-07 07:29:42 +00002715 /* In this code the psk key length equals the length of the hash */
2716 session->resumption_key_len = hash_length;
2717 session->ciphersuite = ciphersuite_info->id;
2718
2719 /* Compute resumption key
2720 *
2721 * HKDF-Expand-Label( resumption_master_secret,
2722 * "resumption", ticket_nonce, Hash.length )
2723 */
2724 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2725 psa_hash_alg,
2726 session->app_secrets.resumption_master_secret,
2727 hash_length,
2728 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2729 ticket_nonce,
2730 ticket_nonce_size,
2731 session->resumption_key,
2732 hash_length );
2733
2734 if( ret != 0 )
2735 {
2736 MBEDTLS_SSL_DEBUG_RET( 2,
2737 "Creating the ticket-resumed PSK failed",
2738 ret );
2739 return ( ret );
2740 }
2741 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2742 session->resumption_key,
2743 session->resumption_key_len );
2744
2745 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2746 session->app_secrets.resumption_master_secret,
2747 hash_length );
2748
2749 return( 0 );
2750}
2751
2752/* This function creates a NewSessionTicket message in the following format:
2753 *
2754 * struct {
2755 * uint32 ticket_lifetime;
2756 * uint32 ticket_age_add;
2757 * opaque ticket_nonce<0..255>;
2758 * opaque ticket<1..2^16-1>;
2759 * Extension extensions<0..2^16-2>;
2760 * } NewSessionTicket;
2761 *
2762 * The ticket inside the NewSessionTicket message is an encrypted container
2763 * carrying the necessary information so that the server is later able to
2764 * re-start the communication.
2765 *
2766 * The following fields are placed inside the ticket by the
2767 * f_ticket_write() function:
2768 *
2769 * - creation time (start)
2770 * - flags (flags)
2771 * - age add (ticket_age_add)
2772 * - key (key)
2773 * - key length (key_len)
2774 * - ciphersuite (ciphersuite)
2775 */
2776MBEDTLS_CHECK_RETURN_CRITICAL
2777static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2778 unsigned char *buf,
2779 unsigned char *end,
2780 size_t *out_len,
2781 unsigned char *ticket_nonce,
2782 size_t ticket_nonce_size )
2783{
2784 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2785 unsigned char *p = buf;
2786 mbedtls_ssl_session *session = ssl->session;
2787 size_t ticket_len;
2788 uint32_t ticket_lifetime;
2789
2790 *out_len = 0;
2791 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2792
2793 /*
2794 * ticket_lifetime 4 bytes
2795 * ticket_age_add 4 bytes
2796 * ticket_nonce 1 + ticket_nonce_size bytes
2797 * ticket >=2 bytes
2798 */
2799 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2800
2801 /* Generate ticket and ticket_lifetime */
2802 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2803 session,
2804 p + 9 + ticket_nonce_size + 2,
2805 end,
2806 &ticket_len,
2807 &ticket_lifetime);
2808 if( ret != 0 )
2809 {
2810 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2811 return( ret );
2812 }
2813 /* RFC 8446 4.6.1
2814 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2815 * unsigned integer in network byte order from the time of ticket
2816 * issuance. Servers MUST NOT use any value greater than
2817 * 604800 seconds (7 days). The value of zero indicates that the
2818 * ticket should be discarded immediately. Clients MUST NOT cache
2819 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2820 * and MAY delete tickets earlier based on local policy. A server
2821 * MAY treat a ticket as valid for a shorter period of time than what
2822 * is stated in the ticket_lifetime.
2823 */
Xiaokang Qian28af5012022-10-13 08:18:19 +00002824 if( ticket_lifetime > 604800 )
2825 ticket_lifetime = 604800;
Jerry Yue67bef42022-07-07 07:29:42 +00002826 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2827 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2828 ( unsigned int )ticket_lifetime ) );
2829
2830 /* Write ticket_age_add */
2831 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2832 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2833 ( unsigned int )session->ticket_age_add ) );
2834
2835 /* Write ticket_nonce */
2836 p[8] = ( unsigned char )ticket_nonce_size;
2837 if( ticket_nonce_size > 0 )
2838 {
2839 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2840 }
2841 p += 9 + ticket_nonce_size;
2842
2843 /* Write ticket */
2844 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2845 p += 2;
2846 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2847 p += ticket_len;
2848
2849 /* Ticket Extensions
2850 *
2851 * Note: We currently don't have any extensions.
2852 * Set length to zero.
2853 */
Jerry Yuedab6372022-10-31 14:37:31 +08002854 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2855
Jerry Yue67bef42022-07-07 07:29:42 +00002856 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2857 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2858 p += 2;
2859
2860 *out_len = p - buf;
2861 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2862 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2863
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002864 MBEDTLS_SSL_PRINT_SENT_EXTS( 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET );
2865
Jerry Yue67bef42022-07-07 07:29:42 +00002866 return( 0 );
2867}
2868
2869/*
2870 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2871 */
2872static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2873{
2874 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2875
2876 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2877
2878 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2879 {
2880 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2881 unsigned char *buf;
2882 size_t buf_len, msg_len;
2883
2884 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2885 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2886
2887 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2888 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2889
2890 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2891 ssl, buf, buf + buf_len, &msg_len,
2892 ticket_nonce, sizeof( ticket_nonce ) ) );
2893
Jerry Yue67bef42022-07-07 07:29:42 +00002894 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2895 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002896
Jerry Yu359e65f2022-09-22 23:47:43 +08002897 /* Limit session tickets count to one when resumption connection.
2898 *
2899 * See document of mbedtls_ssl_conf_new_session_tickets.
2900 */
2901 if( ssl->handshake->resume == 1 )
2902 ssl->handshake->new_session_tickets_count = 0;
2903 else
2904 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002905
Jerry Yufca4d572022-07-21 10:37:48 +08002906 mbedtls_ssl_handshake_set_state( ssl,
2907 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002908 }
2909 else
2910 {
2911 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2912 }
2913
Jerry Yue67bef42022-07-07 07:29:42 +00002914cleanup:
2915
2916 return( ret );
2917}
2918#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2919
2920/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002921 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002922 */
Jerry Yu27561932021-08-27 17:07:38 +08002923int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002924{
XiaokangQian08037552022-04-20 07:16:41 +00002925 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002926
2927 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2928 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2929
Jerry Yue3b34122021-09-28 17:53:35 +08002930 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2931 mbedtls_ssl_states_str( ssl->state ),
2932 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002933
XiaokangQian7807f9f2022-02-15 10:04:37 +00002934 switch( ssl->state )
2935 {
2936 /* start state */
2937 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002938 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002939 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002940 break;
2941
XiaokangQian7807f9f2022-02-15 10:04:37 +00002942 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002943 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002944 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002945 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002946 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002947
Jerry Yuf41553b2022-05-09 22:20:30 +08002948 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2949 ret = ssl_tls13_write_hello_retry_request( ssl );
2950 if( ret != 0 )
2951 {
2952 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2953 return( ret );
2954 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002955 break;
2956
Jerry Yu5b64ae92022-03-30 17:15:02 +08002957 case MBEDTLS_SSL_SERVER_HELLO:
2958 ret = ssl_tls13_write_server_hello( ssl );
2959 break;
2960
Xiaofei Baicba64af2022-02-15 10:00:56 +00002961 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002962 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002963 if( ret != 0 )
2964 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002965 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2966 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002967 }
Jerry Yu48330562022-05-06 21:35:44 +08002968 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002969
Ronald Cron928cbd32022-10-04 16:14:26 +02002970#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002971 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002972 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002973 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002974
Jerry Yu83da34e2022-04-16 13:59:52 +08002975 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2976 ret = ssl_tls13_write_server_certificate( ssl );
2977 break;
2978
2979 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
2980 ret = ssl_tls13_write_certificate_verify( ssl );
2981 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002982#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002983
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002984 /*
2985 * Injection of dummy-CCS's for middlebox compatibility
2986 */
2987#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002988 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002989 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2990 if( ret == 0 )
2991 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2992 break;
2993
2994 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
2995 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2996 if( ret == 0 )
2997 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2998 break;
2999#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3000
Jerry Yu69dd8d42022-04-16 12:51:26 +08003001 case MBEDTLS_SSL_SERVER_FINISHED:
3002 ret = ssl_tls13_write_server_finished( ssl );
3003 break;
3004
3005 case MBEDTLS_SSL_CLIENT_FINISHED:
3006 ret = ssl_tls13_process_client_finished( ssl );
3007 break;
3008
Jerry Yu69dd8d42022-04-16 12:51:26 +08003009 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3010 ret = ssl_tls13_handshake_wrapup( ssl );
3011 break;
3012
Ronald Cron766c0cd2022-10-18 12:17:11 +02003013#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003014 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3015 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003016 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003017 {
Ronald Cron209cae92022-06-07 10:30:19 +02003018 if( ssl->session_negotiate->peer_cert != NULL )
3019 {
3020 mbedtls_ssl_handshake_set_state(
3021 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3022 }
3023 else
Ronald Cron19385882022-06-15 16:26:13 +02003024 {
3025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003026 mbedtls_ssl_handshake_set_state(
3027 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003028 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003029 }
3030 break;
3031
3032 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3033 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3034 if( ret == 0 )
3035 {
3036 mbedtls_ssl_handshake_set_state(
3037 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3038 }
3039 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003040#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003041
Jerry Yue67bef42022-07-07 07:29:42 +00003042#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3043 case MBEDTLS_SSL_NEW_SESSION_TICKET:
3044 ret = ssl_tls13_write_new_session_ticket( ssl );
3045 if( ret != 0 )
3046 {
3047 MBEDTLS_SSL_DEBUG_RET( 1,
3048 "ssl_tls13_write_new_session_ticket ",
3049 ret );
3050 }
3051 break;
3052 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
3053 /* This state is necessary to do the flush of the New Session
3054 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
3055 * as part of ssl_prepare_handshake_step.
3056 */
3057 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003058
Jerry Yud0766ec2022-09-22 10:46:57 +08003059 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003060 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3061 else
3062 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003063 break;
3064
3065#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3066
XiaokangQian7807f9f2022-02-15 10:04:37 +00003067 default:
3068 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003069 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003070 }
3071
3072 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003073}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003074
Jerry Yufb4b6472022-01-27 15:03:26 +08003075#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */