blob: a8540808475c91eacb89f16d6d07558ebe82a815 [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:
920 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
921 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
922 return( PSA_ALG_RSA_PKCS1V15_CRYPT );
923 default:
924 return( PSA_ALG_NONE );
925 }
926}
927#endif /* MBEDTLS_USE_PSA_CRYPTO */
928
XiaokangQian23c5be62022-06-07 02:04:34 +0000929/*
XiaokangQianfb665a82022-06-15 03:57:21 +0000930 * Pick best ( private key, certificate chain ) pair based on the signature
931 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +0000932 */
Ronald Cronce7d76e2022-07-08 18:56:49 +0200933MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +0000934static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +0000935{
XiaokangQianfb665a82022-06-15 03:57:21 +0000936 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +0000937 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +0000938
939#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
940 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +0000941 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +0000942 else
943#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +0000944 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +0000945
XiaokangQianfb665a82022-06-15 03:57:21 +0000946 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +0000947 {
948 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
949 return( -1 );
950 }
951
XiaokangQian81802f42022-06-10 13:25:22 +0000952 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +0000953 {
Ronald Cron67ea2542022-09-15 17:34:42 +0200954 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
955 continue;
956
957 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
958 continue;
959
XiaokangQianfb665a82022-06-15 03:57:21 +0000960 for( key_cert = key_cert_list; key_cert != NULL;
961 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +0000962 {
Ronald Cron67ea2542022-09-15 17:34:42 +0200963#if defined(MBEDTLS_USE_PSA_CRYPTO)
964 psa_algorithm_t psa_alg = PSA_ALG_NONE;
965#endif /* MBEDTLS_USE_PSA_CRYPTO */
966
XiaokangQianfb665a82022-06-15 03:57:21 +0000967 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
968 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +0000969
970 /*
971 * This avoids sending the client a cert it'll reject based on
972 * keyUsage or other extensions.
973 */
974 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +0000975 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +0000976 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +0000977 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
978 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +0000979 {
980 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +0000981 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +0000982 continue;
983 }
XiaokangQian23c5be62022-06-07 02:04:34 +0000984
Jerry Yucc539102022-06-27 16:27:35 +0800985 MBEDTLS_SSL_DEBUG_MSG( 3,
986 ( "ssl_tls13_pick_key_cert:"
987 "check signature algorithm %s [%04x]",
988 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
989 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +0200990#if defined(MBEDTLS_USE_PSA_CRYPTO)
991 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
992#endif /* MBEDTLS_USE_PSA_CRYPTO */
993
Jerry Yufb526692022-06-19 11:22:49 +0800994 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +0200995 *sig_alg, &key_cert->cert->pk )
996#if defined(MBEDTLS_USE_PSA_CRYPTO)
997 && psa_alg != PSA_ALG_NONE &&
998 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
999 PSA_KEY_USAGE_SIGN_HASH ) == 1
1000#endif /* MBEDTLS_USE_PSA_CRYPTO */
1001 )
XiaokangQian81802f42022-06-10 13:25:22 +00001002 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001003 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001004 MBEDTLS_SSL_DEBUG_MSG( 3,
1005 ( "ssl_tls13_pick_key_cert:"
1006 "selected signature algorithm"
1007 " %s [%04x]",
1008 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1009 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001010 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001011 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001012 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001013 return( 0 );
1014 }
XiaokangQian81802f42022-06-10 13:25:22 +00001015 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001016 }
1017
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001018 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1019 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001020 return( -1 );
1021}
XiaokangQian81802f42022-06-10 13:25:22 +00001022#endif /* MBEDTLS_X509_CRT_PARSE_C &&
1023 MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001024
XiaokangQian4080a7f2022-04-11 09:55:18 +00001025/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001026 *
1027 * STATE HANDLING: ClientHello
1028 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001029 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001030 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001031 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001032 *
1033 * In this case, the server progresses to sending its ServerHello.
1034 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001035 * 2) The ClientHello was well-formed but didn't match the server's
1036 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001037 *
1038 * For example, the client might not have offered a key share which
1039 * the server supports, or the server might require a cookie.
1040 *
1041 * In this case, the server sends a HelloRetryRequest.
1042 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001043 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001044 *
1045 * In this case, we abort the handshake.
1046 *
1047 */
1048
1049/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001050 * Structure of this message:
1051 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001052 * uint16 ProtocolVersion;
1053 * opaque Random[32];
1054 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001055 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001056 * struct {
1057 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1058 * Random random;
1059 * opaque legacy_session_id<0..32>;
1060 * CipherSuite cipher_suites<2..2^16-2>;
1061 * opaque legacy_compression_methods<1..2^8-1>;
1062 * Extension extensions<8..2^16-1>;
1063 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001064 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001065
1066#define SSL_CLIENT_HELLO_OK 0
1067#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1068
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001069MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001070static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1071 const unsigned char *buf,
1072 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001073{
XiaokangQianb67384d2022-04-19 00:02:38 +00001074 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1075 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001076 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001077 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001078 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001079 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001080 const unsigned char *extensions_end;
Jerry Yu49ca9282022-05-05 11:05:22 +08001081 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001082
Jerry Yu1c105562022-07-10 06:32:38 +00001083#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001084 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001085 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001086 const unsigned char *pre_shared_key_ext_end = NULL;
1087#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001088
1089 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1090
1091 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001092 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001093 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001094 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001095 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001096 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001097 * .. . .. ciphersuite list length ( 2 bytes )
1098 * .. . .. ciphersuite list
1099 * .. . .. compression alg. list length ( 1 byte )
1100 * .. . .. compression alg. list
1101 * .. . .. extensions length ( 2 bytes, optional )
1102 * .. . .. extensions ( optional )
1103 */
1104
XiaokangQianb67384d2022-04-19 00:02:38 +00001105 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001106 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001107 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1108 * read at least up to session id length without worrying.
1109 */
1110 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1111
1112 /* ...
1113 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1114 * ...
1115 * with ProtocolVersion defined as:
1116 * uint16 ProtocolVersion;
1117 */
XiaokangQiande333912022-04-20 08:49:42 +00001118 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1119 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001120 {
1121 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1122 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1123 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001124 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001125 }
1126 p += 2;
1127
1128 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001129 * Only support TLS 1.3 currently, temporarily set the version.
1130 */
XiaokangQiande333912022-04-20 08:49:42 +00001131 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001132
Jerry Yue67bef42022-07-07 07:29:42 +00001133#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1134 /* Store minor version for later use with ticket serialization. */
1135 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001136 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001137#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001138
Jerry Yuc1be19f2022-04-23 16:11:39 +08001139 /* ...
1140 * Random random;
1141 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001142 * with Random defined as:
1143 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001144 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001145 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001146 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001147
XiaokangQian08037552022-04-20 07:16:41 +00001148 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
1149 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001150
Jerry Yuc1be19f2022-04-23 16:11:39 +08001151 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001152 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001153 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001154 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001155 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001156 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001157
XiaokangQianb67384d2022-04-19 00:02:38 +00001158 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001159 {
1160 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1161 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1162 }
1163
XiaokangQian4080a7f2022-04-11 09:55:18 +00001164 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001165 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001166 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001167 /*
1168 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001169 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001170 */
1171 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001172
XiaokangQianed582dd2022-04-13 08:21:05 +00001173 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001174 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001175
XiaokangQian7807f9f2022-02-15 10:04:37 +00001176 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1177 p += 2;
1178
XiaokangQianb67384d2022-04-19 00:02:38 +00001179 /* Check we have enough data for the ciphersuite list, the legacy
1180 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001181 *
1182 * cipher_suites cipher_suites_len bytes
1183 * legacy_compression_methods 2 bytes
1184 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001185 */
1186 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001187
Jerry Yu24b8c812022-08-20 19:06:56 +08001188 /* ...
1189 * CipherSuite cipher_suites<2..2^16-2>;
1190 * ...
1191 * with CipherSuite defined as:
1192 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001193 */
Jerry Yu5725f1c2022-08-21 17:27:16 +08001194#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001195 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001196#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001197 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001198 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1199 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001200
1201 /*
1202 * Search for a matching ciphersuite
1203 */
XiaokangQian060d8672022-04-21 09:24:56 +00001204 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001205 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001206 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001207 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001208
XiaokangQiane8ff3502022-04-22 02:34:40 +00001209 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001210
XiaokangQiane8ff3502022-04-22 02:34:40 +00001211 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001212 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001213 ssl,cipher_suite );
1214 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001215 continue;
1216
Jerry Yu5725f1c2022-08-21 17:27:16 +08001217 ssl->session_negotiate->ciphersuite = cipher_suite;
1218 ssl->handshake->ciphersuite_info = ciphersuite_info;
1219 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001220 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001221 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001222 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001223
1224 if( ssl->handshake->ciphersuite_info == NULL )
1225 {
1226 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1227 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1228 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1229 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001230
XiaokangQian4080a7f2022-04-11 09:55:18 +00001231 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001232 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001233 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001234 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001235 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001236 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001237 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1238 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1239 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1240 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001241 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001242 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001243
Jerry Yuc1be19f2022-04-23 16:11:39 +08001244 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001245 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001246 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001247 * with Extension defined as:
1248 * struct {
1249 * ExtensionType extension_type;
1250 * opaque extension_data<0..2^16-1>;
1251 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001252 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001253 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001254 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001255 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001256 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001257
XiaokangQian4080a7f2022-04-11 09:55:18 +00001258 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001259
1260 while( p < extensions_end )
1261 {
1262 unsigned int extension_type;
1263 size_t extension_data_len;
1264 const unsigned char *extension_data_end;
1265
Jerry Yu1c9247c2022-07-21 12:37:39 +08001266 /* RFC 8446, page 57
1267 *
1268 * The "pre_shared_key" extension MUST be the last extension in the
1269 * ClientHello (this facilitates implementation as described below).
1270 * Servers MUST check that it is the last extension and otherwise fail
1271 * the handshake with an "illegal_parameter" alert.
1272 */
1273 if( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY )
1274 {
1275 MBEDTLS_SSL_DEBUG_MSG(
1276 3, ( "pre_shared_key is not last extension." ) );
1277 MBEDTLS_SSL_PEND_FATAL_ALERT(
1278 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1279 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1280 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1281 }
1282
XiaokangQian318dc762022-04-20 09:43:51 +00001283 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001284 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1285 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1286 p += 4;
1287
1288 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1289 extension_data_end = p + extension_data_len;
1290
1291 switch( extension_type )
1292 {
XiaokangQian40a35232022-05-07 09:02:40 +00001293#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1294 case MBEDTLS_TLS_EXT_SERVERNAME:
1295 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001296 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1297 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001298 if( ret != 0 )
1299 {
1300 MBEDTLS_SSL_DEBUG_RET(
1301 1, "mbedtls_ssl_parse_servername_ext", ret );
1302 return( ret );
1303 }
1304 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SERVERNAME;
1305 break;
1306#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1307
XiaokangQianb67384d2022-04-19 00:02:38 +00001308#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001309 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1310 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1311
1312 /* Supported Groups Extension
1313 *
1314 * When sent by the client, the "supported_groups" extension
1315 * indicates the named groups which the client supports,
1316 * ordered from most preferred to least preferred.
1317 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001318 ret = ssl_tls13_parse_supported_groups_ext(
1319 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001320 if( ret != 0 )
1321 {
1322 MBEDTLS_SSL_DEBUG_RET( 1,
1323 "mbedtls_ssl_parse_supported_groups_ext", ret );
1324 return( ret );
1325 }
1326
1327 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
1328 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001329#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001330
XiaokangQian88408882022-04-02 10:15:03 +00001331#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001332 case MBEDTLS_TLS_EXT_KEY_SHARE:
1333 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1334
1335 /*
1336 * Key Share Extension
1337 *
1338 * When sent by the client, the "key_share" extension
1339 * contains the endpoint's cryptographic parameters for
1340 * ECDHE/DHE key establishment methods.
1341 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001342 ret = ssl_tls13_parse_key_shares_ext(
1343 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001344 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001345 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001346 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001347 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001348 }
1349
Jerry Yu582dd062022-04-22 21:59:01 +08001350 if( ret < 0 )
1351 {
1352 MBEDTLS_SSL_DEBUG_RET(
1353 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001354 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001355 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001356
1357 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
1358 break;
XiaokangQian88408882022-04-02 10:15:03 +00001359#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001360
1361 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1362 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1363
1364 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001365 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001366 if( ret != 0 )
1367 {
1368 MBEDTLS_SSL_DEBUG_RET( 1,
1369 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1370 return( ret );
1371 }
1372 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
1373 break;
1374
Jerry Yue19e3b92022-07-08 12:04:51 +00001375#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1376 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1377 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1378
1379 ret = ssl_tls13_parse_key_exchange_modes_ext(
1380 ssl, p, extension_data_end );
1381 if( ret != 0 )
1382 {
1383 MBEDTLS_SSL_DEBUG_RET(
1384 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1385 return( ret );
1386 }
1387
1388 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
1389 break;
1390#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1391
Jerry Yu1c105562022-07-10 06:32:38 +00001392 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1393 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001394 if( ( ssl->handshake->extensions_present &
1395 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) == 0 )
1396 {
1397 MBEDTLS_SSL_PEND_FATAL_ALERT(
1398 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1399 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1400 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1401 }
Jerry Yu1c9247c2022-07-21 12:37:39 +08001402#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001403 /* Delay processing of the PSK identity once we have
1404 * found out which algorithms to use. We keep a pointer
1405 * to the buffer and the size for later processing.
1406 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001407 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001408 pre_shared_key_ext_end = extension_data_end;
Jerry Yu1c9247c2022-07-21 12:37:39 +08001409#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001410 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1411 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001412
XiaokangQianacb39922022-06-17 10:18:48 +00001413#if defined(MBEDTLS_SSL_ALPN)
1414 case MBEDTLS_TLS_EXT_ALPN:
1415 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1416
1417 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1418 if( ret != 0 )
1419 {
1420 MBEDTLS_SSL_DEBUG_RET(
1421 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1422 return( ret );
1423 }
1424 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_ALPN;
1425 break;
1426#endif /* MBEDTLS_SSL_ALPN */
1427
XiaokangQian7807f9f2022-02-15 10:04:37 +00001428#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1429 case MBEDTLS_TLS_EXT_SIG_ALG:
1430 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1431
Gabor Mezei078e8032022-04-27 21:17:56 +02001432 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001433 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001434 if( ret != 0 )
1435 {
1436 MBEDTLS_SSL_DEBUG_MSG( 1,
1437 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1438 ret ) );
1439 return( ret );
1440 }
1441 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
1442 break;
1443#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1444
1445 default:
1446 MBEDTLS_SSL_DEBUG_MSG( 3,
1447 ( "unknown extension found: %ud ( ignoring )",
1448 extension_type ) );
1449 }
1450
1451 p += extension_data_len;
1452 }
1453
Jerry Yu1c105562022-07-10 06:32:38 +00001454#if defined(MBEDTLS_DEBUG_C)
1455 /* List all the extensions we have received */
1456 ssl_tls13_debug_print_client_hello_exts( ssl );
1457#endif /* MBEDTLS_DEBUG_C */
1458
1459 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1460 MBEDTLS_SSL_HS_CLIENT_HELLO,
1461 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001462
Jerry Yu1c105562022-07-10 06:32:38 +00001463#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001464 /* Update checksum with either
1465 * - The entire content of the CH message, if no PSK extension is present
1466 * - The content up to but excluding the PSK extension, if present.
1467 */
Jerry Yu1c105562022-07-10 06:32:38 +00001468 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001469 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001470 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yuba9b6e92022-07-22 21:35:18 +08001471 ( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001472 {
1473 ssl->handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001474 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001475 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001476 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001477 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001478 cipher_suites,
1479 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001480 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001481 {
1482 ssl->handshake->extensions_present &= ~MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001483 }
1484 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001485 {
Jerry Yubb852022022-07-20 21:10:44 +08001486 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_tls13_parse_pre_shared_key_ext" ),
Jerry Yu1c105562022-07-10 06:32:38 +00001487 ret );
1488 return( ret );
1489 }
Jerry Yu1c105562022-07-10 06:32:38 +00001490 }
1491 else
1492#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1493 {
1494 ssl->handshake->update_checksum( ssl, buf, p - buf );
1495 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001496
Jerry Yuba9b6e92022-07-22 21:35:18 +08001497 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1498 if( ret < 0 )
1499 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001500
Jerry Yue5834fd2022-08-29 20:16:09 +08001501 mbedtls_ssl_optimize_checksum( ssl, ssl->handshake->ciphersuite_info );
1502
XiaokangQian75fe8c72022-06-15 09:42:45 +00001503 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1504}
1505
1506/* Update the handshake state machine */
1507
Ronald Cronce7d76e2022-07-08 18:56:49 +02001508MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001509static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1510{
1511 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1512
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001514 * Server certificate selection
1515 */
1516 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1517 {
1518 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1519 return( ret );
1520 }
1521#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1522 ssl->handshake->sni_name = NULL;
1523 ssl->handshake->sni_name_len = 0;
1524#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001525
XiaokangQian7807f9f2022-02-15 10:04:37 +00001526 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1527 if( ret != 0 )
1528 {
1529 MBEDTLS_SSL_DEBUG_RET( 1,
1530 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1531 return( ret );
1532 }
1533
XiaokangQian7807f9f2022-02-15 10:04:37 +00001534 return( 0 );
1535
1536}
1537
1538/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001539 * Main entry point from the state machine; orchestrates the otherfunctions.
1540 */
1541
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001542MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001543static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1544{
1545
XiaokangQian08037552022-04-20 07:16:41 +00001546 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001547 unsigned char* buf = NULL;
1548 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001549 int parse_client_hello_ret;
1550
XiaokangQianed582dd2022-04-13 08:21:05 +00001551 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1552
XiaokangQianed582dd2022-04-13 08:21:05 +00001553 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1554 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1555 &buf, &buflen ) );
1556
1557 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1558 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001559 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1560 * only SSL_CLIENT_HELLO_OK or
1561 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1562 * stage as negative error codes are handled
1563 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001564
XiaokangQiancfd925f2022-04-14 07:10:37 +00001565 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001566
Jerry Yu4ca91402022-05-09 15:50:57 +08001567 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1568 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1569 else
1570 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001571
1572cleanup:
1573
1574 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1575 return( ret );
1576}
1577
1578/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001579 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001580 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001581MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001582static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1583{
Jerry Yu637a3f12022-04-20 21:37:58 +08001584 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1585 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001586 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001587 if( ssl->conf->f_rng == NULL )
1588 {
1589 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1590 return( MBEDTLS_ERR_SSL_NO_RNG );
1591 }
1592
Jerry Yu637a3f12022-04-20 21:37:58 +08001593 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001594 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1595 {
1596 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1597 return( ret );
1598 }
1599
Jerry Yu637a3f12022-04-20 21:37:58 +08001600 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001601 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1602
1603#if defined(MBEDTLS_HAVE_TIME)
1604 ssl->session_negotiate->start = time( NULL );
1605#endif /* MBEDTLS_HAVE_TIME */
1606
1607 return( ret );
1608}
1609
Jerry Yu3bf2c642022-03-30 22:02:12 +08001610/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001611 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001612 *
1613 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001614 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001615 * } SupportedVersions;
1616 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001617MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001618static int ssl_tls13_write_server_hello_supported_versions_ext(
1619 mbedtls_ssl_context *ssl,
1620 unsigned char *buf,
1621 unsigned char *end,
1622 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001623{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001624 *out_len = 0;
1625
Jerry Yu955ddd72022-04-22 22:27:33 +08001626 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001627
1628 /* Check if we have space to write the extension:
1629 * - extension_type (2 bytes)
1630 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001631 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001632 */
Jerry Yu349a6132022-04-14 20:52:56 +08001633 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001634
Jerry Yu349a6132022-04-14 20:52:56 +08001635 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001636
Jerry Yu349a6132022-04-14 20:52:56 +08001637 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001638
Jerry Yu349a6132022-04-14 20:52:56 +08001639 mbedtls_ssl_write_version( buf + 4,
1640 ssl->conf->transport,
1641 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001642
1643 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1644 ssl->tls_version ) );
1645
Jerry Yu349a6132022-04-14 20:52:56 +08001646 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001647
1648 return( 0 );
1649}
1650
Jerry Yud9436a12022-04-20 22:28:09 +08001651
Jerry Yu3bf2c642022-03-30 22:02:12 +08001652
1653/* Generate and export a single key share. For hybrid KEMs, this can
1654 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001655MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001656static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1657 uint16_t named_group,
1658 unsigned char *buf,
1659 unsigned char *end,
1660 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001661{
1662 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001663
1664 *out_len = 0;
1665
Jerry Yu89e103c2022-03-30 22:43:29 +08001666#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001667 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1668 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001669 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1670 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001671 if( ret != 0 )
1672 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001673 MBEDTLS_SSL_DEBUG_RET(
1674 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1675 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001676 return( ret );
1677 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001678 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001679 else
1680#endif /* MBEDTLS_ECDH_C */
1681 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001682 {
1683 }
1684 else
1685 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001686 ((void) ssl);
1687 ((void) named_group);
1688 ((void) buf);
1689 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001690 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1691 }
1692
1693 return( ret );
1694}
1695
1696/*
1697 * ssl_tls13_write_key_share_ext
1698 *
1699 * Structure of key_share extension in ServerHello:
1700 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001701 * struct {
1702 * NamedGroup group;
1703 * opaque key_exchange<1..2^16-1>;
1704 * } KeyShareEntry;
1705 * struct {
1706 * KeyShareEntry server_share;
1707 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001708 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001709MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001710static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1711 unsigned char *buf,
1712 unsigned char *end,
1713 size_t *out_len )
1714{
Jerry Yu955ddd72022-04-22 22:27:33 +08001715 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001716 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001717 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001718 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001719 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001720
1721 *out_len = 0;
1722
1723 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1724
Jerry Yu58af2332022-09-06 11:19:31 +08001725 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1726 mbedtls_ssl_named_group_to_str( group ),
1727 group ) );
1728
Jerry Yu3bf2c642022-03-30 22:02:12 +08001729 /* Check if we have space for header and length fields:
1730 * - extension_type (2 bytes)
1731 * - extension_data_length (2 bytes)
1732 * - group (2 bytes)
1733 * - key_exchange_length (2 bytes)
1734 */
1735 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001736 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1737 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001738 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001739
Jerry Yu3bf2c642022-03-30 22:02:12 +08001740 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1741 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001742 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001743 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001744 if( ret != 0 )
1745 return( ret );
1746 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001747
Jerry Yu955ddd72022-04-22 22:27:33 +08001748 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001749
Jerry Yu57d48412022-04-20 21:50:42 +08001750 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001751
Jerry Yu57d48412022-04-20 21:50:42 +08001752 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001753
Jerry Yu3bf2c642022-03-30 22:02:12 +08001754 return( 0 );
1755}
Jerry Yud9436a12022-04-20 22:28:09 +08001756
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001757MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001758static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1759 unsigned char *buf,
1760 unsigned char *end,
1761 size_t *out_len )
1762{
1763 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1764 /* key_share Extension
1765 *
1766 * struct {
1767 * select (Handshake.msg_type) {
1768 * ...
1769 * case hello_retry_request:
1770 * NamedGroup selected_group;
1771 * ...
1772 * };
1773 * } KeyShare;
1774 */
1775
1776 *out_len = 0;
1777
Jerry Yub0ac10b2022-05-05 11:10:08 +08001778 /*
1779 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1780 * of the HRR is then to transmit a cookie to force the client to demonstrate
1781 * reachability at their apparent network address (primarily useful for DTLS).
1782 */
Ronald Cron79907712022-07-20 17:05:29 +02001783 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001784 return( 0 );
1785
1786 /* We should only send the key_share extension if the client's initial
1787 * key share was not acceptable. */
1788 if( ssl->handshake->offered_group_id != 0 )
1789 {
1790 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
1791 return( 0 );
1792 }
1793
1794 if( selected_group == 0 )
1795 {
1796 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
1797 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1798 }
1799
Jerry Yub0ac10b2022-05-05 11:10:08 +08001800 /* Check if we have enough space:
1801 * - extension_type (2 bytes)
1802 * - extension_data_length (2 bytes)
1803 * - selected_group (2 bytes)
1804 */
Ronald Cron154d1b62022-06-01 15:33:26 +02001805 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001806
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001807 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001808 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001809 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
1810
1811 MBEDTLS_SSL_DEBUG_MSG( 3,
1812 ( "HRR selected_group: %s (%x)",
1813 mbedtls_ssl_named_group_to_str( selected_group ),
1814 selected_group ) );
1815
1816 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001817
Jerry Yub0ac10b2022-05-05 11:10:08 +08001818 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001819}
Jerry Yu3bf2c642022-03-30 22:02:12 +08001820
1821/*
1822 * Structure of ServerHello message:
1823 *
1824 * struct {
1825 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1826 * Random random;
1827 * opaque legacy_session_id_echo<0..32>;
1828 * CipherSuite cipher_suite;
1829 * uint8 legacy_compression_method = 0;
1830 * Extension extensions<6..2^16-1>;
1831 * } ServerHello;
1832 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001833MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001834static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08001835 unsigned char *buf,
1836 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001837 size_t *out_len,
1838 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08001839{
Jerry Yu955ddd72022-04-22 22:27:33 +08001840 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001841 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001842 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08001843 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001844
1845 *out_len = 0;
1846
Jerry Yucfc04b32022-04-21 09:31:58 +08001847 /* ...
1848 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1849 * ...
1850 * with ProtocolVersion defined as:
1851 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001852 */
1853 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1854 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
1855 p += 2;
1856
Jerry Yu1c3e6882022-04-20 21:23:40 +08001857 /* ...
1858 * Random random;
1859 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001860 * with Random defined as:
1861 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001862 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001863 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001864 if( is_hrr )
1865 {
1866 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08001867 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001868 }
1869 else
1870 {
1871 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08001872 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001873 }
Jerry Yu955ddd72022-04-22 22:27:33 +08001874 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08001875 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1876 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
1877
Jerry Yucfc04b32022-04-21 09:31:58 +08001878 /* ...
1879 * opaque legacy_session_id_echo<0..32>;
1880 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08001881 */
1882 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
1883 *p++ = (unsigned char)ssl->session_negotiate->id_len;
1884 if( ssl->session_negotiate->id_len > 0 )
1885 {
1886 memcpy( p, &ssl->session_negotiate->id[0],
1887 ssl->session_negotiate->id_len );
1888 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08001889
Jerry Yu3bf2c642022-03-30 22:02:12 +08001890 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
1891 ssl->session_negotiate->id_len );
1892 }
1893
Jerry Yucfc04b32022-04-21 09:31:58 +08001894 /* ...
1895 * CipherSuite cipher_suite;
1896 * ...
1897 * with CipherSuite defined as:
1898 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08001899 */
1900 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1901 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
1902 p += 2;
1903 MBEDTLS_SSL_DEBUG_MSG( 3,
1904 ( "server hello, chosen ciphersuite: %s ( id=%d )",
1905 mbedtls_ssl_get_ciphersuite_name(
1906 ssl->session_negotiate->ciphersuite ),
1907 ssl->session_negotiate->ciphersuite ) );
1908
Jerry Yucfc04b32022-04-21 09:31:58 +08001909 /* ...
1910 * uint8 legacy_compression_method = 0;
1911 * ...
1912 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001913 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001914 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001915
Jerry Yucfc04b32022-04-21 09:31:58 +08001916 /* ...
1917 * Extension extensions<6..2^16-1>;
1918 * ...
1919 * struct {
1920 * ExtensionType extension_type; (2 bytes)
1921 * opaque extension_data<0..2^16-1>;
1922 * } Extension;
1923 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001924 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08001925 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001926 p += 2;
1927
Jerry Yue74e04a2022-04-21 09:23:16 +08001928 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08001929 ssl, p, end, &output_len ) ) != 0 )
1930 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001931 MBEDTLS_SSL_DEBUG_RET(
1932 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001933 return( ret );
1934 }
1935 p += output_len;
1936
Jerry Yu56acc942022-07-30 23:02:36 +08001937 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001938 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001939 if( is_hrr )
1940 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
1941 else
1942 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001943 if( ret != 0 )
1944 return( ret );
1945 p += output_len;
1946 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001947
Jerry Yu032b15ce2022-07-11 06:10:03 +00001948#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yu96a2e362022-07-21 15:11:34 +08001949 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00001950 {
Jerry Yubb852022022-07-20 21:10:44 +08001951 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001952 if( ret != 0 )
1953 {
Jerry Yubb852022022-07-20 21:10:44 +08001954 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00001955 ret );
1956 return( ret );
1957 }
1958 p += output_len;
1959 }
1960#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1961
Jerry Yud9436a12022-04-20 22:28:09 +08001962 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001963
Jerry Yud9436a12022-04-20 22:28:09 +08001964 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
1965 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001966
Jerry Yud9436a12022-04-20 22:28:09 +08001967 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001968
Jerry Yud9436a12022-04-20 22:28:09 +08001969 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001970
1971 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08001972}
1973
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001974MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08001975static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
1976{
1977 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08001978 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08001979 if( ret != 0 )
1980 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001981 MBEDTLS_SSL_DEBUG_RET( 1,
1982 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08001983 ret );
1984 return( ret );
1985 }
1986
Jerry Yue110d252022-05-05 10:19:22 +08001987 return( ret );
1988}
1989
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001990MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08001991static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
1992{
Jerry Yu637a3f12022-04-20 21:37:58 +08001993 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001994 unsigned char *buf;
1995 size_t buf_len, msg_len;
1996
1997 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
1998
Jerry Yuf4b27e42022-03-30 17:32:21 +08001999 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2000
Jerry Yu3bf2c642022-03-30 22:02:12 +08002001 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002002 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2003
Jerry Yu3bf2c642022-03-30 22:02:12 +08002004 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2005 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002006 &msg_len,
2007 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002008
Jerry Yu3bf2c642022-03-30 22:02:12 +08002009 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002010 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2011
Jerry Yu3bf2c642022-03-30 22:02:12 +08002012 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002013 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002014
Jerry Yue110d252022-05-05 10:19:22 +08002015 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2016
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002017#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2018 /* The server sends a dummy change_cipher_spec record immediately
2019 * after its first handshake message. This may either be after
2020 * a ServerHello or a HelloRetryRequest.
2021 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002022 mbedtls_ssl_handshake_set_state(
2023 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002024#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002025 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002026#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002027
Jerry Yuf4b27e42022-03-30 17:32:21 +08002028cleanup:
2029
2030 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2031 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002032}
2033
Jerry Yu23d1a252022-05-12 18:08:59 +08002034
2035/*
2036 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2037 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002038MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002039static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002040{
2041 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2042 if( ssl->handshake->hello_retry_request_count > 0 )
2043 {
2044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2045 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2046 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2047 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2048 }
2049
2050 /*
2051 * Create stateless transcript hash for HRR
2052 */
2053 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2054 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2055 if( ret != 0 )
2056 {
2057 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2058 return( ret );
2059 }
2060 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2061
2062 return( 0 );
2063}
2064
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002065MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002066static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2067{
2068 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2069 unsigned char *buf;
2070 size_t buf_len, msg_len;
2071
2072 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2073
Ronald Cron7b840462022-06-01 17:05:53 +02002074 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002075
2076 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2077 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2078 &buf, &buf_len ) );
2079
2080 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2081 buf + buf_len,
2082 &msg_len,
2083 1 ) );
2084 mbedtls_ssl_add_hs_msg_to_checksum(
2085 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2086
2087
2088 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2089 msg_len ) );
2090
2091 ssl->handshake->hello_retry_request_count++;
2092
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002093#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2094 /* The server sends a dummy change_cipher_spec record immediately
2095 * after its first handshake message. This may either be after
2096 * a ServerHello or a HelloRetryRequest.
2097 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002098 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002099 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002100#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002101 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002102#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002103
2104cleanup:
2105 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2106 return( ret );
2107}
2108
Jerry Yu5b64ae92022-03-30 17:15:02 +08002109/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002110 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2111 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002112
2113/*
2114 * struct {
2115 * Extension extensions<0..2 ^ 16 - 1>;
2116 * } EncryptedExtensions;
2117 *
2118 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002119MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002120static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2121 unsigned char *buf,
2122 unsigned char *end,
2123 size_t *out_len )
2124{
XiaokangQianacb39922022-06-17 10:18:48 +00002125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002126 unsigned char *p = buf;
2127 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002128 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002129 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002130
Jerry Yu4d3841a2022-04-16 12:37:19 +08002131 *out_len = 0;
2132
2133 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002134 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002135 p += 2;
2136
Jerry Yu8937eb42022-05-03 12:12:14 +08002137 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002138 ((void) ret);
2139 ((void) output_len);
2140
2141#if defined(MBEDTLS_SSL_ALPN)
2142 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2143 if( ret != 0 )
2144 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002145 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002146#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002147
Jerry Yu8937eb42022-05-03 12:12:14 +08002148 extensions_len = ( p - p_extensions_len ) - 2;
2149 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2150
2151 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002152
2153 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2154
2155 return( 0 );
2156}
2157
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002158MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002159static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2160{
2161 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2162 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002163 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002164
Gabor Mezei54719122022-06-28 11:34:56 +02002165 mbedtls_ssl_set_outbound_transform( ssl,
2166 ssl->handshake->transform_handshake );
2167 MBEDTLS_SSL_DEBUG_MSG(
2168 3, ( "switching to handshake transform for outbound data" ) );
2169
Jerry Yuab452cc2022-04-28 15:27:08 +08002170 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002171
Jerry Yu4d3841a2022-04-16 12:37:19 +08002172 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2173 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2174
2175 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2176 ssl, buf, buf + buf_len, &msg_len ) );
2177
2178 mbedtls_ssl_add_hs_msg_to_checksum(
2179 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2180
Jerry Yu4d3841a2022-04-16 12:37:19 +08002181 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2182 ssl, buf_len, msg_len ) );
2183
Jerry Yu8937eb42022-05-03 12:12:14 +08002184#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002185 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002186 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2187 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002188 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002189#else
2190 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2191#endif
2192
Jerry Yu4d3841a2022-04-16 12:37:19 +08002193cleanup:
2194
Jerry Yuab452cc2022-04-28 15:27:08 +08002195 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002196 return( ret );
2197}
2198
XiaokangQiancec9ae62022-05-06 07:28:50 +00002199#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002200#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2201#define SSL_CERTIFICATE_REQUEST_SKIP 1
2202/* Coordination:
2203 * Check whether a CertificateRequest message should be written.
2204 * Returns a negative code on failure, or
2205 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2206 * - SSL_CERTIFICATE_REQUEST_SKIP
2207 * indicating if the writing of the CertificateRequest
2208 * should be skipped or not.
2209 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002210MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002211static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2212{
2213 int authmode;
2214
XiaokangQian40a35232022-05-07 09:02:40 +00002215#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2216 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2217 authmode = ssl->handshake->sni_authmode;
2218 else
2219#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002220 authmode = ssl->conf->authmode;
2221
2222 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
2223 return( SSL_CERTIFICATE_REQUEST_SKIP );
2224
XiaokangQianc3017f62022-05-13 05:55:41 +00002225 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002226
XiaokangQiana987e1d2022-05-07 01:25:58 +00002227 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2228}
2229
XiaokangQiancec9ae62022-05-06 07:28:50 +00002230/*
2231 * struct {
2232 * opaque certificate_request_context<0..2^8-1>;
2233 * Extension extensions<2..2^16-1>;
2234 * } CertificateRequest;
2235 *
2236 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002237MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002238static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2239 unsigned char *buf,
2240 const unsigned char *end,
2241 size_t *out_len )
2242{
2243 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2244 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002245 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002246 unsigned char *p_extensions_len;
2247
2248 *out_len = 0;
2249
2250 /* Check if we have enough space:
2251 * - certificate_request_context (1 byte)
2252 * - extensions length (2 bytes)
2253 */
2254 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2255
2256 /*
2257 * Write certificate_request_context
2258 */
2259 /*
2260 * We use a zero length context for the normal handshake
2261 * messages. For post-authentication handshake messages
2262 * this request context would be set to a non-zero value.
2263 */
2264 *p++ = 0x0;
2265
2266 /*
2267 * Write extensions
2268 */
2269 /* The extensions must contain the signature_algorithms. */
2270 p_extensions_len = p;
2271 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002272 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002273 if( ret != 0 )
2274 return( ret );
2275
XiaokangQianec6efb92022-05-06 09:53:10 +00002276 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002277 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002278
2279 *out_len = p - buf;
2280
2281 return( 0 );
2282}
2283
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002284MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002285static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2286{
2287 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2288
2289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2290
2291 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2292
2293 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2294 {
2295 unsigned char *buf;
2296 size_t buf_len, msg_len;
2297
2298 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2299 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2300
2301 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2302 ssl, buf, buf + buf_len, &msg_len ) );
2303
2304 mbedtls_ssl_add_hs_msg_to_checksum(
2305 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2306
2307 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2308 ssl, buf_len, msg_len ) );
2309 }
2310 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2311 {
2312 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2313 ret = 0;
2314 }
2315 else
2316 {
2317 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2318 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2319 goto cleanup;
2320 }
2321
2322 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2323cleanup:
2324
2325 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2326 return( ret );
2327}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002328
Jerry Yu4d3841a2022-04-16 12:37:19 +08002329/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002330 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002331 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002332MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002333static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002334{
Jerry Yu5a26f302022-05-10 20:46:40 +08002335 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002336
2337#if defined(MBEDTLS_X509_CRT_PARSE_C)
2338 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2339 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002340 {
Jerry Yub89125b2022-05-13 15:45:49 +08002341 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002342 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2343 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002344 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002345 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002346#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002347
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002348 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2349 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002350 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002351 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2352 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002353}
2354
2355/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002356 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002357 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002358MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002359static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002360{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002361 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002362 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002363 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002364 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2365 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002366}
Jerry Yu5a26f302022-05-10 20:46:40 +08002367#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002368
2369/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002370 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002371 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002372MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002373static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002374{
Jerry Yud6e253d2022-05-18 13:59:24 +08002375 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002376
2377 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2378 if( ret != 0 )
2379 return( ret );
2380
Jerry Yue3d67cb2022-05-19 15:33:10 +08002381 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2382 if( ret != 0 )
2383 {
2384 MBEDTLS_SSL_PEND_FATAL_ALERT(
2385 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2386 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2387 return( ret );
2388 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002389
Ronald Cron63dc4632022-05-31 14:41:53 +02002390 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2391 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002392
Ronald Cron63dc4632022-05-31 14:41:53 +02002393 if( ssl->handshake->certificate_request_sent )
2394 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002395 else
Ronald Cron19385882022-06-15 16:26:13 +02002396 {
2397 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002399 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002400 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002401
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002402 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002403}
2404
2405/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002406 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002407 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002408MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002409static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002410{
Jerry Yud6e253d2022-05-18 13:59:24 +08002411 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2412
Jerry Yuff226982022-04-16 16:52:57 +08002413 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2414 if( ret != 0 )
2415 return( ret );
2416
Jerry Yue3d67cb2022-05-19 15:33:10 +08002417 ret = mbedtls_ssl_tls13_generate_resumption_master_secret( ssl );
2418 if( ret != 0 )
2419 {
2420 MBEDTLS_SSL_DEBUG_RET( 1,
2421 "mbedtls_ssl_tls13_generate_resumption_master_secret ", ret );
2422 }
2423
Jerry Yu03ed50b2022-04-16 17:13:30 +08002424 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002425 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002426}
2427
2428/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002429 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002430 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002431MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002432static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002433{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002434 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2435
Jerry Yu03ed50b2022-04-16 17:13:30 +08002436 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002437
2438#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002439 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2440#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002441 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002442#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002443 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002444}
2445
2446/*
Jerry Yue67bef42022-07-07 07:29:42 +00002447 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2448 */
2449#define SSL_NEW_SESSION_TICKET_SKIP 0
2450#define SSL_NEW_SESSION_TICKET_WRITE 1
2451MBEDTLS_CHECK_RETURN_CRITICAL
2452static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2453{
2454 /* Check whether the use of session tickets is enabled */
2455 if( ssl->conf->f_ticket_write == NULL )
2456 {
2457 MBEDTLS_SSL_DEBUG_MSG( 2, ( "new session ticket is not enabled" ) );
2458 return( SSL_NEW_SESSION_TICKET_SKIP );
2459 }
2460
Jerry Yue67bef42022-07-07 07:29:42 +00002461 return( SSL_NEW_SESSION_TICKET_WRITE );
2462}
2463
2464#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2465MBEDTLS_CHECK_RETURN_CRITICAL
2466static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2467 unsigned char *ticket_nonce,
2468 size_t ticket_nonce_size )
2469{
2470 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2471 mbedtls_ssl_session *session = ssl->session;
2472 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2473 psa_algorithm_t psa_hash_alg;
2474 int hash_length;
2475
2476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2477
2478#if defined(MBEDTLS_HAVE_TIME)
2479 session->start = mbedtls_time( NULL );
2480#endif
2481
2482 /* Generate ticket_age_add */
2483 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002484 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002485 sizeof( session->ticket_age_add ) ) != 0 ) )
2486 {
2487 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2488 return( ret );
2489 }
2490 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002491 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002492
2493 /* Generate ticket_nonce */
2494 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2495 if( ret != 0 )
2496 {
2497 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2498 return( ret );
2499 }
2500 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2501 ticket_nonce, ticket_nonce_size );
2502
2503 ciphersuite_info =
2504 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2505 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2506 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002507 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002508 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002509 {
Jerry Yue67bef42022-07-07 07:29:42 +00002510 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002511 }
2512
Jerry Yue67bef42022-07-07 07:29:42 +00002513 /* In this code the psk key length equals the length of the hash */
2514 session->resumption_key_len = hash_length;
2515 session->ciphersuite = ciphersuite_info->id;
2516
2517 /* Compute resumption key
2518 *
2519 * HKDF-Expand-Label( resumption_master_secret,
2520 * "resumption", ticket_nonce, Hash.length )
2521 */
2522 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2523 psa_hash_alg,
2524 session->app_secrets.resumption_master_secret,
2525 hash_length,
2526 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2527 ticket_nonce,
2528 ticket_nonce_size,
2529 session->resumption_key,
2530 hash_length );
2531
2532 if( ret != 0 )
2533 {
2534 MBEDTLS_SSL_DEBUG_RET( 2,
2535 "Creating the ticket-resumed PSK failed",
2536 ret );
2537 return ( ret );
2538 }
2539 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2540 session->resumption_key,
2541 session->resumption_key_len );
2542
2543 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2544 session->app_secrets.resumption_master_secret,
2545 hash_length );
2546
2547 return( 0 );
2548}
2549
2550/* This function creates a NewSessionTicket message in the following format:
2551 *
2552 * struct {
2553 * uint32 ticket_lifetime;
2554 * uint32 ticket_age_add;
2555 * opaque ticket_nonce<0..255>;
2556 * opaque ticket<1..2^16-1>;
2557 * Extension extensions<0..2^16-2>;
2558 * } NewSessionTicket;
2559 *
2560 * The ticket inside the NewSessionTicket message is an encrypted container
2561 * carrying the necessary information so that the server is later able to
2562 * re-start the communication.
2563 *
2564 * The following fields are placed inside the ticket by the
2565 * f_ticket_write() function:
2566 *
2567 * - creation time (start)
2568 * - flags (flags)
2569 * - age add (ticket_age_add)
2570 * - key (key)
2571 * - key length (key_len)
2572 * - ciphersuite (ciphersuite)
2573 */
2574MBEDTLS_CHECK_RETURN_CRITICAL
2575static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2576 unsigned char *buf,
2577 unsigned char *end,
2578 size_t *out_len,
2579 unsigned char *ticket_nonce,
2580 size_t ticket_nonce_size )
2581{
2582 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2583 unsigned char *p = buf;
2584 mbedtls_ssl_session *session = ssl->session;
2585 size_t ticket_len;
2586 uint32_t ticket_lifetime;
2587
2588 *out_len = 0;
2589 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2590
2591 /*
2592 * ticket_lifetime 4 bytes
2593 * ticket_age_add 4 bytes
2594 * ticket_nonce 1 + ticket_nonce_size bytes
2595 * ticket >=2 bytes
2596 */
2597 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2598
2599 /* Generate ticket and ticket_lifetime */
2600 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2601 session,
2602 p + 9 + ticket_nonce_size + 2,
2603 end,
2604 &ticket_len,
2605 &ticket_lifetime);
2606 if( ret != 0 )
2607 {
2608 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2609 return( ret );
2610 }
2611 /* RFC 8446 4.6.1
2612 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2613 * unsigned integer in network byte order from the time of ticket
2614 * issuance. Servers MUST NOT use any value greater than
2615 * 604800 seconds (7 days). The value of zero indicates that the
2616 * ticket should be discarded immediately. Clients MUST NOT cache
2617 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2618 * and MAY delete tickets earlier based on local policy. A server
2619 * MAY treat a ticket as valid for a shorter period of time than what
2620 * is stated in the ticket_lifetime.
2621 */
2622 ticket_lifetime %= 604800;
2623 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2624 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2625 ( unsigned int )ticket_lifetime ) );
2626
2627 /* Write ticket_age_add */
2628 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2629 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2630 ( unsigned int )session->ticket_age_add ) );
2631
2632 /* Write ticket_nonce */
2633 p[8] = ( unsigned char )ticket_nonce_size;
2634 if( ticket_nonce_size > 0 )
2635 {
2636 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2637 }
2638 p += 9 + ticket_nonce_size;
2639
2640 /* Write ticket */
2641 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2642 p += 2;
2643 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2644 p += ticket_len;
2645
2646 /* Ticket Extensions
2647 *
2648 * Note: We currently don't have any extensions.
2649 * Set length to zero.
2650 */
2651 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2652 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2653 p += 2;
2654
2655 *out_len = p - buf;
2656 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2657 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2658
2659 return( 0 );
2660}
2661
2662/*
2663 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2664 */
2665static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2666{
2667 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2668
2669 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2670
2671 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2672 {
2673 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2674 unsigned char *buf;
2675 size_t buf_len, msg_len;
2676
2677 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2678 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2679
2680 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2681 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2682
2683 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2684 ssl, buf, buf + buf_len, &msg_len,
2685 ticket_nonce, sizeof( ticket_nonce ) ) );
2686
Jerry Yue67bef42022-07-07 07:29:42 +00002687 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2688 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002689
2690 mbedtls_ssl_handshake_set_state( ssl,
2691 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002692 }
2693 else
2694 {
2695 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2696 }
2697
Jerry Yue67bef42022-07-07 07:29:42 +00002698cleanup:
2699
2700 return( ret );
2701}
2702#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2703
2704/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002705 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002706 */
Jerry Yu27561932021-08-27 17:07:38 +08002707int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002708{
XiaokangQian08037552022-04-20 07:16:41 +00002709 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002710
2711 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2712 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2713
Jerry Yue3b34122021-09-28 17:53:35 +08002714 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2715 mbedtls_ssl_states_str( ssl->state ),
2716 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002717
XiaokangQian7807f9f2022-02-15 10:04:37 +00002718 switch( ssl->state )
2719 {
2720 /* start state */
2721 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002722 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002723 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002724 break;
2725
XiaokangQian7807f9f2022-02-15 10:04:37 +00002726 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002727 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002728 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002729 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002730 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002731
Jerry Yuf41553b2022-05-09 22:20:30 +08002732 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2733 ret = ssl_tls13_write_hello_retry_request( ssl );
2734 if( ret != 0 )
2735 {
2736 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2737 return( ret );
2738 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002739 break;
2740
Jerry Yu5b64ae92022-03-30 17:15:02 +08002741 case MBEDTLS_SSL_SERVER_HELLO:
2742 ret = ssl_tls13_write_server_hello( ssl );
2743 break;
2744
Xiaofei Baicba64af2022-02-15 10:00:56 +00002745 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002746 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002747 if( ret != 0 )
2748 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002749 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2750 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002751 }
Jerry Yu48330562022-05-06 21:35:44 +08002752 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002753
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002754#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
2755 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002756 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002757 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002758
Jerry Yu83da34e2022-04-16 13:59:52 +08002759 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2760 ret = ssl_tls13_write_server_certificate( ssl );
2761 break;
2762
2763 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
2764 ret = ssl_tls13_write_certificate_verify( ssl );
2765 break;
Jerry Yu5a26f302022-05-10 20:46:40 +08002766#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002767
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002768 /*
2769 * Injection of dummy-CCS's for middlebox compatibility
2770 */
2771#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002772 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002773 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2774 if( ret == 0 )
2775 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2776 break;
2777
2778 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
2779 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2780 if( ret == 0 )
2781 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2782 break;
2783#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2784
Jerry Yu69dd8d42022-04-16 12:51:26 +08002785 case MBEDTLS_SSL_SERVER_FINISHED:
2786 ret = ssl_tls13_write_server_finished( ssl );
2787 break;
2788
2789 case MBEDTLS_SSL_CLIENT_FINISHED:
2790 ret = ssl_tls13_process_client_finished( ssl );
2791 break;
2792
Jerry Yu69dd8d42022-04-16 12:51:26 +08002793 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
2794 ret = ssl_tls13_handshake_wrapup( ssl );
2795 break;
2796
XiaokangQian6b916b12022-04-25 07:29:34 +00002797 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2798 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02002799 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00002800 {
Ronald Cron209cae92022-06-07 10:30:19 +02002801 if( ssl->session_negotiate->peer_cert != NULL )
2802 {
2803 mbedtls_ssl_handshake_set_state(
2804 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2805 }
2806 else
Ronald Cron19385882022-06-15 16:26:13 +02002807 {
2808 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02002809 mbedtls_ssl_handshake_set_state(
2810 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002811 }
XiaokangQian6b916b12022-04-25 07:29:34 +00002812 }
2813 break;
2814
2815 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2816 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2817 if( ret == 0 )
2818 {
2819 mbedtls_ssl_handshake_set_state(
2820 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2821 }
2822 break;
2823
Jerry Yue67bef42022-07-07 07:29:42 +00002824#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2825 case MBEDTLS_SSL_NEW_SESSION_TICKET:
2826 ret = ssl_tls13_write_new_session_ticket( ssl );
2827 if( ret != 0 )
2828 {
2829 MBEDTLS_SSL_DEBUG_RET( 1,
2830 "ssl_tls13_write_new_session_ticket ",
2831 ret );
2832 }
2833 break;
2834 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
2835 /* This state is necessary to do the flush of the New Session
2836 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
2837 * as part of ssl_prepare_handshake_step.
2838 */
2839 ret = 0;
2840 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2841 break;
2842
2843#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2844
XiaokangQian7807f9f2022-02-15 10:04:37 +00002845 default:
2846 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00002847 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002848 }
2849
2850 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08002851}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002852
Jerry Yufb4b6472022-01-27 15:03:26 +08002853#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */