blob: 32f64d73c9f8544b97c0faa5e533e036282c74f7 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18*/
19
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu1c105562022-07-10 06:32:38 +000027#include "mbedtls/constant_time.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080028
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000029#include "ssl_misc.h"
30#include "ssl_tls13_keys.h"
31#include "ssl_debug_helpers.h"
32
XiaokangQian7807f9f2022-02-15 10:04:37 +000033#if defined(MBEDTLS_ECP_C)
34#include "mbedtls/ecp.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000035#endif /* MBEDTLS_ECP_C */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080036
XiaokangQiana9c58412022-02-17 09:41:26 +000037#include "mbedtls/platform.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000038
Jerry Yu4d3841a2022-04-16 12:37:19 +080039#include "ssl_misc.h"
40#include "ssl_tls13_keys.h"
41#include "ssl_debug_helpers.h"
42
Jerry Yuf35ba382022-08-23 17:58:26 +080043
Jerry Yuc5a23a02022-08-25 10:51:44 +080044static const mbedtls_ssl_ciphersuite_t *ssl_tls13_validate_peer_ciphersuite(
Jerry Yuf35ba382022-08-23 17:58:26 +080045 mbedtls_ssl_context *ssl,
Jerry Yuc5a23a02022-08-25 10:51:44 +080046 unsigned int cipher_suite )
Jerry Yuf35ba382022-08-23 17:58:26 +080047{
48 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
49 if( ! mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
50 return( NULL );
51
52 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
53 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
54 ssl->tls_version,
55 ssl->tls_version ) != 0 ) )
56 {
57 return( NULL );
58 }
59 return( ciphersuite_info );
60}
61
Ronald Cron41a443a2022-10-04 16:38:25 +020062#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +000063/* From RFC 8446:
64 *
65 * enum { psk_ke(0), psk_dhe_ke(1), (255) } PskKeyExchangeMode;
66 * struct {
67 * PskKeyExchangeMode ke_modes<1..255>;
68 * } PskKeyExchangeModes;
69 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +080070MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue19e3b92022-07-08 12:04:51 +000071static int ssl_tls13_parse_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
72 const unsigned char *buf,
Jerry Yu299e31f2022-07-13 23:06:36 +080073 const unsigned char *end )
Jerry Yue19e3b92022-07-08 12:04:51 +000074{
Jerry Yu299e31f2022-07-13 23:06:36 +080075 const unsigned char *p = buf;
Jerry Yue19e3b92022-07-08 12:04:51 +000076 size_t ke_modes_len;
77 int ke_modes = 0;
78
Jerry Yu854dd9e2022-07-15 14:28:27 +080079 /* Read ke_modes length (1 Byte) */
Jerry Yu299e31f2022-07-13 23:06:36 +080080 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
81 ke_modes_len = *p++;
Jerry Yue19e3b92022-07-08 12:04:51 +000082 /* Currently, there are only two PSK modes, so even without looking
83 * at the content, something's wrong if the list has more than 2 items. */
84 if( ke_modes_len > 2 )
Jerry Yu299e31f2022-07-13 23:06:36 +080085 {
86 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
87 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +000088 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu299e31f2022-07-13 23:06:36 +080089 }
Jerry Yue19e3b92022-07-08 12:04:51 +000090
Jerry Yu299e31f2022-07-13 23:06:36 +080091 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ke_modes_len );
Jerry Yue19e3b92022-07-08 12:04:51 +000092
93 while( ke_modes_len-- != 0 )
94 {
Jerry Yu299e31f2022-07-13 23:06:36 +080095 switch( *p++ )
Jerry Yue19e3b92022-07-08 12:04:51 +000096 {
97 case MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE:
98 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
99 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK KEX MODE" ) );
100 break;
101 case MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE:
102 ke_modes |= MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
103 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Found PSK_EPHEMERAL KEX MODE" ) );
104 break;
105 default:
Jerry Yu299e31f2022-07-13 23:06:36 +0800106 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
107 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue19e3b92022-07-08 12:04:51 +0000108 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
109 }
110 }
111
112 ssl->handshake->tls13_kex_modes = ke_modes;
113 return( 0 );
114}
Jerry Yu1c105562022-07-10 06:32:38 +0000115
Jerry Yue9d4fc02022-08-20 19:21:15 +0800116#define SSL_TLS1_3_OFFERED_PSK_NOT_MATCH 1
117#define SSL_TLS1_3_OFFERED_PSK_MATCH 0
Jerry Yu95699e72022-08-21 19:22:23 +0800118
119#if defined(MBEDTLS_SSL_SESSION_TICKETS)
120
121MBEDTLS_CHECK_RETURN_CRITICAL
122static int ssl_tls13_offered_psks_check_identity_match_ticket(
123 mbedtls_ssl_context *ssl,
Jerry Yu95699e72022-08-21 19:22:23 +0800124 const unsigned char *identity,
125 size_t identity_len,
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800126 uint32_t obfuscated_ticket_age,
127 mbedtls_ssl_session *session )
Jerry Yu95699e72022-08-21 19:22:23 +0800128{
Jerry Yufd310eb2022-09-06 09:16:35 +0800129 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu95699e72022-08-21 19:22:23 +0800130 unsigned char *ticket_buffer;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800131#if defined(MBEDTLS_HAVE_TIME)
132 mbedtls_time_t now;
Jerry Yuacff8232022-09-14 14:35:11 +0800133 uint64_t age_in_s;
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800134 int64_t age_diff_in_ms;
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800135#endif
Jerry Yu95699e72022-08-21 19:22:23 +0800136
137 ((void) obfuscated_ticket_age);
138
139 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> check_identity_match_ticket" ) );
140
Jerry Yufd310eb2022-09-06 09:16:35 +0800141 /* Ticket parser is not configured, Skip */
142 if( ssl->conf->f_ticket_parse == NULL || identity_len == 0 )
Jerry Yu95699e72022-08-21 19:22:23 +0800143 return( 0 );
Jerry Yu95699e72022-08-21 19:22:23 +0800144
Jerry Yu4746b102022-09-13 11:11:48 +0800145 /* We create a copy of the encrypted ticket since the ticket parsing
146 * function is allowed to use its input buffer as an output buffer
147 * (in-place decryption). We do, however, need the original buffer for
148 * computing the PSK binder value.
Jerry Yu95699e72022-08-21 19:22:23 +0800149 */
150 ticket_buffer = mbedtls_calloc( 1, identity_len );
151 if( ticket_buffer == NULL )
152 {
153 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
154 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
155 }
156 memcpy( ticket_buffer, identity, identity_len );
157
158 if( ( ret = ssl->conf->f_ticket_parse( ssl->conf->p_ticket,
159 session,
160 ticket_buffer, identity_len ) ) != 0 )
161 {
162 if( ret == MBEDTLS_ERR_SSL_INVALID_MAC )
163 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is not authentic" ) );
164 else if( ret == MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED )
165 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket is expired" ) );
166 else
167 MBEDTLS_SSL_DEBUG_RET( 1, "ticket_parse", ret );
168 }
169
170 /* We delete the temporary buffer */
171 mbedtls_free( ticket_buffer );
172
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800173 if( ret != 0 )
174 goto exit;
175
176 ret = MBEDTLS_ERR_SSL_SESSION_TICKET_EXPIRED;
177#if defined(MBEDTLS_HAVE_TIME)
178 now = mbedtls_time( NULL );
179
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800180 if( now < session->start )
Jerry Yu95699e72022-08-21 19:22:23 +0800181 {
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800182 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu03aa1742022-10-10 21:48:37 +0800183 3, ( "Invalid ticket start time ( now=%" MBEDTLS_PRINTF_LONGLONG
Jerry Yua99cbfa2022-10-08 11:17:14 +0800184 ", start=%" MBEDTLS_PRINTF_LONGLONG " )",
185 (long long)now, (long long)session->start ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800186 goto exit;
187 }
Jerry Yu95699e72022-08-21 19:22:23 +0800188
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800189 age_in_s = (uint64_t)( now - session->start );
Jerry Yu95699e72022-08-21 19:22:23 +0800190
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800191 /* RFC 8446 section 4.6.1
192 *
193 * Servers MUST NOT use any value greater than 604800 seconds (7 days).
194 *
195 * RFC 8446 section 4.2.11.1
196 *
197 * Clients MUST NOT attempt to use tickets which have ages greater than
198 * the "ticket_lifetime" value which was provided with the ticket.
199 *
200 * For time being, the age MUST be less than 604800 seconds (7 days).
201 */
202 if( age_in_s > 604800 )
203 {
204 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuc2bfaf02022-10-11 15:55:52 +0800205 3, ( "Ticket age exceeds limitation ticket_age=%lu",
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800206 (long unsigned int)age_in_s ) );
207 goto exit;
208 }
Jerry Yu95699e72022-08-21 19:22:23 +0800209
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800210 /* RFC 8446 section 4.2.10
211 *
212 * For PSKs provisioned via NewSessionTicket, a server MUST validate that
213 * the ticket age for the selected PSK identity (computed by subtracting
214 * ticket_age_add from PskIdentity.obfuscated_ticket_age modulo 2^32) is
215 * within a small tolerance of the time since the ticket was issued.
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800216 *
Jerry Yu0a55cc62022-09-15 16:15:06 +0800217 * NOTE: When `now == session->start`, `age_diff_in_ms` may be negative
218 * as the age units are different on the server (s) and in the
219 * client (ms) side. Add a -1000 ms tolerance window to take this
220 * into account.
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800221 */
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800222 age_diff_in_ms = age_in_s * 1000;
223 age_diff_in_ms -= ( obfuscated_ticket_age - session->ticket_age_add );
224 if( age_diff_in_ms <= -1000 ||
225 age_diff_in_ms > MBEDTLS_SSL_TLS1_3_TICKET_AGE_TOLERANCE )
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800226 {
227 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yu03aa1742022-10-10 21:48:37 +0800228 3, ( "Ticket age outside tolerance window ( diff=%d )",
229 (int)age_diff_in_ms ) );
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800230 goto exit;
231 }
232
233 ret = 0;
Jerry Yu95699e72022-08-21 19:22:23 +0800234
235#endif /* MBEDTLS_HAVE_TIME */
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800236
237exit:
238 if( ret != 0 )
239 mbedtls_ssl_session_free( session );
Jerry Yu95699e72022-08-21 19:22:23 +0800240
241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= check_identity_match_ticket" ) );
242 return( ret );
243}
244#endif /* MBEDTLS_SSL_SESSION_TICKETS */
245
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800246MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu1c105562022-07-10 06:32:38 +0000247static int ssl_tls13_offered_psks_check_identity_match(
248 mbedtls_ssl_context *ssl,
249 const unsigned char *identity,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800250 size_t identity_len,
Jerry Yu95699e72022-08-21 19:22:23 +0800251 uint32_t obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800252 int *psk_type,
253 mbedtls_ssl_session *session )
Jerry Yu1c105562022-07-10 06:32:38 +0000254{
Jerry Yu95699e72022-08-21 19:22:23 +0800255 ((void) session);
256 ((void) obfuscated_ticket_age);
Jerry Yu5725f1c2022-08-21 17:27:16 +0800257 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
Jerry Yu95699e72022-08-21 19:22:23 +0800258
259 MBEDTLS_SSL_DEBUG_BUF( 4, "identity", identity, identity_len );
260 ssl->handshake->resume = 0;
261
Jerry Yu95699e72022-08-21 19:22:23 +0800262#if defined(MBEDTLS_SSL_SESSION_TICKETS)
263 if( ssl_tls13_offered_psks_check_identity_match_ticket(
Jerry Yu8d4bbba2022-09-13 14:15:48 +0800264 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800265 session ) == SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu95699e72022-08-21 19:22:23 +0800266 {
Jerry Yu95699e72022-08-21 19:22:23 +0800267 ssl->handshake->resume = 1;
268 *psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
269 mbedtls_ssl_set_hs_psk( ssl,
Jerry Yu0a55cc62022-09-15 16:15:06 +0800270 session->resumption_key,
271 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800272
273 MBEDTLS_SSL_DEBUG_BUF( 4, "Ticket-resumed PSK:",
Jerry Yu0a55cc62022-09-15 16:15:06 +0800274 session->resumption_key,
275 session->resumption_key_len );
Jerry Yu95699e72022-08-21 19:22:23 +0800276 MBEDTLS_SSL_DEBUG_MSG( 4, ( "ticket: obfuscated_ticket_age: %u",
277 (unsigned)obfuscated_ticket_age ) );
278 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
279 }
280#endif /* MBEDTLS_SSL_SESSION_TICKETS */
281
Jerry Yu1c105562022-07-10 06:32:38 +0000282 /* Check identity with external configured function */
283 if( ssl->conf->f_psk != NULL )
284 {
285 if( ssl->conf->f_psk(
286 ssl->conf->p_psk, ssl, identity, identity_len ) == 0 )
287 {
288 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
289 }
290 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
291 }
292
Jerry Yu96a2e362022-07-21 15:11:34 +0800293 MBEDTLS_SSL_DEBUG_BUF( 5, "identity", identity, identity_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000294 /* Check identity with pre-configured psk */
Jerry Yu2f0abc92022-07-22 19:34:48 +0800295 if( ssl->conf->psk_identity != NULL &&
296 identity_len == ssl->conf->psk_identity_len &&
Jerry Yu1c105562022-07-10 06:32:38 +0000297 mbedtls_ct_memcmp( ssl->conf->psk_identity,
298 identity, identity_len ) == 0 )
299 {
300 mbedtls_ssl_set_hs_psk( ssl, ssl->conf->psk, ssl->conf->psk_len );
301 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
302 }
303
Jerry Yu1c105562022-07-10 06:32:38 +0000304 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
305}
306
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800307MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu96a2e362022-07-21 15:11:34 +0800308static int ssl_tls13_offered_psks_check_binder_match( mbedtls_ssl_context *ssl,
309 const unsigned char *binder,
Jerry Yue95c8af2022-07-26 15:48:20 +0800310 size_t binder_len,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800311 int psk_type,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800312 psa_algorithm_t psk_hash_alg )
Jerry Yu1c105562022-07-10 06:32:38 +0000313{
314 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu96a2e362022-07-21 15:11:34 +0800315
Jerry Yudaf375a2022-07-20 21:31:43 +0800316 unsigned char transcript[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000317 size_t transcript_len;
Jerry Yu2f0abc92022-07-22 19:34:48 +0800318 unsigned char *psk;
Jerry Yu96a2e362022-07-21 15:11:34 +0800319 size_t psk_len;
Jerry Yudaf375a2022-07-20 21:31:43 +0800320 unsigned char server_computed_binder[PSA_HASH_MAX_SIZE];
Jerry Yu1c105562022-07-10 06:32:38 +0000321
Jerry Yu1c105562022-07-10 06:32:38 +0000322 /* Get current state of handshake transcript. */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800323 ret = mbedtls_ssl_get_handshake_transcript(
324 ssl, mbedtls_hash_info_md_from_psa( psk_hash_alg ),
325 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000326 if( ret != 0 )
327 return( ret );
328
Jerry Yu40f37712022-07-26 16:58:57 +0800329 ret = mbedtls_ssl_tls13_export_handshake_psk( ssl, &psk, &psk_len );
Jerry Yu96a2e362022-07-21 15:11:34 +0800330 if( ret != 0 )
331 return( ret );
332
Jerry Yu29d9faa2022-08-23 17:52:45 +0800333 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psk_hash_alg,
Jerry Yu1c105562022-07-10 06:32:38 +0000334 psk, psk_len, psk_type,
335 transcript,
336 server_computed_binder );
Jerry Yu96a2e362022-07-21 15:11:34 +0800337#if defined(MBEDTLS_USE_PSA_CRYPTO)
338 mbedtls_free( (void*)psk );
339#endif
Jerry Yu1c105562022-07-10 06:32:38 +0000340 if( ret != 0 )
341 {
342 MBEDTLS_SSL_DEBUG_MSG( 1, ( "PSK binder calculation failed." ) );
343 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
344 }
345
346 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( computed ): ",
Jerry Yu2f0abc92022-07-22 19:34:48 +0800347 server_computed_binder, transcript_len );
Jerry Yu1c105562022-07-10 06:32:38 +0000348 MBEDTLS_SSL_DEBUG_BUF( 3, "psk binder ( received ): ", binder, binder_len );
349
350 if( mbedtls_ct_memcmp( server_computed_binder, binder, binder_len ) == 0 )
351 {
352 return( SSL_TLS1_3_OFFERED_PSK_MATCH );
353 }
354
Jerry Yudaf375a2022-07-20 21:31:43 +0800355 mbedtls_platform_zeroize( server_computed_binder,
356 sizeof( server_computed_binder ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000357 return( SSL_TLS1_3_OFFERED_PSK_NOT_MATCH );
358}
Jerry Yu96a2e362022-07-21 15:11:34 +0800359
Jerry Yu5725f1c2022-08-21 17:27:16 +0800360MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf35ba382022-08-23 17:58:26 +0800361static int ssl_tls13_select_ciphersuite_for_psk(
362 mbedtls_ssl_context *ssl,
363 const unsigned char *cipher_suites,
364 const unsigned char *cipher_suites_end,
365 uint16_t *selected_ciphersuite,
366 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800367{
Jerry Yuf35ba382022-08-23 17:58:26 +0800368 psa_algorithm_t psk_hash_alg = PSA_ALG_SHA_256;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800369
Jerry Yu0baf9072022-08-25 11:21:04 +0800370 *selected_ciphersuite = 0;
371 *selected_ciphersuite_info = NULL;
372
Jerry Yuf35ba382022-08-23 17:58:26 +0800373 /* RFC 8446, page 55.
374 *
375 * For externally established PSKs, the Hash algorithm MUST be set when the
376 * PSK is established or default to SHA-256 if no such algorithm is defined.
377 *
378 */
Jerry Yu5725f1c2022-08-21 17:27:16 +0800379
Jerry Yu5725f1c2022-08-21 17:27:16 +0800380 /*
381 * Search for a matching ciphersuite
382 */
Jerry Yu1e05b6d2022-08-31 10:35:52 +0800383 for ( const unsigned char *p = cipher_suites;
384 p < cipher_suites_end; p += 2 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800385 {
386 uint16_t cipher_suite;
Jerry Yuf35ba382022-08-23 17:58:26 +0800387 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800388
389 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +0800390 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
391 cipher_suite );
Jerry Yuf35ba382022-08-23 17:58:26 +0800392 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800393 continue;
394
Jerry Yu5725f1c2022-08-21 17:27:16 +0800395 /* MAC of selected ciphersuite MUST be same with PSK binder if exist.
396 * Otherwise, client should reject.
397 */
Jerry Yuf35ba382022-08-23 17:58:26 +0800398 if( psk_hash_alg == mbedtls_psa_translate_md( ciphersuite_info->mac ) )
399 {
400 *selected_ciphersuite = cipher_suite;
401 *selected_ciphersuite_info = ciphersuite_info;
402 return( 0 );
403 }
404 }
405 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No matched ciphersuite" ) );
406 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
407}
Jerry Yu5725f1c2022-08-21 17:27:16 +0800408
Jerry Yu82534862022-08-30 10:42:33 +0800409#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf35ba382022-08-23 17:58:26 +0800410MBEDTLS_CHECK_RETURN_CRITICAL
411static int ssl_tls13_select_ciphersuite_for_resumption(
412 mbedtls_ssl_context *ssl,
413 const unsigned char *cipher_suites,
414 const unsigned char *cipher_suites_end,
415 mbedtls_ssl_session *session,
416 uint16_t *selected_ciphersuite,
417 const mbedtls_ssl_ciphersuite_t **selected_ciphersuite_info )
418{
Jerry Yu82534862022-08-30 10:42:33 +0800419
Jerry Yuf35ba382022-08-23 17:58:26 +0800420 *selected_ciphersuite = 0;
421 *selected_ciphersuite_info = NULL;
Jerry Yu82534862022-08-30 10:42:33 +0800422 for( const unsigned char *p = cipher_suites; p < cipher_suites_end; p += 2 )
423 {
424 uint16_t cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
425 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
426
427 if( cipher_suite != session->ciphersuite )
428 continue;
429
430 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite( ssl,
431 cipher_suite );
432 if( ciphersuite_info == NULL )
433 continue;
434
Jerry Yu4746b102022-09-13 11:11:48 +0800435 *selected_ciphersuite = cipher_suite;
Jerry Yu82534862022-08-30 10:42:33 +0800436 *selected_ciphersuite_info = ciphersuite_info;
437
438 return( 0 );
Jerry Yu82534862022-08-30 10:42:33 +0800439 }
440
441 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800442}
Jerry Yuf35ba382022-08-23 17:58:26 +0800443
Jerry Yu82534862022-08-30 10:42:33 +0800444MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4746b102022-09-13 11:11:48 +0800445static int ssl_tls13_session_copy_ticket( mbedtls_ssl_session *dst,
446 const mbedtls_ssl_session *src )
Jerry Yu82534862022-08-30 10:42:33 +0800447{
Jerry Yu82534862022-08-30 10:42:33 +0800448 dst->ticket_age_add = src->ticket_age_add;
449 dst->ticket_flags = src->ticket_flags;
450 dst->resumption_key_len = src->resumption_key_len;
451 if( src->resumption_key_len == 0 )
452 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
453 memcpy( dst->resumption_key, src->resumption_key, src->resumption_key_len );
Jerry Yu4746b102022-09-13 11:11:48 +0800454
Jerry Yu82534862022-08-30 10:42:33 +0800455 return( 0 );
456}
457#endif /* MBEDTLS_SSL_SESSION_TICKETS */
458
Jerry Yu1c105562022-07-10 06:32:38 +0000459/* Parser for pre_shared_key extension in client hello
460 * struct {
461 * opaque identity<1..2^16-1>;
462 * uint32 obfuscated_ticket_age;
463 * } PskIdentity;
464 *
465 * opaque PskBinderEntry<32..255>;
466 *
467 * struct {
468 * PskIdentity identities<7..2^16-1>;
469 * PskBinderEntry binders<33..2^16-1>;
470 * } OfferedPsks;
471 *
472 * struct {
473 * select (Handshake.msg_type) {
474 * case client_hello: OfferedPsks;
475 * ....
476 * };
477 * } PreSharedKeyExtension;
478 */
Jerry Yu6e74a7e2022-07-20 20:49:32 +0800479MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yubb852022022-07-20 21:10:44 +0800480static int ssl_tls13_parse_pre_shared_key_ext( mbedtls_ssl_context *ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +0800481 const unsigned char *pre_shared_key_ext,
482 const unsigned char *pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +0800483 const unsigned char *ciphersuites,
484 const unsigned char *ciphersuites_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000485{
Jerry Yu29d9faa2022-08-23 17:52:45 +0800486 const unsigned char *identities = pre_shared_key_ext;
Jerry Yu568ec252022-07-22 21:27:34 +0800487 const unsigned char *p_identity_len;
488 size_t identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000489 const unsigned char *identities_end;
Jerry Yu568ec252022-07-22 21:27:34 +0800490 const unsigned char *binders;
491 const unsigned char *p_binder_len;
492 size_t binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000493 const unsigned char *binders_end;
Jerry Yu96a2e362022-07-21 15:11:34 +0800494 int matched_identity = -1;
495 int identity_id = -1;
Jerry Yu1c105562022-07-10 06:32:38 +0000496
Jerry Yu29d9faa2022-08-23 17:52:45 +0800497 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key extension",
498 pre_shared_key_ext,
499 pre_shared_key_ext_end - pre_shared_key_ext );
Jerry Yu1c105562022-07-10 06:32:38 +0000500
Jerry Yu96a2e362022-07-21 15:11:34 +0800501 /* identities_len 2 bytes
502 * identities_data >= 7 bytes
503 */
Jerry Yu29d9faa2022-08-23 17:52:45 +0800504 MBEDTLS_SSL_CHK_BUF_READ_PTR( identities, pre_shared_key_ext_end, 7 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800505 identities_len = MBEDTLS_GET_UINT16_BE( identities, 0 );
506 p_identity_len = identities + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800507 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, pre_shared_key_ext_end,
508 identities_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800509 identities_end = p_identity_len + identities_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000510
Jerry Yu96a2e362022-07-21 15:11:34 +0800511 /* binders_len 2 bytes
512 * binders >= 33 bytes
513 */
Jerry Yu568ec252022-07-22 21:27:34 +0800514 binders = identities_end;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800515 MBEDTLS_SSL_CHK_BUF_READ_PTR( binders, pre_shared_key_ext_end, 33 + 2 );
Jerry Yu568ec252022-07-22 21:27:34 +0800516 binders_len = MBEDTLS_GET_UINT16_BE( binders, 0 );
517 p_binder_len = binders + 2;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800518 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, pre_shared_key_ext_end, binders_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800519 binders_end = p_binder_len + binders_len;
Jerry Yu1c105562022-07-10 06:32:38 +0000520
Jerry Yu29d9faa2022-08-23 17:52:45 +0800521 ssl->handshake->update_checksum( ssl, pre_shared_key_ext,
522 identities_end - pre_shared_key_ext );
Jerry Yu96a2e362022-07-21 15:11:34 +0800523
Jerry Yu568ec252022-07-22 21:27:34 +0800524 while( p_identity_len < identities_end && p_binder_len < binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000525 {
Jerry Yu1c105562022-07-10 06:32:38 +0000526 const unsigned char *identity;
Jerry Yu568ec252022-07-22 21:27:34 +0800527 size_t identity_len;
Jerry Yu82534862022-08-30 10:42:33 +0800528 uint32_t obfuscated_ticket_age;
Jerry Yu96a2e362022-07-21 15:11:34 +0800529 const unsigned char *binder;
Jerry Yu568ec252022-07-22 21:27:34 +0800530 size_t binder_len;
Jerry Yu96a2e362022-07-21 15:11:34 +0800531 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800532 int psk_type;
533 uint16_t cipher_suite;
Jerry Yu29d9faa2022-08-23 17:52:45 +0800534 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
Jerry Yu82534862022-08-30 10:42:33 +0800535#if defined(MBEDTLS_SSL_SESSION_TICKETS)
536 mbedtls_ssl_session session;
Jerry Yu4746b102022-09-13 11:11:48 +0800537 mbedtls_ssl_session_init( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800538#endif
Jerry Yubb852022022-07-20 21:10:44 +0800539
Jerry Yu568ec252022-07-22 21:27:34 +0800540 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_identity_len, identities_end, 2 + 1 + 4 );
541 identity_len = MBEDTLS_GET_UINT16_BE( p_identity_len, 0 );
542 identity = p_identity_len + 2;
543 MBEDTLS_SSL_CHK_BUF_READ_PTR( identity, identities_end, identity_len + 4 );
Jerry Yu82534862022-08-30 10:42:33 +0800544 obfuscated_ticket_age = MBEDTLS_GET_UINT32_BE( identity , identity_len );
Jerry Yu568ec252022-07-22 21:27:34 +0800545 p_identity_len += identity_len + 6;
Jerry Yu1c105562022-07-10 06:32:38 +0000546
Jerry Yu568ec252022-07-22 21:27:34 +0800547 MBEDTLS_SSL_CHK_BUF_READ_PTR( p_binder_len, binders_end, 1 + 32 );
548 binder_len = *p_binder_len;
549 binder = p_binder_len + 1;
550 MBEDTLS_SSL_CHK_BUF_READ_PTR( binder, binders_end, binder_len );
551 p_binder_len += binder_len + 1;
Jerry Yu96a2e362022-07-21 15:11:34 +0800552
Jerry Yu96a2e362022-07-21 15:11:34 +0800553 identity_id++;
554 if( matched_identity != -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000555 continue;
556
Jerry Yu96a2e362022-07-21 15:11:34 +0800557 ret = ssl_tls13_offered_psks_check_identity_match(
Jerry Yu82534862022-08-30 10:42:33 +0800558 ssl, identity, identity_len, obfuscated_ticket_age,
Jerry Yu4746b102022-09-13 11:11:48 +0800559 &psk_type, &session );
Jerry Yue95c8af2022-07-26 15:48:20 +0800560 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800561 continue;
562
Jerry Yuf35ba382022-08-23 17:58:26 +0800563 MBEDTLS_SSL_DEBUG_MSG( 4, ( "found matched identity" ) );
Jerry Yu0baf9072022-08-25 11:21:04 +0800564 switch( psk_type )
565 {
566 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
567 ret = ssl_tls13_select_ciphersuite_for_psk(
568 ssl, ciphersuites, ciphersuites_end,
569 &cipher_suite, &ciphersuite_info );
570 break;
571 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu82534862022-08-30 10:42:33 +0800572#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu0baf9072022-08-25 11:21:04 +0800573 ret = ssl_tls13_select_ciphersuite_for_resumption(
Jerry Yu82534862022-08-30 10:42:33 +0800574 ssl, ciphersuites, ciphersuites_end, &session,
Jerry Yu0baf9072022-08-25 11:21:04 +0800575 &cipher_suite, &ciphersuite_info );
Jerry Yu4746b102022-09-13 11:11:48 +0800576 if( ret != 0 )
577 mbedtls_ssl_session_free( &session );
Jerry Yu82534862022-08-30 10:42:33 +0800578#else
579 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
580#endif
Jerry Yu0baf9072022-08-25 11:21:04 +0800581 break;
582 default:
583 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
584 }
Jerry Yuf35ba382022-08-23 17:58:26 +0800585 if( ret != 0 )
Jerry Yu5725f1c2022-08-21 17:27:16 +0800586 {
Jerry Yuf35ba382022-08-23 17:58:26 +0800587 /* See below, no cipher_suite available, abort handshake */
588 MBEDTLS_SSL_PEND_FATAL_ALERT(
589 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
590 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
591 MBEDTLS_SSL_DEBUG_RET(
Jerry Yu0baf9072022-08-25 11:21:04 +0800592 2, "ssl_tls13_select_ciphersuite", ret );
Jerry Yuf35ba382022-08-23 17:58:26 +0800593 return( ret );
Jerry Yu5725f1c2022-08-21 17:27:16 +0800594 }
595
Jerry Yu96a2e362022-07-21 15:11:34 +0800596 ret = ssl_tls13_offered_psks_check_binder_match(
Jerry Yu29d9faa2022-08-23 17:52:45 +0800597 ssl, binder, binder_len, psk_type,
598 mbedtls_psa_translate_md( ciphersuite_info->mac ) );
Jerry Yue9d4fc02022-08-20 19:21:15 +0800599 if( ret != SSL_TLS1_3_OFFERED_PSK_MATCH )
Jerry Yu96a2e362022-07-21 15:11:34 +0800600 {
Jerry Yuc5a23a02022-08-25 10:51:44 +0800601 /* For security reasons, the handshake should be aborted when we
602 * fail to validate a binder value. See RFC 8446 section 4.2.11.2
603 * and appendix E.6. */
Jerry Yu82534862022-08-30 10:42:33 +0800604#if defined(MBEDTLS_SSL_SESSION_TICKETS)
605 mbedtls_ssl_session_free( &session );
606#endif
Jerry Yuc5a23a02022-08-25 10:51:44 +0800607 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Invalid binder." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800608 MBEDTLS_SSL_DEBUG_RET( 1,
609 "ssl_tls13_offered_psks_check_binder_match" , ret );
610 MBEDTLS_SSL_PEND_FATAL_ALERT(
611 MBEDTLS_SSL_ALERT_MSG_DECRYPT_ERROR,
612 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
613 return( ret );
614 }
Jerry Yu96a2e362022-07-21 15:11:34 +0800615
616 matched_identity = identity_id;
Jerry Yu5725f1c2022-08-21 17:27:16 +0800617
618 /* Update handshake parameters */
Jerry Yue5834fd2022-08-29 20:16:09 +0800619 ssl->handshake->ciphersuite_info = ciphersuite_info;
Jerry Yu4746b102022-09-13 11:11:48 +0800620 ssl->session_negotiate->ciphersuite = cipher_suite;
Jerry Yue5834fd2022-08-29 20:16:09 +0800621 MBEDTLS_SSL_DEBUG_MSG( 2, ( "overwrite ciphersuite: %04x - %s",
622 cipher_suite, ciphersuite_info->name ) );
Jerry Yu82534862022-08-30 10:42:33 +0800623#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yu82534862022-08-30 10:42:33 +0800624 if( psk_type == MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION )
625 {
Jerry Yuf7dad3c2022-09-14 22:31:39 +0800626 ret = ssl_tls13_session_copy_ticket( ssl->session_negotiate,
627 &session );
Jerry Yu82534862022-08-30 10:42:33 +0800628 mbedtls_ssl_session_free( &session );
629 if( ret != 0 )
630 return( ret );
631 }
632#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1c105562022-07-10 06:32:38 +0000633 }
634
Jerry Yu568ec252022-07-22 21:27:34 +0800635 if( p_identity_len != identities_end || p_binder_len != binders_end )
Jerry Yu1c105562022-07-10 06:32:38 +0000636 {
637 MBEDTLS_SSL_DEBUG_MSG( 3, ( "pre_shared_key extesion decode error" ) );
638 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
639 MBEDTLS_ERR_SSL_DECODE_ERROR );
640 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
641 }
642
Jerry Yu6f1db3f2022-07-22 23:05:59 +0800643 /* Update the handshake transcript with the binder list. */
644 ssl->handshake->update_checksum( ssl,
645 identities_end,
646 (size_t)( binders_end - identities_end ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800647 if( matched_identity == -1 )
Jerry Yu1c105562022-07-10 06:32:38 +0000648 {
Jerry Yue9d4fc02022-08-20 19:21:15 +0800649 MBEDTLS_SSL_DEBUG_MSG( 3, ( "No matched PSK or ticket." ) );
Jerry Yu96a2e362022-07-21 15:11:34 +0800650 return( MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY );
Jerry Yu1c105562022-07-10 06:32:38 +0000651 }
652
Jerry Yu96a2e362022-07-21 15:11:34 +0800653 ssl->handshake->selected_identity = (uint16_t)matched_identity;
654 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Pre shared key found" ) );
Jerry Yu1c105562022-07-10 06:32:38 +0000655
Jerry Yu96a2e362022-07-21 15:11:34 +0800656 return( 0 );
Jerry Yu1c105562022-07-10 06:32:38 +0000657}
Jerry Yu032b15ce2022-07-11 06:10:03 +0000658
659/*
660 * struct {
661 * select ( Handshake.msg_type ) {
662 * ....
663 * case server_hello:
664 * uint16 selected_identity;
665 * }
666 * } PreSharedKeyExtension;
667 */
Jerry Yubb852022022-07-20 21:10:44 +0800668static int ssl_tls13_write_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
669 unsigned char *buf,
670 unsigned char *end,
671 size_t *olen )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000672{
673 unsigned char *p = (unsigned char*)buf;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000674
675 *olen = 0;
676
David Horstmann21b89762022-10-06 18:34:28 +0100677 int not_using_psk = 0;
Jerry Yu032b15ce2022-07-11 06:10:03 +0000678#if defined(MBEDTLS_USE_PSA_CRYPTO)
David Horstmann21b89762022-10-06 18:34:28 +0100679 not_using_psk = ( mbedtls_svc_key_id_is_null( ssl->handshake->psk_opaque ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000680#else
David Horstmann21b89762022-10-06 18:34:28 +0100681 not_using_psk = ( ssl->handshake->psk == NULL );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000682#endif
David Horstmann21b89762022-10-06 18:34:28 +0100683 if( not_using_psk )
Jerry Yu032b15ce2022-07-11 06:10:03 +0000684 {
685 /* We shouldn't have called this extension writer unless we've
686 * chosen to use a PSK. */
687 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
688 }
689
690 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding pre_shared_key extension" ) );
691 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
692
Jerry Yu032b15ce2022-07-11 06:10:03 +0000693 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, p, 0 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000694 MBEDTLS_PUT_UINT16_BE( 2, p, 2 );
695
Jerry Yu96a2e362022-07-21 15:11:34 +0800696 MBEDTLS_PUT_UINT16_BE( ssl->handshake->selected_identity, p, 4 );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000697
698 *olen = 6;
699
Jerry Yu96a2e362022-07-21 15:11:34 +0800700 MBEDTLS_SSL_DEBUG_MSG( 4, ( "sent selected_identity: %u",
701 ssl->handshake->selected_identity ) );
Jerry Yu032b15ce2022-07-11 06:10:03 +0000702
703 return( 0 );
704}
705
Ronald Cron41a443a2022-10-04 16:38:25 +0200706#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yue19e3b92022-07-08 12:04:51 +0000707
XiaokangQian7807f9f2022-02-15 10:04:37 +0000708/* From RFC 8446:
709 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000710 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000711 * } SupportedVersions;
712 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200713MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000714static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
715 const unsigned char *buf,
716 const unsigned char *end )
717{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000718 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000719 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000720 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000721 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000722 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000723
724 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000725 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000726 p += 1;
727
XiaokangQian4080a7f2022-04-11 09:55:18 +0000728 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000729 versions_end = p + versions_len;
730 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000731 {
XiaokangQiancfd925f2022-04-14 07:10:37 +0000732 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +0000733 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +0000734 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000735
736 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +0000737 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000738 {
739 tls13_supported = 1;
740 break;
741 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000742 }
743
XiaokangQianb67384d2022-04-19 00:02:38 +0000744 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000745 {
XiaokangQian7807f9f2022-02-15 10:04:37 +0000746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
747
748 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
749 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
750 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
751 }
752
XiaokangQiande333912022-04-20 08:49:42 +0000753 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000754 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000755
XiaokangQian7807f9f2022-02-15 10:04:37 +0000756 return( 0 );
757}
758
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000759#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +0000760/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000761 *
762 * From RFC 8446:
763 * enum {
764 * ... (0xFFFF)
765 * } NamedGroup;
766 * struct {
767 * NamedGroup named_group_list<2..2^16-1>;
768 * } NamedGroupList;
769 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200770MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc1be19f2022-04-23 16:11:39 +0800771static int ssl_tls13_parse_supported_groups_ext( mbedtls_ssl_context *ssl,
772 const unsigned char *buf,
773 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000774{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000775 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000776 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000777 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000778
779 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000780 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000781 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000782 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000783 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000784 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000785 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000786
XiaokangQian08037552022-04-20 07:16:41 +0000787 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000788 {
XiaokangQian08037552022-04-20 07:16:41 +0000789 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000790 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000791 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
792 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000793
Jerry Yuc1be19f2022-04-23 16:11:39 +0800794 MBEDTLS_SSL_DEBUG_MSG( 2,
795 ( "got named group: %s(%04x)",
796 mbedtls_ssl_named_group_to_str( named_group ),
797 named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000798
799 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
800 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000801 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000802 {
XiaokangQian08037552022-04-20 07:16:41 +0000803 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000804 }
805
Jerry Yuc1be19f2022-04-23 16:11:39 +0800806 MBEDTLS_SSL_DEBUG_MSG( 2,
807 ( "add named group %s(%04x) into received list.",
808 mbedtls_ssl_named_group_to_str( named_group ),
809 named_group ) );
810
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000811 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000812 }
813
814 return( 0 );
815
816}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000817#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000818
XiaokangQian08037552022-04-20 07:16:41 +0000819#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
820
XiaokangQian88408882022-04-02 10:15:03 +0000821#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000822/*
823 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000824 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000825 *
826 * Possible return values are:
827 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000828 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000829 * does not match a group supported by the server. A HelloRetryRequest will
830 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000831 * - A negative value for fatal errors.
Jerry Yuc1be19f2022-04-23 16:11:39 +0800832 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200833MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian7807f9f2022-02-15 10:04:37 +0000834static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
835 const unsigned char *buf,
836 const unsigned char *end )
837{
XiaokangQianb67384d2022-04-19 00:02:38 +0000838 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000839 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000840 unsigned char const *client_shares_end;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800841 size_t client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000842
843 /* From RFC 8446:
844 *
845 * struct {
846 * KeyShareEntry client_shares<0..2^16-1>;
847 * } KeyShareClientHello;
848 *
849 */
850
XiaokangQian7807f9f2022-02-15 10:04:37 +0000851 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000852 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000853 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000854 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000855
856 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000857 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000858
859 /* We try to find a suitable key share entry and copy it to the
860 * handshake context. Later, we have to find out whether we can do
861 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000862 * dismiss it and send a HelloRetryRequest message.
863 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000864
Jerry Yuc1be19f2022-04-23 16:11:39 +0800865 while( p < client_shares_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000866 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000867 uint16_t group;
Jerry Yuc1be19f2022-04-23 16:11:39 +0800868 size_t key_exchange_len;
Jerry Yu086edc22022-05-05 10:50:38 +0800869 const unsigned char *key_exchange;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000870
871 /*
872 * struct {
873 * NamedGroup group;
874 * opaque key_exchange<1..2^16-1>;
875 * } KeyShareEntry;
876 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000877 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000878 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc1be19f2022-04-23 16:11:39 +0800879 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 2 );
880 p += 4;
Jerry Yu086edc22022-05-05 10:50:38 +0800881 key_exchange = p;
XiaokangQianb67384d2022-04-19 00:02:38 +0000882 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
Jerry Yu086edc22022-05-05 10:50:38 +0800883 p += key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000884
885 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000886 * for input validation purposes.
887 */
XiaokangQian060d8672022-04-21 09:24:56 +0000888 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
Jerry Yuc1be19f2022-04-23 16:11:39 +0800889 ! mbedtls_ssl_named_group_is_supported( group ) ||
890 ssl->handshake->offered_group_id != 0 )
XiaokangQian060d8672022-04-21 09:24:56 +0000891 {
892 continue;
893 }
XiaokangQian060d8672022-04-21 09:24:56 +0000894
XiaokangQian7807f9f2022-02-15 10:04:37 +0000895 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000896 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000897 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000898 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
899 {
Jerry Yuc1be19f2022-04-23 16:11:39 +0800900 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH group: %s (%04x)",
901 mbedtls_ssl_named_group_to_str( group ),
902 group ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000903 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
Jerry Yu086edc22022-05-05 10:50:38 +0800904 ssl, key_exchange - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000905 if( ret != 0 )
906 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000907
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000908 }
909 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000910 {
911 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000912 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000913 continue;
914 }
915
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000916 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000917 }
918
Jerry Yuc1be19f2022-04-23 16:11:39 +0800919
920 if( ssl->handshake->offered_group_id == 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000921 {
922 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000923 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000924 }
925 return( 0 );
926}
XiaokangQian88408882022-04-02 10:15:03 +0000927#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000928
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200929MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000930static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000931 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000932{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000933 int masked = ssl->handshake->extensions_present & exts_mask;
934 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000935}
936
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200937MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000938static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
939 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000940{
Jerry Yu77f01482022-07-11 07:03:24 +0000941 return( ssl_tls13_client_hello_has_exts(
942 ssl,
943 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
944 MBEDTLS_SSL_EXT_KEY_SHARE |
945 MBEDTLS_SSL_EXT_SIG_ALG ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000946}
947
Ronald Cron41a443a2022-10-04 16:38:25 +0200948#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000949MBEDTLS_CHECK_RETURN_CRITICAL
950static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
951 mbedtls_ssl_context *ssl )
952{
953 return( ssl_tls13_client_hello_has_exts(
954 ssl,
955 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
956 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
957}
958
959MBEDTLS_CHECK_RETURN_CRITICAL
960static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
961 mbedtls_ssl_context *ssl )
962{
963 return( ssl_tls13_client_hello_has_exts(
964 ssl,
965 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
966 MBEDTLS_SSL_EXT_KEY_SHARE |
967 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
968 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
969}
Ronald Cron41a443a2022-10-04 16:38:25 +0200970#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +0000971
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200972MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000973static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000974{
Jerry Yu77f01482022-07-11 07:03:24 +0000975 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
976 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
977}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000978
Jerry Yu77f01482022-07-11 07:03:24 +0000979MBEDTLS_CHECK_RETURN_CRITICAL
980static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
981{
Ronald Cron41a443a2022-10-04 16:38:25 +0200982#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000983 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
984 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
985 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
986#else
987 ((void) ssl);
988 return( 0 );
989#endif
990}
XiaokangQian7807f9f2022-02-15 10:04:37 +0000991
Jerry Yu77f01482022-07-11 07:03:24 +0000992MBEDTLS_CHECK_RETURN_CRITICAL
993static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
994{
Ronald Cron41a443a2022-10-04 16:38:25 +0200995#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000996 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
997 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
998 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
999#else
1000 ((void) ssl);
1001 return( 0 );
1002#endif
1003}
1004
1005static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1006{
1007 /*
1008 * Determine the key exchange algorithm to use.
1009 * There are three types of key exchanges supported in TLS 1.3:
1010 * - (EC)DH with ECDSA,
1011 * - (EC)DH with PSK,
1012 * - plain PSK.
1013 *
1014 * The PSK-based key exchanges may additionally be used with 0-RTT.
1015 *
1016 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001017 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1018 * 2 ) Certificate Mode ( ephemeral )
1019 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001020 */
1021
1022 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1023
Jerry Yu77f01482022-07-11 07:03:24 +00001024 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1025 {
1026 ssl->handshake->key_exchange_mode =
1027 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1028 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1029 }
1030 else
1031 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1032 {
1033 ssl->handshake->key_exchange_mode =
1034 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1035 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1036 }
1037 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001038 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1039 {
1040 ssl->handshake->key_exchange_mode =
1041 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1042 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1043 }
1044 else
Jerry Yu77f01482022-07-11 07:03:24 +00001045 {
1046 MBEDTLS_SSL_DEBUG_MSG(
1047 1,
1048 ( "ClientHello message misses mandatory extensions." ) );
1049 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1050 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1051 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1052 }
1053
1054 return( 0 );
1055
XiaokangQian7807f9f2022-02-15 10:04:37 +00001056}
1057
XiaokangQian81802f42022-06-10 13:25:22 +00001058#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001059 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001060
1061#if defined(MBEDTLS_USE_PSA_CRYPTO)
1062static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1063{
1064 switch( sig_alg )
1065 {
1066 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1067 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1068 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1069 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1070 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1071 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1072 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1073 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1074 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1075 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1076 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1077 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1078 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001079 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001080 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001081 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001082 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001083 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001084 default:
1085 return( PSA_ALG_NONE );
1086 }
1087}
1088#endif /* MBEDTLS_USE_PSA_CRYPTO */
1089
XiaokangQian23c5be62022-06-07 02:04:34 +00001090/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001091 * Pick best ( private key, certificate chain ) pair based on the signature
1092 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001093 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001094MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001095static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001096{
XiaokangQianfb665a82022-06-15 03:57:21 +00001097 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001098 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001099
1100#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1101 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001102 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001103 else
1104#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001105 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001106
XiaokangQianfb665a82022-06-15 03:57:21 +00001107 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001108 {
1109 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1110 return( -1 );
1111 }
1112
XiaokangQian81802f42022-06-10 13:25:22 +00001113 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001114 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001115 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1116 continue;
1117
1118 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1119 continue;
1120
XiaokangQianfb665a82022-06-15 03:57:21 +00001121 for( key_cert = key_cert_list; key_cert != NULL;
1122 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001123 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001124#if defined(MBEDTLS_USE_PSA_CRYPTO)
1125 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1126#endif /* MBEDTLS_USE_PSA_CRYPTO */
1127
XiaokangQianfb665a82022-06-15 03:57:21 +00001128 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1129 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001130
1131 /*
1132 * This avoids sending the client a cert it'll reject based on
1133 * keyUsage or other extensions.
1134 */
1135 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001136 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001137 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001138 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1139 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001140 {
1141 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001142 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001143 continue;
1144 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001145
Jerry Yucc539102022-06-27 16:27:35 +08001146 MBEDTLS_SSL_DEBUG_MSG( 3,
1147 ( "ssl_tls13_pick_key_cert:"
1148 "check signature algorithm %s [%04x]",
1149 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1150 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001151#if defined(MBEDTLS_USE_PSA_CRYPTO)
1152 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1153#endif /* MBEDTLS_USE_PSA_CRYPTO */
1154
Jerry Yufb526692022-06-19 11:22:49 +08001155 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001156 *sig_alg, &key_cert->cert->pk )
1157#if defined(MBEDTLS_USE_PSA_CRYPTO)
1158 && psa_alg != PSA_ALG_NONE &&
1159 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1160 PSA_KEY_USAGE_SIGN_HASH ) == 1
1161#endif /* MBEDTLS_USE_PSA_CRYPTO */
1162 )
XiaokangQian81802f42022-06-10 13:25:22 +00001163 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001164 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001165 MBEDTLS_SSL_DEBUG_MSG( 3,
1166 ( "ssl_tls13_pick_key_cert:"
1167 "selected signature algorithm"
1168 " %s [%04x]",
1169 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1170 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001171 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001172 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001173 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001174 return( 0 );
1175 }
XiaokangQian81802f42022-06-10 13:25:22 +00001176 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001177 }
1178
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001179 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1180 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001181 return( -1 );
1182}
XiaokangQian81802f42022-06-10 13:25:22 +00001183#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001184 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001185
XiaokangQian4080a7f2022-04-11 09:55:18 +00001186/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001187 *
1188 * STATE HANDLING: ClientHello
1189 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001190 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001191 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001192 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001193 *
1194 * In this case, the server progresses to sending its ServerHello.
1195 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001196 * 2) The ClientHello was well-formed but didn't match the server's
1197 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001198 *
1199 * For example, the client might not have offered a key share which
1200 * the server supports, or the server might require a cookie.
1201 *
1202 * In this case, the server sends a HelloRetryRequest.
1203 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001204 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001205 *
1206 * In this case, we abort the handshake.
1207 *
1208 */
1209
1210/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001211 * Structure of this message:
1212 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001213 * uint16 ProtocolVersion;
1214 * opaque Random[32];
1215 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001216 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001217 * struct {
1218 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1219 * Random random;
1220 * opaque legacy_session_id<0..32>;
1221 * CipherSuite cipher_suites<2..2^16-2>;
1222 * opaque legacy_compression_methods<1..2^8-1>;
1223 * Extension extensions<8..2^16-1>;
1224 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001225 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001226
1227#define SSL_CLIENT_HELLO_OK 0
1228#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1229
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001230MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001231static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1232 const unsigned char *buf,
1233 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001234{
XiaokangQianb67384d2022-04-19 00:02:38 +00001235 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1236 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001237 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001238 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001239 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001240 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001241 const unsigned char *extensions_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001242 uint32_t extensions_present;
Jerry Yu49ca9282022-05-05 11:05:22 +08001243 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001244
Ronald Cron41a443a2022-10-04 16:38:25 +02001245#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001246 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001247 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001248 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001249#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001250
Jerry Yue18dc7e2022-08-04 16:29:22 +08001251 extensions_present = MBEDTLS_SSL_EXT_NONE;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001252
1253 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001254 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001255 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001256 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001257 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001258 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001259 * .. . .. ciphersuite list length ( 2 bytes )
1260 * .. . .. ciphersuite list
1261 * .. . .. compression alg. list length ( 1 byte )
1262 * .. . .. compression alg. list
1263 * .. . .. extensions length ( 2 bytes, optional )
1264 * .. . .. extensions ( optional )
1265 */
1266
XiaokangQianb67384d2022-04-19 00:02:38 +00001267 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001268 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001269 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1270 * read at least up to session id length without worrying.
1271 */
1272 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1273
1274 /* ...
1275 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1276 * ...
1277 * with ProtocolVersion defined as:
1278 * uint16 ProtocolVersion;
1279 */
XiaokangQiande333912022-04-20 08:49:42 +00001280 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1281 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001282 {
1283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1284 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1285 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001286 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001287 }
1288 p += 2;
1289
1290 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001291 * Only support TLS 1.3 currently, temporarily set the version.
1292 */
XiaokangQiande333912022-04-20 08:49:42 +00001293 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001294
Jerry Yue67bef42022-07-07 07:29:42 +00001295#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1296 /* Store minor version for later use with ticket serialization. */
1297 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001298 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001299#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001300
Jerry Yuc1be19f2022-04-23 16:11:39 +08001301 /* ...
1302 * Random random;
1303 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001304 * with Random defined as:
1305 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001306 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001307 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001308 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001309
XiaokangQian08037552022-04-20 07:16:41 +00001310 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
1311 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001312
Jerry Yuc1be19f2022-04-23 16:11:39 +08001313 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001314 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001315 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001316 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001317 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001318 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001319
XiaokangQianb67384d2022-04-19 00:02:38 +00001320 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001321 {
1322 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1323 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1324 }
1325
XiaokangQian4080a7f2022-04-11 09:55:18 +00001326 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001327 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001328 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001329 /*
1330 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001331 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001332 */
1333 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001334
XiaokangQianed582dd2022-04-13 08:21:05 +00001335 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001336 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001337
XiaokangQian7807f9f2022-02-15 10:04:37 +00001338 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1339 p += 2;
1340
XiaokangQianb67384d2022-04-19 00:02:38 +00001341 /* Check we have enough data for the ciphersuite list, the legacy
1342 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001343 *
1344 * cipher_suites cipher_suites_len bytes
1345 * legacy_compression_methods 2 bytes
1346 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001347 */
1348 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001349
Jerry Yu24b8c812022-08-20 19:06:56 +08001350 /* ...
1351 * CipherSuite cipher_suites<2..2^16-2>;
1352 * ...
1353 * with CipherSuite defined as:
1354 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001355 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001356#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001357 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001358#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001359 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001360 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1361 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001362
1363 /*
1364 * Search for a matching ciphersuite
1365 */
XiaokangQian060d8672022-04-21 09:24:56 +00001366 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001367 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001368 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001369 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001370
XiaokangQiane8ff3502022-04-22 02:34:40 +00001371 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001372
XiaokangQiane8ff3502022-04-22 02:34:40 +00001373 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001374 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001375 ssl,cipher_suite );
1376 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001377 continue;
1378
Jerry Yu5725f1c2022-08-21 17:27:16 +08001379 ssl->session_negotiate->ciphersuite = cipher_suite;
1380 ssl->handshake->ciphersuite_info = ciphersuite_info;
1381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001382 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001383 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001384 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001385
1386 if( ssl->handshake->ciphersuite_info == NULL )
1387 {
1388 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1389 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1390 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1391 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001392
XiaokangQian4080a7f2022-04-11 09:55:18 +00001393 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001394 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001395 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001396 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001397 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001398 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001399 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1400 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1401 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1402 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001403 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001404 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001405
Jerry Yuc1be19f2022-04-23 16:11:39 +08001406 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001407 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001408 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001409 * with Extension defined as:
1410 * struct {
1411 * ExtensionType extension_type;
1412 * opaque extension_data<0..2^16-1>;
1413 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001414 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001415 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001416 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001417 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001418 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001419
XiaokangQian4080a7f2022-04-11 09:55:18 +00001420 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001421
1422 while( p < extensions_end )
1423 {
1424 unsigned int extension_type;
1425 size_t extension_data_len;
1426 const unsigned char *extension_data_end;
1427
Jerry Yu1c9247c2022-07-21 12:37:39 +08001428 /* RFC 8446, page 57
1429 *
1430 * The "pre_shared_key" extension MUST be the last extension in the
1431 * ClientHello (this facilitates implementation as described below).
1432 * Servers MUST check that it is the last extension and otherwise fail
1433 * the handshake with an "illegal_parameter" alert.
1434 */
Jerry Yue18dc7e2022-08-04 16:29:22 +08001435 if( extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY )
Jerry Yu1c9247c2022-07-21 12:37:39 +08001436 {
1437 MBEDTLS_SSL_DEBUG_MSG(
1438 3, ( "pre_shared_key is not last extension." ) );
1439 MBEDTLS_SSL_PEND_FATAL_ALERT(
1440 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1441 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1442 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1443 }
1444
XiaokangQian318dc762022-04-20 09:43:51 +00001445 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001446 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1447 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1448 p += 4;
1449
1450 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1451 extension_data_end = p + extension_data_len;
1452
Jerry Yue18dc7e2022-08-04 16:29:22 +08001453 /* RFC 8446 page 35
1454 *
1455 * If an implementation receives an extension which it recognizes and which
1456 * is not specified for the message in which it appears, it MUST abort the
1457 * handshake with an "illegal_parameter" alert.
1458 */
1459 extensions_present |= mbedtls_tls13_get_extension_mask( extension_type );
1460 MBEDTLS_SSL_DEBUG_MSG( 3,
1461 ( "client hello : received %s(%u) extension",
1462 mbedtls_tls13_get_extension_name( extension_type ),
1463 extension_type ) );
1464 if( ( extensions_present & MBEDTLS_SSL_TLS1_3_ALLOWED_EXTS_OF_CH ) == 0 )
1465 {
1466 MBEDTLS_SSL_DEBUG_MSG(
1467 3, ( "forbidden extension received." ) );
1468 MBEDTLS_SSL_PEND_FATAL_ALERT(
1469 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1470 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1471 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1472 }
1473
XiaokangQian7807f9f2022-02-15 10:04:37 +00001474 switch( extension_type )
1475 {
XiaokangQian40a35232022-05-07 09:02:40 +00001476#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1477 case MBEDTLS_TLS_EXT_SERVERNAME:
1478 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001479 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1480 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001481 if( ret != 0 )
1482 {
1483 MBEDTLS_SSL_DEBUG_RET(
1484 1, "mbedtls_ssl_parse_servername_ext", ret );
1485 return( ret );
1486 }
XiaokangQian40a35232022-05-07 09:02:40 +00001487 break;
1488#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1489
XiaokangQianb67384d2022-04-19 00:02:38 +00001490#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001491 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1492 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1493
1494 /* Supported Groups Extension
1495 *
1496 * When sent by the client, the "supported_groups" extension
1497 * indicates the named groups which the client supports,
1498 * ordered from most preferred to least preferred.
1499 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001500 ret = ssl_tls13_parse_supported_groups_ext(
1501 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001502 if( ret != 0 )
1503 {
1504 MBEDTLS_SSL_DEBUG_RET( 1,
1505 "mbedtls_ssl_parse_supported_groups_ext", ret );
1506 return( ret );
1507 }
1508
XiaokangQian7807f9f2022-02-15 10:04:37 +00001509 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001510#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001511
XiaokangQian88408882022-04-02 10:15:03 +00001512#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001513 case MBEDTLS_TLS_EXT_KEY_SHARE:
1514 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1515
1516 /*
1517 * Key Share Extension
1518 *
1519 * When sent by the client, the "key_share" extension
1520 * contains the endpoint's cryptographic parameters for
1521 * ECDHE/DHE key establishment methods.
1522 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001523 ret = ssl_tls13_parse_key_shares_ext(
1524 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001525 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001526 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001528 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001529 }
1530
Jerry Yu582dd062022-04-22 21:59:01 +08001531 if( ret < 0 )
1532 {
1533 MBEDTLS_SSL_DEBUG_RET(
1534 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001535 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001536 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001537
XiaokangQian7807f9f2022-02-15 10:04:37 +00001538 break;
XiaokangQian88408882022-04-02 10:15:03 +00001539#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001540
1541 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1542 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1543
1544 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001545 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001546 if( ret != 0 )
1547 {
1548 MBEDTLS_SSL_DEBUG_RET( 1,
1549 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1550 return( ret );
1551 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001552 break;
1553
Ronald Cron41a443a2022-10-04 16:38:25 +02001554#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001555 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1556 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1557
1558 ret = ssl_tls13_parse_key_exchange_modes_ext(
1559 ssl, p, extension_data_end );
1560 if( ret != 0 )
1561 {
1562 MBEDTLS_SSL_DEBUG_RET(
1563 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1564 return( ret );
1565 }
1566
Jerry Yue19e3b92022-07-08 12:04:51 +00001567 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001568#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001569
Jerry Yu1c105562022-07-10 06:32:38 +00001570 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1571 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yue18dc7e2022-08-04 16:29:22 +08001572 if( ( extensions_present &
Jerry Yu13ab81d2022-07-22 23:17:11 +08001573 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) == 0 )
1574 {
1575 MBEDTLS_SSL_PEND_FATAL_ALERT(
1576 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1577 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1578 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1579 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001580#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001581 /* Delay processing of the PSK identity once we have
1582 * found out which algorithms to use. We keep a pointer
1583 * to the buffer and the size for later processing.
1584 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001585 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001586 pre_shared_key_ext_end = extension_data_end;
Jerry Yue18dc7e2022-08-04 16:29:22 +08001587#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001588 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001589
XiaokangQianacb39922022-06-17 10:18:48 +00001590#if defined(MBEDTLS_SSL_ALPN)
1591 case MBEDTLS_TLS_EXT_ALPN:
1592 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1593
1594 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1595 if( ret != 0 )
1596 {
1597 MBEDTLS_SSL_DEBUG_RET(
1598 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1599 return( ret );
1600 }
XiaokangQianacb39922022-06-17 10:18:48 +00001601 break;
1602#endif /* MBEDTLS_SSL_ALPN */
1603
Ronald Cron928cbd32022-10-04 16:14:26 +02001604#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001605 case MBEDTLS_TLS_EXT_SIG_ALG:
1606 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1607
Gabor Mezei078e8032022-04-27 21:17:56 +02001608 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001609 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001610 if( ret != 0 )
1611 {
1612 MBEDTLS_SSL_DEBUG_MSG( 1,
1613 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1614 ret ) );
1615 return( ret );
1616 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001617 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001618#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001619
1620 default:
1621 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu471dee52022-08-04 16:33:14 +08001622 ( "client hello: received %s(%u) extension ( ignored )",
1623 mbedtls_tls13_get_extension_name( extension_type ),
1624 extension_type ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001625 }
1626
1627 p += extension_data_len;
1628 }
1629
Jerry Yue18dc7e2022-08-04 16:29:22 +08001630 MBEDTLS_SSL_TLS1_3_PRINT_EXTS( 3, "ClientHello", extensions_present );
1631
1632 /* RFC 8446 page 102
1633 * - "supported_versions" is REQUIRED for all ClientHello, ServerHello, and
1634 * HelloRetryRequest messages.
1635 */
1636 if( ( extensions_present & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) == 0 )
1637 {
1638 MBEDTLS_SSL_DEBUG_MSG( 1,
1639 ( "client hello: supported_versions not found" ) );
1640 MBEDTLS_SSL_PEND_FATAL_ALERT(
1641 MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION,
1642 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1643 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1644 }
1645
Jerry Yu1c105562022-07-10 06:32:38 +00001646 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1647 MBEDTLS_SSL_HS_CLIENT_HELLO,
1648 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001649
Ronald Cron41a443a2022-10-04 16:38:25 +02001650#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001651 /* Update checksum with either
1652 * - The entire content of the CH message, if no PSK extension is present
1653 * - The content up to but excluding the PSK extension, if present.
1654 */
Jerry Yu1c105562022-07-10 06:32:38 +00001655 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001656 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001657 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yuba9b6e92022-07-22 21:35:18 +08001658 ( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001659 {
1660 ssl->handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001661 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001662 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001663 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001664 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001665 cipher_suites,
1666 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001667 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001668 {
Jerry Yue18dc7e2022-08-04 16:29:22 +08001669 extensions_present &= ~MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001670 }
1671 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001672 {
Jerry Yubb852022022-07-20 21:10:44 +08001673 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_tls13_parse_pre_shared_key_ext" ),
Jerry Yu1c105562022-07-10 06:32:38 +00001674 ret );
1675 return( ret );
1676 }
Jerry Yu1c105562022-07-10 06:32:38 +00001677 }
1678 else
Ronald Cron41a443a2022-10-04 16:38:25 +02001679#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001680 {
1681 ssl->handshake->update_checksum( ssl, buf, p - buf );
1682 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001683
Jerry Yue18dc7e2022-08-04 16:29:22 +08001684 ssl->handshake->extensions_present = extensions_present;
Jerry Yuba9b6e92022-07-22 21:35:18 +08001685 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1686 if( ret < 0 )
1687 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001688
Jerry Yue5834fd2022-08-29 20:16:09 +08001689 mbedtls_ssl_optimize_checksum( ssl, ssl->handshake->ciphersuite_info );
1690
XiaokangQian75fe8c72022-06-15 09:42:45 +00001691 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1692}
1693
1694/* Update the handshake state machine */
1695
Ronald Cronce7d76e2022-07-08 18:56:49 +02001696MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001697static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1698{
1699 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1700
XiaokangQian7807f9f2022-02-15 10:04:37 +00001701 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001702 * Server certificate selection
1703 */
1704 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1705 {
1706 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1707 return( ret );
1708 }
1709#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1710 ssl->handshake->sni_name = NULL;
1711 ssl->handshake->sni_name_len = 0;
1712#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001713
XiaokangQian7807f9f2022-02-15 10:04:37 +00001714 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1715 if( ret != 0 )
1716 {
1717 MBEDTLS_SSL_DEBUG_RET( 1,
1718 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1719 return( ret );
1720 }
1721
XiaokangQian7807f9f2022-02-15 10:04:37 +00001722 return( 0 );
1723
1724}
1725
1726/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001727 * Main entry point from the state machine; orchestrates the otherfunctions.
1728 */
1729
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001730MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001731static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1732{
1733
XiaokangQian08037552022-04-20 07:16:41 +00001734 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001735 unsigned char* buf = NULL;
1736 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001737 int parse_client_hello_ret;
1738
XiaokangQianed582dd2022-04-13 08:21:05 +00001739 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1740
XiaokangQianed582dd2022-04-13 08:21:05 +00001741 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1742 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1743 &buf, &buflen ) );
1744
1745 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1746 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001747 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1748 * only SSL_CLIENT_HELLO_OK or
1749 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1750 * stage as negative error codes are handled
1751 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001752
XiaokangQiancfd925f2022-04-14 07:10:37 +00001753 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001754
Jerry Yu4ca91402022-05-09 15:50:57 +08001755 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1756 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1757 else
1758 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001759
1760cleanup:
1761
1762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1763 return( ret );
1764}
1765
1766/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001767 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001768 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001769MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001770static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1771{
Jerry Yu637a3f12022-04-20 21:37:58 +08001772 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1773 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001774 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001775 if( ssl->conf->f_rng == NULL )
1776 {
1777 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1778 return( MBEDTLS_ERR_SSL_NO_RNG );
1779 }
1780
Jerry Yu637a3f12022-04-20 21:37:58 +08001781 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001782 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1783 {
1784 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1785 return( ret );
1786 }
1787
Jerry Yu637a3f12022-04-20 21:37:58 +08001788 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001789 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1790
1791#if defined(MBEDTLS_HAVE_TIME)
1792 ssl->session_negotiate->start = time( NULL );
1793#endif /* MBEDTLS_HAVE_TIME */
1794
1795 return( ret );
1796}
1797
Jerry Yu3bf2c642022-03-30 22:02:12 +08001798/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001799 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001800 *
1801 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001802 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001803 * } SupportedVersions;
1804 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001805MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001806static int ssl_tls13_write_server_hello_supported_versions_ext(
1807 mbedtls_ssl_context *ssl,
1808 unsigned char *buf,
1809 unsigned char *end,
1810 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001811{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001812 *out_len = 0;
1813
Jerry Yu955ddd72022-04-22 22:27:33 +08001814 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001815
1816 /* Check if we have space to write the extension:
1817 * - extension_type (2 bytes)
1818 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001819 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001820 */
Jerry Yu349a6132022-04-14 20:52:56 +08001821 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001822
Jerry Yu349a6132022-04-14 20:52:56 +08001823 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001824
Jerry Yu349a6132022-04-14 20:52:56 +08001825 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001826
Jerry Yu349a6132022-04-14 20:52:56 +08001827 mbedtls_ssl_write_version( buf + 4,
1828 ssl->conf->transport,
1829 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001830
1831 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1832 ssl->tls_version ) );
1833
Jerry Yu349a6132022-04-14 20:52:56 +08001834 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001835
1836 return( 0 );
1837}
1838
Jerry Yud9436a12022-04-20 22:28:09 +08001839
Jerry Yu3bf2c642022-03-30 22:02:12 +08001840
1841/* Generate and export a single key share. For hybrid KEMs, this can
1842 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001843MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001844static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1845 uint16_t named_group,
1846 unsigned char *buf,
1847 unsigned char *end,
1848 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849{
1850 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001851
1852 *out_len = 0;
1853
Jerry Yu89e103c2022-03-30 22:43:29 +08001854#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001855 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1856 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001857 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1858 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001859 if( ret != 0 )
1860 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001861 MBEDTLS_SSL_DEBUG_RET(
1862 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1863 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001864 return( ret );
1865 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001866 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001867 else
1868#endif /* MBEDTLS_ECDH_C */
1869 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001870 {
1871 }
1872 else
1873 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001874 ((void) ssl);
1875 ((void) named_group);
1876 ((void) buf);
1877 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001878 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1879 }
1880
1881 return( ret );
1882}
1883
1884/*
1885 * ssl_tls13_write_key_share_ext
1886 *
1887 * Structure of key_share extension in ServerHello:
1888 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001889 * struct {
1890 * NamedGroup group;
1891 * opaque key_exchange<1..2^16-1>;
1892 * } KeyShareEntry;
1893 * struct {
1894 * KeyShareEntry server_share;
1895 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001896 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001897MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001898static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1899 unsigned char *buf,
1900 unsigned char *end,
1901 size_t *out_len )
1902{
Jerry Yu955ddd72022-04-22 22:27:33 +08001903 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001904 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001905 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001906 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001907 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001908
1909 *out_len = 0;
1910
1911 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1912
Jerry Yu58af2332022-09-06 11:19:31 +08001913 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1914 mbedtls_ssl_named_group_to_str( group ),
1915 group ) );
1916
Jerry Yu3bf2c642022-03-30 22:02:12 +08001917 /* Check if we have space for header and length fields:
1918 * - extension_type (2 bytes)
1919 * - extension_data_length (2 bytes)
1920 * - group (2 bytes)
1921 * - key_exchange_length (2 bytes)
1922 */
1923 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001924 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1925 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001926 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001927
Jerry Yu3bf2c642022-03-30 22:02:12 +08001928 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1929 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001930 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001931 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001932 if( ret != 0 )
1933 return( ret );
1934 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001935
Jerry Yu955ddd72022-04-22 22:27:33 +08001936 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001937
Jerry Yu57d48412022-04-20 21:50:42 +08001938 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001939
Jerry Yu57d48412022-04-20 21:50:42 +08001940 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001941
Jerry Yu3bf2c642022-03-30 22:02:12 +08001942 return( 0 );
1943}
Jerry Yud9436a12022-04-20 22:28:09 +08001944
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001945MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001946static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1947 unsigned char *buf,
1948 unsigned char *end,
1949 size_t *out_len )
1950{
1951 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1952 /* key_share Extension
1953 *
1954 * struct {
1955 * select (Handshake.msg_type) {
1956 * ...
1957 * case hello_retry_request:
1958 * NamedGroup selected_group;
1959 * ...
1960 * };
1961 * } KeyShare;
1962 */
1963
1964 *out_len = 0;
1965
Jerry Yub0ac10b2022-05-05 11:10:08 +08001966 /*
1967 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1968 * of the HRR is then to transmit a cookie to force the client to demonstrate
1969 * reachability at their apparent network address (primarily useful for DTLS).
1970 */
Ronald Cron79907712022-07-20 17:05:29 +02001971 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001972 return( 0 );
1973
1974 /* We should only send the key_share extension if the client's initial
1975 * key share was not acceptable. */
1976 if( ssl->handshake->offered_group_id != 0 )
1977 {
1978 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
1979 return( 0 );
1980 }
1981
1982 if( selected_group == 0 )
1983 {
1984 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
1985 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1986 }
1987
Jerry Yub0ac10b2022-05-05 11:10:08 +08001988 /* Check if we have enough space:
1989 * - extension_type (2 bytes)
1990 * - extension_data_length (2 bytes)
1991 * - selected_group (2 bytes)
1992 */
Ronald Cron154d1b62022-06-01 15:33:26 +02001993 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001994
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001995 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001996 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001997 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
1998
1999 MBEDTLS_SSL_DEBUG_MSG( 3,
2000 ( "HRR selected_group: %s (%x)",
2001 mbedtls_ssl_named_group_to_str( selected_group ),
2002 selected_group ) );
2003
2004 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002005
Jerry Yub0ac10b2022-05-05 11:10:08 +08002006 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002007}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002008
2009/*
2010 * Structure of ServerHello message:
2011 *
2012 * struct {
2013 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2014 * Random random;
2015 * opaque legacy_session_id_echo<0..32>;
2016 * CipherSuite cipher_suite;
2017 * uint8 legacy_compression_method = 0;
2018 * Extension extensions<6..2^16-1>;
2019 * } ServerHello;
2020 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002021MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002022static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002023 unsigned char *buf,
2024 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002025 size_t *out_len,
2026 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002027{
Jerry Yu955ddd72022-04-22 22:27:33 +08002028 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002029 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002030 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002031 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002032
2033 *out_len = 0;
2034
Jerry Yucfc04b32022-04-21 09:31:58 +08002035 /* ...
2036 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2037 * ...
2038 * with ProtocolVersion defined as:
2039 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002040 */
2041 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2042 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2043 p += 2;
2044
Jerry Yu1c3e6882022-04-20 21:23:40 +08002045 /* ...
2046 * Random random;
2047 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002048 * with Random defined as:
2049 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002050 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002051 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002052 if( is_hrr )
2053 {
2054 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002055 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002056 }
2057 else
2058 {
2059 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002060 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002061 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002062 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002063 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2064 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2065
Jerry Yucfc04b32022-04-21 09:31:58 +08002066 /* ...
2067 * opaque legacy_session_id_echo<0..32>;
2068 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002069 */
2070 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2071 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2072 if( ssl->session_negotiate->id_len > 0 )
2073 {
2074 memcpy( p, &ssl->session_negotiate->id[0],
2075 ssl->session_negotiate->id_len );
2076 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002077
Jerry Yu3bf2c642022-03-30 22:02:12 +08002078 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2079 ssl->session_negotiate->id_len );
2080 }
2081
Jerry Yucfc04b32022-04-21 09:31:58 +08002082 /* ...
2083 * CipherSuite cipher_suite;
2084 * ...
2085 * with CipherSuite defined as:
2086 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002087 */
2088 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2089 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2090 p += 2;
2091 MBEDTLS_SSL_DEBUG_MSG( 3,
2092 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2093 mbedtls_ssl_get_ciphersuite_name(
2094 ssl->session_negotiate->ciphersuite ),
2095 ssl->session_negotiate->ciphersuite ) );
2096
Jerry Yucfc04b32022-04-21 09:31:58 +08002097 /* ...
2098 * uint8 legacy_compression_method = 0;
2099 * ...
2100 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002102 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002103
Jerry Yucfc04b32022-04-21 09:31:58 +08002104 /* ...
2105 * Extension extensions<6..2^16-1>;
2106 * ...
2107 * struct {
2108 * ExtensionType extension_type; (2 bytes)
2109 * opaque extension_data<0..2^16-1>;
2110 * } Extension;
2111 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002112 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002113 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002114 p += 2;
2115
Jerry Yue74e04a2022-04-21 09:23:16 +08002116 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002117 ssl, p, end, &output_len ) ) != 0 )
2118 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002119 MBEDTLS_SSL_DEBUG_RET(
2120 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002121 return( ret );
2122 }
2123 p += output_len;
2124
Jerry Yu56acc942022-07-30 23:02:36 +08002125 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002126 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002127 if( is_hrr )
2128 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2129 else
2130 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002131 if( ret != 0 )
2132 return( ret );
2133 p += output_len;
2134 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002135
Ronald Cron41a443a2022-10-04 16:38:25 +02002136#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002137 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002138 {
Jerry Yubb852022022-07-20 21:10:44 +08002139 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002140 if( ret != 0 )
2141 {
Jerry Yubb852022022-07-20 21:10:44 +08002142 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002143 ret );
2144 return( ret );
2145 }
2146 p += output_len;
2147 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002148#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002149
Jerry Yud9436a12022-04-20 22:28:09 +08002150 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002151
Jerry Yud9436a12022-04-20 22:28:09 +08002152 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2153 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002154
Jerry Yud9436a12022-04-20 22:28:09 +08002155 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002156
Jerry Yud9436a12022-04-20 22:28:09 +08002157 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002158
2159 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002160}
2161
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002162MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002163static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2164{
2165 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002166 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002167 if( ret != 0 )
2168 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002169 MBEDTLS_SSL_DEBUG_RET( 1,
2170 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002171 ret );
2172 return( ret );
2173 }
2174
Jerry Yue110d252022-05-05 10:19:22 +08002175 return( ret );
2176}
2177
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002178MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002179static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2180{
Jerry Yu637a3f12022-04-20 21:37:58 +08002181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002182 unsigned char *buf;
2183 size_t buf_len, msg_len;
2184
2185 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2186
Jerry Yuf4b27e42022-03-30 17:32:21 +08002187 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2188
Jerry Yu3bf2c642022-03-30 22:02:12 +08002189 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002190 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2191
Jerry Yu3bf2c642022-03-30 22:02:12 +08002192 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2193 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002194 &msg_len,
2195 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002196
Jerry Yu3bf2c642022-03-30 22:02:12 +08002197 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002198 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2199
Jerry Yu3bf2c642022-03-30 22:02:12 +08002200 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002201 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002202
Jerry Yue110d252022-05-05 10:19:22 +08002203 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2204
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002205#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2206 /* The server sends a dummy change_cipher_spec record immediately
2207 * after its first handshake message. This may either be after
2208 * a ServerHello or a HelloRetryRequest.
2209 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002210 mbedtls_ssl_handshake_set_state(
2211 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002212#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002213 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002214#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002215
Jerry Yuf4b27e42022-03-30 17:32:21 +08002216cleanup:
2217
2218 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2219 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002220}
2221
Jerry Yu23d1a252022-05-12 18:08:59 +08002222
2223/*
2224 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2225 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002226MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002227static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002228{
2229 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2230 if( ssl->handshake->hello_retry_request_count > 0 )
2231 {
2232 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2233 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2234 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2235 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2236 }
2237
2238 /*
2239 * Create stateless transcript hash for HRR
2240 */
2241 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2242 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2243 if( ret != 0 )
2244 {
2245 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2246 return( ret );
2247 }
2248 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2249
2250 return( 0 );
2251}
2252
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002253MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002254static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2255{
2256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2257 unsigned char *buf;
2258 size_t buf_len, msg_len;
2259
2260 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2261
Ronald Cron7b840462022-06-01 17:05:53 +02002262 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002263
2264 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2265 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2266 &buf, &buf_len ) );
2267
2268 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2269 buf + buf_len,
2270 &msg_len,
2271 1 ) );
2272 mbedtls_ssl_add_hs_msg_to_checksum(
2273 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2274
2275
2276 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2277 msg_len ) );
2278
2279 ssl->handshake->hello_retry_request_count++;
2280
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002281#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2282 /* The server sends a dummy change_cipher_spec record immediately
2283 * after its first handshake message. This may either be after
2284 * a ServerHello or a HelloRetryRequest.
2285 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002286 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002287 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002288#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002289 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002290#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002291
2292cleanup:
2293 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2294 return( ret );
2295}
2296
Jerry Yu5b64ae92022-03-30 17:15:02 +08002297/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002298 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2299 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002300
2301/*
2302 * struct {
2303 * Extension extensions<0..2 ^ 16 - 1>;
2304 * } EncryptedExtensions;
2305 *
2306 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002307MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002308static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2309 unsigned char *buf,
2310 unsigned char *end,
2311 size_t *out_len )
2312{
XiaokangQianacb39922022-06-17 10:18:48 +00002313 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002314 unsigned char *p = buf;
2315 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002316 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002317 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002318
Jerry Yu4d3841a2022-04-16 12:37:19 +08002319 *out_len = 0;
2320
2321 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002322 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002323 p += 2;
2324
Jerry Yu8937eb42022-05-03 12:12:14 +08002325 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002326 ((void) ret);
2327 ((void) output_len);
2328
2329#if defined(MBEDTLS_SSL_ALPN)
2330 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2331 if( ret != 0 )
2332 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002333 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002334#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002335
Jerry Yu8937eb42022-05-03 12:12:14 +08002336 extensions_len = ( p - p_extensions_len ) - 2;
2337 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2338
2339 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002340
2341 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2342
2343 return( 0 );
2344}
2345
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002346MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002347static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2348{
2349 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2350 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002351 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002352
Gabor Mezei54719122022-06-28 11:34:56 +02002353 mbedtls_ssl_set_outbound_transform( ssl,
2354 ssl->handshake->transform_handshake );
2355 MBEDTLS_SSL_DEBUG_MSG(
2356 3, ( "switching to handshake transform for outbound data" ) );
2357
Jerry Yuab452cc2022-04-28 15:27:08 +08002358 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002359
Jerry Yu4d3841a2022-04-16 12:37:19 +08002360 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2361 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2362
2363 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2364 ssl, buf, buf + buf_len, &msg_len ) );
2365
2366 mbedtls_ssl_add_hs_msg_to_checksum(
2367 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2368
Jerry Yu4d3841a2022-04-16 12:37:19 +08002369 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2370 ssl, buf_len, msg_len ) );
2371
Ronald Cron928cbd32022-10-04 16:14:26 +02002372#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002373 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002374 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2375 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002376 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002377#else
2378 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2379#endif
2380
Jerry Yu4d3841a2022-04-16 12:37:19 +08002381cleanup:
2382
Jerry Yuab452cc2022-04-28 15:27:08 +08002383 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002384 return( ret );
2385}
2386
Ronald Cron928cbd32022-10-04 16:14:26 +02002387#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002388#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2389#define SSL_CERTIFICATE_REQUEST_SKIP 1
2390/* Coordination:
2391 * Check whether a CertificateRequest message should be written.
2392 * Returns a negative code on failure, or
2393 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2394 * - SSL_CERTIFICATE_REQUEST_SKIP
2395 * indicating if the writing of the CertificateRequest
2396 * should be skipped or not.
2397 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002398MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002399static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2400{
2401 int authmode;
2402
XiaokangQian40a35232022-05-07 09:02:40 +00002403#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2404 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2405 authmode = ssl->handshake->sni_authmode;
2406 else
2407#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002408 authmode = ssl->conf->authmode;
2409
2410 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
Ronald Croneac00ad2022-09-13 10:16:31 +02002411 {
2412 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002413 return( SSL_CERTIFICATE_REQUEST_SKIP );
Ronald Croneac00ad2022-09-13 10:16:31 +02002414 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002415
XiaokangQianc3017f62022-05-13 05:55:41 +00002416 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002417
XiaokangQiana987e1d2022-05-07 01:25:58 +00002418 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2419}
2420
XiaokangQiancec9ae62022-05-06 07:28:50 +00002421/*
2422 * struct {
2423 * opaque certificate_request_context<0..2^8-1>;
2424 * Extension extensions<2..2^16-1>;
2425 * } CertificateRequest;
2426 *
2427 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002428MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002429static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2430 unsigned char *buf,
2431 const unsigned char *end,
2432 size_t *out_len )
2433{
2434 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2435 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002436 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002437 unsigned char *p_extensions_len;
2438
2439 *out_len = 0;
2440
2441 /* Check if we have enough space:
2442 * - certificate_request_context (1 byte)
2443 * - extensions length (2 bytes)
2444 */
2445 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2446
2447 /*
2448 * Write certificate_request_context
2449 */
2450 /*
2451 * We use a zero length context for the normal handshake
2452 * messages. For post-authentication handshake messages
2453 * this request context would be set to a non-zero value.
2454 */
2455 *p++ = 0x0;
2456
2457 /*
2458 * Write extensions
2459 */
2460 /* The extensions must contain the signature_algorithms. */
2461 p_extensions_len = p;
2462 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002463 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002464 if( ret != 0 )
2465 return( ret );
2466
XiaokangQianec6efb92022-05-06 09:53:10 +00002467 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002468 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002469
2470 *out_len = p - buf;
2471
2472 return( 0 );
2473}
2474
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002475MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002476static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2477{
2478 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2479
2480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2481
2482 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2483
2484 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2485 {
2486 unsigned char *buf;
2487 size_t buf_len, msg_len;
2488
2489 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2490 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2491
2492 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2493 ssl, buf, buf + buf_len, &msg_len ) );
2494
2495 mbedtls_ssl_add_hs_msg_to_checksum(
2496 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2497
2498 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2499 ssl, buf_len, msg_len ) );
2500 }
2501 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2502 {
2503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2504 ret = 0;
2505 }
2506 else
2507 {
2508 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2509 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2510 goto cleanup;
2511 }
2512
2513 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2514cleanup:
2515
2516 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2517 return( ret );
2518}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002519
Jerry Yu4d3841a2022-04-16 12:37:19 +08002520/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002521 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002522 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002523MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002524static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002525{
Jerry Yu5a26f302022-05-10 20:46:40 +08002526 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002527
2528#if defined(MBEDTLS_X509_CRT_PARSE_C)
2529 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2530 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002531 {
Jerry Yub89125b2022-05-13 15:45:49 +08002532 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002533 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2534 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002535 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002536 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002537#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002538
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002539 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2540 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002541 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002542 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2543 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002544}
2545
2546/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002547 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002548 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002549MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002550static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002551{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002552 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002553 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002554 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002555 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2556 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002557}
Ronald Cron928cbd32022-10-04 16:14:26 +02002558#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002559
2560/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002561 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002562 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002563MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002564static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002565{
Jerry Yud6e253d2022-05-18 13:59:24 +08002566 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002567
2568 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2569 if( ret != 0 )
2570 return( ret );
2571
Jerry Yue3d67cb2022-05-19 15:33:10 +08002572 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2573 if( ret != 0 )
2574 {
2575 MBEDTLS_SSL_PEND_FATAL_ALERT(
2576 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2577 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2578 return( ret );
2579 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002580
Ronald Cron63dc4632022-05-31 14:41:53 +02002581 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2582 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002583
Ronald Cron63dc4632022-05-31 14:41:53 +02002584 if( ssl->handshake->certificate_request_sent )
2585 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002586 else
Ronald Cron19385882022-06-15 16:26:13 +02002587 {
2588 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2589 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002590 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002591 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002592
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002593 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002594}
2595
2596/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002597 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002598 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002599MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002600static int ssl_tls13_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002601{
Jerry Yud6e253d2022-05-18 13:59:24 +08002602 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2603
Jerry Yuff226982022-04-16 16:52:57 +08002604 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2605 if( ret != 0 )
2606 return( ret );
2607
Jerry Yu466dda82022-09-13 11:20:20 +08002608 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002609 if( ret != 0 )
2610 {
2611 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002612 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002613 }
2614
Jerry Yu03ed50b2022-04-16 17:13:30 +08002615 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002616 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002617}
2618
2619/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002620 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002621 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002622MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002623static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002624{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002625 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2626
Jerry Yu03ed50b2022-04-16 17:13:30 +08002627 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002628
2629#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002630 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2631#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002632 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002633#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002634 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002635}
2636
2637/*
Jerry Yue67bef42022-07-07 07:29:42 +00002638 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2639 */
2640#define SSL_NEW_SESSION_TICKET_SKIP 0
2641#define SSL_NEW_SESSION_TICKET_WRITE 1
2642MBEDTLS_CHECK_RETURN_CRITICAL
2643static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2644{
2645 /* Check whether the use of session tickets is enabled */
2646 if( ssl->conf->f_ticket_write == NULL )
2647 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2649 " callback is not set" ) );
2650 return( SSL_NEW_SESSION_TICKET_SKIP );
2651 }
2652 if( ssl->conf->new_session_tickets_count == 0 )
2653 {
2654 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2655 " configured count is zero" ) );
2656 return( SSL_NEW_SESSION_TICKET_SKIP );
2657 }
2658
2659 if( ssl->handshake->new_session_tickets_count == 0 )
2660 {
2661 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2662 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002663 return( SSL_NEW_SESSION_TICKET_SKIP );
2664 }
2665
Jerry Yue67bef42022-07-07 07:29:42 +00002666 return( SSL_NEW_SESSION_TICKET_WRITE );
2667}
2668
2669#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2670MBEDTLS_CHECK_RETURN_CRITICAL
2671static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2672 unsigned char *ticket_nonce,
2673 size_t ticket_nonce_size )
2674{
2675 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2676 mbedtls_ssl_session *session = ssl->session;
2677 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2678 psa_algorithm_t psa_hash_alg;
2679 int hash_length;
2680
2681 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2682
2683#if defined(MBEDTLS_HAVE_TIME)
2684 session->start = mbedtls_time( NULL );
2685#endif
2686
2687 /* Generate ticket_age_add */
2688 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002689 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002690 sizeof( session->ticket_age_add ) ) != 0 ) )
2691 {
2692 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2693 return( ret );
2694 }
2695 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002696 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002697
2698 /* Generate ticket_nonce */
2699 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2700 if( ret != 0 )
2701 {
2702 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2703 return( ret );
2704 }
2705 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2706 ticket_nonce, ticket_nonce_size );
2707
2708 ciphersuite_info =
2709 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2710 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2711 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002712 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002713 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002714 {
Jerry Yue67bef42022-07-07 07:29:42 +00002715 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002716 }
2717
Jerry Yue67bef42022-07-07 07:29:42 +00002718 /* In this code the psk key length equals the length of the hash */
2719 session->resumption_key_len = hash_length;
2720 session->ciphersuite = ciphersuite_info->id;
2721
2722 /* Compute resumption key
2723 *
2724 * HKDF-Expand-Label( resumption_master_secret,
2725 * "resumption", ticket_nonce, Hash.length )
2726 */
2727 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2728 psa_hash_alg,
2729 session->app_secrets.resumption_master_secret,
2730 hash_length,
2731 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2732 ticket_nonce,
2733 ticket_nonce_size,
2734 session->resumption_key,
2735 hash_length );
2736
2737 if( ret != 0 )
2738 {
2739 MBEDTLS_SSL_DEBUG_RET( 2,
2740 "Creating the ticket-resumed PSK failed",
2741 ret );
2742 return ( ret );
2743 }
2744 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2745 session->resumption_key,
2746 session->resumption_key_len );
2747
2748 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2749 session->app_secrets.resumption_master_secret,
2750 hash_length );
2751
2752 return( 0 );
2753}
2754
2755/* This function creates a NewSessionTicket message in the following format:
2756 *
2757 * struct {
2758 * uint32 ticket_lifetime;
2759 * uint32 ticket_age_add;
2760 * opaque ticket_nonce<0..255>;
2761 * opaque ticket<1..2^16-1>;
2762 * Extension extensions<0..2^16-2>;
2763 * } NewSessionTicket;
2764 *
2765 * The ticket inside the NewSessionTicket message is an encrypted container
2766 * carrying the necessary information so that the server is later able to
2767 * re-start the communication.
2768 *
2769 * The following fields are placed inside the ticket by the
2770 * f_ticket_write() function:
2771 *
2772 * - creation time (start)
2773 * - flags (flags)
2774 * - age add (ticket_age_add)
2775 * - key (key)
2776 * - key length (key_len)
2777 * - ciphersuite (ciphersuite)
2778 */
2779MBEDTLS_CHECK_RETURN_CRITICAL
2780static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2781 unsigned char *buf,
2782 unsigned char *end,
2783 size_t *out_len,
2784 unsigned char *ticket_nonce,
2785 size_t ticket_nonce_size )
2786{
2787 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2788 unsigned char *p = buf;
2789 mbedtls_ssl_session *session = ssl->session;
2790 size_t ticket_len;
2791 uint32_t ticket_lifetime;
2792
2793 *out_len = 0;
2794 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2795
2796 /*
2797 * ticket_lifetime 4 bytes
2798 * ticket_age_add 4 bytes
2799 * ticket_nonce 1 + ticket_nonce_size bytes
2800 * ticket >=2 bytes
2801 */
2802 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2803
2804 /* Generate ticket and ticket_lifetime */
2805 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2806 session,
2807 p + 9 + ticket_nonce_size + 2,
2808 end,
2809 &ticket_len,
2810 &ticket_lifetime);
2811 if( ret != 0 )
2812 {
2813 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2814 return( ret );
2815 }
2816 /* RFC 8446 4.6.1
2817 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2818 * unsigned integer in network byte order from the time of ticket
2819 * issuance. Servers MUST NOT use any value greater than
2820 * 604800 seconds (7 days). The value of zero indicates that the
2821 * ticket should be discarded immediately. Clients MUST NOT cache
2822 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2823 * and MAY delete tickets earlier based on local policy. A server
2824 * MAY treat a ticket as valid for a shorter period of time than what
2825 * is stated in the ticket_lifetime.
2826 */
Xiaokang Qian28af5012022-10-13 08:18:19 +00002827 if( ticket_lifetime > 604800 )
2828 ticket_lifetime = 604800;
Jerry Yue67bef42022-07-07 07:29:42 +00002829 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2830 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2831 ( unsigned int )ticket_lifetime ) );
2832
2833 /* Write ticket_age_add */
2834 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2835 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2836 ( unsigned int )session->ticket_age_add ) );
2837
2838 /* Write ticket_nonce */
2839 p[8] = ( unsigned char )ticket_nonce_size;
2840 if( ticket_nonce_size > 0 )
2841 {
2842 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2843 }
2844 p += 9 + ticket_nonce_size;
2845
2846 /* Write ticket */
2847 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2848 p += 2;
2849 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2850 p += ticket_len;
2851
2852 /* Ticket Extensions
2853 *
2854 * Note: We currently don't have any extensions.
2855 * Set length to zero.
2856 */
2857 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2858 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2859 p += 2;
2860
2861 *out_len = p - buf;
2862 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2863 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2864
2865 return( 0 );
2866}
2867
2868/*
2869 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2870 */
2871static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2872{
2873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2874
2875 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2876
2877 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2878 {
2879 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2880 unsigned char *buf;
2881 size_t buf_len, msg_len;
2882
2883 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2884 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2885
2886 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2887 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2888
2889 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2890 ssl, buf, buf + buf_len, &msg_len,
2891 ticket_nonce, sizeof( ticket_nonce ) ) );
2892
Jerry Yue67bef42022-07-07 07:29:42 +00002893 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2894 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002895
Jerry Yu359e65f2022-09-22 23:47:43 +08002896 /* Limit session tickets count to one when resumption connection.
2897 *
2898 * See document of mbedtls_ssl_conf_new_session_tickets.
2899 */
2900 if( ssl->handshake->resume == 1 )
2901 ssl->handshake->new_session_tickets_count = 0;
2902 else
2903 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002904
Jerry Yufca4d572022-07-21 10:37:48 +08002905 mbedtls_ssl_handshake_set_state( ssl,
2906 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002907 }
2908 else
2909 {
2910 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2911 }
2912
Jerry Yue67bef42022-07-07 07:29:42 +00002913cleanup:
2914
2915 return( ret );
2916}
2917#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2918
2919/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002920 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002921 */
Jerry Yu27561932021-08-27 17:07:38 +08002922int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002923{
XiaokangQian08037552022-04-20 07:16:41 +00002924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002925
2926 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2927 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2928
Jerry Yue3b34122021-09-28 17:53:35 +08002929 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2930 mbedtls_ssl_states_str( ssl->state ),
2931 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002932
XiaokangQian7807f9f2022-02-15 10:04:37 +00002933 switch( ssl->state )
2934 {
2935 /* start state */
2936 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002937 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002938 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002939 break;
2940
XiaokangQian7807f9f2022-02-15 10:04:37 +00002941 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002942 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002943 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002944 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002945 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002946
Jerry Yuf41553b2022-05-09 22:20:30 +08002947 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2948 ret = ssl_tls13_write_hello_retry_request( ssl );
2949 if( ret != 0 )
2950 {
2951 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2952 return( ret );
2953 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002954 break;
2955
Jerry Yu5b64ae92022-03-30 17:15:02 +08002956 case MBEDTLS_SSL_SERVER_HELLO:
2957 ret = ssl_tls13_write_server_hello( ssl );
2958 break;
2959
Xiaofei Baicba64af2022-02-15 10:00:56 +00002960 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002961 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002962 if( ret != 0 )
2963 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002964 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2965 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002966 }
Jerry Yu48330562022-05-06 21:35:44 +08002967 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002968
Ronald Cron928cbd32022-10-04 16:14:26 +02002969#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002970 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002971 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002972 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002973
Jerry Yu83da34e2022-04-16 13:59:52 +08002974 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2975 ret = ssl_tls13_write_server_certificate( ssl );
2976 break;
2977
2978 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
2979 ret = ssl_tls13_write_certificate_verify( ssl );
2980 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02002981#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002982
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002983 /*
2984 * Injection of dummy-CCS's for middlebox compatibility
2985 */
2986#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002987 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002988 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2989 if( ret == 0 )
2990 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2991 break;
2992
2993 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
2994 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2995 if( ret == 0 )
2996 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2997 break;
2998#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2999
Jerry Yu69dd8d42022-04-16 12:51:26 +08003000 case MBEDTLS_SSL_SERVER_FINISHED:
3001 ret = ssl_tls13_write_server_finished( ssl );
3002 break;
3003
3004 case MBEDTLS_SSL_CLIENT_FINISHED:
3005 ret = ssl_tls13_process_client_finished( ssl );
3006 break;
3007
Jerry Yu69dd8d42022-04-16 12:51:26 +08003008 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3009 ret = ssl_tls13_handshake_wrapup( ssl );
3010 break;
3011
Ronald Cron766c0cd2022-10-18 12:17:11 +02003012#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003013 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3014 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003015 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003016 {
Ronald Cron209cae92022-06-07 10:30:19 +02003017 if( ssl->session_negotiate->peer_cert != NULL )
3018 {
3019 mbedtls_ssl_handshake_set_state(
3020 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3021 }
3022 else
Ronald Cron19385882022-06-15 16:26:13 +02003023 {
3024 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003025 mbedtls_ssl_handshake_set_state(
3026 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003027 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003028 }
3029 break;
3030
3031 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3032 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3033 if( ret == 0 )
3034 {
3035 mbedtls_ssl_handshake_set_state(
3036 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3037 }
3038 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003039#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003040
Jerry Yue67bef42022-07-07 07:29:42 +00003041#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3042 case MBEDTLS_SSL_NEW_SESSION_TICKET:
3043 ret = ssl_tls13_write_new_session_ticket( ssl );
3044 if( ret != 0 )
3045 {
3046 MBEDTLS_SSL_DEBUG_RET( 1,
3047 "ssl_tls13_write_new_session_ticket ",
3048 ret );
3049 }
3050 break;
3051 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
3052 /* This state is necessary to do the flush of the New Session
3053 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
3054 * as part of ssl_prepare_handshake_step.
3055 */
3056 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003057
Jerry Yud0766ec2022-09-22 10:46:57 +08003058 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003059 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3060 else
3061 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003062 break;
3063
3064#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3065
XiaokangQian7807f9f2022-02-15 10:04:37 +00003066 default:
3067 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003068 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003069 }
3070
3071 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003072}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003073
Jerry Yufb4b6472022-01-27 15:03:26 +08003074#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */