blob: 598ca91bfa17b0bc4807673c959f1c3dfe1f83fd [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
703 return( 0 );
704}
705
Ronald Cron41a443a2022-10-04 16:38:25 +0200706#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000707
XiaokangQian7807f9f2022-02-15 10:04:37 +0000708/* From RFC 8446:
709 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000710 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000711 * } SupportedVersions;
712 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200713MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000714static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
715 const unsigned char *buf,
716 const unsigned char *end )
717{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000719 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000720 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000721 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000722 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000723
724 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000725 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000726 p += 1;
727
XiaokangQian4080a7f2022-04-11 09:55:18 +0000728 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000729 versions_end = p + versions_len;
730 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000731 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000732 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000733 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000734 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735
736 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000737 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 {
739 tls13_supported = 1;
740 break;
741 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742 }
743
XiaokangQianb67384d2022-04-19 00:02:38 +0000744 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
747
748 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
749 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
750 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
751 }
752
XiaokangQiande333912022-04-20 08:49:42 +0000753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000754 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000755
XiaokangQian7807f9f2022-02-15 10:04:37 +0000756 return( 0 );
757}
758
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000759#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000760/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000761 *
762 * From RFC 8446:
763 * enum {
764 * ... (0xFFFF)
765 * } NamedGroup;
766 * struct {
767 * NamedGroup named_group_list<2..2^16-1>;
768 * } NamedGroupList;
769 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200770MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800771static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
772 const unsigned char *buf,
773 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000774{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000775 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000776 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000777 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778
779 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000780 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000781 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000782 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000783 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000784 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000785 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000786
XiaokangQian08037552022-04-20 07:16:41 +0000787 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788 {
XiaokangQian08037552022-04-20 07:16:41 +0000789 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000790 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000791 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
792 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000793
Jerry Yuc1be19f2022-04-23 16:11:39 +0800794 MBEDTLS_SSL_DEBUG_MSG( 2,
795 ( "got named group: %s(%04x)",
796 mbedtls_ssl_named_group_to_str( named_group ),
797 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000798
799 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
800 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000801 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000802 {
XiaokangQian08037552022-04-20 07:16:41 +0000803 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804 }
805
Jerry Yuc1be19f2022-04-23 16:11:39 +0800806 MBEDTLS_SSL_DEBUG_MSG( 2,
807 ( "add named group %s(%04x) into received list.",
808 mbedtls_ssl_named_group_to_str( named_group ),
809 named_group ) );
810
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000811 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000812 }
813
814 return( 0 );
815
816}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000817#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818
XiaokangQian08037552022-04-20 07:16:41 +0000819#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
820
XiaokangQian88408882022-04-02 10:15:03 +0000821#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000822/*
823 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000824 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825 *
826 * Possible return values are:
827 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000828 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000829 * does not match a group supported by the server. A HelloRetryRequest will
830 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000831 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800832 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200833MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000834static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
835 const unsigned char *buf,
836 const unsigned char *end )
837{
XiaokangQianb67384d2022-04-19 00:02:38 +0000838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000840 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800841 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000842
843 /* From RFC 8446:
844 *
845 * struct {
846 * KeyShareEntry client_shares<0..2^16-1>;
847 * } KeyShareClientHello;
848 *
849 */
850
XiaokangQian7807f9f2022-02-15 10:04:37 +0000851 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000852 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000854 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000855
856 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000857 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000858
859 /* We try to find a suitable key share entry and copy it to the
860 * handshake context. Later, we have to find out whether we can do
861 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000862 * dismiss it and send a HelloRetryRequest message.
863 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864
Jerry Yuc1be19f2022-04-23 16:11:39 +0800865 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000866 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000867 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800868 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800869 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000870
871 /*
872 * struct {
873 * NamedGroup group;
874 * opaque key_exchange<1..2^16-1>;
875 * } KeyShareEntry;
876 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000877 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000878 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800879 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
880 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800881 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000882 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
Jerry Yu086edc22022-05-05 10:50:38 +0800883 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000884
885 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000886 * for input validation purposes.
887 */
XiaokangQian060d8672022-04-21 09:24:56 +0000888 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800889 ! mbedtls_ssl_named_group_is_supported( group ) ||
890 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000891 {
892 continue;
893 }
XiaokangQian060d8672022-04-21 09:24:56 +0000894
XiaokangQian7807f9f2022-02-15 10:04:37 +0000895 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000896 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000897 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000898 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
899 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800900 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
901 mbedtls_ssl_named_group_to_str( group ),
902 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000903 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800904 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000905 if( ret != 0 )
906 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000907
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000908 }
909 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000910 {
911 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000912 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000913 continue;
914 }
915
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000916 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917 }
918
Jerry Yuc1be19f2022-04-23 16:11:39 +0800919
920 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000921 {
922 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000923 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000924 }
925 return( 0 );
926}
XiaokangQian88408882022-04-02 10:15:03 +0000927#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000928
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200929MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000930static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000931 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932{
Jerry Yu0c354a22022-08-29 15:25:36 +0800933 int masked = ssl->handshake->received_extensions & exts_mask;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000934 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000935}
936
Jerry Yue5991322022-11-07 14:03:44 +0800937#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200938MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000939static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
940 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000941{
Jerry Yu77f01482022-07-11 07:03:24 +0000942 return( ssl_tls13_client_hello_has_exts(
943 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800944 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) |
945 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) |
946 MBEDTLS_SSL_EXT_MASK( SIG_ALG ) ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000947}
Jerry Yue5991322022-11-07 14:03:44 +0800948#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000949
Jerry Yue5991322022-11-07 14:03:44 +0800950#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000951MBEDTLS_CHECK_RETURN_CRITICAL
952static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
953 mbedtls_ssl_context *ssl )
954{
955 return( ssl_tls13_client_hello_has_exts(
956 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800957 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) |
958 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) );
Jerry Yu77f01482022-07-11 07:03:24 +0000959}
Jerry Yue5991322022-11-07 14:03:44 +0800960#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000961
Jerry Yue5991322022-11-07 14:03:44 +0800962#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000963MBEDTLS_CHECK_RETURN_CRITICAL
964static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
965 mbedtls_ssl_context *ssl )
966{
967 return( ssl_tls13_client_hello_has_exts(
968 ssl,
Jerry Yu63a459c2022-10-31 13:38:40 +0800969 MBEDTLS_SSL_EXT_MASK( SUPPORTED_GROUPS ) |
970 MBEDTLS_SSL_EXT_MASK( KEY_SHARE ) |
971 MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) |
972 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) );
Jerry Yu77f01482022-07-11 07:03:24 +0000973}
Jerry Yue5991322022-11-07 14:03:44 +0800974#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000975
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200976MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000977static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000978{
Jerry Yue5991322022-11-07 14:03:44 +0800979#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000980 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
981 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
Jerry Yue5991322022-11-07 14:03:44 +0800982#else
983 ((void) ssl);
984 return( 0 );
985#endif
Jerry Yu77f01482022-07-11 07:03:24 +0000986}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000987
Jerry Yu77f01482022-07-11 07:03:24 +0000988MBEDTLS_CHECK_RETURN_CRITICAL
989static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
990{
Jerry Yue5991322022-11-07 14:03:44 +0800991#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000992 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
993 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
994 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
995#else
996 ((void) ssl);
997 return( 0 );
998#endif
999}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001000
Jerry Yu77f01482022-07-11 07:03:24 +00001001MBEDTLS_CHECK_RETURN_CRITICAL
1002static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
1003{
Jerry Yue5991322022-11-07 14:03:44 +08001004#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001005 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
1006 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
1007 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
1008#else
1009 ((void) ssl);
1010 return( 0 );
1011#endif
1012}
1013
1014static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1015{
1016 /*
1017 * Determine the key exchange algorithm to use.
1018 * There are three types of key exchanges supported in TLS 1.3:
1019 * - (EC)DH with ECDSA,
1020 * - (EC)DH with PSK,
1021 * - plain PSK.
1022 *
1023 * The PSK-based key exchanges may additionally be used with 0-RTT.
1024 *
1025 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001026 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1027 * 2 ) Certificate Mode ( ephemeral )
1028 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001029 */
1030
1031 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1032
Jerry Yu77f01482022-07-11 07:03:24 +00001033 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1034 {
1035 ssl->handshake->key_exchange_mode =
1036 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1037 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1038 }
1039 else
1040 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1041 {
1042 ssl->handshake->key_exchange_mode =
1043 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1044 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1045 }
1046 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001047 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1048 {
1049 ssl->handshake->key_exchange_mode =
1050 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1051 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1052 }
1053 else
Jerry Yu77f01482022-07-11 07:03:24 +00001054 {
1055 MBEDTLS_SSL_DEBUG_MSG(
1056 1,
1057 ( "ClientHello message misses mandatory extensions." ) );
1058 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1059 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1060 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1061 }
1062
1063 return( 0 );
1064
XiaokangQian7807f9f2022-02-15 10:04:37 +00001065}
1066
XiaokangQian81802f42022-06-10 13:25:22 +00001067#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001068 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001069
1070#if defined(MBEDTLS_USE_PSA_CRYPTO)
1071static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1072{
1073 switch( sig_alg )
1074 {
1075 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1076 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1077 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1078 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1079 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1080 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1081 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1082 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1083 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1084 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1085 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1086 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1087 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001088 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001089 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001090 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001091 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001092 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001093 default:
1094 return( PSA_ALG_NONE );
1095 }
1096}
1097#endif /* MBEDTLS_USE_PSA_CRYPTO */
1098
XiaokangQian23c5be62022-06-07 02:04:34 +00001099/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001100 * Pick best ( private key, certificate chain ) pair based on the signature
1101 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001102 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001103MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001104static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001105{
XiaokangQianfb665a82022-06-15 03:57:21 +00001106 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001107 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001108
1109#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1110 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001111 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001112 else
1113#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001114 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001115
XiaokangQianfb665a82022-06-15 03:57:21 +00001116 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001117 {
1118 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1119 return( -1 );
1120 }
1121
XiaokangQian81802f42022-06-10 13:25:22 +00001122 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001123 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001124 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1125 continue;
1126
1127 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1128 continue;
1129
XiaokangQianfb665a82022-06-15 03:57:21 +00001130 for( key_cert = key_cert_list; key_cert != NULL;
1131 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001132 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001133#if defined(MBEDTLS_USE_PSA_CRYPTO)
1134 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1135#endif /* MBEDTLS_USE_PSA_CRYPTO */
1136
XiaokangQianfb665a82022-06-15 03:57:21 +00001137 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1138 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001139
1140 /*
1141 * This avoids sending the client a cert it'll reject based on
1142 * keyUsage or other extensions.
1143 */
1144 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001145 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001146 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001147 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1148 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001149 {
1150 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001151 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001152 continue;
1153 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001154
Jerry Yucc539102022-06-27 16:27:35 +08001155 MBEDTLS_SSL_DEBUG_MSG( 3,
1156 ( "ssl_tls13_pick_key_cert:"
1157 "check signature algorithm %s [%04x]",
1158 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1159 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001160#if defined(MBEDTLS_USE_PSA_CRYPTO)
1161 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1162#endif /* MBEDTLS_USE_PSA_CRYPTO */
1163
Jerry Yufb526692022-06-19 11:22:49 +08001164 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001165 *sig_alg, &key_cert->cert->pk )
1166#if defined(MBEDTLS_USE_PSA_CRYPTO)
1167 && psa_alg != PSA_ALG_NONE &&
1168 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1169 PSA_KEY_USAGE_SIGN_HASH ) == 1
1170#endif /* MBEDTLS_USE_PSA_CRYPTO */
1171 )
XiaokangQian81802f42022-06-10 13:25:22 +00001172 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001173 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001174 MBEDTLS_SSL_DEBUG_MSG( 3,
1175 ( "ssl_tls13_pick_key_cert:"
1176 "selected signature algorithm"
1177 " %s [%04x]",
1178 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1179 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001180 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001181 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001182 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001183 return( 0 );
1184 }
XiaokangQian81802f42022-06-10 13:25:22 +00001185 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001186 }
1187
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001188 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1189 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001190 return( -1 );
1191}
XiaokangQian81802f42022-06-10 13:25:22 +00001192#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001193 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001194
XiaokangQian4080a7f2022-04-11 09:55:18 +00001195/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001196 *
1197 * STATE HANDLING: ClientHello
1198 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001199 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001200 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001201 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001202 *
1203 * In this case, the server progresses to sending its ServerHello.
1204 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001205 * 2) The ClientHello was well-formed but didn't match the server's
1206 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001207 *
1208 * For example, the client might not have offered a key share which
1209 * the server supports, or the server might require a cookie.
1210 *
1211 * In this case, the server sends a HelloRetryRequest.
1212 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001213 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001214 *
1215 * In this case, we abort the handshake.
1216 *
1217 */
1218
1219/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001220 * Structure of this message:
1221 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001222 * uint16 ProtocolVersion;
1223 * opaque Random[32];
1224 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001225 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001226 * struct {
1227 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1228 * Random random;
1229 * opaque legacy_session_id<0..32>;
1230 * CipherSuite cipher_suites<2..2^16-2>;
1231 * opaque legacy_compression_methods<1..2^8-1>;
1232 * Extension extensions<8..2^16-1>;
1233 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001234 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001235
1236#define SSL_CLIENT_HELLO_OK 0
1237#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1238
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001239MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001240static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1241 const unsigned char *buf,
1242 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001243{
XiaokangQianb67384d2022-04-19 00:02:38 +00001244 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1245 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001246 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001247 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001248 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001249 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001250 const unsigned char *extensions_end;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001251 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu49ca9282022-05-05 11:05:22 +08001252 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001253
Ronald Cron41a443a2022-10-04 16:38:25 +02001254#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001255 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001256 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001257 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001258#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001259
XiaokangQian7807f9f2022-02-15 10:04:37 +00001260 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001261 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001262 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001263 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001264 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001265 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001266 * .. . .. ciphersuite list length ( 2 bytes )
1267 * .. . .. ciphersuite list
1268 * .. . .. compression alg. list length ( 1 byte )
1269 * .. . .. compression alg. list
1270 * .. . .. extensions length ( 2 bytes, optional )
1271 * .. . .. extensions ( optional )
1272 */
1273
XiaokangQianb67384d2022-04-19 00:02:38 +00001274 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001275 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001276 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1277 * read at least up to session id length without worrying.
1278 */
1279 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1280
1281 /* ...
1282 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1283 * ...
1284 * with ProtocolVersion defined as:
1285 * uint16 ProtocolVersion;
1286 */
XiaokangQiande333912022-04-20 08:49:42 +00001287 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1288 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001289 {
1290 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1291 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1292 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001293 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001294 }
1295 p += 2;
1296
1297 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001298 * Only support TLS 1.3 currently, temporarily set the version.
1299 */
XiaokangQiande333912022-04-20 08:49:42 +00001300 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001301
Jerry Yue67bef42022-07-07 07:29:42 +00001302#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1303 /* Store minor version for later use with ticket serialization. */
1304 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001305 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001306#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001307
Jerry Yuc1be19f2022-04-23 16:11:39 +08001308 /* ...
1309 * Random random;
1310 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001311 * with Random defined as:
1312 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001313 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001314 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001315 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001317 memcpy( &handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian08037552022-04-20 07:16:41 +00001318 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319
Jerry Yuc1be19f2022-04-23 16:11:39 +08001320 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001321 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001322 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001323 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001324 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001325 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001326
XiaokangQianb67384d2022-04-19 00:02:38 +00001327 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001328 {
1329 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1330 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1331 }
1332
XiaokangQian4080a7f2022-04-11 09:55:18 +00001333 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001334 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001335 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001336 /*
1337 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001338 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001339 */
1340 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001341
XiaokangQianed582dd2022-04-13 08:21:05 +00001342 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001343 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001344
XiaokangQian7807f9f2022-02-15 10:04:37 +00001345 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1346 p += 2;
1347
XiaokangQianb67384d2022-04-19 00:02:38 +00001348 /* Check we have enough data for the ciphersuite list, the legacy
1349 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001350 *
1351 * cipher_suites cipher_suites_len bytes
1352 * legacy_compression_methods 2 bytes
1353 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001354 */
1355 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001356
Jerry Yu24b8c812022-08-20 19:06:56 +08001357 /* ...
1358 * CipherSuite cipher_suites<2..2^16-2>;
1359 * ...
1360 * with CipherSuite defined as:
1361 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001362 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001363#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001364 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001365#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001366 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001367 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1368 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001369
1370 /*
1371 * Search for a matching ciphersuite
1372 */
XiaokangQian060d8672022-04-21 09:24:56 +00001373 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001374 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001375 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001376 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001377
XiaokangQiane8ff3502022-04-22 02:34:40 +00001378 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001379
XiaokangQiane8ff3502022-04-22 02:34:40 +00001380 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001381 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001382 ssl,cipher_suite );
1383 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001384 continue;
1385
Jerry Yu5725f1c2022-08-21 17:27:16 +08001386 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001387 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001388 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001389 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001390 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001391 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001392
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001393 if( handshake->ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001394 {
1395 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1396 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1397 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1398 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001399
XiaokangQian4080a7f2022-04-11 09:55:18 +00001400 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001401 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001402 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001403 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001404 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001405 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1407 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1408 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1409 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001410 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001411 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001412
Jerry Yuc1be19f2022-04-23 16:11:39 +08001413 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001414 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001415 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001416 * with Extension defined as:
1417 * struct {
1418 * ExtensionType extension_type;
1419 * opaque extension_data<0..2^16-1>;
1420 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001421 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001422 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001423 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001424 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001425 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001426
XiaokangQian4080a7f2022-04-11 09:55:18 +00001427 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001428
Jerry Yu63a459c2022-10-31 13:38:40 +08001429 handshake->received_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu0c354a22022-08-29 15:25:36 +08001430
XiaokangQian7807f9f2022-02-15 10:04:37 +00001431 while( p < extensions_end )
1432 {
1433 unsigned int extension_type;
1434 size_t extension_data_len;
1435 const unsigned char *extension_data_end;
1436
Jerry Yu0c354a22022-08-29 15:25:36 +08001437 /* RFC 8446, section 4.2.11
Jerry Yu1c9247c2022-07-21 12:37:39 +08001438 *
1439 * The "pre_shared_key" extension MUST be the last extension in the
1440 * ClientHello (this facilitates implementation as described below).
1441 * Servers MUST check that it is the last extension and otherwise fail
1442 * the handshake with an "illegal_parameter" alert.
1443 */
Jerry Yu63a459c2022-10-31 13:38:40 +08001444 if( handshake->received_extensions & MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) )
Jerry Yu1c9247c2022-07-21 12:37:39 +08001445 {
1446 MBEDTLS_SSL_DEBUG_MSG(
1447 3, ( "pre_shared_key is not last extension." ) );
1448 MBEDTLS_SSL_PEND_FATAL_ALERT(
1449 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1450 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1451 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1452 }
1453
XiaokangQian318dc762022-04-20 09:43:51 +00001454 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001455 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1456 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1457 p += 4;
1458
1459 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1460 extension_data_end = p + extension_data_len;
1461
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001462 ret = mbedtls_ssl_tls13_check_received_extension(
Jerry Yu0c354a22022-08-29 15:25:36 +08001463 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO, extension_type,
1464 MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH );
1465 if( ret != 0 )
1466 return( ret );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001467
XiaokangQian7807f9f2022-02-15 10:04:37 +00001468 switch( extension_type )
1469 {
XiaokangQian40a35232022-05-07 09:02:40 +00001470#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1471 case MBEDTLS_TLS_EXT_SERVERNAME:
1472 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001473 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1474 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001475 if( ret != 0 )
1476 {
1477 MBEDTLS_SSL_DEBUG_RET(
1478 1, "mbedtls_ssl_parse_servername_ext", ret );
1479 return( ret );
1480 }
XiaokangQian40a35232022-05-07 09:02:40 +00001481 break;
1482#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1483
XiaokangQianb67384d2022-04-19 00:02:38 +00001484#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001485 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1486 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1487
1488 /* Supported Groups Extension
1489 *
1490 * When sent by the client, the "supported_groups" extension
1491 * indicates the named groups which the client supports,
1492 * ordered from most preferred to least preferred.
1493 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001494 ret = ssl_tls13_parse_supported_groups_ext(
1495 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001496 if( ret != 0 )
1497 {
1498 MBEDTLS_SSL_DEBUG_RET( 1,
1499 "mbedtls_ssl_parse_supported_groups_ext", ret );
1500 return( ret );
1501 }
1502
XiaokangQian7807f9f2022-02-15 10:04:37 +00001503 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001504#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001505
XiaokangQian88408882022-04-02 10:15:03 +00001506#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001507 case MBEDTLS_TLS_EXT_KEY_SHARE:
1508 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1509
1510 /*
1511 * Key Share Extension
1512 *
1513 * When sent by the client, the "key_share" extension
1514 * contains the endpoint's cryptographic parameters for
1515 * ECDHE/DHE key establishment methods.
1516 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001517 ret = ssl_tls13_parse_key_shares_ext(
1518 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001519 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001520 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001521 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001522 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001523 }
1524
Jerry Yu582dd062022-04-22 21:59:01 +08001525 if( ret < 0 )
1526 {
1527 MBEDTLS_SSL_DEBUG_RET(
1528 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001529 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001530 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001531
XiaokangQian7807f9f2022-02-15 10:04:37 +00001532 break;
XiaokangQian88408882022-04-02 10:15:03 +00001533#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001534
1535 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1536 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1537
1538 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001539 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001540 if( ret != 0 )
1541 {
1542 MBEDTLS_SSL_DEBUG_RET( 1,
1543 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1544 return( ret );
1545 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001546 break;
1547
Ronald Cron41a443a2022-10-04 16:38:25 +02001548#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001549 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1550 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1551
1552 ret = ssl_tls13_parse_key_exchange_modes_ext(
1553 ssl, p, extension_data_end );
1554 if( ret != 0 )
1555 {
1556 MBEDTLS_SSL_DEBUG_RET(
1557 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1558 return( ret );
1559 }
1560
Jerry Yue19e3b92022-07-08 12:04:51 +00001561 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001562#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001563
Jerry Yu1c105562022-07-10 06:32:38 +00001564 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1565 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001566 if( ( handshake->received_extensions &
Jerry Yu63a459c2022-10-31 13:38:40 +08001567 MBEDTLS_SSL_EXT_MASK( PSK_KEY_EXCHANGE_MODES ) ) == 0 )
Jerry Yu13ab81d2022-07-22 23:17:11 +08001568 {
1569 MBEDTLS_SSL_PEND_FATAL_ALERT(
1570 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001571 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1572 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001573 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001574#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001575 /* Delay processing of the PSK identity once we have
1576 * found out which algorithms to use. We keep a pointer
1577 * to the buffer and the size for later processing.
1578 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001579 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001580 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001581#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001582 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001583
XiaokangQianacb39922022-06-17 10:18:48 +00001584#if defined(MBEDTLS_SSL_ALPN)
1585 case MBEDTLS_TLS_EXT_ALPN:
1586 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1587
1588 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1589 if( ret != 0 )
1590 {
1591 MBEDTLS_SSL_DEBUG_RET(
1592 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1593 return( ret );
1594 }
XiaokangQianacb39922022-06-17 10:18:48 +00001595 break;
1596#endif /* MBEDTLS_SSL_ALPN */
1597
Ronald Cron928cbd32022-10-04 16:14:26 +02001598#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001599 case MBEDTLS_TLS_EXT_SIG_ALG:
1600 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1601
Gabor Mezei078e8032022-04-27 21:17:56 +02001602 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001603 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001604 if( ret != 0 )
1605 {
1606 MBEDTLS_SSL_DEBUG_MSG( 1,
1607 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1608 ret ) );
1609 return( ret );
1610 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001611 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001612#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001613
1614 default:
Jerry Yu63a459c2022-10-31 13:38:40 +08001615 MBEDTLS_SSL_PRINT_EXT_TYPE(
1616 3, MBEDTLS_SSL_HS_CLIENT_HELLO,
1617 extension_type, "( ignored )" );
Jerry Yu0c354a22022-08-29 15:25:36 +08001618 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001619 }
1620
1621 p += extension_data_len;
1622 }
1623
Jerry Yu63a459c2022-10-31 13:38:40 +08001624 MBEDTLS_SSL_PRINT_RECEIVED_EXTS( 3, MBEDTLS_SSL_HS_CLIENT_HELLO );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001625
Jerry Yu1c105562022-07-10 06:32:38 +00001626 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1627 MBEDTLS_SSL_HS_CLIENT_HELLO,
1628 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001629
Ronald Cron41a443a2022-10-04 16:38:25 +02001630#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001631 /* Update checksum with either
1632 * - The entire content of the CH message, if no PSK extension is present
1633 * - The content up to but excluding the PSK extension, if present.
1634 */
Jerry Yu1c105562022-07-10 06:32:38 +00001635 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001636 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001637 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yu63a459c2022-10-31 13:38:40 +08001638 ( handshake->received_extensions & MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY ) ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001639 {
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001640 handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001641 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001642 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001643 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001644 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001645 cipher_suites,
1646 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001647 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001648 {
Jerry Yu63a459c2022-10-31 13:38:40 +08001649 handshake->received_extensions &= ~MBEDTLS_SSL_EXT_MASK( PRE_SHARED_KEY );
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001650 }
1651 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001652 {
Jerry Yu63a459c2022-10-31 13:38:40 +08001653 MBEDTLS_SSL_DEBUG_RET(
1654 1, "ssl_tls13_parse_pre_shared_key_ext" , ret );
Jerry Yu1c105562022-07-10 06:32:38 +00001655 return( ret );
1656 }
Jerry Yu1c105562022-07-10 06:32:38 +00001657 }
1658 else
Ronald Cron41a443a2022-10-04 16:38:25 +02001659#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001660 {
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001661 handshake->update_checksum( ssl, buf, p - buf );
Jerry Yu1c105562022-07-10 06:32:38 +00001662 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001663
Jerry Yuba9b6e92022-07-22 21:35:18 +08001664 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1665 if( ret < 0 )
1666 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001667
Jerry Yuc4bf5d62022-10-29 09:08:47 +08001668 mbedtls_ssl_optimize_checksum( ssl, handshake->ciphersuite_info );
Jerry Yue5834fd2022-08-29 20:16:09 +08001669
XiaokangQian75fe8c72022-06-15 09:42:45 +00001670 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1671}
1672
1673/* Update the handshake state machine */
1674
Ronald Cronce7d76e2022-07-08 18:56:49 +02001675MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001676static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1677{
1678 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1679
XiaokangQian7807f9f2022-02-15 10:04:37 +00001680 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001681 * Server certificate selection
1682 */
1683 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1684 {
1685 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1686 return( ret );
1687 }
1688#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1689 ssl->handshake->sni_name = NULL;
1690 ssl->handshake->sni_name_len = 0;
1691#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001692
XiaokangQian7807f9f2022-02-15 10:04:37 +00001693 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1694 if( ret != 0 )
1695 {
1696 MBEDTLS_SSL_DEBUG_RET( 1,
1697 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1698 return( ret );
1699 }
1700
XiaokangQian7807f9f2022-02-15 10:04:37 +00001701 return( 0 );
1702
1703}
1704
1705/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001706 * Main entry point from the state machine; orchestrates the otherfunctions.
1707 */
1708
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001709MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001710static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1711{
1712
XiaokangQian08037552022-04-20 07:16:41 +00001713 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001714 unsigned char* buf = NULL;
1715 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001716 int parse_client_hello_ret;
1717
XiaokangQianed582dd2022-04-13 08:21:05 +00001718 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1719
XiaokangQianed582dd2022-04-13 08:21:05 +00001720 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1721 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1722 &buf, &buflen ) );
1723
1724 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1725 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001726 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1727 * only SSL_CLIENT_HELLO_OK or
1728 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1729 * stage as negative error codes are handled
1730 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001731
XiaokangQiancfd925f2022-04-14 07:10:37 +00001732 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001733
Jerry Yu4ca91402022-05-09 15:50:57 +08001734 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1735 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1736 else
1737 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001738
1739cleanup:
1740
1741 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1742 return( ret );
1743}
1744
1745/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001746 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001747 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001748MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001749static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1750{
Jerry Yu637a3f12022-04-20 21:37:58 +08001751 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1752 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001753 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001754 if( ssl->conf->f_rng == NULL )
1755 {
1756 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1757 return( MBEDTLS_ERR_SSL_NO_RNG );
1758 }
1759
Jerry Yu637a3f12022-04-20 21:37:58 +08001760 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001761 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1762 {
1763 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1764 return( ret );
1765 }
1766
Jerry Yu637a3f12022-04-20 21:37:58 +08001767 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001768 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1769
1770#if defined(MBEDTLS_HAVE_TIME)
1771 ssl->session_negotiate->start = time( NULL );
1772#endif /* MBEDTLS_HAVE_TIME */
1773
1774 return( ret );
1775}
1776
Jerry Yu3bf2c642022-03-30 22:02:12 +08001777/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001778 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001779 *
1780 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001781 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001782 * } SupportedVersions;
1783 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001784MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001785static int ssl_tls13_write_server_hello_supported_versions_ext(
1786 mbedtls_ssl_context *ssl,
1787 unsigned char *buf,
1788 unsigned char *end,
1789 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001790{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001791 *out_len = 0;
1792
Jerry Yu955ddd72022-04-22 22:27:33 +08001793 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001794
1795 /* Check if we have space to write the extension:
1796 * - extension_type (2 bytes)
1797 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001798 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001799 */
Jerry Yu349a6132022-04-14 20:52:56 +08001800 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001801
Jerry Yu349a6132022-04-14 20:52:56 +08001802 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803
Jerry Yu349a6132022-04-14 20:52:56 +08001804 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001805
Jerry Yu349a6132022-04-14 20:52:56 +08001806 mbedtls_ssl_write_version( buf + 4,
1807 ssl->conf->transport,
1808 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001809
1810 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1811 ssl->tls_version ) );
1812
Jerry Yu349a6132022-04-14 20:52:56 +08001813 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001814
1815 return( 0 );
1816}
1817
Jerry Yud9436a12022-04-20 22:28:09 +08001818
Jerry Yu3bf2c642022-03-30 22:02:12 +08001819
1820/* Generate and export a single key share. For hybrid KEMs, this can
1821 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001822MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001823static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1824 uint16_t named_group,
1825 unsigned char *buf,
1826 unsigned char *end,
1827 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001828{
1829 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001830
1831 *out_len = 0;
1832
Jerry Yu89e103c2022-03-30 22:43:29 +08001833#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001834 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1835 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001836 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1837 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001838 if( ret != 0 )
1839 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001840 MBEDTLS_SSL_DEBUG_RET(
1841 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1842 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843 return( ret );
1844 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001845 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001846 else
1847#endif /* MBEDTLS_ECDH_C */
1848 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849 {
1850 }
1851 else
1852 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001853 ((void) ssl);
1854 ((void) named_group);
1855 ((void) buf);
1856 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001857 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1858 }
1859
1860 return( ret );
1861}
1862
1863/*
1864 * ssl_tls13_write_key_share_ext
1865 *
1866 * Structure of key_share extension in ServerHello:
1867 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001868 * struct {
1869 * NamedGroup group;
1870 * opaque key_exchange<1..2^16-1>;
1871 * } KeyShareEntry;
1872 * struct {
1873 * KeyShareEntry server_share;
1874 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001875 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001876MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001877static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1878 unsigned char *buf,
1879 unsigned char *end,
1880 size_t *out_len )
1881{
Jerry Yu955ddd72022-04-22 22:27:33 +08001882 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001884 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001885 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001886 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001887
1888 *out_len = 0;
1889
1890 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1891
Jerry Yu58af2332022-09-06 11:19:31 +08001892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1893 mbedtls_ssl_named_group_to_str( group ),
1894 group ) );
1895
Jerry Yu3bf2c642022-03-30 22:02:12 +08001896 /* Check if we have space for header and length fields:
1897 * - extension_type (2 bytes)
1898 * - extension_data_length (2 bytes)
1899 * - group (2 bytes)
1900 * - key_exchange_length (2 bytes)
1901 */
1902 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001903 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1904 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001905 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001906
Jerry Yu3bf2c642022-03-30 22:02:12 +08001907 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1908 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001909 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001910 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001911 if( ret != 0 )
1912 return( ret );
1913 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001914
Jerry Yu955ddd72022-04-22 22:27:33 +08001915 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001916
Jerry Yu57d48412022-04-20 21:50:42 +08001917 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001918
Jerry Yu57d48412022-04-20 21:50:42 +08001919 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001920
Jerry Yu3bf2c642022-03-30 22:02:12 +08001921 return( 0 );
1922}
Jerry Yud9436a12022-04-20 22:28:09 +08001923
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001924MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001925static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1926 unsigned char *buf,
1927 unsigned char *end,
1928 size_t *out_len )
1929{
1930 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1931 /* key_share Extension
1932 *
1933 * struct {
1934 * select (Handshake.msg_type) {
1935 * ...
1936 * case hello_retry_request:
1937 * NamedGroup selected_group;
1938 * ...
1939 * };
1940 * } KeyShare;
1941 */
1942
1943 *out_len = 0;
1944
Jerry Yub0ac10b2022-05-05 11:10:08 +08001945 /*
1946 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1947 * of the HRR is then to transmit a cookie to force the client to demonstrate
1948 * reachability at their apparent network address (primarily useful for DTLS).
1949 */
Ronald Cron79907712022-07-20 17:05:29 +02001950 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001951 return( 0 );
1952
1953 /* We should only send the key_share extension if the client's initial
1954 * key share was not acceptable. */
1955 if( ssl->handshake->offered_group_id != 0 )
1956 {
1957 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
1958 return( 0 );
1959 }
1960
1961 if( selected_group == 0 )
1962 {
1963 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
1964 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1965 }
1966
Jerry Yub0ac10b2022-05-05 11:10:08 +08001967 /* Check if we have enough space:
1968 * - extension_type (2 bytes)
1969 * - extension_data_length (2 bytes)
1970 * - selected_group (2 bytes)
1971 */
Ronald Cron154d1b62022-06-01 15:33:26 +02001972 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001973
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001974 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001975 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001976 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
1977
1978 MBEDTLS_SSL_DEBUG_MSG( 3,
1979 ( "HRR selected_group: %s (%x)",
1980 mbedtls_ssl_named_group_to_str( selected_group ),
1981 selected_group ) );
1982
1983 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001984
Jerry Yub0ac10b2022-05-05 11:10:08 +08001985 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001986}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001987
1988/*
1989 * Structure of ServerHello message:
1990 *
1991 * struct {
1992 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1993 * Random random;
1994 * opaque legacy_session_id_echo<0..32>;
1995 * CipherSuite cipher_suite;
1996 * uint8 legacy_compression_method = 0;
1997 * Extension extensions<6..2^16-1>;
1998 * } ServerHello;
1999 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002000MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002001static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002002 unsigned char *buf,
2003 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002004 size_t *out_len,
2005 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002006{
Jerry Yu955ddd72022-04-22 22:27:33 +08002007 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002008 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002009 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002010 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002011
2012 *out_len = 0;
Jerry Yu50e00e32022-10-31 14:45:01 +08002013 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014
Jerry Yucfc04b32022-04-21 09:31:58 +08002015 /* ...
2016 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2017 * ...
2018 * with ProtocolVersion defined as:
2019 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002020 */
2021 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2022 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2023 p += 2;
2024
Jerry Yu1c3e6882022-04-20 21:23:40 +08002025 /* ...
2026 * Random random;
2027 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002028 * with Random defined as:
2029 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002030 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002031 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002032 if( is_hrr )
2033 {
2034 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002035 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002036 }
2037 else
2038 {
2039 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002040 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002041 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002042 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002043 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2044 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2045
Jerry Yucfc04b32022-04-21 09:31:58 +08002046 /* ...
2047 * opaque legacy_session_id_echo<0..32>;
2048 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002049 */
2050 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2051 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2052 if( ssl->session_negotiate->id_len > 0 )
2053 {
2054 memcpy( p, &ssl->session_negotiate->id[0],
2055 ssl->session_negotiate->id_len );
2056 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002057
Jerry Yu3bf2c642022-03-30 22:02:12 +08002058 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2059 ssl->session_negotiate->id_len );
2060 }
2061
Jerry Yucfc04b32022-04-21 09:31:58 +08002062 /* ...
2063 * CipherSuite cipher_suite;
2064 * ...
2065 * with CipherSuite defined as:
2066 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002067 */
2068 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2069 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2070 p += 2;
2071 MBEDTLS_SSL_DEBUG_MSG( 3,
2072 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2073 mbedtls_ssl_get_ciphersuite_name(
2074 ssl->session_negotiate->ciphersuite ),
2075 ssl->session_negotiate->ciphersuite ) );
2076
Jerry Yucfc04b32022-04-21 09:31:58 +08002077 /* ...
2078 * uint8 legacy_compression_method = 0;
2079 * ...
2080 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002081 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002082 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002083
Jerry Yucfc04b32022-04-21 09:31:58 +08002084 /* ...
2085 * Extension extensions<6..2^16-1>;
2086 * ...
2087 * struct {
2088 * ExtensionType extension_type; (2 bytes)
2089 * opaque extension_data<0..2^16-1>;
2090 * } Extension;
2091 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002093 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002094 p += 2;
2095
Jerry Yue74e04a2022-04-21 09:23:16 +08002096 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002097 ssl, p, end, &output_len ) ) != 0 )
2098 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002099 MBEDTLS_SSL_DEBUG_RET(
2100 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101 return( ret );
2102 }
2103 p += output_len;
2104
Jerry Yu56acc942022-07-30 23:02:36 +08002105 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002106 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002107 if( is_hrr )
2108 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2109 else
2110 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002111 if( ret != 0 )
2112 return( ret );
2113 p += output_len;
2114 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002115
Ronald Cron41a443a2022-10-04 16:38:25 +02002116#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002117 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002118 {
Jerry Yubb852022022-07-20 21:10:44 +08002119 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002120 if( ret != 0 )
2121 {
Jerry Yubb852022022-07-20 21:10:44 +08002122 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002123 ret );
2124 return( ret );
2125 }
2126 p += output_len;
2127 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002128#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002129
Jerry Yud9436a12022-04-20 22:28:09 +08002130 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002131
Jerry Yud9436a12022-04-20 22:28:09 +08002132 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2133 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002134
Jerry Yud9436a12022-04-20 22:28:09 +08002135 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002136
Jerry Yud9436a12022-04-20 22:28:09 +08002137 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002138
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002139 MBEDTLS_SSL_PRINT_SENT_EXTS(
2140 3, is_hrr ? MBEDTLS_SSL_TLS1_3_HS_HELLO_RETRY_REQUEST :
2141 MBEDTLS_SSL_HS_SERVER_HELLO );
2142
Jerry Yu3bf2c642022-03-30 22:02:12 +08002143 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002144}
2145
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002146MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002147static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2148{
2149 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002150 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002151 if( ret != 0 )
2152 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002153 MBEDTLS_SSL_DEBUG_RET( 1,
2154 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002155 ret );
2156 return( ret );
2157 }
2158
Jerry Yue110d252022-05-05 10:19:22 +08002159 return( ret );
2160}
2161
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002162MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002163static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2164{
Jerry Yu637a3f12022-04-20 21:37:58 +08002165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002166 unsigned char *buf;
2167 size_t buf_len, msg_len;
2168
2169 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2170
Jerry Yuf4b27e42022-03-30 17:32:21 +08002171 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2172
Jerry Yu3bf2c642022-03-30 22:02:12 +08002173 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002174 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2175
Jerry Yu3bf2c642022-03-30 22:02:12 +08002176 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2177 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002178 &msg_len,
2179 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002180
Jerry Yu3bf2c642022-03-30 22:02:12 +08002181 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002182 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2183
Jerry Yu3bf2c642022-03-30 22:02:12 +08002184 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002185 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002186
Jerry Yue110d252022-05-05 10:19:22 +08002187 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2188
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002189#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2190 /* The server sends a dummy change_cipher_spec record immediately
2191 * after its first handshake message. This may either be after
2192 * a ServerHello or a HelloRetryRequest.
2193 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002194 mbedtls_ssl_handshake_set_state(
2195 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002196#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002197 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002198#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002199
Jerry Yuf4b27e42022-03-30 17:32:21 +08002200cleanup:
2201
2202 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2203 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002204}
2205
Jerry Yu23d1a252022-05-12 18:08:59 +08002206
2207/*
2208 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2209 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002210MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002211static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002212{
2213 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2214 if( ssl->handshake->hello_retry_request_count > 0 )
2215 {
2216 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2217 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2218 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2219 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2220 }
2221
2222 /*
2223 * Create stateless transcript hash for HRR
2224 */
2225 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2226 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2227 if( ret != 0 )
2228 {
2229 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2230 return( ret );
2231 }
2232 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2233
2234 return( 0 );
2235}
2236
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002237MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002238static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2239{
2240 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2241 unsigned char *buf;
2242 size_t buf_len, msg_len;
2243
2244 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2245
Ronald Cron7b840462022-06-01 17:05:53 +02002246 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002247
2248 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2249 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2250 &buf, &buf_len ) );
2251
2252 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2253 buf + buf_len,
2254 &msg_len,
2255 1 ) );
2256 mbedtls_ssl_add_hs_msg_to_checksum(
2257 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2258
2259
2260 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2261 msg_len ) );
2262
2263 ssl->handshake->hello_retry_request_count++;
2264
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002265#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2266 /* The server sends a dummy change_cipher_spec record immediately
2267 * after its first handshake message. This may either be after
2268 * a ServerHello or a HelloRetryRequest.
2269 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002270 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002271 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002272#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002273 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002274#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002275
2276cleanup:
2277 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2278 return( ret );
2279}
2280
Jerry Yu5b64ae92022-03-30 17:15:02 +08002281/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002282 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2283 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002284
2285/*
2286 * struct {
2287 * Extension extensions<0..2 ^ 16 - 1>;
2288 * } EncryptedExtensions;
2289 *
2290 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002291MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002292static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2293 unsigned char *buf,
2294 unsigned char *end,
2295 size_t *out_len )
2296{
XiaokangQianacb39922022-06-17 10:18:48 +00002297 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002298 unsigned char *p = buf;
2299 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002300 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002301 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002302
Jerry Yu4d3841a2022-04-16 12:37:19 +08002303 *out_len = 0;
2304
2305 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002306 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002307 p += 2;
2308
Jerry Yu8937eb42022-05-03 12:12:14 +08002309 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002310 ((void) ret);
2311 ((void) output_len);
2312
2313#if defined(MBEDTLS_SSL_ALPN)
2314 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2315 if( ret != 0 )
2316 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002317 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002318#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002319
Jerry Yu8937eb42022-05-03 12:12:14 +08002320 extensions_len = ( p - p_extensions_len ) - 2;
2321 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2322
2323 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002324
2325 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2326
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002327 MBEDTLS_SSL_PRINT_SENT_EXTS( 3, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS );
2328
Jerry Yu4d3841a2022-04-16 12:37:19 +08002329 return( 0 );
2330}
2331
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002332MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002333static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2334{
2335 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2336 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002337 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002338
Gabor Mezei54719122022-06-28 11:34:56 +02002339 mbedtls_ssl_set_outbound_transform( ssl,
2340 ssl->handshake->transform_handshake );
2341 MBEDTLS_SSL_DEBUG_MSG(
2342 3, ( "switching to handshake transform for outbound data" ) );
2343
Jerry Yuab452cc2022-04-28 15:27:08 +08002344 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002345
Jerry Yu4d3841a2022-04-16 12:37:19 +08002346 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2347 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2348
2349 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2350 ssl, buf, buf + buf_len, &msg_len ) );
2351
2352 mbedtls_ssl_add_hs_msg_to_checksum(
2353 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2354
Jerry Yu4d3841a2022-04-16 12:37:19 +08002355 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2356 ssl, buf_len, msg_len ) );
2357
Ronald Cron928cbd32022-10-04 16:14:26 +02002358#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002359 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002360 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2361 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002362 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002363#else
2364 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2365#endif
2366
Jerry Yu4d3841a2022-04-16 12:37:19 +08002367cleanup:
2368
Jerry Yuab452cc2022-04-28 15:27:08 +08002369 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002370 return( ret );
2371}
2372
Ronald Cron928cbd32022-10-04 16:14:26 +02002373#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002374#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2375#define SSL_CERTIFICATE_REQUEST_SKIP 1
2376/* Coordination:
2377 * Check whether a CertificateRequest message should be written.
2378 * Returns a negative code on failure, or
2379 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2380 * - SSL_CERTIFICATE_REQUEST_SKIP
2381 * indicating if the writing of the CertificateRequest
2382 * should be skipped or not.
2383 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002384MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002385static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2386{
2387 int authmode;
2388
XiaokangQian40a35232022-05-07 09:02:40 +00002389#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2390 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2391 authmode = ssl->handshake->sni_authmode;
2392 else
2393#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002394 authmode = ssl->conf->authmode;
2395
2396 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
Ronald Croneac00ad2022-09-13 10:16:31 +02002397 {
2398 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002399 return( SSL_CERTIFICATE_REQUEST_SKIP );
Ronald Croneac00ad2022-09-13 10:16:31 +02002400 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002401
XiaokangQianc3017f62022-05-13 05:55:41 +00002402 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002403
XiaokangQiana987e1d2022-05-07 01:25:58 +00002404 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2405}
2406
XiaokangQiancec9ae62022-05-06 07:28:50 +00002407/*
2408 * struct {
2409 * opaque certificate_request_context<0..2^8-1>;
2410 * Extension extensions<2..2^16-1>;
2411 * } CertificateRequest;
2412 *
2413 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002414MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002415static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2416 unsigned char *buf,
2417 const unsigned char *end,
2418 size_t *out_len )
2419{
2420 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2421 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002422 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002423 unsigned char *p_extensions_len;
2424
2425 *out_len = 0;
2426
2427 /* Check if we have enough space:
2428 * - certificate_request_context (1 byte)
2429 * - extensions length (2 bytes)
2430 */
2431 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2432
2433 /*
2434 * Write certificate_request_context
2435 */
2436 /*
2437 * We use a zero length context for the normal handshake
2438 * messages. For post-authentication handshake messages
2439 * this request context would be set to a non-zero value.
2440 */
2441 *p++ = 0x0;
2442
2443 /*
2444 * Write extensions
2445 */
2446 /* The extensions must contain the signature_algorithms. */
2447 p_extensions_len = p;
2448 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002449 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002450 if( ret != 0 )
2451 return( ret );
2452
XiaokangQianec6efb92022-05-06 09:53:10 +00002453 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002454 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002455
2456 *out_len = p - buf;
2457
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002458 MBEDTLS_SSL_PRINT_SENT_EXTS( 3, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST );
2459
XiaokangQiancec9ae62022-05-06 07:28:50 +00002460 return( 0 );
2461}
2462
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002463MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002464static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2465{
2466 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2467
2468 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2469
2470 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2471
2472 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2473 {
2474 unsigned char *buf;
2475 size_t buf_len, msg_len;
2476
2477 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2478 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2479
2480 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2481 ssl, buf, buf + buf_len, &msg_len ) );
2482
2483 mbedtls_ssl_add_hs_msg_to_checksum(
2484 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2485
2486 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2487 ssl, buf_len, msg_len ) );
2488 }
2489 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2490 {
2491 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2492 ret = 0;
2493 }
2494 else
2495 {
2496 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2497 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2498 goto cleanup;
2499 }
2500
2501 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2502cleanup:
2503
2504 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2505 return( ret );
2506}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002507
Jerry Yu4d3841a2022-04-16 12:37:19 +08002508/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002509 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002510 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002511MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002512static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002513{
Jerry Yu5a26f302022-05-10 20:46:40 +08002514 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002515
2516#if defined(MBEDTLS_X509_CRT_PARSE_C)
2517 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2518 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002519 {
Jerry Yub89125b2022-05-13 15:45:49 +08002520 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002521 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2522 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002523 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002524 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002525#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002526
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002527 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2528 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002529 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002530 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2531 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002532}
2533
2534/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002535 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002536 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002537MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002538static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002539{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002540 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002541 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002542 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002543 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2544 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002545}
Ronald Cron928cbd32022-10-04 16:14:26 +02002546#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002547
2548/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002549 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002550 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002551MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002552static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002553{
Jerry Yud6e253d2022-05-18 13:59:24 +08002554 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002555
2556 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2557 if( ret != 0 )
2558 return( ret );
2559
Jerry Yue3d67cb2022-05-19 15:33:10 +08002560 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2561 if( ret != 0 )
2562 {
2563 MBEDTLS_SSL_PEND_FATAL_ALERT(
2564 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2565 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2566 return( ret );
2567 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002568
Ronald Cron63dc4632022-05-31 14:41:53 +02002569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2570 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002571
Ronald Cron63dc4632022-05-31 14:41:53 +02002572 if( ssl->handshake->certificate_request_sent )
2573 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002574 else
Ronald Cron19385882022-06-15 16:26:13 +02002575 {
2576 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2577 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002578 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002579 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002580
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002581 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002582}
2583
2584/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002585 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002586 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002587MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002588static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002589{
Jerry Yud6e253d2022-05-18 13:59:24 +08002590 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2591
Jerry Yuff226982022-04-16 16:52:57 +08002592 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2593 if( ret != 0 )
2594 return( ret );
2595
Jerry Yu466dda82022-09-13 11:20:20 +08002596 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002597 if( ret != 0 )
2598 {
2599 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002600 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002601 }
2602
Jerry Yu03ed50b2022-04-16 17:13:30 +08002603 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002604 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002605}
2606
2607/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002608 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002609 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002610MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002611static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002612{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002613 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2614
Jerry Yu03ed50b2022-04-16 17:13:30 +08002615 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002616
2617#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002618 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2619#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002620 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002621#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002622 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002623}
2624
2625/*
Jerry Yue67bef42022-07-07 07:29:42 +00002626 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2627 */
2628#define SSL_NEW_SESSION_TICKET_SKIP 0
2629#define SSL_NEW_SESSION_TICKET_WRITE 1
2630MBEDTLS_CHECK_RETURN_CRITICAL
2631static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2632{
2633 /* Check whether the use of session tickets is enabled */
2634 if( ssl->conf->f_ticket_write == NULL )
2635 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002636 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2637 " callback is not set" ) );
2638 return( SSL_NEW_SESSION_TICKET_SKIP );
2639 }
2640 if( ssl->conf->new_session_tickets_count == 0 )
2641 {
2642 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2643 " configured count is zero" ) );
2644 return( SSL_NEW_SESSION_TICKET_SKIP );
2645 }
2646
2647 if( ssl->handshake->new_session_tickets_count == 0 )
2648 {
2649 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2650 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002651 return( SSL_NEW_SESSION_TICKET_SKIP );
2652 }
2653
Jerry Yue67bef42022-07-07 07:29:42 +00002654 return( SSL_NEW_SESSION_TICKET_WRITE );
2655}
2656
2657#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2658MBEDTLS_CHECK_RETURN_CRITICAL
2659static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2660 unsigned char *ticket_nonce,
2661 size_t ticket_nonce_size )
2662{
2663 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2664 mbedtls_ssl_session *session = ssl->session;
2665 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2666 psa_algorithm_t psa_hash_alg;
2667 int hash_length;
2668
2669 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2670
2671#if defined(MBEDTLS_HAVE_TIME)
2672 session->start = mbedtls_time( NULL );
2673#endif
2674
2675 /* Generate ticket_age_add */
2676 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002677 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002678 sizeof( session->ticket_age_add ) ) != 0 ) )
2679 {
2680 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2681 return( ret );
2682 }
2683 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002684 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002685
2686 /* Generate ticket_nonce */
2687 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2688 if( ret != 0 )
2689 {
2690 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2691 return( ret );
2692 }
2693 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2694 ticket_nonce, ticket_nonce_size );
2695
2696 ciphersuite_info =
2697 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2698 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2699 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002700 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002701 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002702 {
Jerry Yue67bef42022-07-07 07:29:42 +00002703 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002704 }
2705
Jerry Yue67bef42022-07-07 07:29:42 +00002706 /* In this code the psk key length equals the length of the hash */
2707 session->resumption_key_len = hash_length;
2708 session->ciphersuite = ciphersuite_info->id;
2709
2710 /* Compute resumption key
2711 *
2712 * HKDF-Expand-Label( resumption_master_secret,
2713 * "resumption", ticket_nonce, Hash.length )
2714 */
2715 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2716 psa_hash_alg,
2717 session->app_secrets.resumption_master_secret,
2718 hash_length,
2719 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2720 ticket_nonce,
2721 ticket_nonce_size,
2722 session->resumption_key,
2723 hash_length );
2724
2725 if( ret != 0 )
2726 {
2727 MBEDTLS_SSL_DEBUG_RET( 2,
2728 "Creating the ticket-resumed PSK failed",
2729 ret );
2730 return ( ret );
2731 }
2732 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2733 session->resumption_key,
2734 session->resumption_key_len );
2735
2736 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2737 session->app_secrets.resumption_master_secret,
2738 hash_length );
2739
2740 return( 0 );
2741}
2742
2743/* This function creates a NewSessionTicket message in the following format:
2744 *
2745 * struct {
2746 * uint32 ticket_lifetime;
2747 * uint32 ticket_age_add;
2748 * opaque ticket_nonce<0..255>;
2749 * opaque ticket<1..2^16-1>;
2750 * Extension extensions<0..2^16-2>;
2751 * } NewSessionTicket;
2752 *
2753 * The ticket inside the NewSessionTicket message is an encrypted container
2754 * carrying the necessary information so that the server is later able to
2755 * re-start the communication.
2756 *
2757 * The following fields are placed inside the ticket by the
2758 * f_ticket_write() function:
2759 *
2760 * - creation time (start)
2761 * - flags (flags)
2762 * - age add (ticket_age_add)
2763 * - key (key)
2764 * - key length (key_len)
2765 * - ciphersuite (ciphersuite)
2766 */
2767MBEDTLS_CHECK_RETURN_CRITICAL
2768static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2769 unsigned char *buf,
2770 unsigned char *end,
2771 size_t *out_len,
2772 unsigned char *ticket_nonce,
2773 size_t ticket_nonce_size )
2774{
2775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2776 unsigned char *p = buf;
2777 mbedtls_ssl_session *session = ssl->session;
2778 size_t ticket_len;
2779 uint32_t ticket_lifetime;
2780
2781 *out_len = 0;
2782 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2783
2784 /*
2785 * ticket_lifetime 4 bytes
2786 * ticket_age_add 4 bytes
2787 * ticket_nonce 1 + ticket_nonce_size bytes
2788 * ticket >=2 bytes
2789 */
2790 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2791
2792 /* Generate ticket and ticket_lifetime */
2793 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2794 session,
2795 p + 9 + ticket_nonce_size + 2,
2796 end,
2797 &ticket_len,
2798 &ticket_lifetime);
2799 if( ret != 0 )
2800 {
2801 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2802 return( ret );
2803 }
2804 /* RFC 8446 4.6.1
2805 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2806 * unsigned integer in network byte order from the time of ticket
2807 * issuance. Servers MUST NOT use any value greater than
2808 * 604800 seconds (7 days). The value of zero indicates that the
2809 * ticket should be discarded immediately. Clients MUST NOT cache
2810 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2811 * and MAY delete tickets earlier based on local policy. A server
2812 * MAY treat a ticket as valid for a shorter period of time than what
2813 * is stated in the ticket_lifetime.
2814 */
Xiaokang Qian28af5012022-10-13 08:18:19 +00002815 if( ticket_lifetime > 604800 )
2816 ticket_lifetime = 604800;
Jerry Yue67bef42022-07-07 07:29:42 +00002817 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2818 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2819 ( unsigned int )ticket_lifetime ) );
2820
2821 /* Write ticket_age_add */
2822 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2823 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2824 ( unsigned int )session->ticket_age_add ) );
2825
2826 /* Write ticket_nonce */
2827 p[8] = ( unsigned char )ticket_nonce_size;
2828 if( ticket_nonce_size > 0 )
2829 {
2830 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2831 }
2832 p += 9 + ticket_nonce_size;
2833
2834 /* Write ticket */
2835 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2836 p += 2;
2837 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2838 p += ticket_len;
2839
2840 /* Ticket Extensions
2841 *
2842 * Note: We currently don't have any extensions.
2843 * Set length to zero.
2844 */
Jerry Yuedab6372022-10-31 14:37:31 +08002845 ssl->handshake->sent_extensions = MBEDTLS_SSL_EXT_MASK_NONE;
2846
Jerry Yue67bef42022-07-07 07:29:42 +00002847 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2848 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2849 p += 2;
2850
2851 *out_len = p - buf;
2852 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2853 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2854
Jerry Yu4b8f2f72022-10-31 13:31:22 +08002855 MBEDTLS_SSL_PRINT_SENT_EXTS( 3, MBEDTLS_SSL_HS_NEW_SESSION_TICKET );
2856
Jerry Yue67bef42022-07-07 07:29:42 +00002857 return( 0 );
2858}
2859
2860/*
2861 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2862 */
2863static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2864{
2865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2866
2867 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2868
2869 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2870 {
2871 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2872 unsigned char *buf;
2873 size_t buf_len, msg_len;
2874
2875 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2876 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2877
2878 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2879 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2880
2881 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2882 ssl, buf, buf + buf_len, &msg_len,
2883 ticket_nonce, sizeof( ticket_nonce ) ) );
2884
Jerry Yue67bef42022-07-07 07:29:42 +00002885 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2886 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002887
Jerry Yu359e65f2022-09-22 23:47:43 +08002888 /* Limit session tickets count to one when resumption connection.
2889 *
2890 * See document of mbedtls_ssl_conf_new_session_tickets.
2891 */
2892 if( ssl->handshake->resume == 1 )
2893 ssl->handshake->new_session_tickets_count = 0;
2894 else
2895 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002896
Jerry Yufca4d572022-07-21 10:37:48 +08002897 mbedtls_ssl_handshake_set_state( ssl,
2898 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002899 }
2900 else
2901 {
2902 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2903 }
2904
Jerry Yue67bef42022-07-07 07:29:42 +00002905cleanup:
2906
2907 return( ret );
2908}
2909#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2910
2911/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002912 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002913 */
Jerry Yu27561932021-08-27 17:07:38 +08002914int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002915{
XiaokangQian08037552022-04-20 07:16:41 +00002916 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002917
2918 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2919 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2920
Jerry Yue3b34122021-09-28 17:53:35 +08002921 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2922 mbedtls_ssl_states_str( ssl->state ),
2923 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002924
XiaokangQian7807f9f2022-02-15 10:04:37 +00002925 switch( ssl->state )
2926 {
2927 /* start state */
2928 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002929 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002930 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002931 break;
2932
XiaokangQian7807f9f2022-02-15 10:04:37 +00002933 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002934 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002935 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002936 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002937 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002938
Jerry Yuf41553b2022-05-09 22:20:30 +08002939 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2940 ret = ssl_tls13_write_hello_retry_request( ssl );
2941 if( ret != 0 )
2942 {
2943 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2944 return( ret );
2945 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002946 break;
2947
Jerry Yu5b64ae92022-03-30 17:15:02 +08002948 case MBEDTLS_SSL_SERVER_HELLO:
2949 ret = ssl_tls13_write_server_hello( ssl );
2950 break;
2951
Xiaofei Baicba64af2022-02-15 10:00:56 +00002952 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002953 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002954 if( ret != 0 )
2955 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002956 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2957 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002958 }
Jerry Yu48330562022-05-06 21:35:44 +08002959 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002960
Ronald Cron928cbd32022-10-04 16:14:26 +02002961#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002962 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002963 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002964 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002965
Jerry Yu83da34e2022-04-16 13:59:52 +08002966 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2967 ret = ssl_tls13_write_server_certificate( ssl );
2968 break;
2969
2970 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
2971 ret = ssl_tls13_write_certificate_verify( ssl );
2972 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002973#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002974
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002975 /*
2976 * Injection of dummy-CCS's for middlebox compatibility
2977 */
2978#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002979 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002980 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2981 if( ret == 0 )
2982 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2983 break;
2984
2985 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
2986 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2987 if( ret == 0 )
2988 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2989 break;
2990#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2991
Jerry Yu69dd8d42022-04-16 12:51:26 +08002992 case MBEDTLS_SSL_SERVER_FINISHED:
2993 ret = ssl_tls13_write_server_finished( ssl );
2994 break;
2995
2996 case MBEDTLS_SSL_CLIENT_FINISHED:
2997 ret = ssl_tls13_process_client_finished( ssl );
2998 break;
2999
Jerry Yu69dd8d42022-04-16 12:51:26 +08003000 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3001 ret = ssl_tls13_handshake_wrapup( ssl );
3002 break;
3003
Ronald Cron766c0cd2022-10-18 12:17:11 +02003004#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003005 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3006 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003007 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003008 {
Ronald Cron209cae92022-06-07 10:30:19 +02003009 if( ssl->session_negotiate->peer_cert != NULL )
3010 {
3011 mbedtls_ssl_handshake_set_state(
3012 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3013 }
3014 else
Ronald Cron19385882022-06-15 16:26:13 +02003015 {
3016 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003017 mbedtls_ssl_handshake_set_state(
3018 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003019 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003020 }
3021 break;
3022
3023 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3024 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3025 if( ret == 0 )
3026 {
3027 mbedtls_ssl_handshake_set_state(
3028 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3029 }
3030 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003031#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003032
Jerry Yue67bef42022-07-07 07:29:42 +00003033#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3034 case MBEDTLS_SSL_NEW_SESSION_TICKET:
3035 ret = ssl_tls13_write_new_session_ticket( ssl );
3036 if( ret != 0 )
3037 {
3038 MBEDTLS_SSL_DEBUG_RET( 1,
3039 "ssl_tls13_write_new_session_ticket ",
3040 ret );
3041 }
3042 break;
3043 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
3044 /* This state is necessary to do the flush of the New Session
3045 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
3046 * as part of ssl_prepare_handshake_step.
3047 */
3048 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003049
Jerry Yud0766ec2022-09-22 10:46:57 +08003050 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003051 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3052 else
3053 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003054 break;
3055
3056#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3057
XiaokangQian7807f9f2022-02-15 10:04:37 +00003058 default:
3059 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003060 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003061 }
3062
3063 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003064}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003065
Jerry Yufb4b6472022-01-27 15:03:26 +08003066#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */