blob: 3762393b96afe734cad8784941242b489d51f03b [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
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000929#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000930static void ssl_tls13_debug_print_client_hello_exts( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000931{
XiaokangQian3207a322022-02-23 03:15:27 +0000932 ((void) ssl);
933
XiaokangQian7807f9f2022-02-15 10:04:37 +0000934 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Supported Extensions:" ) );
XiaokangQianb67384d2022-04-19 00:02:38 +0000935 MBEDTLS_SSL_DEBUG_MSG( 3,
936 ( "- KEY_SHARE_EXTENSION ( %s )",
937 ( ( ssl->handshake->extensions_present
938 & MBEDTLS_SSL_EXT_KEY_SHARE ) > 0 ) ? "TRUE" : "FALSE" ) );
939 MBEDTLS_SSL_DEBUG_MSG( 3,
940 ( "- PSK_KEY_EXCHANGE_MODES_EXTENSION ( %s )",
941 ( ( ssl->handshake->extensions_present
942 & MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) > 0 ) ?
943 "TRUE" : "FALSE" ) );
944 MBEDTLS_SSL_DEBUG_MSG( 3,
945 ( "- PRE_SHARED_KEY_EXTENSION ( %s )",
946 ( ( ssl->handshake->extensions_present
947 & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) > 0 ) ? "TRUE" : "FALSE" ) );
948 MBEDTLS_SSL_DEBUG_MSG( 3,
949 ( "- SIGNATURE_ALGORITHM_EXTENSION ( %s )",
950 ( ( ssl->handshake->extensions_present
951 & MBEDTLS_SSL_EXT_SIG_ALG ) > 0 ) ? "TRUE" : "FALSE" ) );
952 MBEDTLS_SSL_DEBUG_MSG( 3,
953 ( "- SUPPORTED_GROUPS_EXTENSION ( %s )",
954 ( ( ssl->handshake->extensions_present
955 & MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ) >0 ) ?
956 "TRUE" : "FALSE" ) );
957 MBEDTLS_SSL_DEBUG_MSG( 3,
958 ( "- SUPPORTED_VERSION_EXTENSION ( %s )",
959 ( ( ssl->handshake->extensions_present
960 & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) > 0 ) ?
961 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000962#if defined ( MBEDTLS_SSL_SERVER_NAME_INDICATION )
XiaokangQianb67384d2022-04-19 00:02:38 +0000963 MBEDTLS_SSL_DEBUG_MSG( 3,
964 ( "- SERVERNAME_EXTENSION ( %s )",
965 ( ( ssl->handshake->extensions_present
966 & MBEDTLS_SSL_EXT_SERVERNAME ) > 0 ) ?
967 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000968#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianacb39922022-06-17 10:18:48 +0000969#if defined ( MBEDTLS_SSL_ALPN )
970 MBEDTLS_SSL_DEBUG_MSG( 3,
971 ( "- ALPN_EXTENSION ( %s )",
972 ( ( ssl->handshake->extensions_present
973 & MBEDTLS_SSL_EXT_ALPN ) > 0 ) ?
974 "TRUE" : "FALSE" ) );
975#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000976}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000977#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000978
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200979MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +0000980static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000981 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000982{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000983 int masked = ssl->handshake->extensions_present & exts_mask;
984 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000985}
986
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200987MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +0000988static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
989 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000990{
Jerry Yu77f01482022-07-11 07:03:24 +0000991 return( ssl_tls13_client_hello_has_exts(
992 ssl,
993 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
994 MBEDTLS_SSL_EXT_KEY_SHARE |
995 MBEDTLS_SSL_EXT_SIG_ALG ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000996}
997
Ronald Cron41a443a2022-10-04 16:38:25 +0200998#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +0000999MBEDTLS_CHECK_RETURN_CRITICAL
1000static int ssl_tls13_client_hello_has_exts_for_psk_key_exchange(
1001 mbedtls_ssl_context *ssl )
1002{
1003 return( ssl_tls13_client_hello_has_exts(
1004 ssl,
1005 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
1006 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
1007}
1008
1009MBEDTLS_CHECK_RETURN_CRITICAL
1010static int ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange(
1011 mbedtls_ssl_context *ssl )
1012{
1013 return( ssl_tls13_client_hello_has_exts(
1014 ssl,
1015 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
1016 MBEDTLS_SSL_EXT_KEY_SHARE |
1017 MBEDTLS_SSL_EXT_PRE_SHARED_KEY |
1018 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) );
1019}
Ronald Cron41a443a2022-10-04 16:38:25 +02001020#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu77f01482022-07-11 07:03:24 +00001021
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001022MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianb67384d2022-04-19 00:02:38 +00001023static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001024{
Jerry Yu77f01482022-07-11 07:03:24 +00001025 return( mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) &&
1026 ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) );
1027}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001028
Jerry Yu77f01482022-07-11 07:03:24 +00001029MBEDTLS_CHECK_RETURN_CRITICAL
1030static int ssl_tls13_check_psk_key_exchange( mbedtls_ssl_context *ssl )
1031{
Ronald Cron41a443a2022-10-04 16:38:25 +02001032#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001033 return( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) &&
1034 mbedtls_ssl_tls13_psk_enabled( ssl ) &&
1035 ssl_tls13_client_hello_has_exts_for_psk_key_exchange( ssl ) );
1036#else
1037 ((void) ssl);
1038 return( 0 );
1039#endif
1040}
XiaokangQian7807f9f2022-02-15 10:04:37 +00001041
Jerry Yu77f01482022-07-11 07:03:24 +00001042MBEDTLS_CHECK_RETURN_CRITICAL
1043static int ssl_tls13_check_psk_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
1044{
Ronald Cron41a443a2022-10-04 16:38:25 +02001045#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu77f01482022-07-11 07:03:24 +00001046 return( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) &&
1047 mbedtls_ssl_tls13_psk_ephemeral_enabled( ssl ) &&
1048 ssl_tls13_client_hello_has_exts_for_psk_ephemeral_key_exchange( ssl ) );
1049#else
1050 ((void) ssl);
1051 return( 0 );
1052#endif
1053}
1054
1055static int ssl_tls13_determine_key_exchange_mode( mbedtls_ssl_context *ssl )
1056{
1057 /*
1058 * Determine the key exchange algorithm to use.
1059 * There are three types of key exchanges supported in TLS 1.3:
1060 * - (EC)DH with ECDSA,
1061 * - (EC)DH with PSK,
1062 * - plain PSK.
1063 *
1064 * The PSK-based key exchanges may additionally be used with 0-RTT.
1065 *
1066 * Our built-in order of preference is
Jerry Yuce6ed702022-07-22 21:49:53 +08001067 * 1 ) (EC)DHE-PSK Mode ( psk_ephemeral )
1068 * 2 ) Certificate Mode ( ephemeral )
1069 * 3 ) Plain PSK Mode ( psk )
Jerry Yu77f01482022-07-11 07:03:24 +00001070 */
1071
1072 ssl->handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_NONE;
1073
Jerry Yu77f01482022-07-11 07:03:24 +00001074 if( ssl_tls13_check_psk_ephemeral_key_exchange( ssl ) )
1075 {
1076 ssl->handshake->key_exchange_mode =
1077 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
1078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk_ephemeral" ) );
1079 }
1080 else
1081 if( ssl_tls13_check_ephemeral_key_exchange( ssl ) )
1082 {
1083 ssl->handshake->key_exchange_mode =
1084 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
1085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: ephemeral" ) );
1086 }
1087 else
Jerry Yuce6ed702022-07-22 21:49:53 +08001088 if( ssl_tls13_check_psk_key_exchange( ssl ) )
1089 {
1090 ssl->handshake->key_exchange_mode =
1091 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
1092 MBEDTLS_SSL_DEBUG_MSG( 2, ( "key exchange mode: psk" ) );
1093 }
1094 else
Jerry Yu77f01482022-07-11 07:03:24 +00001095 {
1096 MBEDTLS_SSL_DEBUG_MSG(
1097 1,
1098 ( "ClientHello message misses mandatory extensions." ) );
1099 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
1100 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1101 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1102 }
1103
1104 return( 0 );
1105
XiaokangQian7807f9f2022-02-15 10:04:37 +00001106}
1107
XiaokangQian81802f42022-06-10 13:25:22 +00001108#if defined(MBEDTLS_X509_CRT_PARSE_C) && \
Ronald Cron928cbd32022-10-04 16:14:26 +02001109 defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron67ea2542022-09-15 17:34:42 +02001110
1111#if defined(MBEDTLS_USE_PSA_CRYPTO)
1112static psa_algorithm_t ssl_tls13_iana_sig_alg_to_psa_alg( uint16_t sig_alg )
1113{
1114 switch( sig_alg )
1115 {
1116 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP256R1_SHA256:
1117 return( PSA_ALG_ECDSA( PSA_ALG_SHA_256 ) );
1118 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP384R1_SHA384:
1119 return( PSA_ALG_ECDSA( PSA_ALG_SHA_384 ) );
1120 case MBEDTLS_TLS1_3_SIG_ECDSA_SECP521R1_SHA512:
1121 return( PSA_ALG_ECDSA( PSA_ALG_SHA_512 ) );
1122 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA256:
1123 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_256 ) );
1124 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA384:
1125 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_384 ) );
1126 case MBEDTLS_TLS1_3_SIG_RSA_PSS_RSAE_SHA512:
1127 return( PSA_ALG_RSA_PSS( PSA_ALG_SHA_512 ) );
1128 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA256:
Ronald Cronb72dac42022-09-27 08:56:47 +02001129 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_256 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001130 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA384:
Ronald Cronb72dac42022-09-27 08:56:47 +02001131 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_384 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001132 case MBEDTLS_TLS1_3_SIG_RSA_PKCS1_SHA512:
Ronald Cronb72dac42022-09-27 08:56:47 +02001133 return( PSA_ALG_RSA_PKCS1V15_SIGN( PSA_ALG_SHA_512 ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001134 default:
1135 return( PSA_ALG_NONE );
1136 }
1137}
1138#endif /* MBEDTLS_USE_PSA_CRYPTO */
1139
XiaokangQian23c5be62022-06-07 02:04:34 +00001140/*
XiaokangQianfb665a82022-06-15 03:57:21 +00001141 * Pick best ( private key, certificate chain ) pair based on the signature
1142 * algorithms supported by the client.
XiaokangQian23c5be62022-06-07 02:04:34 +00001143 */
Ronald Cronce7d76e2022-07-08 18:56:49 +02001144MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian07aad072022-06-14 05:35:09 +00001145static int ssl_tls13_pick_key_cert( mbedtls_ssl_context *ssl )
XiaokangQian23c5be62022-06-07 02:04:34 +00001146{
XiaokangQianfb665a82022-06-15 03:57:21 +00001147 mbedtls_ssl_key_cert *key_cert, *key_cert_list;
XiaokangQian81802f42022-06-10 13:25:22 +00001148 const uint16_t *sig_alg = ssl->handshake->received_sig_algs;
XiaokangQian23c5be62022-06-07 02:04:34 +00001149
1150#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1151 if( ssl->handshake->sni_key_cert != NULL )
XiaokangQianfb665a82022-06-15 03:57:21 +00001152 key_cert_list = ssl->handshake->sni_key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001153 else
1154#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQianfb665a82022-06-15 03:57:21 +00001155 key_cert_list = ssl->conf->key_cert;
XiaokangQian23c5be62022-06-07 02:04:34 +00001156
XiaokangQianfb665a82022-06-15 03:57:21 +00001157 if( key_cert_list == NULL )
XiaokangQian23c5be62022-06-07 02:04:34 +00001158 {
1159 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server has no certificate" ) );
1160 return( -1 );
1161 }
1162
XiaokangQian81802f42022-06-10 13:25:22 +00001163 for( ; *sig_alg != MBEDTLS_TLS1_3_SIG_NONE; sig_alg++ )
XiaokangQian23c5be62022-06-07 02:04:34 +00001164 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001165 if( !mbedtls_ssl_sig_alg_is_offered( ssl, *sig_alg ) )
1166 continue;
1167
1168 if( !mbedtls_ssl_tls13_sig_alg_for_cert_verify_is_supported( *sig_alg ) )
1169 continue;
1170
XiaokangQianfb665a82022-06-15 03:57:21 +00001171 for( key_cert = key_cert_list; key_cert != NULL;
1172 key_cert = key_cert->next )
XiaokangQian23c5be62022-06-07 02:04:34 +00001173 {
Ronald Cron67ea2542022-09-15 17:34:42 +02001174#if defined(MBEDTLS_USE_PSA_CRYPTO)
1175 psa_algorithm_t psa_alg = PSA_ALG_NONE;
1176#endif /* MBEDTLS_USE_PSA_CRYPTO */
1177
XiaokangQianfb665a82022-06-15 03:57:21 +00001178 MBEDTLS_SSL_DEBUG_CRT( 3, "certificate (chain) candidate",
1179 key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001180
1181 /*
1182 * This avoids sending the client a cert it'll reject based on
1183 * keyUsage or other extensions.
1184 */
1185 if( mbedtls_x509_crt_check_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001186 key_cert->cert, MBEDTLS_X509_KU_DIGITAL_SIGNATURE ) != 0 ||
XiaokangQian81802f42022-06-10 13:25:22 +00001187 mbedtls_x509_crt_check_extended_key_usage(
XiaokangQianfb665a82022-06-15 03:57:21 +00001188 key_cert->cert, MBEDTLS_OID_SERVER_AUTH,
1189 MBEDTLS_OID_SIZE( MBEDTLS_OID_SERVER_AUTH ) ) != 0 )
XiaokangQian81802f42022-06-10 13:25:22 +00001190 {
1191 MBEDTLS_SSL_DEBUG_MSG( 3, ( "certificate mismatch: "
XiaokangQianfb665a82022-06-15 03:57:21 +00001192 "(extended) key usage extension" ) );
XiaokangQian81802f42022-06-10 13:25:22 +00001193 continue;
1194 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001195
Jerry Yucc539102022-06-27 16:27:35 +08001196 MBEDTLS_SSL_DEBUG_MSG( 3,
1197 ( "ssl_tls13_pick_key_cert:"
1198 "check signature algorithm %s [%04x]",
1199 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1200 *sig_alg ) );
Ronald Cron67ea2542022-09-15 17:34:42 +02001201#if defined(MBEDTLS_USE_PSA_CRYPTO)
1202 psa_alg = ssl_tls13_iana_sig_alg_to_psa_alg( *sig_alg );
1203#endif /* MBEDTLS_USE_PSA_CRYPTO */
1204
Jerry Yufb526692022-06-19 11:22:49 +08001205 if( mbedtls_ssl_tls13_check_sig_alg_cert_key_match(
Ronald Cron67ea2542022-09-15 17:34:42 +02001206 *sig_alg, &key_cert->cert->pk )
1207#if defined(MBEDTLS_USE_PSA_CRYPTO)
1208 && psa_alg != PSA_ALG_NONE &&
1209 mbedtls_pk_can_do_ext( &key_cert->cert->pk, psa_alg,
1210 PSA_KEY_USAGE_SIGN_HASH ) == 1
1211#endif /* MBEDTLS_USE_PSA_CRYPTO */
1212 )
XiaokangQian81802f42022-06-10 13:25:22 +00001213 {
XiaokangQianfb665a82022-06-15 03:57:21 +00001214 ssl->handshake->key_cert = key_cert;
Jerry Yucc539102022-06-27 16:27:35 +08001215 MBEDTLS_SSL_DEBUG_MSG( 3,
1216 ( "ssl_tls13_pick_key_cert:"
1217 "selected signature algorithm"
1218 " %s [%04x]",
1219 mbedtls_ssl_sig_alg_to_str( *sig_alg ),
1220 *sig_alg ) );
XiaokangQianfb665a82022-06-15 03:57:21 +00001221 MBEDTLS_SSL_DEBUG_CRT(
XiaokangQian75fe8c72022-06-15 09:42:45 +00001222 3, "selected certificate (chain)",
XiaokangQianfb665a82022-06-15 03:57:21 +00001223 ssl->handshake->key_cert->cert );
XiaokangQian81802f42022-06-10 13:25:22 +00001224 return( 0 );
1225 }
XiaokangQian81802f42022-06-10 13:25:22 +00001226 }
XiaokangQian23c5be62022-06-07 02:04:34 +00001227 }
1228
Jerry Yu9d3e2fa2022-06-27 22:14:01 +08001229 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ssl_tls13_pick_key_cert:"
1230 "no suitable certificate found" ) );
XiaokangQian23c5be62022-06-07 02:04:34 +00001231 return( -1 );
1232}
XiaokangQian81802f42022-06-10 13:25:22 +00001233#endif /* MBEDTLS_X509_CRT_PARSE_C &&
Ronald Cron928cbd32022-10-04 16:14:26 +02001234 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian23c5be62022-06-07 02:04:34 +00001235
XiaokangQian4080a7f2022-04-11 09:55:18 +00001236/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001237 *
1238 * STATE HANDLING: ClientHello
1239 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001240 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +00001241 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001242 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001243 *
1244 * In this case, the server progresses to sending its ServerHello.
1245 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001246 * 2) The ClientHello was well-formed but didn't match the server's
1247 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +00001248 *
1249 * For example, the client might not have offered a key share which
1250 * the server supports, or the server might require a cookie.
1251 *
1252 * In this case, the server sends a HelloRetryRequest.
1253 *
XiaokangQianb67384d2022-04-19 00:02:38 +00001254 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +00001255 *
1256 * In this case, we abort the handshake.
1257 *
1258 */
1259
1260/*
XiaokangQian4080a7f2022-04-11 09:55:18 +00001261 * Structure of this message:
1262 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001263 * uint16 ProtocolVersion;
1264 * opaque Random[32];
1265 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +00001266 *
XiaokangQiane8ff3502022-04-22 02:34:40 +00001267 * struct {
1268 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
1269 * Random random;
1270 * opaque legacy_session_id<0..32>;
1271 * CipherSuite cipher_suites<2..2^16-2>;
1272 * opaque legacy_compression_methods<1..2^8-1>;
1273 * Extension extensions<8..2^16-1>;
1274 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001275 */
XiaokangQianed582dd2022-04-13 08:21:05 +00001276
1277#define SSL_CLIENT_HELLO_OK 0
1278#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
1279
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001280MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian4080a7f2022-04-11 09:55:18 +00001281static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
1282 const unsigned char *buf,
1283 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001284{
XiaokangQianb67384d2022-04-19 00:02:38 +00001285 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1286 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001287 size_t legacy_session_id_len;
XiaokangQian318dc762022-04-20 09:43:51 +00001288 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +00001289 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +00001290 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001291 const unsigned char *extensions_end;
Jerry Yu49ca9282022-05-05 11:05:22 +08001292 int hrr_required = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001293
Ronald Cron41a443a2022-10-04 16:38:25 +02001294#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu5725f1c2022-08-21 17:27:16 +08001295 const unsigned char *cipher_suites;
Jerry Yu29d9faa2022-08-23 17:52:45 +08001296 const unsigned char *pre_shared_key_ext = NULL;
Jerry Yu1c105562022-07-10 06:32:38 +00001297 const unsigned char *pre_shared_key_ext_end = NULL;
Ronald Cron41a443a2022-10-04 16:38:25 +02001298#endif
XiaokangQian7807f9f2022-02-15 10:04:37 +00001299
1300 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1301
1302 /*
XiaokangQianb67384d2022-04-19 00:02:38 +00001303 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001304 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +00001305 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +00001306 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001307 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +00001308 * .. . .. ciphersuite list length ( 2 bytes )
1309 * .. . .. ciphersuite list
1310 * .. . .. compression alg. list length ( 1 byte )
1311 * .. . .. compression alg. list
1312 * .. . .. extensions length ( 2 bytes, optional )
1313 * .. . .. extensions ( optional )
1314 */
1315
XiaokangQianb67384d2022-04-19 00:02:38 +00001316 /*
bootstrap-prime6dbbf442022-05-17 19:30:44 -04001317 * Minimal length ( with everything empty and extensions omitted ) is
XiaokangQian7807f9f2022-02-15 10:04:37 +00001318 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
1319 * read at least up to session id length without worrying.
1320 */
1321 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
1322
1323 /* ...
1324 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1325 * ...
1326 * with ProtocolVersion defined as:
1327 * uint16 ProtocolVersion;
1328 */
XiaokangQiande333912022-04-20 08:49:42 +00001329 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1330 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001331 {
1332 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1333 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1334 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +00001335 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001336 }
1337 p += 2;
1338
1339 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +00001340 * Only support TLS 1.3 currently, temporarily set the version.
1341 */
XiaokangQiande333912022-04-20 08:49:42 +00001342 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +00001343
Jerry Yue67bef42022-07-07 07:29:42 +00001344#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1345 /* Store minor version for later use with ticket serialization. */
1346 ssl->session_negotiate->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
Jerry Yua66fece2022-07-13 14:30:29 +08001347 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
Jerry Yufca4d572022-07-21 10:37:48 +08001348#endif
Jerry Yue67bef42022-07-07 07:29:42 +00001349
Jerry Yuc1be19f2022-04-23 16:11:39 +08001350 /* ...
1351 * Random random;
1352 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001353 * with Random defined as:
1354 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +00001355 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001356 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +00001357 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001358
XiaokangQian08037552022-04-20 07:16:41 +00001359 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
1360 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001361
Jerry Yuc1be19f2022-04-23 16:11:39 +08001362 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001363 * opaque legacy_session_id<0..32>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001364 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001365 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001366 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +00001367 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001368
XiaokangQianb67384d2022-04-19 00:02:38 +00001369 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001370 {
1371 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
1372 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
1373 }
1374
XiaokangQian4080a7f2022-04-11 09:55:18 +00001375 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +00001376 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +00001377 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +00001378 /*
1379 * Check we have enough data for the legacy session identifier
Jerry Yue95c8af2022-07-26 15:48:20 +08001380 * and the ciphersuite list length.
XiaokangQianb67384d2022-04-19 00:02:38 +00001381 */
1382 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001383
XiaokangQianed582dd2022-04-13 08:21:05 +00001384 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +00001385 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001386
XiaokangQian7807f9f2022-02-15 10:04:37 +00001387 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1388 p += 2;
1389
XiaokangQianb67384d2022-04-19 00:02:38 +00001390 /* Check we have enough data for the ciphersuite list, the legacy
1391 * compression methods and the length of the extensions.
Jerry Yue95c8af2022-07-26 15:48:20 +08001392 *
1393 * cipher_suites cipher_suites_len bytes
1394 * legacy_compression_methods 2 bytes
1395 * extensions_len 2 bytes
XiaokangQianb67384d2022-04-19 00:02:38 +00001396 */
1397 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001398
Jerry Yu24b8c812022-08-20 19:06:56 +08001399 /* ...
1400 * CipherSuite cipher_suites<2..2^16-2>;
1401 * ...
1402 * with CipherSuite defined as:
1403 * uint8 CipherSuite[2];
XiaokangQian08037552022-04-20 07:16:41 +00001404 */
Ronald Cron41a443a2022-10-04 16:38:25 +02001405#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian060d8672022-04-21 09:24:56 +00001406 cipher_suites = p;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001407#endif
XiaokangQian060d8672022-04-21 09:24:56 +00001408 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001409 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
1410 p, cipher_suites_len );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001411
1412 /*
1413 * Search for a matching ciphersuite
1414 */
XiaokangQian060d8672022-04-21 09:24:56 +00001415 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +00001416 {
XiaokangQiane8ff3502022-04-22 02:34:40 +00001417 uint16_t cipher_suite;
Jerry Yue95c8af2022-07-26 15:48:20 +08001418 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
Jerry Yu5725f1c2022-08-21 17:27:16 +08001419
XiaokangQiane8ff3502022-04-22 02:34:40 +00001420 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
Jerry Yu5725f1c2022-08-21 17:27:16 +08001421
XiaokangQiane8ff3502022-04-22 02:34:40 +00001422 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yuc5a23a02022-08-25 10:51:44 +08001423 ciphersuite_info = ssl_tls13_validate_peer_ciphersuite(
Jerry Yudd1bef72022-08-23 17:57:02 +08001424 ssl,cipher_suite );
1425 if( ciphersuite_info == NULL )
Jerry Yu5725f1c2022-08-21 17:27:16 +08001426 continue;
1427
Jerry Yu5725f1c2022-08-21 17:27:16 +08001428 ssl->session_negotiate->ciphersuite = cipher_suite;
1429 ssl->handshake->ciphersuite_info = ciphersuite_info;
1430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %04x - %s",
Jerry Yue95c8af2022-07-26 15:48:20 +08001431 cipher_suite,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001432 ciphersuite_info->name ) );
XiaokangQian17f974c2022-04-19 09:57:41 +00001433 }
Jerry Yu5725f1c2022-08-21 17:27:16 +08001434
1435 if( ssl->handshake->ciphersuite_info == NULL )
1436 {
1437 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1438 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1439 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1440 }
Jerry Yuc1be19f2022-04-23 16:11:39 +08001441
XiaokangQian4080a7f2022-04-11 09:55:18 +00001442 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001443 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001444 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +00001445 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +00001446 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001447 {
XiaokangQian4080a7f2022-04-11 09:55:18 +00001448 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
1449 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1450 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1451 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001452 }
XiaokangQianb67384d2022-04-19 00:02:38 +00001453 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001454
Jerry Yuc1be19f2022-04-23 16:11:39 +08001455 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001456 * Extension extensions<8..2^16-1>;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001457 * ...
XiaokangQianb67384d2022-04-19 00:02:38 +00001458 * with Extension defined as:
1459 * struct {
1460 * ExtensionType extension_type;
1461 * opaque extension_data<0..2^16-1>;
1462 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001463 */
XiaokangQian4080a7f2022-04-11 09:55:18 +00001464 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001465 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +00001466 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +00001467 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001468
XiaokangQian4080a7f2022-04-11 09:55:18 +00001469 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001470
1471 while( p < extensions_end )
1472 {
1473 unsigned int extension_type;
1474 size_t extension_data_len;
1475 const unsigned char *extension_data_end;
1476
Jerry Yu1c9247c2022-07-21 12:37:39 +08001477 /* RFC 8446, page 57
1478 *
1479 * The "pre_shared_key" extension MUST be the last extension in the
1480 * ClientHello (this facilitates implementation as described below).
1481 * Servers MUST check that it is the last extension and otherwise fail
1482 * the handshake with an "illegal_parameter" alert.
1483 */
1484 if( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY )
1485 {
1486 MBEDTLS_SSL_DEBUG_MSG(
1487 3, ( "pre_shared_key is not last extension." ) );
1488 MBEDTLS_SSL_PEND_FATAL_ALERT(
1489 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1490 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1491 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1492 }
1493
XiaokangQian318dc762022-04-20 09:43:51 +00001494 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001495 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1496 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1497 p += 4;
1498
1499 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1500 extension_data_end = p + extension_data_len;
1501
1502 switch( extension_type )
1503 {
XiaokangQian40a35232022-05-07 09:02:40 +00001504#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1505 case MBEDTLS_TLS_EXT_SERVERNAME:
1506 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found ServerName extension" ) );
XiaokangQian9b2b7712022-05-17 02:57:00 +00001507 ret = mbedtls_ssl_parse_server_name_ext( ssl, p,
1508 extension_data_end );
XiaokangQian40a35232022-05-07 09:02:40 +00001509 if( ret != 0 )
1510 {
1511 MBEDTLS_SSL_DEBUG_RET(
1512 1, "mbedtls_ssl_parse_servername_ext", ret );
1513 return( ret );
1514 }
1515 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SERVERNAME;
1516 break;
1517#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
1518
XiaokangQianb67384d2022-04-19 00:02:38 +00001519#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001520 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1521 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
1522
1523 /* Supported Groups Extension
1524 *
1525 * When sent by the client, the "supported_groups" extension
1526 * indicates the named groups which the client supports,
1527 * ordered from most preferred to least preferred.
1528 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001529 ret = ssl_tls13_parse_supported_groups_ext(
1530 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001531 if( ret != 0 )
1532 {
1533 MBEDTLS_SSL_DEBUG_RET( 1,
1534 "mbedtls_ssl_parse_supported_groups_ext", ret );
1535 return( ret );
1536 }
1537
1538 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
1539 break;
XiaokangQianb67384d2022-04-19 00:02:38 +00001540#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001541
XiaokangQian88408882022-04-02 10:15:03 +00001542#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001543 case MBEDTLS_TLS_EXT_KEY_SHARE:
1544 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
1545
1546 /*
1547 * Key Share Extension
1548 *
1549 * When sent by the client, the "key_share" extension
1550 * contains the endpoint's cryptographic parameters for
1551 * ECDHE/DHE key establishment methods.
1552 */
Jerry Yuc1be19f2022-04-23 16:11:39 +08001553 ret = ssl_tls13_parse_key_shares_ext(
1554 ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +00001555 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +00001556 {
XiaokangQianed582dd2022-04-13 08:21:05 +00001557 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu49ca9282022-05-05 11:05:22 +08001558 hrr_required = 1;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001559 }
1560
Jerry Yu582dd062022-04-22 21:59:01 +08001561 if( ret < 0 )
1562 {
1563 MBEDTLS_SSL_DEBUG_RET(
1564 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001565 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +08001566 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001567
1568 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
1569 break;
XiaokangQian88408882022-04-02 10:15:03 +00001570#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001571
1572 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
1573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
1574
1575 ret = ssl_tls13_parse_supported_versions_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001576 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001577 if( ret != 0 )
1578 {
1579 MBEDTLS_SSL_DEBUG_RET( 1,
1580 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
1581 return( ret );
1582 }
1583 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
1584 break;
1585
Ronald Cron41a443a2022-10-04 16:38:25 +02001586#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yue19e3b92022-07-08 12:04:51 +00001587 case MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES:
1588 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found psk key exchange modes extension" ) );
1589
1590 ret = ssl_tls13_parse_key_exchange_modes_ext(
1591 ssl, p, extension_data_end );
1592 if( ret != 0 )
1593 {
1594 MBEDTLS_SSL_DEBUG_RET(
1595 1, "ssl_tls13_parse_key_exchange_modes_ext", ret );
1596 return( ret );
1597 }
1598
1599 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
1600 break;
Ronald Cron41a443a2022-10-04 16:38:25 +02001601#endif
Jerry Yue19e3b92022-07-08 12:04:51 +00001602
Jerry Yu1c105562022-07-10 06:32:38 +00001603 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
1604 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
Jerry Yu13ab81d2022-07-22 23:17:11 +08001605 if( ( ssl->handshake->extensions_present &
1606 MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) == 0 )
1607 {
1608 MBEDTLS_SSL_PEND_FATAL_ALERT(
1609 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1610 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1611 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1612 }
Ronald Cron41a443a2022-10-04 16:38:25 +02001613#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yu1c105562022-07-10 06:32:38 +00001614 /* Delay processing of the PSK identity once we have
1615 * found out which algorithms to use. We keep a pointer
1616 * to the buffer and the size for later processing.
1617 */
Jerry Yu29d9faa2022-08-23 17:52:45 +08001618 pre_shared_key_ext = p;
Jerry Yu1c105562022-07-10 06:32:38 +00001619 pre_shared_key_ext_end = extension_data_end;
Ronald Cron41a443a2022-10-04 16:38:25 +02001620#endif
Jerry Yu1c105562022-07-10 06:32:38 +00001621 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1622 break;
Jerry Yu1c105562022-07-10 06:32:38 +00001623
XiaokangQianacb39922022-06-17 10:18:48 +00001624#if defined(MBEDTLS_SSL_ALPN)
1625 case MBEDTLS_TLS_EXT_ALPN:
1626 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1627
1628 ret = mbedtls_ssl_parse_alpn_ext( ssl, p, extension_data_end );
1629 if( ret != 0 )
1630 {
1631 MBEDTLS_SSL_DEBUG_RET(
1632 1, ( "mbedtls_ssl_parse_alpn_ext" ), ret );
1633 return( ret );
1634 }
1635 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_ALPN;
1636 break;
1637#endif /* MBEDTLS_SSL_ALPN */
1638
Ronald Cron928cbd32022-10-04 16:14:26 +02001639#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001640 case MBEDTLS_TLS_EXT_SIG_ALG:
1641 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
1642
Gabor Mezei078e8032022-04-27 21:17:56 +02001643 ret = mbedtls_ssl_parse_sig_alg_ext(
Jerry Yuc1be19f2022-04-23 16:11:39 +08001644 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001645 if( ret != 0 )
1646 {
1647 MBEDTLS_SSL_DEBUG_MSG( 1,
1648 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
1649 ret ) );
1650 return( ret );
1651 }
1652 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
1653 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02001654#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001655
1656 default:
1657 MBEDTLS_SSL_DEBUG_MSG( 3,
1658 ( "unknown extension found: %ud ( ignoring )",
1659 extension_type ) );
1660 }
1661
1662 p += extension_data_len;
1663 }
1664
Jerry Yu1c105562022-07-10 06:32:38 +00001665#if defined(MBEDTLS_DEBUG_C)
1666 /* List all the extensions we have received */
1667 ssl_tls13_debug_print_client_hello_exts( ssl );
1668#endif /* MBEDTLS_DEBUG_C */
1669
1670 mbedtls_ssl_add_hs_hdr_to_checksum( ssl,
1671 MBEDTLS_SSL_HS_CLIENT_HELLO,
1672 p - buf );
Jerry Yu032b15ce2022-07-11 06:10:03 +00001673
Ronald Cron41a443a2022-10-04 16:38:25 +02001674#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
XiaokangQian7807f9f2022-02-15 10:04:37 +00001675 /* Update checksum with either
1676 * - The entire content of the CH message, if no PSK extension is present
1677 * - The content up to but excluding the PSK extension, if present.
1678 */
Jerry Yu1c105562022-07-10 06:32:38 +00001679 /* If we've settled on a PSK-based exchange, parse PSK identity ext */
Jerry Yuba9b6e92022-07-22 21:35:18 +08001680 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) &&
Jerry Yu32e13702022-07-29 13:04:08 +08001681 mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) &&
Jerry Yuba9b6e92022-07-22 21:35:18 +08001682 ( ssl->handshake->extensions_present & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) )
Jerry Yu1c105562022-07-10 06:32:38 +00001683 {
1684 ssl->handshake->update_checksum( ssl, buf,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001685 pre_shared_key_ext - buf );
Jerry Yubb852022022-07-20 21:10:44 +08001686 ret = ssl_tls13_parse_pre_shared_key_ext( ssl,
Jerry Yu29d9faa2022-08-23 17:52:45 +08001687 pre_shared_key_ext,
Jerry Yue95c8af2022-07-26 15:48:20 +08001688 pre_shared_key_ext_end,
Jerry Yu5725f1c2022-08-21 17:27:16 +08001689 cipher_suites,
1690 cipher_suites_end );
Jerry Yue9d4fc02022-08-20 19:21:15 +08001691 if( ret == MBEDTLS_ERR_SSL_UNKNOWN_IDENTITY )
Jerry Yuba9b6e92022-07-22 21:35:18 +08001692 {
1693 ssl->handshake->extensions_present &= ~MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
Jerry Yu6f1db3f2022-07-22 23:05:59 +08001694 }
1695 else if( ret != 0 )
Jerry Yu1c105562022-07-10 06:32:38 +00001696 {
Jerry Yubb852022022-07-20 21:10:44 +08001697 MBEDTLS_SSL_DEBUG_RET( 1, ( "ssl_tls13_parse_pre_shared_key_ext" ),
Jerry Yu1c105562022-07-10 06:32:38 +00001698 ret );
1699 return( ret );
1700 }
Jerry Yu1c105562022-07-10 06:32:38 +00001701 }
1702 else
Ronald Cron41a443a2022-10-04 16:38:25 +02001703#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED */
Jerry Yu1c105562022-07-10 06:32:38 +00001704 {
1705 ssl->handshake->update_checksum( ssl, buf, p - buf );
1706 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00001707
Jerry Yuba9b6e92022-07-22 21:35:18 +08001708 ret = ssl_tls13_determine_key_exchange_mode( ssl );
1709 if( ret < 0 )
1710 return( ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001711
Jerry Yue5834fd2022-08-29 20:16:09 +08001712 mbedtls_ssl_optimize_checksum( ssl, ssl->handshake->ciphersuite_info );
1713
XiaokangQian75fe8c72022-06-15 09:42:45 +00001714 return( hrr_required ? SSL_CLIENT_HELLO_HRR_REQUIRED : SSL_CLIENT_HELLO_OK );
1715}
1716
1717/* Update the handshake state machine */
1718
Ronald Cronce7d76e2022-07-08 18:56:49 +02001719MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian75fe8c72022-06-15 09:42:45 +00001720static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
1721{
1722 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1723
XiaokangQian7807f9f2022-02-15 10:04:37 +00001724 /*
XiaokangQianfb665a82022-06-15 03:57:21 +00001725 * Server certificate selection
1726 */
1727 if( ssl->conf->f_cert_cb && ( ret = ssl->conf->f_cert_cb( ssl ) ) != 0 )
1728 {
1729 MBEDTLS_SSL_DEBUG_RET( 1, "f_cert_cb", ret );
1730 return( ret );
1731 }
1732#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
1733 ssl->handshake->sni_name = NULL;
1734 ssl->handshake->sni_name_len = 0;
1735#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +00001736
XiaokangQian7807f9f2022-02-15 10:04:37 +00001737 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
1738 if( ret != 0 )
1739 {
1740 MBEDTLS_SSL_DEBUG_RET( 1,
1741 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
1742 return( ret );
1743 }
1744
XiaokangQian7807f9f2022-02-15 10:04:37 +00001745 return( 0 );
1746
1747}
1748
1749/*
XiaokangQianed582dd2022-04-13 08:21:05 +00001750 * Main entry point from the state machine; orchestrates the otherfunctions.
1751 */
1752
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001753MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianed582dd2022-04-13 08:21:05 +00001754static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
1755{
1756
XiaokangQian08037552022-04-20 07:16:41 +00001757 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +00001758 unsigned char* buf = NULL;
1759 size_t buflen = 0;
Jerry Yu4ca91402022-05-09 15:50:57 +08001760 int parse_client_hello_ret;
1761
XiaokangQianed582dd2022-04-13 08:21:05 +00001762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
1763
XiaokangQianed582dd2022-04-13 08:21:05 +00001764 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
1765 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
1766 &buf, &buflen ) );
1767
1768 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
1769 buf + buflen ) );
Jerry Yuf41553b2022-05-09 22:20:30 +08001770 parse_client_hello_ret = ret; /* Store return value of parse_client_hello,
1771 * only SSL_CLIENT_HELLO_OK or
1772 * SSL_CLIENT_HELLO_HRR_REQUIRED at this
1773 * stage as negative error codes are handled
1774 * by MBEDTLS_SSL_PROC_CHK_NEG. */
Jerry Yu4ca91402022-05-09 15:50:57 +08001775
XiaokangQiancfd925f2022-04-14 07:10:37 +00001776 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001777
Jerry Yu4ca91402022-05-09 15:50:57 +08001778 if( parse_client_hello_ret == SSL_CLIENT_HELLO_OK )
1779 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
1780 else
1781 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +00001782
1783cleanup:
1784
1785 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
1786 return( ret );
1787}
1788
1789/*
Jerry Yu1c3e6882022-04-20 21:23:40 +08001790 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +08001791 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001792MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4b27e42022-03-30 17:32:21 +08001793static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
1794{
Jerry Yu637a3f12022-04-20 21:37:58 +08001795 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1796 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +08001797 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001798 if( ssl->conf->f_rng == NULL )
1799 {
1800 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
1801 return( MBEDTLS_ERR_SSL_NO_RNG );
1802 }
1803
Jerry Yu637a3f12022-04-20 21:37:58 +08001804 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001805 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
1806 {
1807 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
1808 return( ret );
1809 }
1810
Jerry Yu637a3f12022-04-20 21:37:58 +08001811 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001812 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1813
1814#if defined(MBEDTLS_HAVE_TIME)
1815 ssl->session_negotiate->start = time( NULL );
1816#endif /* MBEDTLS_HAVE_TIME */
1817
1818 return( ret );
1819}
1820
Jerry Yu3bf2c642022-03-30 22:02:12 +08001821/*
Jerry Yue74e04a2022-04-21 09:23:16 +08001822 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +08001823 *
1824 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +08001825 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001826 * } SupportedVersions;
1827 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001828MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue74e04a2022-04-21 09:23:16 +08001829static int ssl_tls13_write_server_hello_supported_versions_ext(
1830 mbedtls_ssl_context *ssl,
1831 unsigned char *buf,
1832 unsigned char *end,
1833 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001834{
Jerry Yu3bf2c642022-03-30 22:02:12 +08001835 *out_len = 0;
1836
Jerry Yu955ddd72022-04-22 22:27:33 +08001837 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001838
1839 /* Check if we have space to write the extension:
1840 * - extension_type (2 bytes)
1841 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +08001842 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001843 */
Jerry Yu349a6132022-04-14 20:52:56 +08001844 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001845
Jerry Yu349a6132022-04-14 20:52:56 +08001846 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001847
Jerry Yu349a6132022-04-14 20:52:56 +08001848 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001849
Jerry Yu349a6132022-04-14 20:52:56 +08001850 mbedtls_ssl_write_version( buf + 4,
1851 ssl->conf->transport,
1852 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001853
1854 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
1855 ssl->tls_version ) );
1856
Jerry Yu349a6132022-04-14 20:52:56 +08001857 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001858
1859 return( 0 );
1860}
1861
Jerry Yud9436a12022-04-20 22:28:09 +08001862
Jerry Yu3bf2c642022-03-30 22:02:12 +08001863
1864/* Generate and export a single key share. For hybrid KEMs, this can
1865 * be called multiple times with the different components of the hybrid. */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001866MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu955ddd72022-04-22 22:27:33 +08001867static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
1868 uint16_t named_group,
1869 unsigned char *buf,
1870 unsigned char *end,
1871 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001872{
1873 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +08001874
1875 *out_len = 0;
1876
Jerry Yu89e103c2022-03-30 22:43:29 +08001877#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +08001878 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
1879 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001880 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
1881 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001882 if( ret != 0 )
1883 {
Jerry Yu89e103c2022-03-30 22:43:29 +08001884 MBEDTLS_SSL_DEBUG_RET(
1885 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
1886 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001887 return( ret );
1888 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001889 }
Jerry Yu89e103c2022-03-30 22:43:29 +08001890 else
1891#endif /* MBEDTLS_ECDH_C */
1892 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +08001893 {
1894 }
1895 else
1896 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001897 ((void) ssl);
1898 ((void) named_group);
1899 ((void) buf);
1900 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +08001901 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1902 }
1903
1904 return( ret );
1905}
1906
1907/*
1908 * ssl_tls13_write_key_share_ext
1909 *
1910 * Structure of key_share extension in ServerHello:
1911 *
Jerry Yu1c3e6882022-04-20 21:23:40 +08001912 * struct {
1913 * NamedGroup group;
1914 * opaque key_exchange<1..2^16-1>;
1915 * } KeyShareEntry;
1916 * struct {
1917 * KeyShareEntry server_share;
1918 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001919 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001920MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08001921static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
1922 unsigned char *buf,
1923 unsigned char *end,
1924 size_t *out_len )
1925{
Jerry Yu955ddd72022-04-22 22:27:33 +08001926 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001927 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +08001928 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001929 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001930 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001931
1932 *out_len = 0;
1933
1934 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
1935
Jerry Yu58af2332022-09-06 11:19:31 +08001936 MBEDTLS_SSL_DEBUG_MSG( 2, ( "server hello, write selected_group: %s (%04x)",
1937 mbedtls_ssl_named_group_to_str( group ),
1938 group ) );
1939
Jerry Yu3bf2c642022-03-30 22:02:12 +08001940 /* Check if we have space for header and length fields:
1941 * - extension_type (2 bytes)
1942 * - extension_data_length (2 bytes)
1943 * - group (2 bytes)
1944 * - key_exchange_length (2 bytes)
1945 */
1946 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +08001947 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
1948 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001949 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +08001950
Jerry Yu3bf2c642022-03-30 22:02:12 +08001951 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
1952 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +08001953 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +08001954 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001955 if( ret != 0 )
1956 return( ret );
1957 p += key_exchange_length;
Jerry Yuc1be19f2022-04-23 16:11:39 +08001958
Jerry Yu955ddd72022-04-22 22:27:33 +08001959 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001960
Jerry Yu57d48412022-04-20 21:50:42 +08001961 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001962
Jerry Yu57d48412022-04-20 21:50:42 +08001963 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +08001964
Jerry Yu3bf2c642022-03-30 22:02:12 +08001965 return( 0 );
1966}
Jerry Yud9436a12022-04-20 22:28:09 +08001967
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001968MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001969static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
1970 unsigned char *buf,
1971 unsigned char *end,
1972 size_t *out_len )
1973{
1974 uint16_t selected_group = ssl->handshake->hrr_selected_group;
1975 /* key_share Extension
1976 *
1977 * struct {
1978 * select (Handshake.msg_type) {
1979 * ...
1980 * case hello_retry_request:
1981 * NamedGroup selected_group;
1982 * ...
1983 * };
1984 * } KeyShare;
1985 */
1986
1987 *out_len = 0;
1988
Jerry Yub0ac10b2022-05-05 11:10:08 +08001989 /*
1990 * For a pure PSK key exchange, there is no group to agree upon. The purpose
1991 * of the HRR is then to transmit a cookie to force the client to demonstrate
1992 * reachability at their apparent network address (primarily useful for DTLS).
1993 */
Ronald Cron79907712022-07-20 17:05:29 +02001994 if( ! mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001995 return( 0 );
1996
1997 /* We should only send the key_share extension if the client's initial
1998 * key share was not acceptable. */
1999 if( ssl->handshake->offered_group_id != 0 )
2000 {
2001 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
2002 return( 0 );
2003 }
2004
2005 if( selected_group == 0 )
2006 {
2007 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
2008 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2009 }
2010
Jerry Yub0ac10b2022-05-05 11:10:08 +08002011 /* Check if we have enough space:
2012 * - extension_type (2 bytes)
2013 * - extension_data_length (2 bytes)
2014 * - selected_group (2 bytes)
2015 */
Ronald Cron154d1b62022-06-01 15:33:26 +02002016 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002017
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002018 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002019 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002020 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
2021
2022 MBEDTLS_SSL_DEBUG_MSG( 3,
2023 ( "HRR selected_group: %s (%x)",
2024 mbedtls_ssl_named_group_to_str( selected_group ),
2025 selected_group ) );
2026
2027 *out_len = 6;
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002028
Jerry Yub0ac10b2022-05-05 11:10:08 +08002029 return( 0 );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002030}
Jerry Yu3bf2c642022-03-30 22:02:12 +08002031
2032/*
2033 * Structure of ServerHello message:
2034 *
2035 * struct {
2036 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
2037 * Random random;
2038 * opaque legacy_session_id_echo<0..32>;
2039 * CipherSuite cipher_suite;
2040 * uint8 legacy_compression_method = 0;
2041 * Extension extensions<6..2^16-1>;
2042 * } ServerHello;
2043 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002044MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu3bf2c642022-03-30 22:02:12 +08002045static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08002046 unsigned char *buf,
2047 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002048 size_t *out_len,
2049 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08002050{
Jerry Yu955ddd72022-04-22 22:27:33 +08002051 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002052 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08002053 unsigned char *p_extensions_len;
Jerry Yufbe3e642022-04-25 19:31:51 +08002054 size_t output_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002055
2056 *out_len = 0;
2057
Jerry Yucfc04b32022-04-21 09:31:58 +08002058 /* ...
2059 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
2060 * ...
2061 * with ProtocolVersion defined as:
2062 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002063 */
2064 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2065 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
2066 p += 2;
2067
Jerry Yu1c3e6882022-04-20 21:23:40 +08002068 /* ...
2069 * Random random;
2070 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08002071 * with Random defined as:
2072 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08002073 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002074 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002075 if( is_hrr )
2076 {
2077 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
Jerry Yufbe3e642022-04-25 19:31:51 +08002078 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002079 }
2080 else
2081 {
2082 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
Jerry Yufbe3e642022-04-25 19:31:51 +08002083 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002084 }
Jerry Yu955ddd72022-04-22 22:27:33 +08002085 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08002086 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
2087 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
2088
Jerry Yucfc04b32022-04-21 09:31:58 +08002089 /* ...
2090 * opaque legacy_session_id_echo<0..32>;
2091 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08002092 */
2093 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
2094 *p++ = (unsigned char)ssl->session_negotiate->id_len;
2095 if( ssl->session_negotiate->id_len > 0 )
2096 {
2097 memcpy( p, &ssl->session_negotiate->id[0],
2098 ssl->session_negotiate->id_len );
2099 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08002100
Jerry Yu3bf2c642022-03-30 22:02:12 +08002101 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
2102 ssl->session_negotiate->id_len );
2103 }
2104
Jerry Yucfc04b32022-04-21 09:31:58 +08002105 /* ...
2106 * CipherSuite cipher_suite;
2107 * ...
2108 * with CipherSuite defined as:
2109 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08002110 */
2111 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2112 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
2113 p += 2;
2114 MBEDTLS_SSL_DEBUG_MSG( 3,
2115 ( "server hello, chosen ciphersuite: %s ( id=%d )",
2116 mbedtls_ssl_get_ciphersuite_name(
2117 ssl->session_negotiate->ciphersuite ),
2118 ssl->session_negotiate->ciphersuite ) );
2119
Jerry Yucfc04b32022-04-21 09:31:58 +08002120 /* ...
2121 * uint8 legacy_compression_method = 0;
2122 * ...
2123 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002124 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01002125 *p++ = MBEDTLS_SSL_COMPRESS_NULL;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002126
Jerry Yucfc04b32022-04-21 09:31:58 +08002127 /* ...
2128 * Extension extensions<6..2^16-1>;
2129 * ...
2130 * struct {
2131 * ExtensionType extension_type; (2 bytes)
2132 * opaque extension_data<0..2^16-1>;
2133 * } Extension;
2134 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08002135 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08002136 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002137 p += 2;
2138
Jerry Yue74e04a2022-04-21 09:23:16 +08002139 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08002140 ssl, p, end, &output_len ) ) != 0 )
2141 {
Jerry Yu955ddd72022-04-22 22:27:33 +08002142 MBEDTLS_SSL_DEBUG_RET(
2143 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002144 return( ret );
2145 }
2146 p += output_len;
2147
Jerry Yu56acc942022-07-30 23:02:36 +08002148 if( mbedtls_ssl_tls13_key_exchange_mode_with_ephemeral( ssl ) )
Jerry Yu3bf2c642022-03-30 22:02:12 +08002149 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002150 if( is_hrr )
2151 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
2152 else
2153 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002154 if( ret != 0 )
2155 return( ret );
2156 p += output_len;
2157 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08002158
Ronald Cron41a443a2022-10-04 16:38:25 +02002159#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_SOME_PSK_ENABLED)
Jerry Yuad4d2bb2022-09-14 22:40:35 +08002160 if( !is_hrr && mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu032b15ce2022-07-11 06:10:03 +00002161 {
Jerry Yubb852022022-07-20 21:10:44 +08002162 ret = ssl_tls13_write_server_pre_shared_key_ext( ssl, p, end, &output_len );
Jerry Yu032b15ce2022-07-11 06:10:03 +00002163 if( ret != 0 )
2164 {
Jerry Yubb852022022-07-20 21:10:44 +08002165 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_server_pre_shared_key_ext",
Jerry Yu032b15ce2022-07-11 06:10:03 +00002166 ret );
2167 return( ret );
2168 }
2169 p += output_len;
2170 }
Ronald Cron41a443a2022-10-04 16:38:25 +02002171#endif
Jerry Yu032b15ce2022-07-11 06:10:03 +00002172
Jerry Yud9436a12022-04-20 22:28:09 +08002173 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002174
Jerry Yud9436a12022-04-20 22:28:09 +08002175 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
2176 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002177
Jerry Yud9436a12022-04-20 22:28:09 +08002178 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08002179
Jerry Yud9436a12022-04-20 22:28:09 +08002180 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08002181
2182 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08002183}
2184
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002185MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yue110d252022-05-05 10:19:22 +08002186static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
2187{
2188 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08002189 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08002190 if( ret != 0 )
2191 {
Jerry Yuf86eb752022-05-06 11:16:55 +08002192 MBEDTLS_SSL_DEBUG_RET( 1,
2193 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08002194 ret );
2195 return( ret );
2196 }
2197
Jerry Yue110d252022-05-05 10:19:22 +08002198 return( ret );
2199}
2200
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002201MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu5b64ae92022-03-30 17:15:02 +08002202static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
2203{
Jerry Yu637a3f12022-04-20 21:37:58 +08002204 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08002205 unsigned char *buf;
2206 size_t buf_len, msg_len;
2207
2208 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
2209
Jerry Yuf4b27e42022-03-30 17:32:21 +08002210 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
2211
Jerry Yu3bf2c642022-03-30 22:02:12 +08002212 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08002213 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
2214
Jerry Yu3bf2c642022-03-30 22:02:12 +08002215 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2216 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08002217 &msg_len,
2218 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08002219
Jerry Yu3bf2c642022-03-30 22:02:12 +08002220 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002221 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2222
Jerry Yu3bf2c642022-03-30 22:02:12 +08002223 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08002224 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08002225
Jerry Yue110d252022-05-05 10:19:22 +08002226 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
2227
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002228#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2229 /* The server sends a dummy change_cipher_spec record immediately
2230 * after its first handshake message. This may either be after
2231 * a ServerHello or a HelloRetryRequest.
2232 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002233 mbedtls_ssl_handshake_set_state(
2234 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002235#else
Jerry Yu637a3f12022-04-20 21:37:58 +08002236 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002237#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yue110d252022-05-05 10:19:22 +08002238
Jerry Yuf4b27e42022-03-30 17:32:21 +08002239cleanup:
2240
2241 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
2242 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08002243}
2244
Jerry Yu23d1a252022-05-12 18:08:59 +08002245
2246/*
2247 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
2248 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002249MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron7b840462022-06-01 17:05:53 +02002250static int ssl_tls13_prepare_hello_retry_request( mbedtls_ssl_context *ssl )
Jerry Yu23d1a252022-05-12 18:08:59 +08002251{
2252 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2253 if( ssl->handshake->hello_retry_request_count > 0 )
2254 {
2255 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
2256 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2257 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2258 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2259 }
2260
2261 /*
2262 * Create stateless transcript hash for HRR
2263 */
2264 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
2265 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
2266 if( ret != 0 )
2267 {
2268 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
2269 return( ret );
2270 }
2271 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
2272
2273 return( 0 );
2274}
2275
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002276MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu23d1a252022-05-12 18:08:59 +08002277static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
2278{
2279 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2280 unsigned char *buf;
2281 size_t buf_len, msg_len;
2282
2283 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
2284
Ronald Cron7b840462022-06-01 17:05:53 +02002285 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_hello_retry_request( ssl ) );
Jerry Yu23d1a252022-05-12 18:08:59 +08002286
2287 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg(
2288 ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2289 &buf, &buf_len ) );
2290
2291 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
2292 buf + buf_len,
2293 &msg_len,
2294 1 ) );
2295 mbedtls_ssl_add_hs_msg_to_checksum(
2296 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
2297
2298
2299 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
2300 msg_len ) );
2301
2302 ssl->handshake->hello_retry_request_count++;
2303
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002304#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2305 /* The server sends a dummy change_cipher_spec record immediately
2306 * after its first handshake message. This may either be after
2307 * a ServerHello or a HelloRetryRequest.
2308 */
Gabor Mezei96ae9262022-06-28 11:45:18 +02002309 mbedtls_ssl_handshake_set_state(
Gabor Mezeif7044ea2022-06-28 16:01:49 +02002310 ssl, MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002311#else
Jerry Yu23d1a252022-05-12 18:08:59 +08002312 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
Gabor Mezei7b39bf12022-05-24 16:04:14 +02002313#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Jerry Yu23d1a252022-05-12 18:08:59 +08002314
2315cleanup:
2316 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
2317 return( ret );
2318}
2319
Jerry Yu5b64ae92022-03-30 17:15:02 +08002320/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08002321 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
2322 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002323
2324/*
2325 * struct {
2326 * Extension extensions<0..2 ^ 16 - 1>;
2327 * } EncryptedExtensions;
2328 *
2329 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002330MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002331static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
2332 unsigned char *buf,
2333 unsigned char *end,
2334 size_t *out_len )
2335{
XiaokangQianacb39922022-06-17 10:18:48 +00002336 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002337 unsigned char *p = buf;
2338 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08002339 unsigned char *p_extensions_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002340 size_t output_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08002341
Jerry Yu4d3841a2022-04-16 12:37:19 +08002342 *out_len = 0;
2343
2344 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08002345 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002346 p += 2;
2347
Jerry Yu8937eb42022-05-03 12:12:14 +08002348 ((void) ssl);
XiaokangQianacb39922022-06-17 10:18:48 +00002349 ((void) ret);
2350 ((void) output_len);
2351
2352#if defined(MBEDTLS_SSL_ALPN)
2353 ret = mbedtls_ssl_write_alpn_ext( ssl, p, end, &output_len );
2354 if( ret != 0 )
2355 return( ret );
XiaokangQian95d5f542022-06-24 02:29:26 +00002356 p += output_len;
XiaokangQianacb39922022-06-17 10:18:48 +00002357#endif /* MBEDTLS_SSL_ALPN */
Jerry Yu4d3841a2022-04-16 12:37:19 +08002358
Jerry Yu8937eb42022-05-03 12:12:14 +08002359 extensions_len = ( p - p_extensions_len ) - 2;
2360 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
2361
2362 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002363
2364 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
2365
2366 return( 0 );
2367}
2368
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002369MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d3841a2022-04-16 12:37:19 +08002370static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
2371{
2372 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2373 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08002374 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08002375
Gabor Mezei54719122022-06-28 11:34:56 +02002376 mbedtls_ssl_set_outbound_transform( ssl,
2377 ssl->handshake->transform_handshake );
2378 MBEDTLS_SSL_DEBUG_MSG(
2379 3, ( "switching to handshake transform for outbound data" ) );
2380
Jerry Yuab452cc2022-04-28 15:27:08 +08002381 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002382
Jerry Yu4d3841a2022-04-16 12:37:19 +08002383 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2384 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
2385
2386 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
2387 ssl, buf, buf + buf_len, &msg_len ) );
2388
2389 mbedtls_ssl_add_hs_msg_to_checksum(
2390 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
2391
Jerry Yu4d3841a2022-04-16 12:37:19 +08002392 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2393 ssl, buf_len, msg_len ) );
2394
Ronald Cron928cbd32022-10-04 16:14:26 +02002395#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002396 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Jerry Yu8937eb42022-05-03 12:12:14 +08002397 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2398 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00002399 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08002400#else
2401 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2402#endif
2403
Jerry Yu4d3841a2022-04-16 12:37:19 +08002404cleanup:
2405
Jerry Yuab452cc2022-04-28 15:27:08 +08002406 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08002407 return( ret );
2408}
2409
Ronald Cron928cbd32022-10-04 16:14:26 +02002410#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00002411#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
2412#define SSL_CERTIFICATE_REQUEST_SKIP 1
2413/* Coordination:
2414 * Check whether a CertificateRequest message should be written.
2415 * Returns a negative code on failure, or
2416 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
2417 * - SSL_CERTIFICATE_REQUEST_SKIP
2418 * indicating if the writing of the CertificateRequest
2419 * should be skipped or not.
2420 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002421MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiana987e1d2022-05-07 01:25:58 +00002422static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
2423{
2424 int authmode;
2425
XiaokangQian40a35232022-05-07 09:02:40 +00002426#if defined(MBEDTLS_SSL_SERVER_NAME_INDICATION)
2427 if( ssl->handshake->sni_authmode != MBEDTLS_SSL_VERIFY_UNSET )
2428 authmode = ssl->handshake->sni_authmode;
2429 else
2430#endif
XiaokangQiana987e1d2022-05-07 01:25:58 +00002431 authmode = ssl->conf->authmode;
2432
2433 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
Ronald Croneac00ad2022-09-13 10:16:31 +02002434 {
2435 ssl->session_negotiate->verify_result = MBEDTLS_X509_BADCERT_SKIP_VERIFY;
XiaokangQiana987e1d2022-05-07 01:25:58 +00002436 return( SSL_CERTIFICATE_REQUEST_SKIP );
Ronald Croneac00ad2022-09-13 10:16:31 +02002437 }
XiaokangQiana987e1d2022-05-07 01:25:58 +00002438
XiaokangQianc3017f62022-05-13 05:55:41 +00002439 ssl->handshake->certificate_request_sent = 1;
XiaokangQian189ded22022-05-10 08:12:17 +00002440
XiaokangQiana987e1d2022-05-07 01:25:58 +00002441 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
2442}
2443
XiaokangQiancec9ae62022-05-06 07:28:50 +00002444/*
2445 * struct {
2446 * opaque certificate_request_context<0..2^8-1>;
2447 * Extension extensions<2..2^16-1>;
2448 * } CertificateRequest;
2449 *
2450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002451MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002452static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
2453 unsigned char *buf,
2454 const unsigned char *end,
2455 size_t *out_len )
2456{
2457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2458 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00002459 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00002460 unsigned char *p_extensions_len;
2461
2462 *out_len = 0;
2463
2464 /* Check if we have enough space:
2465 * - certificate_request_context (1 byte)
2466 * - extensions length (2 bytes)
2467 */
2468 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
2469
2470 /*
2471 * Write certificate_request_context
2472 */
2473 /*
2474 * We use a zero length context for the normal handshake
2475 * messages. For post-authentication handshake messages
2476 * this request context would be set to a non-zero value.
2477 */
2478 *p++ = 0x0;
2479
2480 /*
2481 * Write extensions
2482 */
2483 /* The extensions must contain the signature_algorithms. */
2484 p_extensions_len = p;
2485 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00002486 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002487 if( ret != 0 )
2488 return( ret );
2489
XiaokangQianec6efb92022-05-06 09:53:10 +00002490 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00002491 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00002492
2493 *out_len = p - buf;
2494
2495 return( 0 );
2496}
2497
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002498MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiancec9ae62022-05-06 07:28:50 +00002499static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
2500{
2501 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2502
2503 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
2504
2505 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2506
2507 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
2508 {
2509 unsigned char *buf;
2510 size_t buf_len, msg_len;
2511
2512 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2513 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
2514
2515 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
2516 ssl, buf, buf + buf_len, &msg_len ) );
2517
2518 mbedtls_ssl_add_hs_msg_to_checksum(
2519 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
2520
2521 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2522 ssl, buf_len, msg_len ) );
2523 }
2524 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
2525 {
2526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
2527 ret = 0;
2528 }
2529 else
2530 {
2531 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2532 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2533 goto cleanup;
2534 }
2535
2536 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2537cleanup:
2538
2539 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
2540 return( ret );
2541}
XiaokangQiancec9ae62022-05-06 07:28:50 +00002542
Jerry Yu4d3841a2022-04-16 12:37:19 +08002543/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002544 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
Jerry Yu83da34e2022-04-16 13:59:52 +08002545 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002546MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002547static int ssl_tls13_write_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002548{
Jerry Yu5a26f302022-05-10 20:46:40 +08002549 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianfb665a82022-06-15 03:57:21 +00002550
2551#if defined(MBEDTLS_X509_CRT_PARSE_C)
2552 if( ( ssl_tls13_pick_key_cert( ssl ) != 0 ) ||
2553 mbedtls_ssl_own_cert( ssl ) == NULL )
Jerry Yu5a26f302022-05-10 20:46:40 +08002554 {
Jerry Yub89125b2022-05-13 15:45:49 +08002555 MBEDTLS_SSL_DEBUG_MSG( 2, ( "No certificate available." ) );
Jerry Yu5a26f302022-05-10 20:46:40 +08002556 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2557 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE);
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002558 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yu5a26f302022-05-10 20:46:40 +08002559 }
XiaokangQianfb665a82022-06-15 03:57:21 +00002560#endif /* MBEDTLS_X509_CRT_PARSE_C */
Jerry Yu5a26f302022-05-10 20:46:40 +08002561
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002562 ret = mbedtls_ssl_tls13_write_certificate( ssl );
2563 if( ret != 0 )
Jerry Yu1bff7112022-04-16 14:29:11 +08002564 return( ret );
Jerry Yu1bff7112022-04-16 14:29:11 +08002565 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2566 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002567}
2568
2569/*
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002570 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
Jerry Yu83da34e2022-04-16 13:59:52 +08002571 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002572MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc6e6dbf2022-04-16 19:42:57 +08002573static int ssl_tls13_write_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu83da34e2022-04-16 13:59:52 +08002574{
Jerry Yu4ff9e142022-04-16 14:57:49 +08002575 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
Jerry Yuf1c3c4e2022-05-10 11:36:35 +08002576 if( ret != 0 )
Jerry Yu4ff9e142022-04-16 14:57:49 +08002577 return( ret );
Jerry Yu4ff9e142022-04-16 14:57:49 +08002578 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2579 return( 0 );
Jerry Yu83da34e2022-04-16 13:59:52 +08002580}
Ronald Cron928cbd32022-10-04 16:14:26 +02002581#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08002582
2583/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002584 * Handler for MBEDTLS_SSL_SERVER_FINISHED
Jerry Yu69dd8d42022-04-16 12:51:26 +08002585 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002586MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002587static int ssl_tls13_write_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002588{
Jerry Yud6e253d2022-05-18 13:59:24 +08002589 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu27bdc7c2022-04-16 13:33:27 +08002590
2591 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2592 if( ret != 0 )
2593 return( ret );
2594
Jerry Yue3d67cb2022-05-19 15:33:10 +08002595 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2596 if( ret != 0 )
2597 {
2598 MBEDTLS_SSL_PEND_FATAL_ALERT(
2599 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2600 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2601 return( ret );
2602 }
XiaokangQianc3017f62022-05-13 05:55:41 +00002603
Ronald Cron63dc4632022-05-31 14:41:53 +02002604 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
2605 mbedtls_ssl_set_inbound_transform( ssl, ssl->handshake->transform_handshake );
XiaokangQian189ded22022-05-10 08:12:17 +00002606
Ronald Cron63dc4632022-05-31 14:41:53 +02002607 if( ssl->handshake->certificate_request_sent )
2608 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
XiaokangQian189ded22022-05-10 08:12:17 +00002609 else
Ronald Cron19385882022-06-15 16:26:13 +02002610 {
2611 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate" ) );
2612 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
XiaokangQian189ded22022-05-10 08:12:17 +00002613 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002614 }
Ronald Cron63dc4632022-05-31 14:41:53 +02002615
Jerry Yu27bdc7c2022-04-16 13:33:27 +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_CLIENT_FINISHED
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_process_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002624{
Jerry Yud6e253d2022-05-18 13:59:24 +08002625 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2626
Jerry Yuff226982022-04-16 16:52:57 +08002627 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
2628 if( ret != 0 )
2629 return( ret );
2630
Jerry Yu466dda82022-09-13 11:20:20 +08002631 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002632 if( ret != 0 )
2633 {
2634 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002635 "mbedtls_ssl_tls13_compute_resumption_master_secret", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002636 }
2637
Jerry Yu03ed50b2022-04-16 17:13:30 +08002638 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yuff226982022-04-16 16:52:57 +08002639 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002640}
2641
2642/*
Jerry Yud6e253d2022-05-18 13:59:24 +08002643 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
Jerry Yu69dd8d42022-04-16 12:51:26 +08002644 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002645MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4d8567f2022-04-17 10:57:57 +08002646static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu69dd8d42022-04-16 12:51:26 +08002647{
Jerry Yu03ed50b2022-04-16 17:13:30 +08002648 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
2649
Jerry Yu03ed50b2022-04-16 17:13:30 +08002650 mbedtls_ssl_tls13_handshake_wrapup( ssl );
Jerry Yue67bef42022-07-07 07:29:42 +00002651
2652#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yufca4d572022-07-21 10:37:48 +08002653 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
2654#else
Jerry Yu03ed50b2022-04-16 17:13:30 +08002655 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
Jerry Yufca4d572022-07-21 10:37:48 +08002656#endif
Jerry Yu03ed50b2022-04-16 17:13:30 +08002657 return( 0 );
Jerry Yu69dd8d42022-04-16 12:51:26 +08002658}
2659
2660/*
Jerry Yue67bef42022-07-07 07:29:42 +00002661 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2662 */
2663#define SSL_NEW_SESSION_TICKET_SKIP 0
2664#define SSL_NEW_SESSION_TICKET_WRITE 1
2665MBEDTLS_CHECK_RETURN_CRITICAL
2666static int ssl_tls13_write_new_session_ticket_coordinate( mbedtls_ssl_context *ssl )
2667{
2668 /* Check whether the use of session tickets is enabled */
2669 if( ssl->conf->f_ticket_write == NULL )
2670 {
Jerry Yud0766ec2022-09-22 10:46:57 +08002671 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2672 " callback is not set" ) );
2673 return( SSL_NEW_SESSION_TICKET_SKIP );
2674 }
2675 if( ssl->conf->new_session_tickets_count == 0 )
2676 {
2677 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: disabled,"
2678 " configured count is zero" ) );
2679 return( SSL_NEW_SESSION_TICKET_SKIP );
2680 }
2681
2682 if( ssl->handshake->new_session_tickets_count == 0 )
2683 {
2684 MBEDTLS_SSL_DEBUG_MSG( 2, ( "NewSessionTicket: all tickets have "
2685 "been sent." ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002686 return( SSL_NEW_SESSION_TICKET_SKIP );
2687 }
2688
Jerry Yue67bef42022-07-07 07:29:42 +00002689 return( SSL_NEW_SESSION_TICKET_WRITE );
2690}
2691
2692#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2693MBEDTLS_CHECK_RETURN_CRITICAL
2694static int ssl_tls13_prepare_new_session_ticket( mbedtls_ssl_context *ssl,
2695 unsigned char *ticket_nonce,
2696 size_t ticket_nonce_size )
2697{
2698 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2699 mbedtls_ssl_session *session = ssl->session;
2700 mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2701 psa_algorithm_t psa_hash_alg;
2702 int hash_length;
2703
2704 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> prepare NewSessionTicket msg" ) );
2705
2706#if defined(MBEDTLS_HAVE_TIME)
2707 session->start = mbedtls_time( NULL );
2708#endif
2709
2710 /* Generate ticket_age_add */
2711 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng,
Jerry Yufca4d572022-07-21 10:37:48 +08002712 (unsigned char *) &session->ticket_age_add,
Jerry Yue67bef42022-07-07 07:29:42 +00002713 sizeof( session->ticket_age_add ) ) != 0 ) )
2714 {
2715 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_age_add", ret );
2716 return( ret );
2717 }
2718 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
Jerry Yufca4d572022-07-21 10:37:48 +08002719 (unsigned int)session->ticket_age_add ) );
Jerry Yue67bef42022-07-07 07:29:42 +00002720
2721 /* Generate ticket_nonce */
2722 ret = ssl->conf->f_rng( ssl->conf->p_rng, ticket_nonce, ticket_nonce_size );
2723 if( ret != 0 )
2724 {
2725 MBEDTLS_SSL_DEBUG_RET( 1, "generate_ticket_nonce", ret );
2726 return( ret );
2727 }
2728 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:",
2729 ticket_nonce, ticket_nonce_size );
2730
2731 ciphersuite_info =
2732 (mbedtls_ssl_ciphersuite_t *) ssl->handshake->ciphersuite_info;
2733 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2734 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yufca4d572022-07-21 10:37:48 +08002735 if( hash_length == -1 ||
Jerry Yu61197152022-07-21 16:28:02 +08002736 (size_t)hash_length > sizeof( session->resumption_key ) )
Jerry Yufca4d572022-07-21 10:37:48 +08002737 {
Jerry Yue67bef42022-07-07 07:29:42 +00002738 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yufca4d572022-07-21 10:37:48 +08002739 }
2740
Jerry Yue67bef42022-07-07 07:29:42 +00002741 /* In this code the psk key length equals the length of the hash */
2742 session->resumption_key_len = hash_length;
2743 session->ciphersuite = ciphersuite_info->id;
2744
2745 /* Compute resumption key
2746 *
2747 * HKDF-Expand-Label( resumption_master_secret,
2748 * "resumption", ticket_nonce, Hash.length )
2749 */
2750 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2751 psa_hash_alg,
2752 session->app_secrets.resumption_master_secret,
2753 hash_length,
2754 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2755 ticket_nonce,
2756 ticket_nonce_size,
2757 session->resumption_key,
2758 hash_length );
2759
2760 if( ret != 0 )
2761 {
2762 MBEDTLS_SSL_DEBUG_RET( 2,
2763 "Creating the ticket-resumed PSK failed",
2764 ret );
2765 return ( ret );
2766 }
2767 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
2768 session->resumption_key,
2769 session->resumption_key_len );
2770
2771 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2772 session->app_secrets.resumption_master_secret,
2773 hash_length );
2774
2775 return( 0 );
2776}
2777
2778/* This function creates a NewSessionTicket message in the following format:
2779 *
2780 * struct {
2781 * uint32 ticket_lifetime;
2782 * uint32 ticket_age_add;
2783 * opaque ticket_nonce<0..255>;
2784 * opaque ticket<1..2^16-1>;
2785 * Extension extensions<0..2^16-2>;
2786 * } NewSessionTicket;
2787 *
2788 * The ticket inside the NewSessionTicket message is an encrypted container
2789 * carrying the necessary information so that the server is later able to
2790 * re-start the communication.
2791 *
2792 * The following fields are placed inside the ticket by the
2793 * f_ticket_write() function:
2794 *
2795 * - creation time (start)
2796 * - flags (flags)
2797 * - age add (ticket_age_add)
2798 * - key (key)
2799 * - key length (key_len)
2800 * - ciphersuite (ciphersuite)
2801 */
2802MBEDTLS_CHECK_RETURN_CRITICAL
2803static int ssl_tls13_write_new_session_ticket_body( mbedtls_ssl_context *ssl,
2804 unsigned char *buf,
2805 unsigned char *end,
2806 size_t *out_len,
2807 unsigned char *ticket_nonce,
2808 size_t ticket_nonce_size )
2809{
2810 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2811 unsigned char *p = buf;
2812 mbedtls_ssl_session *session = ssl->session;
2813 size_t ticket_len;
2814 uint32_t ticket_lifetime;
2815
2816 *out_len = 0;
2817 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write NewSessionTicket msg" ) );
2818
2819 /*
2820 * ticket_lifetime 4 bytes
2821 * ticket_age_add 4 bytes
2822 * ticket_nonce 1 + ticket_nonce_size bytes
2823 * ticket >=2 bytes
2824 */
2825 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 + 4 + 1 + ticket_nonce_size + 2 );
2826
2827 /* Generate ticket and ticket_lifetime */
2828 ret = ssl->conf->f_ticket_write( ssl->conf->p_ticket,
2829 session,
2830 p + 9 + ticket_nonce_size + 2,
2831 end,
2832 &ticket_len,
2833 &ticket_lifetime);
2834 if( ret != 0 )
2835 {
2836 MBEDTLS_SSL_DEBUG_RET( 1, "write_ticket", ret );
2837 return( ret );
2838 }
2839 /* RFC 8446 4.6.1
2840 * ticket_lifetime: Indicates the lifetime in seconds as a 32-bit
2841 * unsigned integer in network byte order from the time of ticket
2842 * issuance. Servers MUST NOT use any value greater than
2843 * 604800 seconds (7 days). The value of zero indicates that the
2844 * ticket should be discarded immediately. Clients MUST NOT cache
2845 * tickets for longer than 7 days, regardless of the ticket_lifetime,
2846 * and MAY delete tickets earlier based on local policy. A server
2847 * MAY treat a ticket as valid for a shorter period of time than what
2848 * is stated in the ticket_lifetime.
2849 */
Xiaokang Qian28af5012022-10-13 08:18:19 +00002850 if( ticket_lifetime > 604800 )
2851 ticket_lifetime = 604800;
Jerry Yue67bef42022-07-07 07:29:42 +00002852 MBEDTLS_PUT_UINT32_BE( ticket_lifetime, p, 0 );
2853 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_lifetime: %u",
2854 ( unsigned int )ticket_lifetime ) );
2855
2856 /* Write ticket_age_add */
2857 MBEDTLS_PUT_UINT32_BE( session->ticket_age_add, p, 4 );
2858 MBEDTLS_SSL_DEBUG_MSG( 3, ( "ticket_age_add: %u",
2859 ( unsigned int )session->ticket_age_add ) );
2860
2861 /* Write ticket_nonce */
2862 p[8] = ( unsigned char )ticket_nonce_size;
2863 if( ticket_nonce_size > 0 )
2864 {
2865 memcpy( p + 9, ticket_nonce, ticket_nonce_size );
2866 }
2867 p += 9 + ticket_nonce_size;
2868
2869 /* Write ticket */
2870 MBEDTLS_PUT_UINT16_BE( ticket_len, p, 0 );
2871 p += 2;
2872 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", p, ticket_len);
2873 p += ticket_len;
2874
2875 /* Ticket Extensions
2876 *
2877 * Note: We currently don't have any extensions.
2878 * Set length to zero.
2879 */
2880 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
2881 MBEDTLS_PUT_UINT16_BE( 0, p, 0 );
2882 p += 2;
2883
2884 *out_len = p - buf;
2885 MBEDTLS_SSL_DEBUG_BUF( 4, "ticket", buf, *out_len );
2886 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write new session ticket" ) );
2887
2888 return( 0 );
2889}
2890
2891/*
2892 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
2893 */
2894static int ssl_tls13_write_new_session_ticket( mbedtls_ssl_context *ssl )
2895{
2896 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2897
2898 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_write_new_session_ticket_coordinate( ssl ) );
2899
2900 if( ret == SSL_NEW_SESSION_TICKET_WRITE )
2901 {
2902 unsigned char ticket_nonce[MBEDTLS_SSL_TLS1_3_TICKET_NONCE_LENGTH];
2903 unsigned char *buf;
2904 size_t buf_len, msg_len;
2905
2906 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_new_session_ticket(
2907 ssl, ticket_nonce, sizeof( ticket_nonce ) ) );
2908
2909 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
2910 MBEDTLS_SSL_HS_NEW_SESSION_TICKET, &buf, &buf_len ) );
2911
2912 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_new_session_ticket_body(
2913 ssl, buf, buf + buf_len, &msg_len,
2914 ticket_nonce, sizeof( ticket_nonce ) ) );
2915
Jerry Yue67bef42022-07-07 07:29:42 +00002916 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
2917 ssl, buf_len, msg_len ) );
Jerry Yufca4d572022-07-21 10:37:48 +08002918
Jerry Yu359e65f2022-09-22 23:47:43 +08002919 /* Limit session tickets count to one when resumption connection.
2920 *
2921 * See document of mbedtls_ssl_conf_new_session_tickets.
2922 */
2923 if( ssl->handshake->resume == 1 )
2924 ssl->handshake->new_session_tickets_count = 0;
2925 else
2926 ssl->handshake->new_session_tickets_count--;
Jerry Yub7e3fa72022-09-22 11:07:18 +08002927
Jerry Yufca4d572022-07-21 10:37:48 +08002928 mbedtls_ssl_handshake_set_state( ssl,
2929 MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH );
Jerry Yue67bef42022-07-07 07:29:42 +00002930 }
2931 else
2932 {
2933 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2934 }
2935
Jerry Yue67bef42022-07-07 07:29:42 +00002936cleanup:
2937
2938 return( ret );
2939}
2940#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2941
2942/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00002943 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00002944 */
Jerry Yu27561932021-08-27 17:07:38 +08002945int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08002946{
XiaokangQian08037552022-04-20 07:16:41 +00002947 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002948
2949 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
2950 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2951
Jerry Yue3b34122021-09-28 17:53:35 +08002952 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
2953 mbedtls_ssl_states_str( ssl->state ),
2954 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08002955
XiaokangQian7807f9f2022-02-15 10:04:37 +00002956 switch( ssl->state )
2957 {
2958 /* start state */
2959 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00002960 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
XiaokangQian08037552022-04-20 07:16:41 +00002961 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002962 break;
2963
XiaokangQian7807f9f2022-02-15 10:04:37 +00002964 case MBEDTLS_SSL_CLIENT_HELLO:
XiaokangQian4080a7f2022-04-11 09:55:18 +00002965 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00002966 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00002967 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
Jerry Yuf41553b2022-05-09 22:20:30 +08002968 break;
XiaokangQian7807f9f2022-02-15 10:04:37 +00002969
Jerry Yuf41553b2022-05-09 22:20:30 +08002970 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
2971 ret = ssl_tls13_write_hello_retry_request( ssl );
2972 if( ret != 0 )
2973 {
2974 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_hello_retry_request", ret );
2975 return( ret );
2976 }
XiaokangQian7807f9f2022-02-15 10:04:37 +00002977 break;
2978
Jerry Yu5b64ae92022-03-30 17:15:02 +08002979 case MBEDTLS_SSL_SERVER_HELLO:
2980 ret = ssl_tls13_write_server_hello( ssl );
2981 break;
2982
Xiaofei Baicba64af2022-02-15 10:00:56 +00002983 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08002984 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002985 if( ret != 0 )
2986 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08002987 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
2988 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00002989 }
Jerry Yu48330562022-05-06 21:35:44 +08002990 break;
Jerry Yu6a2cd9e2022-05-05 11:14:19 +08002991
Ronald Cron928cbd32022-10-04 16:14:26 +02002992#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002993 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00002994 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002995 break;
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00002996
Jerry Yu83da34e2022-04-16 13:59:52 +08002997 case MBEDTLS_SSL_SERVER_CERTIFICATE:
2998 ret = ssl_tls13_write_server_certificate( ssl );
2999 break;
3000
3001 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
3002 ret = ssl_tls13_write_certificate_verify( ssl );
3003 break;
Ronald Cron928cbd32022-10-04 16:14:26 +02003004#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
Jerry Yu83da34e2022-04-16 13:59:52 +08003005
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003006 /*
3007 * Injection of dummy-CCS's for middlebox compatibility
3008 */
3009#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
Gabor Mezeif7044ea2022-06-28 16:01:49 +02003010 case MBEDTLS_SSL_SERVER_CCS_AFTER_HELLO_RETRY_REQUEST:
Gabor Mezei7b39bf12022-05-24 16:04:14 +02003011 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
3012 if( ret == 0 )
3013 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
3014 break;
3015
3016 case MBEDTLS_SSL_SERVER_CCS_AFTER_SERVER_HELLO:
3017 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
3018 if( ret == 0 )
3019 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
3020 break;
3021#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
3022
Jerry Yu69dd8d42022-04-16 12:51:26 +08003023 case MBEDTLS_SSL_SERVER_FINISHED:
3024 ret = ssl_tls13_write_server_finished( ssl );
3025 break;
3026
3027 case MBEDTLS_SSL_CLIENT_FINISHED:
3028 ret = ssl_tls13_process_client_finished( ssl );
3029 break;
3030
Jerry Yu69dd8d42022-04-16 12:51:26 +08003031 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
3032 ret = ssl_tls13_handshake_wrapup( ssl );
3033 break;
3034
Ronald Cron766c0cd2022-10-18 12:17:11 +02003035#if defined(MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED)
XiaokangQian6b916b12022-04-25 07:29:34 +00003036 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
3037 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Ronald Cron209cae92022-06-07 10:30:19 +02003038 if( ret == 0 )
XiaokangQian6b916b12022-04-25 07:29:34 +00003039 {
Ronald Cron209cae92022-06-07 10:30:19 +02003040 if( ssl->session_negotiate->peer_cert != NULL )
3041 {
3042 mbedtls_ssl_handshake_set_state(
3043 ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
3044 }
3045 else
Ronald Cron19385882022-06-15 16:26:13 +02003046 {
3047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip parse certificate verify" ) );
Ronald Cron209cae92022-06-07 10:30:19 +02003048 mbedtls_ssl_handshake_set_state(
3049 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02003050 }
XiaokangQian6b916b12022-04-25 07:29:34 +00003051 }
3052 break;
3053
3054 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
3055 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
3056 if( ret == 0 )
3057 {
3058 mbedtls_ssl_handshake_set_state(
3059 ssl, MBEDTLS_SSL_CLIENT_FINISHED );
3060 }
3061 break;
Ronald Cron766c0cd2022-10-18 12:17:11 +02003062#endif /* MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED */
XiaokangQian6b916b12022-04-25 07:29:34 +00003063
Jerry Yue67bef42022-07-07 07:29:42 +00003064#if defined(MBEDTLS_SSL_SESSION_TICKETS)
3065 case MBEDTLS_SSL_NEW_SESSION_TICKET:
3066 ret = ssl_tls13_write_new_session_ticket( ssl );
3067 if( ret != 0 )
3068 {
3069 MBEDTLS_SSL_DEBUG_RET( 1,
3070 "ssl_tls13_write_new_session_ticket ",
3071 ret );
3072 }
3073 break;
3074 case MBEDTLS_SSL_NEW_SESSION_TICKET_FLUSH:
3075 /* This state is necessary to do the flush of the New Session
3076 * Ticket message written in MBEDTLS_SSL_NEW_SESSION_TICKET
3077 * as part of ssl_prepare_handshake_step.
3078 */
3079 ret = 0;
Jerry Yud4e75002022-08-09 13:33:50 +08003080
Jerry Yud0766ec2022-09-22 10:46:57 +08003081 if( ssl->handshake->new_session_tickets_count == 0 )
Jerry Yud4e75002022-08-09 13:33:50 +08003082 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
3083 else
3084 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_NEW_SESSION_TICKET );
Jerry Yue67bef42022-07-07 07:29:42 +00003085 break;
3086
3087#endif /* MBEDTLS_SSL_SESSION_TICKETS */
3088
XiaokangQian7807f9f2022-02-15 10:04:37 +00003089 default:
3090 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00003091 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00003092 }
3093
3094 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08003095}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003096
Jerry Yufb4b6472022-01-27 15:03:26 +08003097#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */