blob: 78d3449a59845e96bd6987ae16056036564a9058 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18*/
19
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
XiaokangQian7807f9f2022-02-15 10:04:37 +000033#if defined(MBEDTLS_ECP_C)
34#include "mbedtls/ecp.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000035#endif /* MBEDTLS_ECP_C */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080036
XiaokangQiana9c58412022-02-17 09:41:26 +000037#if defined(MBEDTLS_PLATFORM_C)
38#include "mbedtls/platform.h"
39#else
40#include <stdlib.h>
41#define mbedtls_calloc calloc
42#define mbedtls_free free
43#endif /* MBEDTLS_PLATFORM_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +000044
Jerry Yu4d3841a2022-04-16 12:37:19 +080045#include "ssl_misc.h"
46#include "ssl_tls13_keys.h"
47#include "ssl_debug_helpers.h"
48
Jerry Yuf35ba382022-08-23 17:58:26 +080049
Jerry Yuc5a23a02022-08-25 10:51:44 +080050static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Jerry Yuf35ba382022-08-23 17:58:26 +080051 mbedtls_ssl_context *ssl,
Jerry Yuc5a23a02022-08-25 10:51:44 +080052 unsigned int cipher_suite )
Jerry Yuf35ba382022-08-23 17:58:26 +080053{
54 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
55 if( ! mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
56 return( NULL );
57
58 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
59 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
60 ssl->tls_version,
61 ssl->tls_version ) != 0 ) )
62 {
63 return( NULL );
64 }
65 return( ciphersuite_info );
66}
67
Jerry Yue19e3b92022-07-08 12:04:51 +000068#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
69/* From RFC 8446:
70 *
71 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
72 * struct {
73 * PskKeyExchangeMode ke_modes<1..255>;
74 * } PskKeyExchangeModes;
75 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080076MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue19e3b92022-07-08 12:04:51 +000077static int ssl_tls13_parse_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
78 const unsigned char *buf,
Jerry Yu299e31f2022-07-13 23:06:36 +080079 const unsigned char *end )
Jerry Yue19e3b92022-07-08 12:04:51 +000080{
Jerry Yu299e31f2022-07-13 23:06:36 +080081 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000082 size_t ke_modes_len;
83 int ke_modes = 0;
84
Jerry Yu854dd9e2022-07-15 14:28:27 +080085 /* Read ke_modes length (1 Byte) */
Jerry Yu299e31f2022-07-13 23:06:36 +080086 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
87 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000088 /* Currently, there are only two PSK modes, so even without looking
89 * at the content, something's wrong if the list has more than 2 items. */
90 if( ke_modes_len > 2 )
Jerry Yu299e31f2022-07-13 23:06:36 +080091 {
92 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
93 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +000094 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu299e31f2022-07-13 23:06:36 +080095 }
Jerry Yue19e3b92022-07-08 12:04:51 +000096
Jerry Yu299e31f2022-07-13 23:06:36 +080097 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ke_modes_len );
Jerry Yue19e3b92022-07-08 12:04:51 +000098
99 while( ke_modes_len-- != 0 )
100 {
Jerry Yu299e31f2022-07-13 23:06:36 +0800101 switch( *p++ )
Jerry Yue19e3b92022-07-08 12:04:51 +0000102 {
103 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
104 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
105 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK KEX MODE" ) );
106 break;
107 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
108 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
109 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK_EPHEMERAL KEX MODE" ) );
110 break;
111 default:
Jerry Yu299e31f2022-07-13 23:06:36 +0800112 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
113 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +0000114 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
115 }
116 }
117
118 ssl->handshake->tls13_kex_modes = ke_modes;
119 return( 0 );
120}
Jerry Yu1c105562022-07-10 06:32:38 +0000121
Jerry Yue9d4fc02022-08-20 19:21:15 +0800122#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
123#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800124MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000125static int ssl_tls13_offered_psks_check_identity_match(
126 mbedtls_ssl_context *ssl,
127 const unsigned char *identity,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800128 size_t identity_len,
129 int *psk_type )
Jerry Yu1c105562022-07-10 06:32:38 +0000130{
Jerry Yu5725f1c2022-08-21 17:27:16 +0800131 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu1c105562022-07-10 06:32:38 +0000132 /* Check identity with external configured function */
133 if( ssl->conf->f_psk != NULL )
134 {
135 if( ssl->conf->f_psk(
136 ssl->conf->p_psk, ssl, identity, identity_len ) == 0 )
137 {
138 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
139 }
140 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
141 }
142
Jerry Yu96a2e362022-07-21 15:11:34 +0800143 MBEDTLS_SSL_DEBUG_BUF( 5, "identity", identity, identity_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000144 /* Check identity with pre-configured psk */
Jerry Yu2f0abc92022-07-22 19:34:48 +0800145 if( ssl->conf->psk_identity != NULL &&
146 identity_len == ssl->conf->psk_identity_len &&
Jerry Yu1c105562022-07-10 06:32:38 +0000147 mbedtls_ct_memcmp( ssl->conf->psk_identity,
148 identity, identity_len ) == 0 )
149 {
150 mbedtls_ssl_set_hs_psk( ssl, ssl->conf->psk, ssl->conf->psk_len );
151 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
152 }
153
Jerry Yu1c105562022-07-10 06:32:38 +0000154 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
155}
156
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800157MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu96a2e362022-07-21 15:11:34 +0800158static int ssl_tls13_offered_psks_check_binder_match( mbedtls_ssl_context *ssl,
159 const unsigned char *binder,
Jerry Yue95c8af2022-07-26 15:48:20 +0800160 size_t binder_len,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800161 int psk_type,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800162 psa_algorithm_t psk_hash_alg )
Jerry Yu1c105562022-07-10 06:32:38 +0000163{
164 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800165
Jerry Yudaf375a2022-07-20 21:31:43 +0800166 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000167 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800168 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800169 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800170 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000171
Jerry Yu1c105562022-07-10 06:32:38 +0000172 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800173 ret = mbedtls_ssl_get_handshake_transcript(
174 ssl, mbedtls_hash_info_md_from_psa( psk_hash_alg ),
175 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000176 if( ret != 0 )
177 return( ret );
178
Jerry Yu40f37712022-07-26 16:58:57 +0800179 ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len );
Jerry Yu96a2e362022-07-21 15:11:34 +0800180 if( ret != 0 )
181 return( ret );
182
Jerry Yu29d9faa2022-08-23 17:52:45 +0800183 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psk_hash_alg,
Jerry Yu1c105562022-07-10 06:32:38 +0000184 psk, psk_len, psk_type,
185 transcript,
186 server_computed_binder );
Jerry Yu96a2e362022-07-21 15:11:34 +0800187#if defined(MBEDTLS_USE_PSA_CRYPTO)
188 mbedtls_free( (void*)psk );
189#endif
Jerry Yu1c105562022-07-10 06:32:38 +0000190 if( ret != 0 )
191 {
192 MBEDTLS_SSL_DEBUG_MSG( 1, ( "PSK binder calculation failed." ) );
193 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
194 }
195
196 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( computed ): ",
Jerry Yu2f0abc92022-07-22 19:34:48 +0800197 server_computed_binder, transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000198 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( received ): ", binder, binder_len );
199
200 if( mbedtls_ct_memcmp( server_computed_binder, binder, binder_len ) == 0 )
201 {
202 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
203 }
204
Jerry Yudaf375a2022-07-20 21:31:43 +0800205 mbedtls_platform_zeroize( server_computed_binder,
206 sizeof( server_computed_binder ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000207 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
208}
Jerry Yu96a2e362022-07-21 15:11:34 +0800209
Jerry Yu5725f1c2022-08-21 17:27:16 +0800210MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800211static int ssl_tls13_select_ciphersuite_for_psk(
212 mbedtls_ssl_context *ssl,
213 const unsigned char *cipher_suites,
214 const unsigned char *cipher_suites_end,
215 uint16_t *selected_ciphersuite,
216 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800217{
Jerry Yuf35ba382022-08-23 17:58:26 +0800218 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800219
Jerry Yu0baf9072022-08-25 11:21:04 +0800220 *selected_ciphersuite = 0;
221 *selected_ciphersuite_info = NULL;
222
Jerry Yuf35ba382022-08-23 17:58:26 +0800223 /* RFC 8446, page 55.
224 *
225 * For externally established PSKs, the Hash algorithm MUST be set when the
226 * PSK is established or default to SHA-256 if no such algorithm is defined.
227 *
228 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800229
Jerry Yu5725f1c2022-08-21 17:27:16 +0800230 /*
231 * Search for a matching ciphersuite
232 */
Jerry Yu1e05b6d2022-08-31 10:35:52 +0800233 for ( const unsigned char *p = cipher_suites;
234 p < cipher_suites_end; p += 2 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800235 {
236 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800237 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800238
239 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +0800240 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
241 cipher_suite );
Jerry Yuf35ba382022-08-23 17:58:26 +0800242 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800243 continue;
244
Jerry Yu5725f1c2022-08-21 17:27:16 +0800245 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
246 * Otherwise, client should reject.
247 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800248 if( psk_hash_alg == mbedtls_psa_translate_md( ciphersuite_info->mac ) )
249 {
250 *selected_ciphersuite = cipher_suite;
251 *selected_ciphersuite_info = ciphersuite_info;
252 return( 0 );
253 }
254 }
255 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No matched ciphersuite" ) );
256 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
257}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800258
Jerry Yuf35ba382022-08-23 17:58:26 +0800259MBEDTLS_CHECK_RETURN_CRITICAL
260static int ssl_tls13_select_ciphersuite_for_resumption(
261 mbedtls_ssl_context *ssl,
262 const unsigned char *cipher_suites,
263 const unsigned char *cipher_suites_end,
264 mbedtls_ssl_session *session,
265 uint16_t *selected_ciphersuite,
266 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
267{
268 ((void) ssl);
269 ((void) session);
270 ((void) cipher_suites);
271 ((void) cipher_suites_end);
Jerry Yuf35ba382022-08-23 17:58:26 +0800272 *selected_ciphersuite = 0;
273 *selected_ciphersuite_info = NULL;
Jerry Yuf35ba382022-08-23 17:58:26 +0800274 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800275}
Jerry Yuf35ba382022-08-23 17:58:26 +0800276
Jerry Yu1c105562022-07-10 06:32:38 +0000277/* Parser for pre_shared_key extension in client hello
278 * struct {
279 * opaque identity<1..2^16-1>;
280 * uint32 obfuscated_ticket_age;
281 * } PskIdentity;
282 *
283 * opaque PskBinderEntry<32..255>;
284 *
285 * struct {
286 * PskIdentity identities<7..2^16-1>;
287 * PskBinderEntry binders<33..2^16-1>;
288 * } OfferedPsks;
289 *
290 * struct {
291 * select (Handshake.msg_type) {
292 * case client_hello: OfferedPsks;
293 * ....
294 * };
295 * } PreSharedKeyExtension;
296 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800297MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yubb852022022-07-20 21:10:44 +0800298static int ssl_tls13_parse_pre_shared_key_ext( mbedtls_ssl_context *ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800299 const unsigned char *pre_shared_key_ext,
300 const unsigned char *pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800301 const unsigned char *ciphersuites,
302 const unsigned char *ciphersuites_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000303{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800304 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800305 const unsigned char *p_identity_len;
306 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000307 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800308 const unsigned char *binders;
309 const unsigned char *p_binder_len;
310 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000311 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800312 int matched_identity = -1;
313 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000314
Jerry Yu29d9faa2022-08-23 17:52:45 +0800315 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key extension",
316 pre_shared_key_ext,
317 pre_shared_key_ext_end - pre_shared_key_ext );
Jerry Yu1c105562022-07-10 06:32:38 +0000318
Jerry Yu96a2e362022-07-21 15:11:34 +0800319 /* identities_len 2 bytes
320 * identities_data >= 7 bytes
321 */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800322 MBEDTLS_SSL_CHK_BUF_READ_PTR( identities, pre_shared_key_ext_end, 7 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800323 identities_len = MBEDTLS_GET_UINT16_BE( identities, 0 );
324 p_identity_len = identities + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800325 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, pre_shared_key_ext_end,
326 identities_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800327 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000328
Jerry Yu96a2e362022-07-21 15:11:34 +0800329 /* binders_len 2 bytes
330 * binders >= 33 bytes
331 */
Jerry Yu568ec252022-07-22 21:27:34 +0800332 binders = identities_end;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800333 MBEDTLS_SSL_CHK_BUF_READ_PTR( binders, pre_shared_key_ext_end, 33 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800334 binders_len = MBEDTLS_GET_UINT16_BE( binders, 0 );
335 p_binder_len = binders + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800336 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, pre_shared_key_ext_end, binders_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800337 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000338
Jerry Yu29d9faa2022-08-23 17:52:45 +0800339 ssl->handshake->update_checksum( ssl, pre_shared_key_ext,
340 identities_end - pre_shared_key_ext );
Jerry Yu96a2e362022-07-21 15:11:34 +0800341
Jerry Yu568ec252022-07-22 21:27:34 +0800342 while( p_identity_len < identities_end && p_binder_len < binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000343 {
Jerry Yu1c105562022-07-10 06:32:38 +0000344 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800345 size_t identity_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800346 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800347 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800348 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800349 int psk_type;
350 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800351 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yubb852022022-07-20 21:10:44 +0800352
Jerry Yu568ec252022-07-22 21:27:34 +0800353 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, identities_end, 2 + 1 + 4 );
354 identity_len = MBEDTLS_GET_UINT16_BE( p_identity_len, 0 );
355 identity = p_identity_len + 2;
356 MBEDTLS_SSL_CHK_BUF_READ_PTR( identity, identities_end, identity_len + 4 );
357 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000358
Jerry Yu568ec252022-07-22 21:27:34 +0800359 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, binders_end, 1 + 32 );
360 binder_len = *p_binder_len;
361 binder = p_binder_len + 1;
362 MBEDTLS_SSL_CHK_BUF_READ_PTR( binder, binders_end, binder_len );
363 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800364
Jerry Yu96a2e362022-07-21 15:11:34 +0800365 identity_id++;
366 if( matched_identity != -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000367 continue;
368
Jerry Yu96a2e362022-07-21 15:11:34 +0800369 ret = ssl_tls13_offered_psks_check_identity_match(
Jerry Yu5725f1c2022-08-21 17:27:16 +0800370 ssl, identity, identity_len, &psk_type );
Jerry Yue95c8af2022-07-26 15:48:20 +0800371 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800372 continue;
373
Jerry Yuf35ba382022-08-23 17:58:26 +0800374 MBEDTLS_SSL_DEBUG_MSG( 4, ( "found matched identity" ) );
Jerry Yu0baf9072022-08-25 11:21:04 +0800375 switch( psk_type )
376 {
377 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
378 ret = ssl_tls13_select_ciphersuite_for_psk(
379 ssl, ciphersuites, ciphersuites_end,
380 &cipher_suite, &ciphersuite_info );
381 break;
382 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
383 ret = ssl_tls13_select_ciphersuite_for_resumption(
384 ssl, ciphersuites, ciphersuites_end, NULL,
385 &cipher_suite, &ciphersuite_info );
386 break;
387 default:
388 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
389 }
Jerry Yuf35ba382022-08-23 17:58:26 +0800390 if( ret != 0 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800391 {
Jerry Yuf35ba382022-08-23 17:58:26 +0800392 /* See below, no cipher_suite available, abort handshake */
393 MBEDTLS_SSL_PEND_FATAL_ALERT(
394 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
395 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
396 MBEDTLS_SSL_DEBUG_RET(
Jerry Yu0baf9072022-08-25 11:21:04 +0800397 2, "ssl_tls13_select_ciphersuite", ret );
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 return( ret );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800399 }
400
Jerry Yu96a2e362022-07-21 15:11:34 +0800401 ret = ssl_tls13_offered_psks_check_binder_match(
Jerry Yu29d9faa2022-08-23 17:52:45 +0800402 ssl, binder, binder_len, psk_type,
403 mbedtls_psa_translate_md( ciphersuite_info->mac ) );
Jerry Yue9d4fc02022-08-20 19:21:15 +0800404 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800405 {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800406 /* For security reasons, the handshake should be aborted when we
407 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
408 * and appendix E.6. */
409 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Invalid binder." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800410 MBEDTLS_SSL_DEBUG_RET( 1,
411 "ssl_tls13_offered_psks_check_binder_match" , ret );
412 MBEDTLS_SSL_PEND_FATAL_ALERT(
413 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
414 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
415 return( ret );
416 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800417
418 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800419
420 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800421 ssl->session_negotiate->ciphersuite = cipher_suite;
422 ssl->handshake->ciphersuite_info = ciphersuite_info;
423 MBEDTLS_SSL_DEBUG_MSG( 2, ( "overwrite ciphersuite: %04x - %s",
424 cipher_suite, ciphersuite_info->name ) );
425
Jerry Yu1c105562022-07-10 06:32:38 +0000426 }
427
Jerry Yu568ec252022-07-22 21:27:34 +0800428 if( p_identity_len != identities_end || p_binder_len != binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000429 {
430 MBEDTLS_SSL_DEBUG_MSG( 3, ( "pre_shared_key extesion decode error" ) );
431 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
432 MBEDTLS_ERR_SSL_DECODE_ERROR );
433 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
434 }
435
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800436 /* Update the handshake transcript with the binder list. */
437 ssl->handshake->update_checksum( ssl,
438 identities_end,
439 (size_t)( binders_end - identities_end ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800440 if( matched_identity == -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000441 {
Jerry Yue9d4fc02022-08-20 19:21:15 +0800442 MBEDTLS_SSL_DEBUG_MSG( 3, ( "No matched PSK or ticket." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800443 return( MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY );
Jerry Yu1c105562022-07-10 06:32:38 +0000444 }
445
Jerry Yu96a2e362022-07-21 15:11:34 +0800446 ssl->handshake->selected_identity = (uint16_t)matched_identity;
447 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Pre shared key found" ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000448
Jerry Yu96a2e362022-07-21 15:11:34 +0800449 return( 0 );
Jerry Yu1c105562022-07-10 06:32:38 +0000450}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000451
452/*
453 * struct {
454 * select ( Handshake.msg_type ) {
455 * ....
456 * case server_hello:
457 * uint16 selected_identity;
458 * }
459 * } PreSharedKeyExtension;
460 */
Jerry Yubb852022022-07-20 21:10:44 +0800461static int ssl_tls13_write_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
462 unsigned char *buf,
463 unsigned char *end,
464 size_t *olen )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000465{
466 unsigned char *p = (unsigned char*)buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000467
468 *olen = 0;
469
470#if defined(MBEDTLS_USE_PSA_CRYPTO)
471 if( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) )
472#else
473 if( ssl->handshake->psk == NULL )
474#endif
475 {
476 /* We shouldn't have called this extension writer unless we've
477 * chosen to use a PSK. */
478 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
479 }
480
481 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding pre_shared_key extension" ) );
482 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
483
Jerry Yu032b15ce2022-07-11 06:10:03 +0000484 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000485 MBEDTLS_PUT_UINT16_BE( 2, p, 2 );
486
Jerry Yu96a2e362022-07-21 15:11:34 +0800487 MBEDTLS_PUT_UINT16_BE( ssl->handshake->selected_identity, p, 4 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000488
489 *olen = 6;
490
Jerry Yu96a2e362022-07-21 15:11:34 +0800491 MBEDTLS_SSL_DEBUG_MSG( 4, ( "sent selected_identity: %u",
492 ssl->handshake->selected_identity ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000493
494 return( 0 );
495}
496
Jerry Yue19e3b92022-07-08 12:04:51 +0000497#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
498
XiaokangQian7807f9f2022-02-15 10:04:37 +0000499/* From RFC 8446:
500 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000501 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000502 * } SupportedVersions;
503 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200504MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000505static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
506 const unsigned char *buf,
507 const unsigned char *end )
508{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000509 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000510 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000511 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000512 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000513 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000514
515 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000516 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000517 p += 1;
518
XiaokangQian4080a7f2022-04-11 09:55:18 +0000519 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000520 versions_end = p + versions_len;
521 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000522 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000523 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000524 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000525 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000526
527 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000528 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000529 {
530 tls13_supported = 1;
531 break;
532 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000533 }
534
XiaokangQianb67384d2022-04-19 00:02:38 +0000535 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000536 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
538
539 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
540 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
541 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
542 }
543
XiaokangQiande333912022-04-20 08:49:42 +0000544 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000545 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000546
XiaokangQian7807f9f2022-02-15 10:04:37 +0000547 return( 0 );
548}
549
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000550#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000551/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000552 *
553 * From RFC 8446:
554 * enum {
555 * ... (0xFFFF)
556 * } NamedGroup;
557 * struct {
558 * NamedGroup named_group_list<2..2^16-1>;
559 * } NamedGroupList;
560 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200561MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800562static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
563 const unsigned char *buf,
564 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000565{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000566 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000567 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000568 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000569
570 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000571 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000572 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000573 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000574 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000575 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000576 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000577
XiaokangQian08037552022-04-20 07:16:41 +0000578 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000579 {
XiaokangQian08037552022-04-20 07:16:41 +0000580 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000581 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000582 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
583 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000584
Jerry Yuc1be19f2022-04-23 16:11:39 +0800585 MBEDTLS_SSL_DEBUG_MSG( 2,
586 ( "got named group: %s(%04x)",
587 mbedtls_ssl_named_group_to_str( named_group ),
588 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000589
590 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
591 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000592 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000593 {
XiaokangQian08037552022-04-20 07:16:41 +0000594 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000595 }
596
Jerry Yuc1be19f2022-04-23 16:11:39 +0800597 MBEDTLS_SSL_DEBUG_MSG( 2,
598 ( "add named group %s(%04x) into received list.",
599 mbedtls_ssl_named_group_to_str( named_group ),
600 named_group ) );
601
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000602 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000603 }
604
605 return( 0 );
606
607}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000608#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000609
XiaokangQian08037552022-04-20 07:16:41 +0000610#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
611
XiaokangQian88408882022-04-02 10:15:03 +0000612#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000613/*
614 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000615 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000616 *
617 * Possible return values are:
618 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000619 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000620 * does not match a group supported by the server. A HelloRetryRequest will
621 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000622 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800623 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200624MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000625static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
626 const unsigned char *buf,
627 const unsigned char *end )
628{
XiaokangQianb67384d2022-04-19 00:02:38 +0000629 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000630 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000631 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800632 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000633
634 /* From RFC 8446:
635 *
636 * struct {
637 * KeyShareEntry client_shares<0..2^16-1>;
638 * } KeyShareClientHello;
639 *
640 */
641
XiaokangQian7807f9f2022-02-15 10:04:37 +0000642 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000643 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000644 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000645 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000646
647 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000648 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000649
650 /* We try to find a suitable key share entry and copy it to the
651 * handshake context. Later, we have to find out whether we can do
652 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000653 * dismiss it and send a HelloRetryRequest message.
654 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000655
Jerry Yuc1be19f2022-04-23 16:11:39 +0800656 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000657 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000658 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800659 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800660 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000661
662 /*
663 * struct {
664 * NamedGroup group;
665 * opaque key_exchange<1..2^16-1>;
666 * } KeyShareEntry;
667 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000668 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000669 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800670 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
671 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800672 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000673 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
Jerry Yu086edc22022-05-05 10:50:38 +0800674 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000675
676 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000677 * for input validation purposes.
678 */
XiaokangQian060d8672022-04-21 09:24:56 +0000679 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800680 ! mbedtls_ssl_named_group_is_supported( group ) ||
681 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000682 {
683 continue;
684 }
XiaokangQian060d8672022-04-21 09:24:56 +0000685
XiaokangQian7807f9f2022-02-15 10:04:37 +0000686 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000687 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000688 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000689 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
690 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800691 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
692 mbedtls_ssl_named_group_to_str( group ),
693 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000694 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800695 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000696 if( ret != 0 )
697 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000698
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000699 }
700 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000701 {
702 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000703 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000704 continue;
705 }
706
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000707 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000708 }
709
Jerry Yuc1be19f2022-04-23 16:11:39 +0800710
711 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000712 {
713 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000714 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000715 }
716 return( 0 );
717}
XiaokangQian88408882022-04-02 10:15:03 +0000718#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000719
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000720#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000721static void ssl_tls13_debug_print_client_hello_exts( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000722{
XiaokangQian3207a322022-02-23 03:15:27 +0000723 ((void) ssl);
724
XiaokangQian7807f9f2022-02-15 10:04:37 +0000725 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Supported Extensions:" ) );
XiaokangQianb67384d2022-04-19 00:02:38 +0000726 MBEDTLS_SSL_DEBUG_MSG( 3,
727 ( "- KEY_SHARE_EXTENSION ( %s )",
728 ( ( ssl->handshake->extensions_present
729 & MBEDTLS_SSL_EXT_KEY_SHARE ) > 0 ) ? "TRUE" : "FALSE" ) );
730 MBEDTLS_SSL_DEBUG_MSG( 3,
731 ( "- PSK_KEY_EXCHANGE_MODES_EXTENSION ( %s )",
732 ( ( ssl->handshake->extensions_present
733 & MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) > 0 ) ?
734 "TRUE" : "FALSE" ) );
735 MBEDTLS_SSL_DEBUG_MSG( 3,
736 ( "- PRE_SHARED_KEY_EXTENSION ( %s )",
737 ( ( ssl->handshake->extensions_present
738 & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) > 0 ) ? "TRUE" : "FALSE" ) );
739 MBEDTLS_SSL_DEBUG_MSG( 3,
740 ( "- SIGNATURE_ALGORITHM_EXTENSION ( %s )",
741 ( ( ssl->handshake->extensions_present
742 & MBEDTLS_SSL_EXT_SIG_ALG ) > 0 ) ? "TRUE" : "FALSE" ) );
743 MBEDTLS_SSL_DEBUG_MSG( 3,
744 ( "- SUPPORTED_GROUPS_EXTENSION ( %s )",
745 ( ( ssl->handshake->extensions_present
746 & MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ) >0 ) ?
747 "TRUE" : "FALSE" ) );
748 MBEDTLS_SSL_DEBUG_MSG( 3,
749 ( "- SUPPORTED_VERSION_EXTENSION ( %s )",
750 ( ( ssl->handshake->extensions_present
751 & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) > 0 ) ?
752 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000753#if defined ( MBEDTLS_SSL_SERVER_NAME_INDICATION )
XiaokangQianb67384d2022-04-19 00:02:38 +0000754 MBEDTLS_SSL_DEBUG_MSG( 3,
755 ( "- SERVERNAME_EXTENSION ( %s )",
756 ( ( ssl->handshake->extensions_present
757 & MBEDTLS_SSL_EXT_SERVERNAME ) > 0 ) ?
758 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000759#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianacb39922022-06-17 10:18:48 +0000760#if defined ( MBEDTLS_SSL_ALPN )
761 MBEDTLS_SSL_DEBUG_MSG( 3,
762 ( "- ALPN_EXTENSION ( %s )",
763 ( ( ssl->handshake->extensions_present
764 & MBEDTLS_SSL_EXT_ALPN ) > 0 ) ?
765 "TRUE" : "FALSE" ) );
766#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000767}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000768#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000769
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200770MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000771static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000772 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000773{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000774 int masked = ssl->handshake->extensions_present & exts_mask;
775 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000776}
777
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200778MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000779static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
780 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000781{
Jerry Yu77f01482022-07-11 07:03:24 +0000782 return( ssl_tls13_client_hello_has_exts(
783 ssl,
784 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
785 MBEDTLS_SSL_EXT_KEY_SHARE |
786 MBEDTLS_SSL_EXT_SIG_ALG ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000787}
788
Jerry Yu77f01482022-07-11 07:03:24 +0000789#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
790MBEDTLS_CHECK_RETURN_CRITICAL
791static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
792 mbedtls_ssl_context *ssl )
793{
794 return( ssl_tls13_client_hello_has_exts(
795 ssl,
796 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
797 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
798}
799
800MBEDTLS_CHECK_RETURN_CRITICAL
801static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
802 mbedtls_ssl_context *ssl )
803{
804 return( ssl_tls13_client_hello_has_exts(
805 ssl,
806 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
807 MBEDTLS_SSL_EXT_KEY_SHARE |
808 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
809 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
810}
811#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
812
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200813MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000814static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000815{
Jerry Yu77f01482022-07-11 07:03:24 +0000816 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
817 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
818}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000819
Jerry Yu77f01482022-07-11 07:03:24 +0000820MBEDTLS_CHECK_RETURN_CRITICAL
821static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
822{
823#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
824 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
825 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
826 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
827#else
828 ((void) ssl);
829 return( 0 );
830#endif
831}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000832
Jerry Yu77f01482022-07-11 07:03:24 +0000833MBEDTLS_CHECK_RETURN_CRITICAL
834static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
835{
836#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
837 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
838 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
839 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
840#else
841 ((void) ssl);
842 return( 0 );
843#endif
844}
845
846static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
847{
848 /*
849 * Determine the key exchange algorithm to use.
850 * There are three types of key exchanges supported in TLS 1.3:
851 * - (EC)DH with ECDSA,
852 * - (EC)DH with PSK,
853 * - plain PSK.
854 *
855 * The PSK-based key exchanges may additionally be used with 0-RTT.
856 *
857 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +0800858 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
859 * 2 ) Certificate Mode ( ephemeral )
860 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +0000861 */
862
863 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
864
Jerry Yu77f01482022-07-11 07:03:24 +0000865 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
866 {
867 ssl->handshake->key_exchange_mode =
868 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
869 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
870 }
871 else
872 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
873 {
874 ssl->handshake->key_exchange_mode =
875 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
876 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
877 }
878 else
Jerry Yuce6ed702022-07-22 21:49:53 +0800879 if( ssl_tls13_check_psk_key_exchange( ssl ) )
880 {
881 ssl->handshake->key_exchange_mode =
882 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
883 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
884 }
885 else
Jerry Yu77f01482022-07-11 07:03:24 +0000886 {
887 MBEDTLS_SSL_DEBUG_MSG(
888 1,
889 ( "ClientHello message misses mandatory extensions." ) );
890 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
891 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
892 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
893 }
894
895 return( 0 );
896
XiaokangQian7807f9f2022-02-15 10:04:37 +0000897}
898
XiaokangQian81802f42022-06-10 13:25:22 +0000899#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
900 defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +0200901
902#if defined(MBEDTLS_USE_PSA_CRYPTO)
903static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
904{
905 switch( sig_alg )
906 {
907 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
908 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
909 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
910 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
911 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
912 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
913 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
914 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
915 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
916 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
917 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
918 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
919 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +0200920 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +0200921 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +0200922 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +0200923 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +0200924 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +0200925 default:
926 return( PSA_ALG_NONE );
927 }
928}
929#endif /* MBEDTLS_USE_PSA_CRYPTO */
930
XiaokangQian23c5be62022-06-07 02:04:34 +0000931/*
XiaokangQianfb665a82022-06-15 03:57:21 +0000932 * Pick best ( private key, certificate chain ) pair based on the signature
933 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +0000934 */
Ronald Cronce7d76e2022-07-08 18:56:49 +0200935MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +0000936static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +0000937{
XiaokangQianfb665a82022-06-15 03:57:21 +0000938 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +0000939 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +0000940
941#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
942 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +0000943 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +0000944 else
945#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +0000946 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +0000947
XiaokangQianfb665a82022-06-15 03:57:21 +0000948 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +0000949 {
950 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
951 return( -1 );
952 }
953
XiaokangQian81802f42022-06-10 13:25:22 +0000954 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +0000955 {
Ronald Cron67ea2542022-09-15 17:34:42 +0200956 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
957 continue;
958
959 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
960 continue;
961
XiaokangQianfb665a82022-06-15 03:57:21 +0000962 for( key_cert = key_cert_list; key_cert != NULL;
963 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +0000964 {
Ronald Cron67ea2542022-09-15 17:34:42 +0200965#if defined(MBEDTLS_USE_PSA_CRYPTO)
966 psa_algorithm_t psa_alg = PSA_ALG_NONE;
967#endif /* MBEDTLS_USE_PSA_CRYPTO */
968
XiaokangQianfb665a82022-06-15 03:57:21 +0000969 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
970 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +0000971
972 /*
973 * This avoids sending the client a cert it'll reject based on
974 * keyUsage or other extensions.
975 */
976 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +0000977 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +0000978 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +0000979 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
980 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +0000981 {
982 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +0000983 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +0000984 continue;
985 }
XiaokangQian23c5be62022-06-07 02:04:34 +0000986
Jerry Yucc539102022-06-27 16:27:35 +0800987 MBEDTLS_SSL_DEBUG_MSG( 3,
988 ( "ssl_tls13_pick_key_cert:"
989 "check signature algorithm %s [%04x]",
990 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
991 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +0200992#if defined(MBEDTLS_USE_PSA_CRYPTO)
993 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
994#endif /* MBEDTLS_USE_PSA_CRYPTO */
995
Jerry Yufb526692022-06-19 11:22:49 +0800996 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +0200997 *sig_alg, &key_cert->cert->pk )
998#if defined(MBEDTLS_USE_PSA_CRYPTO)
999 && psa_alg != PSA_ALG_NONE &&
1000 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1001 PSA_KEY_USAGE_SIGN_HASH ) == 1
1002#endif /* MBEDTLS_USE_PSA_CRYPTO */
1003 )
XiaokangQian81802f42022-06-10 13:25:22 +00001004 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001005 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001006 MBEDTLS_SSL_DEBUG_MSG( 3,
1007 ( "ssl_tls13_pick_key_cert:"
1008 "selected signature algorithm"
1009 " %s [%04x]",
1010 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1011 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001012 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001013 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001014 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001015 return( 0 );
1016 }
XiaokangQian81802f42022-06-10 13:25:22 +00001017 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001018 }
1019
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001020 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1021 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001022 return( -1 );
1023}
XiaokangQian81802f42022-06-10 13:25:22 +00001024#endif /* MBEDTLS_X509_CRT_PARSE_C &&
1025 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001026
XiaokangQian4080a7f2022-04-11 09:55:18 +00001027/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001028 *
1029 * STATE HANDLING: ClientHello
1030 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001031 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001032 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001033 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001034 *
1035 * In this case, the server progresses to sending its ServerHello.
1036 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001037 * 2) The ClientHello was well-formed but didn't match the server's
1038 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001039 *
1040 * For example, the client might not have offered a key share which
1041 * the server supports, or the server might require a cookie.
1042 *
1043 * In this case, the server sends a HelloRetryRequest.
1044 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001045 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001046 *
1047 * In this case, we abort the handshake.
1048 *
1049 */
1050
1051/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001052 * Structure of this message:
1053 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001054 * uint16 ProtocolVersion;
1055 * opaque Random[32];
1056 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001057 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001058 * struct {
1059 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1060 * Random random;
1061 * opaque legacy_session_id<0..32>;
1062 * CipherSuite cipher_suites<2..2^16-2>;
1063 * opaque legacy_compression_methods<1..2^8-1>;
1064 * Extension extensions<8..2^16-1>;
1065 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001066 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001067
1068#define SSL_CLIENT_HELLO_OK 0
1069#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1070
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001071MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001072static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1073 const unsigned char *buf,
1074 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001075{
XiaokangQianb67384d2022-04-19 00:02:38 +00001076 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1077 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001078 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001079 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001080 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001081 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001082 const unsigned char *extensions_end;
Jerry Yu49ca9282022-05-05 11:05:22 +08001083 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001084
Jerry Yu1c105562022-07-10 06:32:38 +00001085#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001086 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001087 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001088 const unsigned char *pre_shared_key_ext_end = NULL;
1089#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001090
1091 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1092
1093 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001094 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001095 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001096 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001097 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001098 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001099 * .. . .. ciphersuite list length ( 2 bytes )
1100 * .. . .. ciphersuite list
1101 * .. . .. compression alg. list length ( 1 byte )
1102 * .. . .. compression alg. list
1103 * .. . .. extensions length ( 2 bytes, optional )
1104 * .. . .. extensions ( optional )
1105 */
1106
XiaokangQianb67384d2022-04-19 00:02:38 +00001107 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001108 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001109 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1110 * read at least up to session id length without worrying.
1111 */
1112 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1113
1114 /* ...
1115 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1116 * ...
1117 * with ProtocolVersion defined as:
1118 * uint16 ProtocolVersion;
1119 */
XiaokangQiande333912022-04-20 08:49:42 +00001120 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1121 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001122 {
1123 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1124 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1125 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001126 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001127 }
1128 p += 2;
1129
1130 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001131 * Only support TLS 1.3 currently, temporarily set the version.
1132 */
XiaokangQiande333912022-04-20 08:49:42 +00001133 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001134
Jerry Yue67bef42022-07-07 07:29:42 +00001135#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1136 /* Store minor version for later use with ticket serialization. */
1137 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001138 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001139#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001140
Jerry Yuc1be19f2022-04-23 16:11:39 +08001141 /* ...
1142 * Random random;
1143 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001144 * with Random defined as:
1145 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001146 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001147 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001148 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001149
XiaokangQian08037552022-04-20 07:16:41 +00001150 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
1151 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001152
Jerry Yuc1be19f2022-04-23 16:11:39 +08001153 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001154 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001155 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001156 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001157 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001158 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001159
XiaokangQianb67384d2022-04-19 00:02:38 +00001160 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001161 {
1162 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1163 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1164 }
1165
XiaokangQian4080a7f2022-04-11 09:55:18 +00001166 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001167 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001168 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001169 /*
1170 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001171 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001172 */
1173 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001174
XiaokangQianed582dd2022-04-13 08:21:05 +00001175 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001176 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001177
XiaokangQian7807f9f2022-02-15 10:04:37 +00001178 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1179 p += 2;
1180
XiaokangQianb67384d2022-04-19 00:02:38 +00001181 /* Check we have enough data for the ciphersuite list, the legacy
1182 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001183 *
1184 * cipher_suites cipher_suites_len bytes
1185 * legacy_compression_methods 2 bytes
1186 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001187 */
1188 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001189
Jerry Yu24b8c812022-08-20 19:06:56 +08001190 /* ...
1191 * CipherSuite cipher_suites<2..2^16-2>;
1192 * ...
1193 * with CipherSuite defined as:
1194 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001195 */
Jerry Yu5725f1c2022-08-21 17:27:16 +08001196#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001197 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001198#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001199 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001200 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1201 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001202
1203 /*
1204 * Search for a matching ciphersuite
1205 */
XiaokangQian060d8672022-04-21 09:24:56 +00001206 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001207 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001208 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001209 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001210
XiaokangQiane8ff3502022-04-22 02:34:40 +00001211 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001212
XiaokangQiane8ff3502022-04-22 02:34:40 +00001213 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001214 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001215 ssl,cipher_suite );
1216 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001217 continue;
1218
Jerry Yu5725f1c2022-08-21 17:27:16 +08001219 ssl->session_negotiate->ciphersuite = cipher_suite;
1220 ssl->handshake->ciphersuite_info = ciphersuite_info;
1221 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001222 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001223 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001224 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001225
1226 if( ssl->handshake->ciphersuite_info == NULL )
1227 {
1228 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1229 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1230 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1231 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001232
XiaokangQian4080a7f2022-04-11 09:55:18 +00001233 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001234 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001235 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001236 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001237 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001238 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001239 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1240 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1241 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1242 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001243 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001244 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001245
Jerry Yuc1be19f2022-04-23 16:11:39 +08001246 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001247 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001248 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001249 * with Extension defined as:
1250 * struct {
1251 * ExtensionType extension_type;
1252 * opaque extension_data<0..2^16-1>;
1253 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001254 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001255 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001256 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001257 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001258 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001259
XiaokangQian4080a7f2022-04-11 09:55:18 +00001260 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001261
1262 while( p < extensions_end )
1263 {
1264 unsigned int extension_type;
1265 size_t extension_data_len;
1266 const unsigned char *extension_data_end;
1267
Jerry Yu1c9247c2022-07-21 12:37:39 +08001268 /* RFC 8446, page 57
1269 *
1270 * The "pre_shared_key" extension MUST be the last extension in the
1271 * ClientHello (this facilitates implementation as described below).
1272 * Servers MUST check that it is the last extension and otherwise fail
1273 * the handshake with an "illegal_parameter" alert.
1274 */
1275 if( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY )
1276 {
1277 MBEDTLS_SSL_DEBUG_MSG(
1278 3, ( "pre_shared_key is not last extension." ) );
1279 MBEDTLS_SSL_PEND_FATAL_ALERT(
1280 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1281 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1282 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1283 }
1284
XiaokangQian318dc762022-04-20 09:43:51 +00001285 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001286 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1287 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1288 p += 4;
1289
1290 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1291 extension_data_end = p + extension_data_len;
1292
1293 switch( extension_type )
1294 {
XiaokangQian40a35232022-05-07 09:02:40 +00001295#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1296 case MBEDTLS_TLS_EXT_SERVERNAME:
1297 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001298 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1299 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001300 if( ret != 0 )
1301 {
1302 MBEDTLS_SSL_DEBUG_RET(
1303 1, "mbedtls_ssl_parse_servername_ext", ret );
1304 return( ret );
1305 }
1306 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SERVERNAME;
1307 break;
1308#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1309
XiaokangQianb67384d2022-04-19 00:02:38 +00001310#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001311 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1312 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1313
1314 /* Supported Groups Extension
1315 *
1316 * When sent by the client, the "supported_groups" extension
1317 * indicates the named groups which the client supports,
1318 * ordered from most preferred to least preferred.
1319 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001320 ret = ssl_tls13_parse_supported_groups_ext(
1321 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001322 if( ret != 0 )
1323 {
1324 MBEDTLS_SSL_DEBUG_RET( 1,
1325 "mbedtls_ssl_parse_supported_groups_ext", ret );
1326 return( ret );
1327 }
1328
1329 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
1330 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001331#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001332
XiaokangQian88408882022-04-02 10:15:03 +00001333#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001334 case MBEDTLS_TLS_EXT_KEY_SHARE:
1335 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1336
1337 /*
1338 * Key Share Extension
1339 *
1340 * When sent by the client, the "key_share" extension
1341 * contains the endpoint's cryptographic parameters for
1342 * ECDHE/DHE key establishment methods.
1343 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001344 ret = ssl_tls13_parse_key_shares_ext(
1345 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001346 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001347 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001348 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001349 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001350 }
1351
Jerry Yu582dd062022-04-22 21:59:01 +08001352 if( ret < 0 )
1353 {
1354 MBEDTLS_SSL_DEBUG_RET(
1355 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001356 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001357 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001358
1359 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
1360 break;
XiaokangQian88408882022-04-02 10:15:03 +00001361#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001362
1363 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1364 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1365
1366 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001367 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001368 if( ret != 0 )
1369 {
1370 MBEDTLS_SSL_DEBUG_RET( 1,
1371 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1372 return( ret );
1373 }
1374 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
1375 break;
1376
Jerry Yue19e3b92022-07-08 12:04:51 +00001377#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1378 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1379 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1380
1381 ret = ssl_tls13_parse_key_exchange_modes_ext(
1382 ssl, p, extension_data_end );
1383 if( ret != 0 )
1384 {
1385 MBEDTLS_SSL_DEBUG_RET(
1386 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1387 return( ret );
1388 }
1389
1390 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
1391 break;
1392#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1393
Jerry Yu1c105562022-07-10 06:32:38 +00001394 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1395 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001396 if( ( ssl->handshake->extensions_present &
1397 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) == 0 )
1398 {
1399 MBEDTLS_SSL_PEND_FATAL_ALERT(
1400 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1401 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1402 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1403 }
Jerry Yu1c9247c2022-07-21 12:37:39 +08001404#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001405 /* Delay processing of the PSK identity once we have
1406 * found out which algorithms to use. We keep a pointer
1407 * to the buffer and the size for later processing.
1408 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001409 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001410 pre_shared_key_ext_end = extension_data_end;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001411#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001412 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1413 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001414
XiaokangQianacb39922022-06-17 10:18:48 +00001415#if defined(MBEDTLS_SSL_ALPN)
1416 case MBEDTLS_TLS_EXT_ALPN:
1417 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1418
1419 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1420 if( ret != 0 )
1421 {
1422 MBEDTLS_SSL_DEBUG_RET(
1423 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1424 return( ret );
1425 }
1426 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_ALPN;
1427 break;
1428#endif /* MBEDTLS_SSL_ALPN */
1429
XiaokangQian7807f9f2022-02-15 10:04:37 +00001430#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1431 case MBEDTLS_TLS_EXT_SIG_ALG:
1432 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1433
Gabor Mezei078e8032022-04-27 21:17:56 +02001434 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001435 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001436 if( ret != 0 )
1437 {
1438 MBEDTLS_SSL_DEBUG_MSG( 1,
1439 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1440 ret ) );
1441 return( ret );
1442 }
1443 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
1444 break;
1445#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1446
1447 default:
1448 MBEDTLS_SSL_DEBUG_MSG( 3,
1449 ( "unknown extension found: %ud ( ignoring )",
1450 extension_type ) );
1451 }
1452
1453 p += extension_data_len;
1454 }
1455
Jerry Yu1c105562022-07-10 06:32:38 +00001456#if defined(MBEDTLS_DEBUG_C)
1457 /* List all the extensions we have received */
1458 ssl_tls13_debug_print_client_hello_exts( ssl );
1459#endif /* MBEDTLS_DEBUG_C */
1460
1461 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1462 MBEDTLS_SSL_HS_CLIENT_HELLO,
1463 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001464
Jerry Yu1c105562022-07-10 06:32:38 +00001465#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001466 /* Update checksum with either
1467 * - The entire content of the CH message, if no PSK extension is present
1468 * - The content up to but excluding the PSK extension, if present.
1469 */
Jerry Yu1c105562022-07-10 06:32:38 +00001470 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001471 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001472 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yuba9b6e92022-07-22 21:35:18 +08001473 ( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001474 {
1475 ssl->handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001476 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001477 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001478 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001479 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001480 cipher_suites,
1481 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001482 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001483 {
1484 ssl->handshake->extensions_present &= ~MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001485 }
1486 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001487 {
Jerry Yubb852022022-07-20 21:10:44 +08001488 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_tls13_parse_pre_shared_key_ext" ),
Jerry Yu1c105562022-07-10 06:32:38 +00001489 ret );
1490 return( ret );
1491 }
Jerry Yu1c105562022-07-10 06:32:38 +00001492 }
1493 else
1494#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1495 {
1496 ssl->handshake->update_checksum( ssl, buf, p - buf );
1497 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001498
Jerry Yuba9b6e92022-07-22 21:35:18 +08001499 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1500 if( ret < 0 )
1501 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001502
Jerry Yue5834fd2022-08-29 20:16:09 +08001503 mbedtls_ssl_optimize_checksum( ssl, ssl->handshake->ciphersuite_info );
1504
XiaokangQian75fe8c72022-06-15 09:42:45 +00001505 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1506}
1507
1508/* Update the handshake state machine */
1509
Ronald Cronce7d76e2022-07-08 18:56:49 +02001510MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001511static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1512{
1513 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1514
XiaokangQian7807f9f2022-02-15 10:04:37 +00001515 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001516 * Server certificate selection
1517 */
1518 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1519 {
1520 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1521 return( ret );
1522 }
1523#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1524 ssl->handshake->sni_name = NULL;
1525 ssl->handshake->sni_name_len = 0;
1526#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001527
XiaokangQian7807f9f2022-02-15 10:04:37 +00001528 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1529 if( ret != 0 )
1530 {
1531 MBEDTLS_SSL_DEBUG_RET( 1,
1532 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1533 return( ret );
1534 }
1535
XiaokangQian7807f9f2022-02-15 10:04:37 +00001536 return( 0 );
1537
1538}
1539
1540/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001541 * Main entry point from the state machine; orchestrates the otherfunctions.
1542 */
1543
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001544MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001545static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1546{
1547
XiaokangQian08037552022-04-20 07:16:41 +00001548 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001549 unsigned char* buf = NULL;
1550 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001551 int parse_client_hello_ret;
1552
XiaokangQianed582dd2022-04-13 08:21:05 +00001553 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1554
XiaokangQianed582dd2022-04-13 08:21:05 +00001555 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1556 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1557 &buf, &buflen ) );
1558
1559 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1560 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001561 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1562 * only SSL_CLIENT_HELLO_OK or
1563 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1564 * stage as negative error codes are handled
1565 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001566
XiaokangQiancfd925f2022-04-14 07:10:37 +00001567 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001568
Jerry Yu4ca91402022-05-09 15:50:57 +08001569 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1570 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1571 else
1572 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001573
1574cleanup:
1575
1576 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1577 return( ret );
1578}
1579
1580/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001581 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001582 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001583MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001584static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1585{
Jerry Yu637a3f12022-04-20 21:37:58 +08001586 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1587 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001588 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001589 if( ssl->conf->f_rng == NULL )
1590 {
1591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1592 return( MBEDTLS_ERR_SSL_NO_RNG );
1593 }
1594
Jerry Yu637a3f12022-04-20 21:37:58 +08001595 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001596 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1597 {
1598 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1599 return( ret );
1600 }
1601
Jerry Yu637a3f12022-04-20 21:37:58 +08001602 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001603 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1604
1605#if defined(MBEDTLS_HAVE_TIME)
1606 ssl->session_negotiate->start = time( NULL );
1607#endif /* MBEDTLS_HAVE_TIME */
1608
1609 return( ret );
1610}
1611
Jerry Yu3bf2c642022-03-30 22:02:12 +08001612/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001613 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001614 *
1615 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001616 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001617 * } SupportedVersions;
1618 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001619MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001620static int ssl_tls13_write_server_hello_supported_versions_ext(
1621 mbedtls_ssl_context *ssl,
1622 unsigned char *buf,
1623 unsigned char *end,
1624 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001625{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001626 *out_len = 0;
1627
Jerry Yu955ddd72022-04-22 22:27:33 +08001628 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001629
1630 /* Check if we have space to write the extension:
1631 * - extension_type (2 bytes)
1632 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001633 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001634 */
Jerry Yu349a6132022-04-14 20:52:56 +08001635 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001636
Jerry Yu349a6132022-04-14 20:52:56 +08001637 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001638
Jerry Yu349a6132022-04-14 20:52:56 +08001639 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001640
Jerry Yu349a6132022-04-14 20:52:56 +08001641 mbedtls_ssl_write_version( buf + 4,
1642 ssl->conf->transport,
1643 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001644
1645 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1646 ssl->tls_version ) );
1647
Jerry Yu349a6132022-04-14 20:52:56 +08001648 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001649
1650 return( 0 );
1651}
1652
Jerry Yud9436a12022-04-20 22:28:09 +08001653
Jerry Yu3bf2c642022-03-30 22:02:12 +08001654
1655/* Generate and export a single key share. For hybrid KEMs, this can
1656 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001657MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001658static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1659 uint16_t named_group,
1660 unsigned char *buf,
1661 unsigned char *end,
1662 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001663{
1664 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001665
1666 *out_len = 0;
1667
Jerry Yu89e103c2022-03-30 22:43:29 +08001668#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001669 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1670 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001671 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1672 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001673 if( ret != 0 )
1674 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001675 MBEDTLS_SSL_DEBUG_RET(
1676 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1677 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001678 return( ret );
1679 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001680 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001681 else
1682#endif /* MBEDTLS_ECDH_C */
1683 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001684 {
1685 }
1686 else
1687 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001688 ((void) ssl);
1689 ((void) named_group);
1690 ((void) buf);
1691 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001692 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1693 }
1694
1695 return( ret );
1696}
1697
1698/*
1699 * ssl_tls13_write_key_share_ext
1700 *
1701 * Structure of key_share extension in ServerHello:
1702 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001703 * struct {
1704 * NamedGroup group;
1705 * opaque key_exchange<1..2^16-1>;
1706 * } KeyShareEntry;
1707 * struct {
1708 * KeyShareEntry server_share;
1709 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001710 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001711MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001712static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1713 unsigned char *buf,
1714 unsigned char *end,
1715 size_t *out_len )
1716{
Jerry Yu955ddd72022-04-22 22:27:33 +08001717 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001718 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001719 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001720 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001721 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001722
1723 *out_len = 0;
1724
1725 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1726
Jerry Yu58af2332022-09-06 11:19:31 +08001727 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1728 mbedtls_ssl_named_group_to_str( group ),
1729 group ) );
1730
Jerry Yu3bf2c642022-03-30 22:02:12 +08001731 /* Check if we have space for header and length fields:
1732 * - extension_type (2 bytes)
1733 * - extension_data_length (2 bytes)
1734 * - group (2 bytes)
1735 * - key_exchange_length (2 bytes)
1736 */
1737 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001738 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1739 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001740 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001741
Jerry Yu3bf2c642022-03-30 22:02:12 +08001742 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1743 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001744 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001745 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001746 if( ret != 0 )
1747 return( ret );
1748 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001749
Jerry Yu955ddd72022-04-22 22:27:33 +08001750 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001751
Jerry Yu57d48412022-04-20 21:50:42 +08001752 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001753
Jerry Yu57d48412022-04-20 21:50:42 +08001754 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001755
Jerry Yu3bf2c642022-03-30 22:02:12 +08001756 return( 0 );
1757}
Jerry Yud9436a12022-04-20 22:28:09 +08001758
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001759MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001760static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1761 unsigned char *buf,
1762 unsigned char *end,
1763 size_t *out_len )
1764{
1765 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1766 /* key_share Extension
1767 *
1768 * struct {
1769 * select (Handshake.msg_type) {
1770 * ...
1771 * case hello_retry_request:
1772 * NamedGroup selected_group;
1773 * ...
1774 * };
1775 * } KeyShare;
1776 */
1777
1778 *out_len = 0;
1779
Jerry Yub0ac10b2022-05-05 11:10:08 +08001780 /*
1781 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1782 * of the HRR is then to transmit a cookie to force the client to demonstrate
1783 * reachability at their apparent network address (primarily useful for DTLS).
1784 */
Ronald Cron79907712022-07-20 17:05:29 +02001785 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001786 return( 0 );
1787
1788 /* We should only send the key_share extension if the client's initial
1789 * key share was not acceptable. */
1790 if( ssl->handshake->offered_group_id != 0 )
1791 {
1792 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
1793 return( 0 );
1794 }
1795
1796 if( selected_group == 0 )
1797 {
1798 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
1799 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1800 }
1801
Jerry Yub0ac10b2022-05-05 11:10:08 +08001802 /* Check if we have enough space:
1803 * - extension_type (2 bytes)
1804 * - extension_data_length (2 bytes)
1805 * - selected_group (2 bytes)
1806 */
Ronald Cron154d1b62022-06-01 15:33:26 +02001807 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001808
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001809 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001810 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001811 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
1812
1813 MBEDTLS_SSL_DEBUG_MSG( 3,
1814 ( "HRR selected_group: %s (%x)",
1815 mbedtls_ssl_named_group_to_str( selected_group ),
1816 selected_group ) );
1817
1818 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001819
Jerry Yub0ac10b2022-05-05 11:10:08 +08001820 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001821}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001822
1823/*
1824 * Structure of ServerHello message:
1825 *
1826 * struct {
1827 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1828 * Random random;
1829 * opaque legacy_session_id_echo<0..32>;
1830 * CipherSuite cipher_suite;
1831 * uint8 legacy_compression_method = 0;
1832 * Extension extensions<6..2^16-1>;
1833 * } ServerHello;
1834 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001835MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001836static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08001837 unsigned char *buf,
1838 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001839 size_t *out_len,
1840 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08001841{
Jerry Yu955ddd72022-04-22 22:27:33 +08001842 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001844 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001845 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001846
1847 *out_len = 0;
1848
Jerry Yucfc04b32022-04-21 09:31:58 +08001849 /* ...
1850 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1851 * ...
1852 * with ProtocolVersion defined as:
1853 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001854 */
1855 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1856 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
1857 p += 2;
1858
Jerry Yu1c3e6882022-04-20 21:23:40 +08001859 /* ...
1860 * Random random;
1861 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001862 * with Random defined as:
1863 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001864 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001865 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001866 if( is_hrr )
1867 {
1868 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08001869 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001870 }
1871 else
1872 {
1873 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08001874 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001875 }
Jerry Yu955ddd72022-04-22 22:27:33 +08001876 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08001877 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1878 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
1879
Jerry Yucfc04b32022-04-21 09:31:58 +08001880 /* ...
1881 * opaque legacy_session_id_echo<0..32>;
1882 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08001883 */
1884 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
1885 *p++ = (unsigned char)ssl->session_negotiate->id_len;
1886 if( ssl->session_negotiate->id_len > 0 )
1887 {
1888 memcpy( p, &ssl->session_negotiate->id[0],
1889 ssl->session_negotiate->id_len );
1890 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08001891
Jerry Yu3bf2c642022-03-30 22:02:12 +08001892 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
1893 ssl->session_negotiate->id_len );
1894 }
1895
Jerry Yucfc04b32022-04-21 09:31:58 +08001896 /* ...
1897 * CipherSuite cipher_suite;
1898 * ...
1899 * with CipherSuite defined as:
1900 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08001901 */
1902 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1903 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
1904 p += 2;
1905 MBEDTLS_SSL_DEBUG_MSG( 3,
1906 ( "server hello, chosen ciphersuite: %s ( id=%d )",
1907 mbedtls_ssl_get_ciphersuite_name(
1908 ssl->session_negotiate->ciphersuite ),
1909 ssl->session_negotiate->ciphersuite ) );
1910
Jerry Yucfc04b32022-04-21 09:31:58 +08001911 /* ...
1912 * uint8 legacy_compression_method = 0;
1913 * ...
1914 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001915 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001916 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001917
Jerry Yucfc04b32022-04-21 09:31:58 +08001918 /* ...
1919 * Extension extensions<6..2^16-1>;
1920 * ...
1921 * struct {
1922 * ExtensionType extension_type; (2 bytes)
1923 * opaque extension_data<0..2^16-1>;
1924 * } Extension;
1925 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001926 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08001927 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001928 p += 2;
1929
Jerry Yue74e04a2022-04-21 09:23:16 +08001930 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08001931 ssl, p, end, &output_len ) ) != 0 )
1932 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001933 MBEDTLS_SSL_DEBUG_RET(
1934 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001935 return( ret );
1936 }
1937 p += output_len;
1938
Jerry Yu56acc942022-07-30 23:02:36 +08001939 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001940 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001941 if( is_hrr )
1942 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
1943 else
1944 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001945 if( ret != 0 )
1946 return( ret );
1947 p += output_len;
1948 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001949
Jerry Yu032b15ce2022-07-11 06:10:03 +00001950#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu96a2e362022-07-21 15:11:34 +08001951 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00001952 {
Jerry Yubb852022022-07-20 21:10:44 +08001953 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001954 if( ret != 0 )
1955 {
Jerry Yubb852022022-07-20 21:10:44 +08001956 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00001957 ret );
1958 return( ret );
1959 }
1960 p += output_len;
1961 }
1962#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1963
Jerry Yud9436a12022-04-20 22:28:09 +08001964 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001965
Jerry Yud9436a12022-04-20 22:28:09 +08001966 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
1967 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001968
Jerry Yud9436a12022-04-20 22:28:09 +08001969 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001970
Jerry Yud9436a12022-04-20 22:28:09 +08001971 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001972
1973 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08001974}
1975
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001976MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08001977static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
1978{
1979 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08001980 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08001981 if( ret != 0 )
1982 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001983 MBEDTLS_SSL_DEBUG_RET( 1,
1984 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08001985 ret );
1986 return( ret );
1987 }
1988
Jerry Yue110d252022-05-05 10:19:22 +08001989 return( ret );
1990}
1991
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001992MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08001993static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
1994{
Jerry Yu637a3f12022-04-20 21:37:58 +08001995 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001996 unsigned char *buf;
1997 size_t buf_len, msg_len;
1998
1999 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2000
Jerry Yuf4b27e42022-03-30 17:32:21 +08002001 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2002
Jerry Yu3bf2c642022-03-30 22:02:12 +08002003 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002004 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2005
Jerry Yu3bf2c642022-03-30 22:02:12 +08002006 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2007 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002008 &msg_len,
2009 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002010
Jerry Yu3bf2c642022-03-30 22:02:12 +08002011 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002012 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2013
Jerry Yu3bf2c642022-03-30 22:02:12 +08002014 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002015 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002016
Jerry Yue110d252022-05-05 10:19:22 +08002017 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2018
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002019#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2020 /* The server sends a dummy change_cipher_spec record immediately
2021 * after its first handshake message. This may either be after
2022 * a ServerHello or a HelloRetryRequest.
2023 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002024 mbedtls_ssl_handshake_set_state(
2025 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002026#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002027 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002028#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002029
Jerry Yuf4b27e42022-03-30 17:32:21 +08002030cleanup:
2031
2032 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2033 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002034}
2035
Jerry Yu23d1a252022-05-12 18:08:59 +08002036
2037/*
2038 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2039 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002040MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002041static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002042{
2043 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2044 if( ssl->handshake->hello_retry_request_count > 0 )
2045 {
2046 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2047 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2048 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2049 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2050 }
2051
2052 /*
2053 * Create stateless transcript hash for HRR
2054 */
2055 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2056 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2057 if( ret != 0 )
2058 {
2059 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2060 return( ret );
2061 }
2062 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2063
2064 return( 0 );
2065}
2066
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002067MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002068static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2069{
2070 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2071 unsigned char *buf;
2072 size_t buf_len, msg_len;
2073
2074 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2075
Ronald Cron7b840462022-06-01 17:05:53 +02002076 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002077
2078 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2079 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2080 &buf, &buf_len ) );
2081
2082 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2083 buf + buf_len,
2084 &msg_len,
2085 1 ) );
2086 mbedtls_ssl_add_hs_msg_to_checksum(
2087 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2088
2089
2090 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2091 msg_len ) );
2092
2093 ssl->handshake->hello_retry_request_count++;
2094
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002095#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2096 /* The server sends a dummy change_cipher_spec record immediately
2097 * after its first handshake message. This may either be after
2098 * a ServerHello or a HelloRetryRequest.
2099 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002100 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002101 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002102#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002103 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002104#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002105
2106cleanup:
2107 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2108 return( ret );
2109}
2110
Jerry Yu5b64ae92022-03-30 17:15:02 +08002111/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002112 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2113 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002114
2115/*
2116 * struct {
2117 * Extension extensions<0..2 ^ 16 - 1>;
2118 * } EncryptedExtensions;
2119 *
2120 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002121MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002122static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2123 unsigned char *buf,
2124 unsigned char *end,
2125 size_t *out_len )
2126{
XiaokangQianacb39922022-06-17 10:18:48 +00002127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002128 unsigned char *p = buf;
2129 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002130 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002131 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002132
Jerry Yu4d3841a2022-04-16 12:37:19 +08002133 *out_len = 0;
2134
2135 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002136 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002137 p += 2;
2138
Jerry Yu8937eb42022-05-03 12:12:14 +08002139 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002140 ((void) ret);
2141 ((void) output_len);
2142
2143#if defined(MBEDTLS_SSL_ALPN)
2144 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2145 if( ret != 0 )
2146 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002147 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002148#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002149
Jerry Yu8937eb42022-05-03 12:12:14 +08002150 extensions_len = ( p - p_extensions_len ) - 2;
2151 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2152
2153 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002154
2155 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2156
2157 return( 0 );
2158}
2159
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002160MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002161static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2162{
2163 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2164 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002165 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002166
Gabor Mezei54719122022-06-28 11:34:56 +02002167 mbedtls_ssl_set_outbound_transform( ssl,
2168 ssl->handshake->transform_handshake );
2169 MBEDTLS_SSL_DEBUG_MSG(
2170 3, ( "switching to handshake transform for outbound data" ) );
2171
Jerry Yuab452cc2022-04-28 15:27:08 +08002172 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002173
Jerry Yu4d3841a2022-04-16 12:37:19 +08002174 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2175 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2176
2177 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2178 ssl, buf, buf + buf_len, &msg_len ) );
2179
2180 mbedtls_ssl_add_hs_msg_to_checksum(
2181 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2182
Jerry Yu4d3841a2022-04-16 12:37:19 +08002183 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2184 ssl, buf_len, msg_len ) );
2185
Jerry Yu8937eb42022-05-03 12:12:14 +08002186#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002187 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002188 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2189 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002190 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002191#else
2192 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2193#endif
2194
Jerry Yu4d3841a2022-04-16 12:37:19 +08002195cleanup:
2196
Jerry Yuab452cc2022-04-28 15:27:08 +08002197 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002198 return( ret );
2199}
2200
XiaokangQiancec9ae62022-05-06 07:28:50 +00002201#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002202#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2203#define SSL_CERTIFICATE_REQUEST_SKIP 1
2204/* Coordination:
2205 * Check whether a CertificateRequest message should be written.
2206 * Returns a negative code on failure, or
2207 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2208 * - SSL_CERTIFICATE_REQUEST_SKIP
2209 * indicating if the writing of the CertificateRequest
2210 * should be skipped or not.
2211 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002212MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002213static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2214{
2215 int authmode;
2216
XiaokangQian40a35232022-05-07 09:02:40 +00002217#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2218 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2219 authmode = ssl->handshake->sni_authmode;
2220 else
2221#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002222 authmode = ssl->conf->authmode;
2223
2224 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
2225 return( SSL_CERTIFICATE_REQUEST_SKIP );
2226
XiaokangQianc3017f62022-05-13 05:55:41 +00002227 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002228
XiaokangQiana987e1d2022-05-07 01:25:58 +00002229 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2230}
2231
XiaokangQiancec9ae62022-05-06 07:28:50 +00002232/*
2233 * struct {
2234 * opaque certificate_request_context<0..2^8-1>;
2235 * Extension extensions<2..2^16-1>;
2236 * } CertificateRequest;
2237 *
2238 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002239MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002240static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2241 unsigned char *buf,
2242 const unsigned char *end,
2243 size_t *out_len )
2244{
2245 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2246 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002247 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002248 unsigned char *p_extensions_len;
2249
2250 *out_len = 0;
2251
2252 /* Check if we have enough space:
2253 * - certificate_request_context (1 byte)
2254 * - extensions length (2 bytes)
2255 */
2256 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2257
2258 /*
2259 * Write certificate_request_context
2260 */
2261 /*
2262 * We use a zero length context for the normal handshake
2263 * messages. For post-authentication handshake messages
2264 * this request context would be set to a non-zero value.
2265 */
2266 *p++ = 0x0;
2267
2268 /*
2269 * Write extensions
2270 */
2271 /* The extensions must contain the signature_algorithms. */
2272 p_extensions_len = p;
2273 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002274 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002275 if( ret != 0 )
2276 return( ret );
2277
XiaokangQianec6efb92022-05-06 09:53:10 +00002278 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002279 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002280
2281 *out_len = p - buf;
2282
2283 return( 0 );
2284}
2285
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002286MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002287static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2288{
2289 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2290
2291 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2292
2293 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2294
2295 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2296 {
2297 unsigned char *buf;
2298 size_t buf_len, msg_len;
2299
2300 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2301 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2302
2303 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2304 ssl, buf, buf + buf_len, &msg_len ) );
2305
2306 mbedtls_ssl_add_hs_msg_to_checksum(
2307 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2308
2309 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2310 ssl, buf_len, msg_len ) );
2311 }
2312 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2313 {
2314 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2315 ret = 0;
2316 }
2317 else
2318 {
2319 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2320 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2321 goto cleanup;
2322 }
2323
2324 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2325cleanup:
2326
2327 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2328 return( ret );
2329}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002330
Jerry Yu4d3841a2022-04-16 12:37:19 +08002331/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002332 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002333 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002334MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002335static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002336{
Jerry Yu5a26f302022-05-10 20:46:40 +08002337 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002338
2339#if defined(MBEDTLS_X509_CRT_PARSE_C)
2340 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2341 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002342 {
Jerry Yub89125b2022-05-13 15:45:49 +08002343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002344 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2345 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002346 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002347 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002348#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002349
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002350 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2351 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002352 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002353 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2354 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002355}
2356
2357/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002358 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002359 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002360MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002361static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002362{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002363 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002364 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002365 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002366 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2367 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002368}
Jerry Yu5a26f302022-05-10 20:46:40 +08002369#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002370
2371/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002372 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002373 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002374MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002375static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002376{
Jerry Yud6e253d2022-05-18 13:59:24 +08002377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002378
2379 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2380 if( ret != 0 )
2381 return( ret );
2382
Jerry Yue3d67cb2022-05-19 15:33:10 +08002383 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2384 if( ret != 0 )
2385 {
2386 MBEDTLS_SSL_PEND_FATAL_ALERT(
2387 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2388 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2389 return( ret );
2390 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002391
Ronald Cron63dc4632022-05-31 14:41:53 +02002392 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2393 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002394
Ronald Cron63dc4632022-05-31 14:41:53 +02002395 if( ssl->handshake->certificate_request_sent )
2396 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002397 else
Ronald Cron19385882022-06-15 16:26:13 +02002398 {
2399 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2400 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002401 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002402 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002403
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002404 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002405}
2406
2407/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002408 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002409 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002410MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002411static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002412{
Jerry Yud6e253d2022-05-18 13:59:24 +08002413 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2414
Jerry Yuff226982022-04-16 16:52:57 +08002415 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2416 if( ret != 0 )
2417 return( ret );
2418
Jerry Yue3d67cb2022-05-19 15:33:10 +08002419 ret = mbedtls_ssl_tls13_generate_resumption_master_secret( ssl );
2420 if( ret != 0 )
2421 {
2422 MBEDTLS_SSL_DEBUG_RET( 1,
2423 "mbedtls_ssl_tls13_generate_resumption_master_secret ", ret );
2424 }
2425
Jerry Yu03ed50b2022-04-16 17:13:30 +08002426 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002427 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002428}
2429
2430/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002431 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002432 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002433MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002434static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002435{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002436 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2437
Jerry Yu03ed50b2022-04-16 17:13:30 +08002438 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002439
2440#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002441 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2442#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002443 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002444#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002445 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002446}
2447
2448/*
Jerry Yue67bef42022-07-07 07:29:42 +00002449 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2450 */
2451#define SSL_NEW_SESSION_TICKET_SKIP 0
2452#define SSL_NEW_SESSION_TICKET_WRITE 1
2453MBEDTLS_CHECK_RETURN_CRITICAL
2454static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2455{
2456 /* Check whether the use of session tickets is enabled */
2457 if( ssl->conf->f_ticket_write == NULL )
2458 {
2459 MBEDTLS_SSL_DEBUG_MSG( 2, ( "new session ticket is not enabled" ) );
2460 return( SSL_NEW_SESSION_TICKET_SKIP );
2461 }
2462
Jerry Yue67bef42022-07-07 07:29:42 +00002463 return( SSL_NEW_SESSION_TICKET_WRITE );
2464}
2465
2466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2467MBEDTLS_CHECK_RETURN_CRITICAL
2468static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2469 unsigned char *ticket_nonce,
2470 size_t ticket_nonce_size )
2471{
2472 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2473 mbedtls_ssl_session *session = ssl->session;
2474 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2475 psa_algorithm_t psa_hash_alg;
2476 int hash_length;
2477
2478 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2479
2480#if defined(MBEDTLS_HAVE_TIME)
2481 session->start = mbedtls_time( NULL );
2482#endif
2483
2484 /* Generate ticket_age_add */
2485 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002486 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002487 sizeof( session->ticket_age_add ) ) != 0 ) )
2488 {
2489 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2490 return( ret );
2491 }
2492 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002493 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002494
2495 /* Generate ticket_nonce */
2496 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2497 if( ret != 0 )
2498 {
2499 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2500 return( ret );
2501 }
2502 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2503 ticket_nonce, ticket_nonce_size );
2504
2505 ciphersuite_info =
2506 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2507 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2508 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002509 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002510 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002511 {
Jerry Yue67bef42022-07-07 07:29:42 +00002512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002513 }
2514
Jerry Yue67bef42022-07-07 07:29:42 +00002515 /* In this code the psk key length equals the length of the hash */
2516 session->resumption_key_len = hash_length;
2517 session->ciphersuite = ciphersuite_info->id;
2518
2519 /* Compute resumption key
2520 *
2521 * HKDF-Expand-Label( resumption_master_secret,
2522 * "resumption", ticket_nonce, Hash.length )
2523 */
2524 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2525 psa_hash_alg,
2526 session->app_secrets.resumption_master_secret,
2527 hash_length,
2528 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2529 ticket_nonce,
2530 ticket_nonce_size,
2531 session->resumption_key,
2532 hash_length );
2533
2534 if( ret != 0 )
2535 {
2536 MBEDTLS_SSL_DEBUG_RET( 2,
2537 "Creating the ticket-resumed PSK failed",
2538 ret );
2539 return ( ret );
2540 }
2541 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2542 session->resumption_key,
2543 session->resumption_key_len );
2544
2545 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2546 session->app_secrets.resumption_master_secret,
2547 hash_length );
2548
2549 return( 0 );
2550}
2551
2552/* This function creates a NewSessionTicket message in the following format:
2553 *
2554 * struct {
2555 * uint32 ticket_lifetime;
2556 * uint32 ticket_age_add;
2557 * opaque ticket_nonce<0..255>;
2558 * opaque ticket<1..2^16-1>;
2559 * Extension extensions<0..2^16-2>;
2560 * } NewSessionTicket;
2561 *
2562 * The ticket inside the NewSessionTicket message is an encrypted container
2563 * carrying the necessary information so that the server is later able to
2564 * re-start the communication.
2565 *
2566 * The following fields are placed inside the ticket by the
2567 * f_ticket_write() function:
2568 *
2569 * - creation time (start)
2570 * - flags (flags)
2571 * - age add (ticket_age_add)
2572 * - key (key)
2573 * - key length (key_len)
2574 * - ciphersuite (ciphersuite)
2575 */
2576MBEDTLS_CHECK_RETURN_CRITICAL
2577static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2578 unsigned char *buf,
2579 unsigned char *end,
2580 size_t *out_len,
2581 unsigned char *ticket_nonce,
2582 size_t ticket_nonce_size )
2583{
2584 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2585 unsigned char *p = buf;
2586 mbedtls_ssl_session *session = ssl->session;
2587 size_t ticket_len;
2588 uint32_t ticket_lifetime;
2589
2590 *out_len = 0;
2591 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2592
2593 /*
2594 * ticket_lifetime 4 bytes
2595 * ticket_age_add 4 bytes
2596 * ticket_nonce 1 + ticket_nonce_size bytes
2597 * ticket >=2 bytes
2598 */
2599 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2600
2601 /* Generate ticket and ticket_lifetime */
2602 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2603 session,
2604 p + 9 + ticket_nonce_size + 2,
2605 end,
2606 &ticket_len,
2607 &ticket_lifetime);
2608 if( ret != 0 )
2609 {
2610 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2611 return( ret );
2612 }
2613 /* RFC 8446 4.6.1
2614 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2615 * unsigned integer in network byte order from the time of ticket
2616 * issuance. Servers MUST NOT use any value greater than
2617 * 604800 seconds (7 days). The value of zero indicates that the
2618 * ticket should be discarded immediately. Clients MUST NOT cache
2619 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2620 * and MAY delete tickets earlier based on local policy. A server
2621 * MAY treat a ticket as valid for a shorter period of time than what
2622 * is stated in the ticket_lifetime.
2623 */
2624 ticket_lifetime %= 604800;
2625 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2626 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2627 ( unsigned int )ticket_lifetime ) );
2628
2629 /* Write ticket_age_add */
2630 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2631 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2632 ( unsigned int )session->ticket_age_add ) );
2633
2634 /* Write ticket_nonce */
2635 p[8] = ( unsigned char )ticket_nonce_size;
2636 if( ticket_nonce_size > 0 )
2637 {
2638 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2639 }
2640 p += 9 + ticket_nonce_size;
2641
2642 /* Write ticket */
2643 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2644 p += 2;
2645 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2646 p += ticket_len;
2647
2648 /* Ticket Extensions
2649 *
2650 * Note: We currently don't have any extensions.
2651 * Set length to zero.
2652 */
2653 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2654 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2655 p += 2;
2656
2657 *out_len = p - buf;
2658 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2659 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2660
2661 return( 0 );
2662}
2663
2664/*
2665 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2666 */
2667static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2668{
2669 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2670
2671 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2672
2673 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2674 {
2675 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2676 unsigned char *buf;
2677 size_t buf_len, msg_len;
2678
2679 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2680 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2681
2682 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2683 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2684
2685 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2686 ssl, buf, buf + buf_len, &msg_len,
2687 ticket_nonce, sizeof( ticket_nonce ) ) );
2688
Jerry Yue67bef42022-07-07 07:29:42 +00002689 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2690 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002691
2692 mbedtls_ssl_handshake_set_state( ssl,
2693 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002694 }
2695 else
2696 {
2697 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2698 }
2699
Jerry Yue67bef42022-07-07 07:29:42 +00002700cleanup:
2701
2702 return( ret );
2703}
2704#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2705
2706/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002707 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002708 */
Jerry Yu27561932021-08-27 17:07:38 +08002709int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002710{
XiaokangQian08037552022-04-20 07:16:41 +00002711 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002712
2713 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2714 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2715
Jerry Yue3b34122021-09-28 17:53:35 +08002716 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2717 mbedtls_ssl_states_str( ssl->state ),
2718 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002719
XiaokangQian7807f9f2022-02-15 10:04:37 +00002720 switch( ssl->state )
2721 {
2722 /* start state */
2723 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002724 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002725 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002726 break;
2727
XiaokangQian7807f9f2022-02-15 10:04:37 +00002728 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002729 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002730 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002731 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002732 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002733
Jerry Yuf41553b2022-05-09 22:20:30 +08002734 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2735 ret = ssl_tls13_write_hello_retry_request( ssl );
2736 if( ret != 0 )
2737 {
2738 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2739 return( ret );
2740 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002741 break;
2742
Jerry Yu5b64ae92022-03-30 17:15:02 +08002743 case MBEDTLS_SSL_SERVER_HELLO:
2744 ret = ssl_tls13_write_server_hello( ssl );
2745 break;
2746
Xiaofei Baicba64af2022-02-15 10:00:56 +00002747 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002748 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002749 if( ret != 0 )
2750 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002751 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2752 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002753 }
Jerry Yu48330562022-05-06 21:35:44 +08002754 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002755
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002756#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2757 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002758 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002759 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002760
Jerry Yu83da34e2022-04-16 13:59:52 +08002761 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2762 ret = ssl_tls13_write_server_certificate( ssl );
2763 break;
2764
2765 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
2766 ret = ssl_tls13_write_certificate_verify( ssl );
2767 break;
Jerry Yu5a26f302022-05-10 20:46:40 +08002768#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002769
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002770 /*
2771 * Injection of dummy-CCS's for middlebox compatibility
2772 */
2773#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002774 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002775 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2776 if( ret == 0 )
2777 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2778 break;
2779
2780 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
2781 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2782 if( ret == 0 )
2783 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2784 break;
2785#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2786
Jerry Yu69dd8d42022-04-16 12:51:26 +08002787 case MBEDTLS_SSL_SERVER_FINISHED:
2788 ret = ssl_tls13_write_server_finished( ssl );
2789 break;
2790
2791 case MBEDTLS_SSL_CLIENT_FINISHED:
2792 ret = ssl_tls13_process_client_finished( ssl );
2793 break;
2794
Jerry Yu69dd8d42022-04-16 12:51:26 +08002795 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
2796 ret = ssl_tls13_handshake_wrapup( ssl );
2797 break;
2798
XiaokangQian6b916b12022-04-25 07:29:34 +00002799 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2800 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02002801 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00002802 {
Ronald Cron209cae92022-06-07 10:30:19 +02002803 if( ssl->session_negotiate->peer_cert != NULL )
2804 {
2805 mbedtls_ssl_handshake_set_state(
2806 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2807 }
2808 else
Ronald Cron19385882022-06-15 16:26:13 +02002809 {
2810 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02002811 mbedtls_ssl_handshake_set_state(
2812 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002813 }
XiaokangQian6b916b12022-04-25 07:29:34 +00002814 }
2815 break;
2816
2817 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2818 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2819 if( ret == 0 )
2820 {
2821 mbedtls_ssl_handshake_set_state(
2822 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2823 }
2824 break;
2825
Jerry Yue67bef42022-07-07 07:29:42 +00002826#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2827 case MBEDTLS_SSL_NEW_SESSION_TICKET:
2828 ret = ssl_tls13_write_new_session_ticket( ssl );
2829 if( ret != 0 )
2830 {
2831 MBEDTLS_SSL_DEBUG_RET( 1,
2832 "ssl_tls13_write_new_session_ticket ",
2833 ret );
2834 }
2835 break;
2836 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
2837 /* This state is necessary to do the flush of the New Session
2838 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
2839 * as part of ssl_prepare_handshake_step.
2840 */
2841 ret = 0;
2842 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2843 break;
2844
2845#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2846
XiaokangQian7807f9f2022-02-15 10:04:37 +00002847 default:
2848 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00002849 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002850 }
2851
2852 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08002853}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002854
Jerry Yufb4b6472022-01-27 15:03:26 +08002855#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */