blob: c757c6cbaa5a51d4b346ba7569d2e199180bd1f0 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
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 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yubdc71882021-09-14 19:30:36 +080035
Jerry Yubc20bdd2021-08-24 15:59:48 +080036/* Write extensions */
37
Jerry Yu92c6b402021-08-27 16:59:09 +080038/*
39 * ssl_tls13_write_supported_versions_ext():
40 *
41 * struct {
42 * ProtocolVersion versions<2..254>;
43 * } SupportedVersions;
44 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020045MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4436812021-08-26 22:59:56 +080046static int ssl_tls13_write_supported_versions_ext( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +080047 unsigned char *buf,
48 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +000049 size_t *out_len )
Jerry Yu92c6b402021-08-27 16:59:09 +080050{
51 unsigned char *p = buf;
Glenn Strausscd78df62022-04-07 19:07:11 -040052 unsigned char versions_len = ( ssl->handshake->min_tls_version <=
53 MBEDTLS_SSL_VERSION_TLS1_2 ) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080054
Xiaofei Baid25fab62021-12-02 06:36:27 +000055 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080056
Jerry Yu159c5a02021-08-31 12:51:25 +080057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported versions extension" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080058
Jerry Yu388bd0d2021-09-15 18:41:02 +080059 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080060 * - extension_type (2 bytes)
61 * - extension_data_length (2 bytes)
62 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020063 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080064 */
Ronald Crona77fc272022-03-30 17:20:47 +020065 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 5 + versions_len );
Ronald Crondbe87f02022-02-10 14:35:27 +010066
Jerry Yueecfbf02021-08-30 18:32:07 +080067 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0 );
Ronald Crondbe87f02022-02-10 14:35:27 +010068 MBEDTLS_PUT_UINT16_BE( versions_len + 1, p, 2 );
Jerry Yueecfbf02021-08-30 18:32:07 +080069 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080071 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010072 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080073
Jerry Yu0c63af62021-09-02 12:59:12 +080074 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080075 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010076 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080077 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -040078 mbedtls_ssl_write_version( p, MBEDTLS_SSL_TRANSPORT_STREAM,
79 MBEDTLS_SSL_VERSION_TLS1_3 );
Ronald Crondbe87f02022-02-10 14:35:27 +010080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:4]" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080081
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Glenn Strausscd78df62022-04-07 19:07:11 -040083 if( ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
Ronald Crondbe87f02022-02-10 14:35:27 +010084 {
Glenn Strausse3af4cb2022-03-15 03:23:42 -040085 mbedtls_ssl_write_version( p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2 );
Ronald Crondbe87f02022-02-10 14:35:27 +010087 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:3]" ) );
88 }
89
90 *out_len = 5 + versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080091
92 return( 0 );
93}
Jerry Yubc20bdd2021-08-24 15:59:48 +080094
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020095MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +080096static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
97 const unsigned char *buf,
Jerry Yub85277e2021-10-13 13:36:05 +080098 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +080099{
Jerry Yue1b9c292021-09-10 10:08:31 +0800100 ((void) ssl);
101
Ronald Cron98473382022-03-30 20:04:10 +0200102 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Glenn Strausse3af4cb2022-03-15 03:23:42 -0400103 if( mbedtls_ssl_read_version( buf, ssl->conf->transport ) !=
104 MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yue1b9c292021-09-10 10:08:31 +0800105 {
106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unexpected version" ) );
Jerry Yu4a173382021-10-11 21:45:31 +0800107
108 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
109 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
110 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue1b9c292021-09-10 10:08:31 +0800111 }
112
Ronald Cron98473382022-03-30 20:04:10 +0200113 if( &buf[2] != end )
114 {
115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "supported_versions ext data length incorrect" ) );
116 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
117 MBEDTLS_ERR_SSL_DECODE_ERROR );
118 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
119 }
120
Jerry Yue1b9c292021-09-10 10:08:31 +0800121 return( 0 );
122}
123
lhuang0486cacac2022-01-21 07:34:27 -0800124#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200125MBEDTLS_CHECK_RETURN_CRITICAL
lhuang0486cacac2022-01-21 07:34:27 -0800126static int ssl_tls13_parse_alpn_ext( mbedtls_ssl_context *ssl,
Ronald Cron81a334f2022-05-31 16:04:11 +0200127 const unsigned char *buf, size_t len )
lhuang0486cacac2022-01-21 07:34:27 -0800128{
lhuang0486cacac2022-01-21 07:34:27 -0800129 const unsigned char *p = buf;
130 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200131 size_t protocol_name_list_len, protocol_name_len;
132 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800133
134 /* If we didn't send it, the server shouldn't send it */
135 if( ssl->conf->alpn_list == NULL )
136 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
137
138 /*
139 * opaque ProtocolName<1..2^8-1>;
140 *
141 * struct {
142 * ProtocolName protocol_name_list<2..2^16-1>
143 * } ProtocolNameList;
144 *
145 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
146 */
147
Ronald Cron81a334f2022-05-31 16:04:11 +0200148 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
149 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
lhuang0486cacac2022-01-21 07:34:27 -0800150 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800151
Ronald Cron81a334f2022-05-31 16:04:11 +0200152 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
153 protocol_name_list_end = p + protocol_name_list_len;
154
155 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, 1 );
156 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800157
158 /* Check that the server chosen protocol was in our list and save it */
Ronald Cron81a334f2022-05-31 16:04:11 +0200159 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, protocol_name_len );
160 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
lhuang0486cacac2022-01-21 07:34:27 -0800161 {
Ronald Cron81a334f2022-05-31 16:04:11 +0200162 if( protocol_name_len == strlen( *alpn ) &&
163 memcmp( p, *alpn, protocol_name_len ) == 0 )
lhuang0486cacac2022-01-21 07:34:27 -0800164 {
165 ssl->alpn_chosen = *alpn;
166 return( 0 );
167 }
168 }
169
170 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian16acd4b2022-01-14 07:35:47 +0000175static int ssl_tls13_reset_key_share( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
XiaokangQian647719a2021-12-07 09:16:29 +0000179 if( group_id == 0 )
180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
181
XiaokangQian355e09a2022-01-20 11:14:50 +0000182#if defined(MBEDTLS_ECDH_C)
XiaokangQian647719a2021-12-07 09:16:29 +0000183 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
XiaokangQian78b1fa72022-01-19 06:56:30 +0000184 {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
189 status = psa_destroy_key( ssl->handshake->ecdh_psa_privkey );
190 if( status != PSA_SUCCESS )
191 {
192 ret = psa_ssl_status_to_mbedtls( status );
193 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
194 return( ret );
195 }
196
197 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
XiaokangQian78b1fa72022-01-19 06:56:30 +0000198 return( 0 );
199 }
XiaokangQian355e09a2022-01-20 11:14:50 +0000200 else
201#endif /* MBEDTLS_ECDH_C */
202 if( 0 /* other KEMs? */ )
XiaokangQian647719a2021-12-07 09:16:29 +0000203 {
204 /* Do something */
205 }
206
207 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
208}
209
210/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800211 * Functions for writing key_share extension.
212 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub60e3cf2021-09-08 16:41:02 +0800214static int ssl_tls13_get_default_group_id( mbedtls_ssl_context *ssl,
215 uint16_t *group_id )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800216{
217 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
218
Jerry Yu56fc07f2021-09-01 17:48:49 +0800219
Jerry Yu56fc07f2021-09-01 17:48:49 +0800220#if defined(MBEDTLS_ECDH_C)
Brett Warren14efd332021-10-06 09:32:11 +0100221 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Jerry Yu388bd0d2021-09-15 18:41:02 +0800222 /* Pick first available ECDHE group compatible with TLS 1.3 */
Brett Warren14efd332021-10-06 09:32:11 +0100223 if( group_list == NULL )
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
225
Brett Warren14efd332021-10-06 09:32:11 +0100226 for ( ; *group_list != 0; group_list++ )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800227 {
Xiaofei Baieef15042021-11-18 07:29:56 +0000228 const mbedtls_ecp_curve_info *curve_info;
229 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
230 if( curve_info != NULL &&
Brett Warren14efd332021-10-06 09:32:11 +0100231 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800232 {
Brett Warren14efd332021-10-06 09:32:11 +0100233 *group_id = *group_list;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800234 return( 0 );
235 }
236 }
237#else
238 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800239 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800240#endif /* MBEDTLS_ECDH_C */
241
242 /*
243 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800244 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 */
246
247 return( ret );
248}
249
250/*
251 * ssl_tls13_write_key_share_ext
252 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800253 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800254 *
255 * struct {
256 * NamedGroup group;
257 * opaque key_exchange<1..2^16-1>;
258 * } KeyShareEntry;
259 * struct {
260 * KeyShareEntry client_shares<0..2^16-1>;
261 * } KeyShareClientHello;
262 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200263MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
265 unsigned char *buf,
266 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000267 size_t *out_len )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268{
269 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000270 unsigned char *client_shares; /* Start of client_shares */
271 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
274
Xiaofei Baid25fab62021-12-02 06:36:27 +0000275 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800276
Jerry Yub60e3cf2021-09-08 16:41:02 +0800277 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 * - extension_type (2 bytes)
279 * - extension_data_length (2 bytes)
280 * - client_shares_length (2 bytes)
281 */
282 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
283 p += 6;
284
285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello: adding key share extension" ) );
286
287 /* HRR could already have requested something else. */
288 group_id = ssl->handshake->offered_group_id;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800289 if( !mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) &&
290 !mbedtls_ssl_tls13_named_group_is_dhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800291 {
Jerry Yub60e3cf2021-09-08 16:41:02 +0800292 MBEDTLS_SSL_PROC_CHK( ssl_tls13_get_default_group_id( ssl,
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 &group_id ) );
294 }
295
296 /*
297 * Dispatch to type-specific key generation function.
298 *
299 * So far, we're only supporting ECDHE. With the introduction
300 * of PQC KEMs, we'll want to have multiple branches, one per
301 * type of KEM, and dispatch to the corresponding crypto. And
302 * only one key share entry is allowed.
303 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000304 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800305#if defined(MBEDTLS_ECDH_C)
Jerry Yub60e3cf2021-09-08 16:41:02 +0800306 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800307 {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800308 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000309 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800310 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100311 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800312
313 /* Check there is space for header of KeyShareEntry
314 * - group (2 bytes)
315 * - key_exchange_length (2 bytes)
316 */
317 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 );
318 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800319 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
320 ssl, group_id, p, end, &key_exchange_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800321 p += key_exchange_len;
322 if( ret != 0 )
323 return( ret );
324
325 /* Write group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000326 MBEDTLS_PUT_UINT16_BE( group_id, group, 0 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Write key_exchange_length */
Xiaofei Baieef15042021-11-18 07:29:56 +0000328 MBEDTLS_PUT_UINT16_BE( key_exchange_len, group, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329 }
330 else
331#endif /* MBEDTLS_ECDH_C */
332 if( 0 /* other KEMs? */ )
333 {
334 /* Do something */
335 }
336 else
337 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
338
Jerry Yub60e3cf2021-09-08 16:41:02 +0800339 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000340 client_shares_len = p - client_shares;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800341 if( client_shares_len == 0)
342 {
343 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No key share defined." ) );
344 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu7c522d42021-09-08 17:55:09 +0800345 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800346 /* Write extension_type */
347 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
348 /* Write extension_data_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800349 MBEDTLS_PUT_UINT16_BE( client_shares_len + 2, buf, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350 /* Write client_shares_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800351 MBEDTLS_PUT_UINT16_BE( client_shares_len, buf, 4 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352
353 /* Update offered_group_id field */
354 ssl->handshake->offered_group_id = group_id;
355
356 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000357 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
Xiaofei Baid25fab62021-12-02 06:36:27 +0000359 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, key_share extension", buf, *out_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
361 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
362
363cleanup:
364
365 return( ret );
366}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800367
Jerry Yue1b9c292021-09-10 10:08:31 +0800368
XiaokangQiand59be772022-01-24 10:12:51 +0000369/*
370 * ssl_tls13_parse_hrr_key_share_ext()
371 * Parse key_share extension in Hello Retry Request
372 *
373 * struct {
374 * NamedGroup selected_group;
375 * } KeyShareHelloRetryRequest;
376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200377MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiand9e068e2022-01-18 06:23:32 +0000378static int ssl_tls13_parse_hrr_key_share_ext( mbedtls_ssl_context *ssl,
XiaokangQianb851da82022-01-14 04:03:11 +0000379 const unsigned char *buf,
380 const unsigned char *end )
381{
XiaokangQianb851da82022-01-14 04:03:11 +0000382 const mbedtls_ecp_curve_info *curve_info = NULL;
383 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000384 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000385 int found = 0;
386
387 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
388 if( group_list == NULL )
389 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
390
391 MBEDTLS_SSL_DEBUG_BUF( 3, "key_share extension", p, end - buf );
392
393 /* Read selected_group */
XiaokangQianb48894e2022-01-17 02:05:52 +0000394 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQiand59be772022-01-24 10:12:51 +0000395 selected_group = MBEDTLS_GET_UINT16_BE( p, 0 );
396 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_group ( %d )", selected_group ) );
XiaokangQianb851da82022-01-14 04:03:11 +0000397
398 /* Upon receipt of this extension in a HelloRetryRequest, the client
399 * MUST first verify that the selected_group field corresponds to a
400 * group which was provided in the "supported_groups" extension in the
401 * original ClientHello.
402 * The supported_group was based on the info in ssl->conf->group_list.
403 *
404 * If the server provided a key share that was not sent in the ClientHello
405 * then the client MUST abort the handshake with an "illegal_parameter" alert.
406 */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000407 for( ; *group_list != 0; group_list++ )
XiaokangQianb851da82022-01-14 04:03:11 +0000408 {
409 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
XiaokangQiand59be772022-01-24 10:12:51 +0000410 if( curve_info == NULL || curve_info->tls_id != selected_group )
XiaokangQianb851da82022-01-14 04:03:11 +0000411 continue;
412
413 /* We found a match */
414 found = 1;
415 break;
416 }
417
418 /* Client MUST verify that the selected_group field does not
419 * correspond to a group which was provided in the "key_share"
420 * extension in the original ClientHello. If the server sent an
421 * HRR message with a key share already provided in the
422 * ClientHello then the client MUST abort the handshake with
423 * an "illegal_parameter" alert.
424 */
XiaokangQiand59be772022-01-24 10:12:51 +0000425 if( found == 0 || selected_group == ssl->handshake->offered_group_id )
XiaokangQianb851da82022-01-14 04:03:11 +0000426 {
427 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid key share in HRR" ) );
428 MBEDTLS_SSL_PEND_FATAL_ALERT(
429 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
430 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
431 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
432 }
433
434 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000435 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000436
437 return( 0 );
438}
439
Jerry Yue1b9c292021-09-10 10:08:31 +0800440/*
Jerry Yub85277e2021-10-13 13:36:05 +0800441 * ssl_tls13_parse_key_share_ext()
442 * Parse key_share extension in Server Hello
443 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800444 * struct {
445 * KeyShareEntry server_share;
446 * } KeyShareServerHello;
447 * struct {
448 * NamedGroup group;
449 * opaque key_exchange<1..2^16-1>;
450 * } KeyShareEntry;
451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200452MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +0800453static int ssl_tls13_parse_key_share_ext( mbedtls_ssl_context *ssl,
Jerry Yue1b9c292021-09-10 10:08:31 +0800454 const unsigned char *buf,
455 const unsigned char *end )
456{
Jerry Yub85277e2021-10-13 13:36:05 +0800457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800458 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800459 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800460
Jerry Yu4a173382021-10-11 21:45:31 +0800461 /* ...
462 * NamedGroup group; (2 bytes)
463 * ...
464 */
465 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
466 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +0800467 p += 2;
468
Jerry Yu4a173382021-10-11 21:45:31 +0800469 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 offered_group = ssl->handshake->offered_group_id;
Jerry Yu4a173382021-10-11 21:45:31 +0800471 if( offered_group != group )
Jerry Yue1b9c292021-09-10 10:08:31 +0800472 {
473 MBEDTLS_SSL_DEBUG_MSG( 1,
474 ( "Invalid server key share, our group %u, their group %u",
Jerry Yu4a173382021-10-11 21:45:31 +0800475 (unsigned) offered_group, (unsigned) group ) );
476 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
477 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
478 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yue1b9c292021-09-10 10:08:31 +0800479 }
480
481#if defined(MBEDTLS_ECDH_C)
Jerry Yu4a173382021-10-11 21:45:31 +0800482 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
Jerry Yue1b9c292021-09-10 10:08:31 +0800483 {
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100484 const mbedtls_ecp_curve_info *curve_info =
485 mbedtls_ecp_curve_info_from_tls_id( group );
486 if( curve_info == NULL )
487 {
488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid TLS curve group id" ) );
489 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
490 }
491
492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
493
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000494 ret = mbedtls_ssl_tls13_read_public_ecdhe_share( ssl, p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +0800495 if( ret != 0 )
496 return( ret );
497 }
Jerry Yub85277e2021-10-13 13:36:05 +0800498 else
Jerry Yue1b9c292021-09-10 10:08:31 +0800499#endif /* MBEDTLS_ECDH_C */
Jerry Yub85277e2021-10-13 13:36:05 +0800500 if( 0 /* other KEMs? */ )
Jerry Yue1b9c292021-09-10 10:08:31 +0800501 {
502 /* Do something */
503 }
504 else
505 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
506
507 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
508 return( ret );
509}
510
XiaokangQiand59be772022-01-24 10:12:51 +0000511/*
512 * ssl_tls13_parse_cookie_ext()
513 * Parse cookie extension in Hello Retry Request
514 *
515 * struct {
516 * opaque cookie<1..2^16-1>;
517 * } Cookie;
518 *
519 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
520 * extension to the client (this is an exception to the usual rule that
521 * the only extensions that may be sent are those that appear in the
522 * ClientHello). When sending the new ClientHello, the client MUST copy
523 * the contents of the extension received in the HelloRetryRequest into
524 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
525 * cookies in their initial ClientHello in subsequent connections.
526 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200527MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian43550bd2022-01-21 04:32:58 +0000528static int ssl_tls13_parse_cookie_ext( mbedtls_ssl_context *ssl,
529 const unsigned char *buf,
530 const unsigned char *end )
531{
XiaokangQian25c9c902022-02-08 10:49:53 +0000532 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000533 const unsigned char *p = buf;
534 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
535
536 /* Retrieve length field of cookie */
537 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
538 cookie_len = MBEDTLS_GET_UINT16_BE( p, 0 );
539 p += 2;
540
541 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cookie_len );
542 MBEDTLS_SSL_DEBUG_BUF( 3, "cookie extension", p, cookie_len );
543
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000544 mbedtls_free( handshake->cookie );
XiaokangQian25c9c902022-02-08 10:49:53 +0000545 handshake->hrr_cookie_len = 0;
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000546 handshake->cookie = mbedtls_calloc( 1, cookie_len );
547 if( handshake->cookie == NULL )
XiaokangQian43550bd2022-01-21 04:32:58 +0000548 {
549 MBEDTLS_SSL_DEBUG_MSG( 1,
XiaokangQian25c9c902022-02-08 10:49:53 +0000550 ( "alloc failed ( %ud bytes )",
XiaokangQian43550bd2022-01-21 04:32:58 +0000551 cookie_len ) );
552 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
553 }
554
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000555 memcpy( handshake->cookie, p, cookie_len );
XiaokangQian25c9c902022-02-08 10:49:53 +0000556 handshake->hrr_cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000557
558 return( 0 );
559}
XiaokangQian43550bd2022-01-21 04:32:58 +0000560
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200561MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0b64eed2022-01-27 10:36:51 +0000562static int ssl_tls13_write_cookie_ext( mbedtls_ssl_context *ssl,
XiaokangQian233397e2022-02-07 08:32:16 +0000563 unsigned char *buf,
564 unsigned char *end,
XiaokangQian9deb90f2022-02-08 10:31:07 +0000565 size_t *out_len )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000566{
567 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000568 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000569 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000570
XiaokangQianc02768a2022-02-10 07:31:25 +0000571 if( handshake->cookie == NULL )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000572 {
573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no cookie to send; skip extension" ) );
574 return( 0 );
575 }
576
577 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, cookie",
XiaokangQianc02768a2022-02-10 07:31:25 +0000578 handshake->cookie,
579 handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000580
XiaokangQianc02768a2022-02-10 07:31:25 +0000581 MBEDTLS_SSL_CHK_BUF_PTR( p, end, handshake->hrr_cookie_len + 6 );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000582
583 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding cookie extension" ) );
584
XiaokangQian0b64eed2022-01-27 10:36:51 +0000585 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_COOKIE, p, 0 );
XiaokangQianc02768a2022-02-10 07:31:25 +0000586 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len + 2, p, 2 );
587 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len, p, 4 );
XiaokangQian233397e2022-02-07 08:32:16 +0000588 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000589
590 /* Cookie */
XiaokangQianc02768a2022-02-10 07:31:25 +0000591 memcpy( p, handshake->cookie, handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000592
XiaokangQianc02768a2022-02-10 07:31:25 +0000593 *out_len = handshake->hrr_cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000594
595 return( 0 );
596}
597
XiaokangQianeb69aee2022-07-05 08:21:43 +0000598#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
599/*
600 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
601 *
602 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
603 *
604 * struct {
605 * PskKeyExchangeMode ke_modes<1..255>;
606 * } PskKeyExchangeModes;
607 */
XiaokangQian86981952022-07-19 09:51:50 +0000608MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeb69aee2022-07-05 08:21:43 +0000609static int ssl_tls13_write_psk_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
610 unsigned char *buf,
611 unsigned char *end,
612 size_t *out_len )
613{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000615 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616
XiaokangQian008d2bf2022-07-14 07:54:01 +0000617 ((void) ke_modes_len );
XiaokangQianeb69aee2022-07-05 08:21:43 +0000618 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000619
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000621 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000622 */
XiaokangQian86981952022-07-19 09:51:50 +0000623 if( !mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000624 {
625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip psk_key_exchange_modes extension" ) );
626 return( 0 );
627 }
628
629 /* Require 7 bytes of data, otherwise fail,
630 * even if extension might be shorter.
631 */
632 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 );
633 MBEDTLS_SSL_DEBUG_MSG(
634 3, ( "client hello, adding psk_key_exchange_modes extension" ) );
635
XiaokangQianeb69aee2022-07-05 08:21:43 +0000636 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0 );
637
XiaokangQian008d2bf2022-07-14 07:54:01 +0000638 /* Skip extension length (2 bytes) and
639 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000640 */
641 p += 5;
642
643 if( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) )
644 {
645 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000646 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000647
648 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding pure PSK key exchange mode" ) );
649 }
650
651 if( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) )
652 {
653 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000654 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000655
656 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding PSK-ECDHE key exchange mode" ) );
657 }
658
XiaokangQian008d2bf2022-07-14 07:54:01 +0000659 /* Now write the extension and ke_modes length */
660 MBEDTLS_PUT_UINT16_BE( ke_modes_len + 1, buf, 2 );
661 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662
663 *out_len = p - buf;
664 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
665 return ( 0 );
666}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800667
Jerry Yuf7c12592022-09-28 22:09:38 +0800668static psa_algorithm_t ssl_tls13_ciphersuite_to_alg( mbedtls_ssl_context *ssl,
669 int ciphersuite )
670{
Jerry Yuf7c12592022-09-28 22:09:38 +0800671
Jerry Yu19ae6f62022-09-30 09:22:21 +0800672 psa_algorithm_t psa_alg;
673 if( mbedtls_ssl_tls13_ciphersuite_to_alg(
674 ssl, ciphersuite, &psa_alg ) != 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800675 {
Jerry Yu19ae6f62022-09-30 09:22:21 +0800676 /* ciphersuite is `ssl->session_negotiate->ciphersuite` or
677 * PSA_ALG_SHA256, both are validated before writting pre_shared_key.
678 */
679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "should never happen" ) );
680 return( PSA_ALG_NONE );
Jerry Yuf7c12592022-09-28 22:09:38 +0800681 }
Jerry Yu19ae6f62022-09-30 09:22:21 +0800682
683 return( psa_alg );
Jerry Yuf7c12592022-09-28 22:09:38 +0800684}
685
Jerry Yuf75364b2022-09-30 10:30:31 +0800686#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf7c12592022-09-28 22:09:38 +0800687
688static int ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl )
689{
Jerry Yuf7c12592022-09-28 22:09:38 +0800690 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yuf75364b2022-09-30 10:30:31 +0800691 return( session != NULL && session->ticket != NULL );
Jerry Yuf7c12592022-09-28 22:09:38 +0800692}
693
Jerry Yuf7c12592022-09-28 22:09:38 +0800694MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800695static int ssl_tls13_ticket_get_identity( mbedtls_ssl_context *ssl,
696 psa_algorithm_t *psa_alg,
697 const unsigned char **identity,
698 size_t *identity_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800699{
700 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800701
702 *psa_alg = PSA_ALG_NONE;
703 *identity = NULL;
704 *identity_len = 0;
705
706 if( !ssl_tls13_has_configured_ticket( ssl ) )
707 return( -1 );
708
Jerry Yuf7c12592022-09-28 22:09:38 +0800709 *psa_alg = ssl_tls13_ciphersuite_to_alg( ssl, session->ciphersuite );
710 *identity = session->ticket;
711 *identity_len = session->ticket_len;
712 return( 0 );
713}
714
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800715MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800716static int ssl_tls13_ticket_get_psk( mbedtls_ssl_context *ssl,
717 psa_algorithm_t *psa_alg,
718 const unsigned char **psk,
719 size_t *psk_len )
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800720{
721
722 mbedtls_ssl_session *session = ssl->session_negotiate;
723
Jerry Yu8b41e892022-09-30 10:00:20 +0800724 *psa_alg = PSA_ALG_NONE;
725 *psk = NULL;
726 *psk_len = 0;
727
728 if( !ssl_tls13_has_configured_ticket( ssl ) )
729 return( -1 );
730
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800731 *psa_alg = ssl_tls13_ciphersuite_to_alg( ssl, session->ciphersuite );
732 *psk = session->resumption_key;
733 *psk_len = session->resumption_key_len;
734
735 return( 0 );
736}
737
Jerry Yuf7c12592022-09-28 22:09:38 +0800738#endif /* MBEDTLS_SSL_SESSION_TICKETS */
739
Jerry Yuf75364b2022-09-30 10:30:31 +0800740static int ssl_tls13_has_configured_psk( mbedtls_ssl_context *ssl )
741{
742 return( ssl->conf->psk != NULL &&
743 ssl->conf->psk_len != 0 &&
744 ssl->conf->psk_identity != NULL &&
745 ssl->conf->psk_identity_len != 0 );
746}
747
Jerry Yuf7c12592022-09-28 22:09:38 +0800748MBEDTLS_CHECK_RETURN_CRITICAL
749static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
750 psa_algorithm_t *psa_alg,
751 const unsigned char **identity,
752 size_t *identity_len )
753{
Jerry Yu8b41e892022-09-30 10:00:20 +0800754 *psa_alg = PSA_ALG_NONE;
755 *identity = NULL;
756 *identity_len = 0;
757
758 if( !ssl_tls13_has_configured_psk( ssl ) )
759 return( -1 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800760
761 *psa_alg = PSA_ALG_SHA_256;
762 *identity = ssl->conf->psk_identity;
763 *identity_len = ssl->conf->psk_identity_len;
764 return( 0 );
765}
766
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800767MBEDTLS_CHECK_RETURN_CRITICAL
768static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
769 psa_algorithm_t *psa_alg,
770 const unsigned char **psk,
771 size_t *psk_len )
772{
Jerry Yu8b41e892022-09-30 10:00:20 +0800773 *psa_alg = PSA_ALG_NONE;
774 *psk = NULL;
775 *psk_len = 0;
776
777 if( !ssl_tls13_has_configured_psk( ssl ) )
778 return( -1 );
779
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800780 *psa_alg = PSA_ALG_SHA_256;
781 *psk = ssl->conf->psk;
782 *psk_len = ssl->conf->psk_len;
783 return( 0 );
784}
785
Jerry Yuf75364b2022-09-30 10:30:31 +0800786static int ssl_tls13_get_configured_psk_count( mbedtls_ssl_context *ssl )
787{
788 int configured_psk_count = 0;
789#if defined(MBEDTLS_SSL_SESSION_TICKETS)
790 if( ssl_tls13_has_configured_ticket( ssl ) )
791 {
792 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Ticket is configured" ) );
793 configured_psk_count++;
794 }
795#endif
796 if( ssl_tls13_has_configured_psk( ssl ) )
797 {
798 MBEDTLS_SSL_DEBUG_MSG( 3, ( "PSK is configured" ) );
799 configured_psk_count++;
800 }
801 return( configured_psk_count );
802}
803
Jerry Yuf7c12592022-09-28 22:09:38 +0800804MBEDTLS_CHECK_RETURN_CRITICAL
805static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
806 unsigned char *buf,
807 unsigned char *end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800808 const unsigned char *identity,
809 size_t identity_len,
810 uint32_t obfuscated_ticket_age,
811 size_t *out_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800812{
813 unsigned char *p = buf;
Jerry Yuf7c12592022-09-28 22:09:38 +0800814
Jerry Yuf75364b2022-09-30 10:30:31 +0800815 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800816 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800817
818 /*
819 * - identity_len (2 bytes)
820 * - identity (psk_identity_len bytes)
821 * - obfuscated_ticket_age (4 bytes)
822 */
823 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 + identity_len );
824
825 MBEDTLS_PUT_UINT16_BE( identity_len, p, 0 );
826 memcpy( p + 2, identity, identity_len );
827 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, p, 2 + identity_len );
828
829 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", p, 6 + identity_len );
830
831 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800832
833 return( 0 );
834}
835
Jerry Yu8b41e892022-09-30 10:00:20 +0800836MBEDTLS_CHECK_RETURN_CRITICAL
837static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
838 unsigned char *buf,
839 unsigned char *end,
840 int psk_type,
841 size_t *out_len )
842{
843 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
844 unsigned char *p = buf;
845 const unsigned char *psk;
846 psa_algorithm_t psa_alg = PSA_ALG_NONE;
847 size_t psk_len;
848 unsigned char binder_len;
849 unsigned char transcript[MBEDTLS_MD_MAX_SIZE];
850 size_t transcript_len = 0;
851
852 *out_len = 0;
853
854 switch( psk_type )
855 {
856#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_HAVE_TIME)
857 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
858 if( ssl_tls13_ticket_get_psk( ssl, &psa_alg, &psk, &psk_len ) != 0 )
859 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
860 break;
861#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_HAVE_TIME*/
862 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
863 if( ssl_tls13_psk_get_psk( ssl, &psa_alg, &psk, &psk_len ) != 0 )
864 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
865 break;
866 default:
867 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
868 }
869
870 binder_len = PSA_HASH_LENGTH( psa_alg );
871 if( binder_len == 0 )
872 {
873 MBEDTLS_SSL_DEBUG_MSG( 3, ( "should never happen" ) );
874 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
875 }
876
877 /*
878 * - binder_len (1 bytes)
879 * - binder (binder_len bytes)
880 */
881 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + binder_len );
882
883 p[0] = binder_len;
884
885 /* Get current state of handshake transcript. */
886 ret = mbedtls_ssl_get_handshake_transcript(
887 ssl, mbedtls_hash_info_md_from_psa( psa_alg ),
888 transcript, MBEDTLS_MD_MAX_SIZE, &transcript_len );
889 if( ret != 0 )
890 return( ret );
891
892
893
894 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psa_alg,
895 psk, psk_len, psk_type,
896 transcript, p + 1 );
897 if( ret != 0 )
898 {
899 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
900 return( ret );
901 }
902 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", p, 1 + binder_len );
903
904 *out_len = 1 + binder_len;
905
906 return( ret );
907}
908
909/*
910 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
911 *
912 * struct {
913 * opaque identity<1..2^16-1>;
914 * uint32 obfuscated_ticket_age;
915 * } PskIdentity;
916 *
917 * opaque PskBinderEntry<32..255>;
918 *
919 * struct {
920 * PskIdentity identities<7..2^16-1>;
921 * PskBinderEntry binders<33..2^16-1>;
922 * } OfferedPsks;
923 *
924 * struct {
925 * select (Handshake.msg_type) {
926 * case client_hello: OfferedPsks;
927 * ...
928 * };
929 * } PreSharedKeyExtension;
930 *
931 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000932int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Jerry Yuf75364b2022-09-30 10:30:31 +0800933 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
934 size_t *out_len, size_t *binders_len )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000935{
Jerry Yuf7c12592022-09-28 22:09:38 +0800936 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800937 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800938 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800939 psa_algorithm_t hash_alg;
940 const unsigned char *identity;
941 size_t identity_len;
942 uint32_t obfuscated_ticket_age = 0;
943 int hash_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800944 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800945 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800946
947 *out_len = 0;
948 *binders_len = 0;
949
Jerry Yuf75364b2022-09-30 10:30:31 +0800950
Jerry Yuf7c12592022-09-28 22:09:38 +0800951 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Jerry Yuf75364b2022-09-30 10:30:31 +0800952 configured_psk_count = ssl_tls13_get_configured_psk_count( ssl );
953 if( configured_psk_count == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800954 {
955 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
956 return( 0 );
957 }
958
959 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
Jerry Yuf75364b2022-09-30 10:30:31 +0800960 configured_psk_count ) );
961
Jerry Yuf7c12592022-09-28 22:09:38 +0800962 /* Check if we have space to write the extension, binders included.
963 * - extension_type (2 bytes)
964 * - extension_data_len (2 bytes)
965 * - identities_len (2 bytes)
966 */
967 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
968 p += 6;
969
Jerry Yuf75364b2022-09-30 10:30:31 +0800970#if defined(MBEDTLS_SSL_SESSION_TICKETS)
971 if( ssl_tls13_ticket_get_identity(
972 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800973 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800974#if defined(MBEDTLS_HAVE_TIME)
975 mbedtls_time_t now = mbedtls_time( NULL );
976 mbedtls_ssl_session *session = ssl->session_negotiate;
977 obfuscated_ticket_age = (uint32_t)( now - session->ticket_received );
978 obfuscated_ticket_age *= 1000;
979 obfuscated_ticket_age += session->ticket_age_add;
980#endif /* MBEDTLS_HAVE_TIME */
Jerry Yuf7c12592022-09-28 22:09:38 +0800981 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800982 identity, identity_len,
983 obfuscated_ticket_age,
984 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800985 if( ret != 0 )
986 return( ret );
Jerry Yuf7c12592022-09-28 22:09:38 +0800987
Jerry Yuf75364b2022-09-30 10:30:31 +0800988 hash_len = PSA_HASH_LENGTH( hash_alg );
989 if( hash_len == 0 )
990 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
991
992 p += output_len;
993 l_binders_len += 1 + hash_len;
994 }
995#endif /* MBEDTLS_SSL_SESSION_TICKETS */
996
997 if( ssl_tls13_psk_get_identity(
998 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800999 {
Jerry Yuf75364b2022-09-30 10:30:31 +08001000
Jerry Yuf7c12592022-09-28 22:09:38 +08001001 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +08001002 identity, identity_len,
1003 obfuscated_ticket_age,
1004 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +08001005 if( ret != 0 )
1006 return( ret );
Jerry Yuf75364b2022-09-30 10:30:31 +08001007
1008 hash_len = PSA_HASH_LENGTH( hash_alg );
1009 if( hash_len == 0 )
1010 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1011
Jerry Yuf7c12592022-09-28 22:09:38 +08001012 p += output_len;
Jerry Yuf75364b2022-09-30 10:30:31 +08001013 l_binders_len += 1 + hash_len;
Jerry Yuf7c12592022-09-28 22:09:38 +08001014 }
1015
1016 MBEDTLS_SSL_DEBUG_MSG( 3,
1017 ( "client hello, adding pre_shared_key extension, "
1018 "omitting PSK binder list" ) );
1019 /*
1020 * - extension_type (2 bytes)
1021 * - extension_data_len (2 bytes)
1022 * - identities_len (2 bytes)
1023 */
1024 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
1025 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + 2 + l_binders_len , buf, 2 );
1026 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
1027
1028 /* Check if there are enough space for binders */
1029 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len + 2 );
1030
1031 *out_len = ( p - buf ) + l_binders_len + 2;
1032 *binders_len = l_binders_len + 2;
1033
1034 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
1035
1036 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1037
XiaokangQianeb69aee2022-07-05 08:21:43 +00001038 return( 0 );
1039}
1040
XiaokangQian86981952022-07-19 09:51:50 +00001041int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +08001042 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001043{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001044 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1045 unsigned char *p = buf;
1046
1047 /* Check if we have space to write binders_len.
1048 * - binders_len (2 bytes)
1049 */
1050 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1051 p += 2;
1052
1053 if( ssl_tls13_has_configured_ticket( ssl ) )
1054 {
1055 size_t output_len;
1056 ret = ssl_tls13_write_binder( ssl, p, end,
1057 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1058 &output_len );
1059 if( ret != 0 )
1060 return( ret );
1061 p += output_len;
1062 }
1063
1064 if( ssl_tls13_has_configured_psk( ssl ) )
1065 {
1066 size_t output_len;
1067 ret = ssl_tls13_write_binder( ssl, p, end,
1068 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1069 &output_len );
1070 if( ret != 0 )
1071 return( ret );
1072 p += output_len;
1073 }
1074
1075 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1076
1077 /*
1078 * - binders_len (2 bytes)
1079 */
1080 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1081
1082 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001083
1084 return( 0 );
1085}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001086
1087/*
1088 * struct {
1089 * opaque identity<1..2^16-1>;
1090 * uint32 obfuscated_ticket_age;
1091 * } PskIdentity;
1092 *
1093 * opaque PskBinderEntry<32..255>;
1094 *
1095 * struct {
1096 *
1097 * select (Handshake.msg_type) {
1098 * ...
1099 * case server_hello: uint16 selected_identity;
1100 * };
1101 *
1102 * } PreSharedKeyExtension;
1103 *
1104 */
1105MBEDTLS_CHECK_RETURN_CRITICAL
1106static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1107 const unsigned char *buf,
1108 const unsigned char *end )
1109{
Jerry Yub300e3c2022-09-28 22:12:07 +08001110 int ret = 0;
1111 int selected_identity;
1112 int psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1113 const unsigned char *psk;
1114 size_t psk_len;
1115 psa_algorithm_t psa_alg;
1116
1117 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 2 );
1118 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
1119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
1120
1121 if( ssl_tls13_has_configured_psk( ssl ) &&
1122 ssl_tls13_has_configured_ticket( ssl ) )
1123 {
1124 if( selected_identity >= 2 )
1125 {
1126 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1127 goto exit;
1128 }
1129 switch( selected_identity )
1130 {
1131 case 0:
1132 psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
1133 break;
1134 case 1:
1135 psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1136 break;
1137 }
1138 }
1139 else if( ssl_tls13_has_configured_psk( ssl ) ||
1140 ssl_tls13_has_configured_ticket( ssl ) )
1141 {
1142 if( selected_identity >= 1 )
1143 {
1144 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1145 goto exit;
1146 }
1147
1148 if( ssl_tls13_has_configured_psk( ssl ) )
1149 psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1150 else if( ssl_tls13_has_configured_ticket( ssl ) )
1151 psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
1152 }
1153 else
1154 {
1155 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1156 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1157 }
1158 switch( psk_type )
1159 {
1160#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1161 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu8b41e892022-09-30 10:00:20 +08001162 ret = ssl_tls13_ticket_get_psk( ssl, &psa_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001163 break;
1164#endif
1165 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
1166 ret = ssl_tls13_psk_get_psk(
1167 ssl, &psa_alg, &psk, &psk_len );
1168 break;
1169 default:
1170 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1171 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1172 }
1173 if( ret != 0 )
1174 return( ret );
1175
1176 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1177 if( ret != 0 )
1178 {
1179 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
1180 }
1181 else
1182 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1183
1184 return( ret );
1185
1186exit:
1187 MBEDTLS_SSL_DEBUG_MSG(
1188 1, ( "Invalid chosen PSK identity." ) );
1189
1190 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1191 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1192 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001193}
1194
XiaokangQianeb69aee2022-07-05 08:21:43 +00001195#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1196
Ronald Cron3d580bf2022-02-18 17:24:56 +01001197int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1198 unsigned char *buf,
1199 unsigned char *end,
1200 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001201{
1202 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1203 unsigned char *p = buf;
1204 size_t ext_len;
1205
1206 *out_len = 0;
1207
1208 /* Write supported_versions extension
1209 *
1210 * Supported Versions Extension is mandatory with TLS 1.3.
1211 */
1212 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1213 if( ret != 0 )
1214 return( ret );
1215 p += ext_len;
1216
1217 /* Echo the cookie if the server provided one in its preceding
1218 * HelloRetryRequest message.
1219 */
1220 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1221 if( ret != 0 )
1222 return( ret );
1223 p += ext_len;
1224
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001225 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1226 {
1227 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1228 if( ret != 0 )
1229 return( ret );
1230 p += ext_len;
1231 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001232
XiaokangQianeb69aee2022-07-05 08:21:43 +00001233#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1234 /* For PSK-based key exchange we need the pre_shared_key extension
1235 * and the psk_key_exchange_modes extension.
1236 *
1237 * The pre_shared_key extension MUST be the last extension in the
1238 * ClientHello. Servers MUST check that it is the last extension and
1239 * otherwise fail the handshake with an "illegal_parameter" alert.
1240 *
1241 * Add the psk_key_exchange_modes extension.
1242 */
1243 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1244 if( ret != 0 )
1245 return( ret );
1246 p += ext_len;
1247#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1248
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001249 *out_len = p - buf;
1250
1251 return( 0 );
1252}
1253
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001254/*
Jerry Yu4a173382021-10-11 21:45:31 +08001255 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001256 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001257
Ronald Cronda41b382022-03-30 09:57:11 +02001258/**
1259 * \brief Detect if the ServerHello contains a supported_versions extension
1260 * or not.
1261 *
1262 * \param[in] ssl SSL context
1263 * \param[in] buf Buffer containing the ServerHello message
1264 * \param[in] end End of the buffer containing the ServerHello message
1265 *
1266 * \return 0 if the ServerHello does not contain a supported_versions extension
1267 * \return 1 if the ServerHello contains a supported_versions extension
1268 * \return A negative value if an error occurred while parsing the ServerHello.
1269 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001270MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001271static int ssl_tls13_is_supported_versions_ext_present(
1272 mbedtls_ssl_context *ssl,
1273 const unsigned char *buf,
1274 const unsigned char *end )
1275{
1276 const unsigned char *p = buf;
1277 size_t legacy_session_id_echo_len;
1278 size_t extensions_len;
1279 const unsigned char *extensions_end;
1280
1281 /*
1282 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001283 * length:
1284 * - legacy_version 2 bytes
1285 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1286 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001287 */
1288 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1289 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1290 legacy_session_id_echo_len = *p;
1291
1292 /*
1293 * Jump to the extensions, jumping over:
1294 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1295 * - cipher_suite 2 bytes
1296 * - legacy_compression_method 1 byte
1297 */
Ronald Cron28271062022-06-10 14:43:55 +02001298 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001299 p += legacy_session_id_echo_len + 4;
1300
1301 /* Case of no extension */
1302 if( p == end )
1303 return( 0 );
1304
1305 /* ...
1306 * Extension extensions<6..2^16-1>;
1307 * ...
1308 * struct {
1309 * ExtensionType extension_type; (2 bytes)
1310 * opaque extension_data<0..2^16-1>;
1311 * } Extension;
1312 */
1313 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1314 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1315 p += 2;
1316
1317 /* Check extensions do not go beyond the buffer of data. */
1318 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1319 extensions_end = p + extensions_len;
1320
1321 while( p < extensions_end )
1322 {
1323 unsigned int extension_type;
1324 size_t extension_data_len;
1325
1326 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1327 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1328 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1329 p += 4;
1330
1331 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1332 return( 1 );
1333
1334 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1335 p += extension_data_len;
1336 }
1337
1338 return( 0 );
1339}
1340
Jerry Yu7a186a02021-10-15 18:46:14 +08001341/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001342 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1343 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1344 * - 0 otherwise
1345 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001346MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001347static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1348 const unsigned char *buf,
1349 const unsigned char *end )
1350{
1351 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1352 static const unsigned char magic_downgrade_string[] =
1353 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1354 const unsigned char *last_eight_bytes_of_random;
1355 unsigned char last_byte_of_random;
1356
1357 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1358 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1359
1360 if( memcmp( last_eight_bytes_of_random,
1361 magic_downgrade_string,
1362 sizeof( magic_downgrade_string ) ) == 0 )
1363 {
1364 last_byte_of_random = last_eight_bytes_of_random[7];
1365 return( last_byte_of_random == 0 ||
1366 last_byte_of_random == 1 );
1367 }
1368
1369 return( 0 );
1370}
1371
1372/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001373 * - SSL_SERVER_HELLO or
1374 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001375 * to indicate which message is expected and to be parsed next.
1376 */
Ronald Cron828aff62022-05-31 12:04:31 +02001377#define SSL_SERVER_HELLO 0
1378#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001379MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001380static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1381 const unsigned char *buf,
1382 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001383{
Jerry Yue1b9c292021-09-10 10:08:31 +08001384
1385 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1386 *
Jerry Yu4a173382021-10-11 21:45:31 +08001387 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001388 * special value of the SHA-256 of "HelloRetryRequest".
1389 *
1390 * struct {
1391 * ProtocolVersion legacy_version = 0x0303;
1392 * Random random;
1393 * opaque legacy_session_id_echo<0..32>;
1394 * CipherSuite cipher_suite;
1395 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001396 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001397 * } ServerHello;
1398 *
1399 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001400 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1401 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001402
Jerry Yu93a13f22022-04-11 23:00:01 +08001403 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1404 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001405 {
Ronald Cron828aff62022-05-31 12:04:31 +02001406 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001407 }
1408
Ronald Cron828aff62022-05-31 12:04:31 +02001409 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001410}
1411
Ronald Cron828aff62022-05-31 12:04:31 +02001412/*
Jerry Yu745bb612021-10-13 22:01:04 +08001413 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001414 * - SSL_SERVER_HELLO or
1415 * - SSL_SERVER_HELLO_HRR or
1416 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001417 */
Ronald Cron828aff62022-05-31 12:04:31 +02001418#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001419MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001420static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001421 const unsigned char *buf,
1422 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001423{
Jerry Yu4a173382021-10-11 21:45:31 +08001424 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001425 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001426
Ronald Cron9f0fba32022-02-10 16:45:15 +01001427 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001428 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001429
Ronald Cron9f0fba32022-02-10 16:45:15 +01001430 if( ret == 0 )
1431 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001432 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001433 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001434
1435 /* If the server is negotiating TLS 1.2 or below and:
1436 * . we did not propose TLS 1.2 or
1437 * . the server responded it is TLS 1.3 capable but negotiating a lower
1438 * version of the protocol and thus we are under downgrade attack
1439 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001440 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001441 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001442 {
1443 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1444 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1445 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1446 }
1447
1448 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001449 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001450 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001451 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001452
1453 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1454 {
1455 ret = ssl_tls13_reset_key_share( ssl );
1456 if( ret != 0 )
1457 return( ret );
1458 }
1459
Ronald Cron828aff62022-05-31 12:04:31 +02001460 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001461 }
1462
Jerry Yua66fece2022-07-13 14:30:29 +08001463#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1464 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1465 ssl->session_negotiate->tls_version = ssl->tls_version;
1466#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1467
Ronald Cron5afb9042022-05-31 12:11:39 +02001468 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1469
Ronald Crondb5dfa12022-05-31 11:44:38 +02001470 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001471 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001472 {
Ronald Cron828aff62022-05-31 12:04:31 +02001473 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001474 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1475 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001476 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001478 /* If a client receives a second
1479 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1480 * was itself in response to a HelloRetryRequest), it MUST abort the
1481 * handshake with an "unexpected_message" alert.
1482 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001483 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001484 {
1485 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1486 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1487 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1488 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1489 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001490 /*
1491 * Clients must abort the handshake with an "illegal_parameter"
1492 * alert if the HelloRetryRequest would not result in any change
1493 * in the ClientHello.
1494 * In a PSK only key exchange that what we expect.
1495 */
1496 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1497 {
1498 MBEDTLS_SSL_DEBUG_MSG( 1,
1499 ( "Unexpected HRR in pure PSK key exchange." ) );
1500 MBEDTLS_SSL_PEND_FATAL_ALERT(
1501 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1502 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1503 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1504 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001505
Ronald Cron5afb9042022-05-31 12:11:39 +02001506 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001507
Jerry Yu745bb612021-10-13 22:01:04 +08001508 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001509 }
1510
1511cleanup:
1512
1513 return( ret );
1514}
1515
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001516MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001517static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1518 const unsigned char **buf,
1519 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001520{
1521 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001522 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001523
Jerry Yude4fb2c2021-09-19 18:05:08 +08001524 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001525 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001526
Jerry Yu4a173382021-10-11 21:45:31 +08001527 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001528
1529 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001530 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1531 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001532 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001533 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1534 ssl->session_negotiate->id,
1535 ssl->session_negotiate->id_len );
1536 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001537 legacy_session_id_echo_len );
1538
1539 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1540 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1541
Jerry Yue1b9c292021-09-10 10:08:31 +08001542 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1543 }
1544
Jerry Yu4a173382021-10-11 21:45:31 +08001545 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001546 *buf = p;
1547
1548 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001549 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001550 return( 0 );
1551}
1552
Jerry Yue1b9c292021-09-10 10:08:31 +08001553/* Parse ServerHello message and configure context
1554 *
1555 * struct {
1556 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1557 * Random random;
1558 * opaque legacy_session_id_echo<0..32>;
1559 * CipherSuite cipher_suite;
1560 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001561 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001562 * } ServerHello;
1563 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001564MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001565static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1566 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001567 const unsigned char *end,
1568 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001569{
Jerry Yub85277e2021-10-13 13:36:05 +08001570 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001571 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001572 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001573 size_t extensions_len;
1574 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001575 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001576 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001577 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001578
1579 /*
1580 * Check there is space for minimal fields
1581 *
1582 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001583 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001584 * - legacy_session_id_echo ( 1 byte ), minimum size
1585 * - cipher_suite ( 2 bytes)
1586 * - legacy_compression_method ( 1 byte )
1587 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001588 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001589
1590 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001591 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1592
Jerry Yu4a173382021-10-11 21:45:31 +08001593 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001594 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001595 * ...
1596 * with ProtocolVersion defined as:
1597 * uint16 ProtocolVersion;
1598 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001599 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1600 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001601 {
1602 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1603 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1604 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001605 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1606 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001607 }
1608 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001609
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001610 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001611 * Random random;
1612 * ...
1613 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001614 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001615 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001616 if( !is_hrr )
1617 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001618 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001619 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1620 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1621 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1622 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001623 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001624
Jerry Yu4a173382021-10-11 21:45:31 +08001625 /* ...
1626 * opaque legacy_session_id_echo<0..32>;
1627 * ...
1628 */
1629 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001630 {
XiaokangQian52da5582022-01-26 09:49:29 +00001631 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001632 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001633 }
1634
Jerry Yu4a173382021-10-11 21:45:31 +08001635 /* ...
1636 * CipherSuite cipher_suite;
1637 * ...
1638 * with CipherSuite defined as:
1639 * uint8 CipherSuite[2];
1640 */
1641 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001642 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1643 p += 2;
1644
Jerry Yu4a173382021-10-11 21:45:31 +08001645
XiaokangQian355e09a2022-01-20 11:14:50 +00001646 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001647 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001648 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001649 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001650 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1651 ssl->tls_version,
1652 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001653 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001654 {
XiaokangQian52da5582022-01-26 09:49:29 +00001655 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001656 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001657 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001658 * If we received an HRR before and that the proposed selected
1659 * ciphersuite in this server hello is not the same as the one
1660 * proposed in the HRR, we abort the handshake and send an
1661 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001662 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001663 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1664 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001665 {
XiaokangQian52da5582022-01-26 09:49:29 +00001666 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001667 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001668
XiaokangQian52da5582022-01-26 09:49:29 +00001669 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001670 {
1671 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1672 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001673 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001674 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001675
Jerry Yu4a173382021-10-11 21:45:31 +08001676 /* Configure ciphersuites */
1677 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1678
XiaokangQian355e09a2022-01-20 11:14:50 +00001679 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001680 ssl->session_negotiate->ciphersuite = cipher_suite;
1681
Jerry Yue1b9c292021-09-10 10:08:31 +08001682 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1683 cipher_suite, ciphersuite_info->name ) );
1684
1685#if defined(MBEDTLS_HAVE_TIME)
1686 ssl->session_negotiate->start = time( NULL );
1687#endif /* MBEDTLS_HAVE_TIME */
1688
Jerry Yu4a173382021-10-11 21:45:31 +08001689 /* ...
1690 * uint8 legacy_compression_method = 0;
1691 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001692 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001693 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001694 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001695 {
Jerry Yub85277e2021-10-13 13:36:05 +08001696 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001697 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001698 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001699 }
1700 p++;
1701
Jerry Yub85277e2021-10-13 13:36:05 +08001702 /* ...
1703 * Extension extensions<6..2^16-1>;
1704 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001705 * struct {
1706 * ExtensionType extension_type; (2 bytes)
1707 * opaque extension_data<0..2^16-1>;
1708 * } Extension;
1709 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001710 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001711 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001712 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001713
Jerry Yu4a173382021-10-11 21:45:31 +08001714 /* Check extensions do not go beyond the buffer of data. */
1715 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1716 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001717
Jerry Yu4a173382021-10-11 21:45:31 +08001718 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001719
Jerry Yu4a173382021-10-11 21:45:31 +08001720 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001721 {
1722 unsigned int extension_type;
1723 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001724 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001725
Jerry Yu4a173382021-10-11 21:45:31 +08001726 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001727 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1728 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1729 p += 4;
1730
Jerry Yu4a173382021-10-11 21:45:31 +08001731 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001732 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001733
1734 switch( extension_type )
1735 {
XiaokangQianb851da82022-01-14 04:03:11 +00001736 case MBEDTLS_TLS_EXT_COOKIE:
1737
XiaokangQiand9e068e2022-01-18 06:23:32 +00001738 if( !is_hrr )
1739 {
XiaokangQian52da5582022-01-26 09:49:29 +00001740 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001741 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001742 }
1743
XiaokangQian43550bd2022-01-21 04:32:58 +00001744 ret = ssl_tls13_parse_cookie_ext( ssl,
1745 p, extension_data_end );
1746 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001747 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001748 MBEDTLS_SSL_DEBUG_RET( 1,
1749 "ssl_tls13_parse_cookie_ext",
1750 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001751 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001752 }
XiaokangQianb851da82022-01-14 04:03:11 +00001753 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001754
Jerry Yue1b9c292021-09-10 10:08:31 +08001755 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001756 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001757 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001758 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001759 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001760 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001761 break;
1762
XiaokangQianeb69aee2022-07-05 08:21:43 +00001763#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001764 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001765 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1766 if( is_hrr )
1767 {
1768 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1769 goto cleanup;
1770 }
Jerry Yu4a173382021-10-11 21:45:31 +08001771
XiaokangQian86981952022-07-19 09:51:50 +00001772 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001773 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001774 {
1775 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001776 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001777 return( ret );
1778 }
1779 break;
1780#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001781
Jerry Yue1b9c292021-09-10 10:08:31 +08001782 case MBEDTLS_TLS_EXT_KEY_SHARE:
1783 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001784 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1785 {
XiaokangQian52da5582022-01-26 09:49:29 +00001786 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001787 goto cleanup;
1788 }
1789
XiaokangQian53f20b72022-01-18 10:47:33 +00001790 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001791 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001792 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001793 else
XiaokangQianb851da82022-01-14 04:03:11 +00001794 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001795 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001796 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001797 {
1798 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001799 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001800 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001801 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001802 }
1803 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001804
1805 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001806 MBEDTLS_SSL_DEBUG_MSG(
1807 3,
1808 ( "unknown extension found: %u ( ignoring )",
1809 extension_type ) );
1810
XiaokangQian52da5582022-01-26 09:49:29 +00001811 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001812 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001813 }
1814
1815 p += extension_data_len;
1816 }
1817
XiaokangQiand59be772022-01-24 10:12:51 +00001818cleanup:
1819
XiaokangQian52da5582022-01-26 09:49:29 +00001820 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001821 {
1822 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1823 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1824 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1825 }
XiaokangQian52da5582022-01-26 09:49:29 +00001826 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001827 {
1828 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1829 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1830 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1831 }
1832 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001833}
1834
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001835#if defined(MBEDTLS_DEBUG_C)
1836static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001837{
1838 switch( mode )
1839 {
1840 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1841 return "psk";
1842 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1843 return "ephemeral";
1844 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1845 return "psk_ephemeral";
1846 default:
1847 return "unknown mode";
1848 }
1849}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001850#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001851
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001852MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001853static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001854{
Jerry Yub85277e2021-10-13 13:36:05 +08001855 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001856 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001857
Jerry Yub85277e2021-10-13 13:36:05 +08001858 /* Determine the key exchange mode:
1859 * 1) If both the pre_shared_key and key_share extensions were received
1860 * then the key exchange mode is PSK with EPHEMERAL.
1861 * 2) If only the pre_shared_key extension was received then the key
1862 * exchange mode is PSK-only.
1863 * 3) If only the key_share extension was received then the key
1864 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001865 */
Jerry Yub85277e2021-10-13 13:36:05 +08001866 switch( handshake->extensions_present &
1867 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001868 {
Jerry Yu745bb612021-10-13 22:01:04 +08001869 /* Only the pre_shared_key extension was received */
1870 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001871 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001872 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001873
Jerry Yu745bb612021-10-13 22:01:04 +08001874 /* Only the key_share extension was received */
1875 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001876 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001877 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001878
Jerry Yu745bb612021-10-13 22:01:04 +08001879 /* Both the pre_shared_key and key_share extensions were received */
1880 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001881 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001882 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001883
Jerry Yu745bb612021-10-13 22:01:04 +08001884 /* Neither pre_shared_key nor key_share extension was received */
1885 default:
1886 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1887 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1888 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001889 }
1890
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001891 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1892 {
1893 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1894 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001895 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001896 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001897 goto cleanup;
1898 }
1899
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001900 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001901 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001902 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001903
Jerry Yu0b177842021-09-05 19:41:30 +08001904 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1905 *
1906 * TODO: We don't have to do this in case we offered 0-RTT and the
1907 * server accepted it. In this case, we could skip generating
1908 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001909 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001910 if( ret != 0 )
1911 {
Jerry Yue110d252022-05-05 10:19:22 +08001912 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001913 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001914 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001915 }
1916
Jerry Yuf86eb752022-05-06 11:16:55 +08001917 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001918 if( ret != 0 )
1919 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001920 MBEDTLS_SSL_DEBUG_RET( 1,
1921 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001922 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001923 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001924 }
1925
Jerry Yue110d252022-05-05 10:19:22 +08001926 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001927 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1928 ssl->session_in = ssl->session_negotiate;
1929
Jerry Yu4a173382021-10-11 21:45:31 +08001930cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001931 if( ret != 0 )
1932 {
Jerry Yu4a173382021-10-11 21:45:31 +08001933 MBEDTLS_SSL_PEND_FATAL_ALERT(
1934 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1935 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1936 }
Jerry Yue110d252022-05-05 10:19:22 +08001937
Jerry Yu4a173382021-10-11 21:45:31 +08001938 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001939}
1940
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001941MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001942static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001943{
1944 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1945
XiaokangQian78b1fa72022-01-19 06:56:30 +00001946 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001947
XiaokangQian78b1fa72022-01-19 06:56:30 +00001948 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001949 * We are going to re-generate a shared secret corresponding to the group
1950 * selected by the server, which is different from the group for which we
1951 * generated a shared secret in the first client hello.
1952 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001953 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001954 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001955 if( ret != 0 )
1956 return( ret );
1957
1958 return( 0 );
1959}
1960
Jerry Yue1b9c292021-09-10 10:08:31 +08001961/*
Jerry Yu4a173382021-10-11 21:45:31 +08001962 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001963 * Handler for MBEDTLS_SSL_SERVER_HELLO
1964 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001965MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001966static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001967{
Jerry Yu4a173382021-10-11 21:45:31 +08001968 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001969 unsigned char *buf = NULL;
1970 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001971 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001972
1973 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1974
Ronald Crondb5dfa12022-05-31 11:44:38 +02001975 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1976 MBEDTLS_SSL_HS_SERVER_HELLO,
1977 &buf, &buf_len ) );
1978
Ronald Cron828aff62022-05-31 12:04:31 +02001979 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001980 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001981 goto cleanup;
1982 else
Ronald Cron828aff62022-05-31 12:04:31 +02001983 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001984
Ronald Cron828aff62022-05-31 12:04:31 +02001985 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001986 {
1987 ret = 0;
1988 goto cleanup;
1989 }
1990
XiaokangQianb851da82022-01-14 04:03:11 +00001991 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001992 buf + buf_len,
1993 is_hrr ) );
1994 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001995 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1996
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001997 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1998 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001999
XiaokangQiand9e068e2022-01-18 06:23:32 +00002000 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02002001 {
XiaokangQian355e09a2022-01-20 11:14:50 +00002002 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02002003#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2004 /* If not offering early data, the client sends a dummy CCS record
2005 * immediately before its second flight. This may either be before
2006 * its second ClientHello or before its encrypted handshake flight.
2007 */
2008 mbedtls_ssl_handshake_set_state( ssl,
2009 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
2010#else
2011 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2012#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2013 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00002014 else
Ronald Cronfb508b82022-05-31 14:49:55 +02002015 {
XiaokangQian355e09a2022-01-20 11:14:50 +00002016 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02002017 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2018 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002019
2020cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00002021 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
2022 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08002023 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08002024}
2025
2026/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002027 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002028 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002029 *
2030 * The EncryptedExtensions message contains any extensions which
2031 * should be protected, i.e., any which are not needed to establish
2032 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002033 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002034
XiaokangQian08da26c2021-10-09 10:12:11 +00002035/* Parse EncryptedExtensions message
2036 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002037 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002038 * } EncryptedExtensions;
2039 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002040MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00002041static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
2042 const unsigned char *buf,
2043 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002044{
2045 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002046 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002047 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002048 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002049
XiaokangQian08da26c2021-10-09 10:12:11 +00002050 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00002051 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002052 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002053
XiaokangQian97799ac2021-10-11 10:05:54 +00002054 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00002055 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02002056 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002057
XiaokangQian8db25ff2021-10-13 05:56:18 +00002058 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002059 {
XiaokangQian08da26c2021-10-09 10:12:11 +00002060 unsigned int extension_type;
2061 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002062
XiaokangQian08da26c2021-10-09 10:12:11 +00002063 /*
2064 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002065 * ExtensionType extension_type; (2 bytes)
2066 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002067 * } Extension;
2068 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00002069 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002070 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2071 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2072 p += 4;
2073
XiaokangQian8db25ff2021-10-13 05:56:18 +00002074 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002075
XiaokangQian97799ac2021-10-11 10:05:54 +00002076 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002077 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00002078 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002079 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002080 switch( extension_type )
2081 {
Jerry Yu661dd942022-08-03 14:50:01 +08002082 case MBEDTLS_TLS_EXT_SERVERNAME:
2083 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002084
Jerry Yu661dd942022-08-03 14:50:01 +08002085 /* The server_name extension should be an empty extension */
2086
2087 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002088 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2089 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2090 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002091
lhuang0486cacac2022-01-21 07:34:27 -08002092#if defined(MBEDTLS_SSL_ALPN)
2093 case MBEDTLS_TLS_EXT_ALPN:
2094 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2095
2096 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2097 {
2098 return( ret );
2099 }
2100
2101 break;
2102#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002103 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002104 MBEDTLS_SSL_DEBUG_MSG(
2105 3, ( "unsupported extension found: %u ", extension_type) );
2106 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002107 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002108 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2109 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002110 }
2111
XiaokangQian08da26c2021-10-09 10:12:11 +00002112 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002113 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002114
XiaokangQian97799ac2021-10-11 10:05:54 +00002115 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002116 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002117 {
2118 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002119 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002120 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002121 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002122 }
2123
2124 return( ret );
2125}
2126
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002127MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002128static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2129{
2130 int ret;
2131 unsigned char *buf;
2132 size_t buf_len;
2133
2134 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2135
2136 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2137 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2138 &buf, &buf_len ) );
2139
2140 /* Process the message contents */
2141 MBEDTLS_SSL_PROC_CHK(
2142 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2143
2144 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2145 buf, buf_len );
2146
Ronald Cronfb508b82022-05-31 14:49:55 +02002147#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002148 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002149 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2150 else
2151 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2152#else
2153 ((void) ssl);
2154 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2155#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002156
2157cleanup:
2158
2159 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2160 return( ret );
2161
2162}
2163
Jerry Yua93ac112021-10-27 16:31:48 +08002164#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002165/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002166 * STATE HANDLING: CertificateRequest
2167 *
Jerry Yud2674312021-10-29 10:08:19 +08002168 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002169#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2170#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002171/* Coordination:
2172 * Deals with the ambiguity of not knowing if a CertificateRequest
2173 * will be sent. Returns a negative code on failure, or
2174 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2175 * - SSL_CERTIFICATE_REQUEST_SKIP
2176 * indicating if a Certificate Request is expected or not.
2177 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002178MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002179static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002180{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002181 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002182
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002183 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002184 {
2185 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2186 return( ret );
2187 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002188 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002189
2190 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2191 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2192 {
Ronald Cron19385882022-06-15 16:26:13 +02002193 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002194 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002195 }
2196
Ronald Cron19385882022-06-15 16:26:13 +02002197 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2198
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002199 return( SSL_CERTIFICATE_REQUEST_SKIP );
2200}
2201
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002202/*
2203 * ssl_tls13_parse_certificate_request()
2204 * Parse certificate request
2205 * struct {
2206 * opaque certificate_request_context<0..2^8-1>;
2207 * Extension extensions<2..2^16-1>;
2208 * } CertificateRequest;
2209 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002210MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002211static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2212 const unsigned char *buf,
2213 const unsigned char *end )
2214{
2215 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2216 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002217 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002218 size_t extensions_len = 0;
2219 const unsigned char *extensions_end;
2220 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002221
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002222 /* ...
2223 * opaque certificate_request_context<0..2^8-1>
2224 * ...
2225 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002226 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2227 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002228 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002229
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002230 if( certificate_request_context_len > 0 )
2231 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002232 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002233 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2234 p, certificate_request_context_len );
2235
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002236 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002237 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002238 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002239 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002240 {
2241 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2242 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2243 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002244 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002245 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002246 p += certificate_request_context_len;
2247 }
2248
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002249 /* ...
2250 * Extension extensions<2..2^16-1>;
2251 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002252 */
2253 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2254 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2255 p += 2;
2256
2257 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2258 extensions_end = p + extensions_len;
2259
2260 while( p < extensions_end )
2261 {
2262 unsigned int extension_type;
2263 size_t extension_data_len;
2264
2265 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2266 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2267 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2268 p += 4;
2269
2270 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2271
2272 switch( extension_type )
2273 {
2274 case MBEDTLS_TLS_EXT_SIG_ALG:
2275 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002276 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002277 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002278 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002279 if( ret != 0 )
2280 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002281 if( ! sig_alg_ext_found )
2282 sig_alg_ext_found = 1;
2283 else
2284 {
2285 MBEDTLS_SSL_DEBUG_MSG( 3,
2286 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002287 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002288 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002289 break;
2290
2291 default:
2292 MBEDTLS_SSL_DEBUG_MSG(
2293 3,
2294 ( "unknown extension found: %u ( ignoring )",
2295 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002296 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002297 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002298 p += extension_data_len;
2299 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002300 /* Check that we consumed all the message. */
2301 if( p != end )
2302 {
2303 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002304 ( "CertificateRequest misaligned" ) );
2305 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002306 }
2307 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002308 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002309 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002310 MBEDTLS_SSL_DEBUG_MSG( 3,
2311 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002312 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002313 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002314
Jerry Yu7840f812022-01-29 10:26:51 +08002315 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002316 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002317
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002318decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002319 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2320 MBEDTLS_ERR_SSL_DECODE_ERROR );
2321 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002322}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002323
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002324/*
2325 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2326 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002327MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002328static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002329{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002330 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331
2332 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2333
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002334 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2335
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002336 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2337 {
2338 unsigned char *buf;
2339 size_t buf_len;
2340
2341 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2342 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2343 &buf, &buf_len ) );
2344
2345 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2346 buf, buf + buf_len ) );
2347
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002348 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2349 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002350 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002351 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002352 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002353 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002354 }
2355 else
2356 {
2357 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002358 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2359 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002360 }
2361
Jerry Yud2674312021-10-29 10:08:19 +08002362 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2363
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002364cleanup:
2365
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002366 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2367 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002368}
2369
2370/*
Jerry Yu687101b2021-09-14 16:03:56 +08002371 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2372 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002373MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002374static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002375{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002376 int ret;
2377
2378 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002379 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002380 return( ret );
2381
Jerry Yu687101b2021-09-14 16:03:56 +08002382 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2383 return( 0 );
2384}
2385
2386/*
2387 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2388 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002389MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002390static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002391{
Jerry Yu30b071c2021-09-12 20:16:03 +08002392 int ret;
2393
2394 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2395 if( ret != 0 )
2396 return( ret );
2397
Jerry Yu687101b2021-09-14 16:03:56 +08002398 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2399 return( 0 );
2400}
Jerry Yua93ac112021-10-27 16:31:48 +08002401#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002402
Jerry Yu687101b2021-09-14 16:03:56 +08002403/*
2404 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2405 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002406MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002407static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002408{
XiaokangQianac0385c2021-11-03 06:40:11 +00002409 int ret;
2410
XiaokangQianc5c39d52021-11-09 11:55:10 +00002411 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002412 if( ret != 0 )
2413 return( ret );
2414
Jerry Yue3d67cb2022-05-19 15:33:10 +08002415 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2416 if( ret != 0 )
2417 {
2418 MBEDTLS_SSL_PEND_FATAL_ALERT(
2419 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2420 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2421 return( ret );
2422 }
2423
Ronald Cron49ad6192021-11-24 16:25:31 +01002424#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2425 mbedtls_ssl_handshake_set_state(
2426 ssl,
2427 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2428#else
Jerry Yuca133a32022-02-15 14:22:05 +08002429 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002430#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002431
XiaokangQianac0385c2021-11-03 06:40:11 +00002432 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002433}
2434
2435/*
Jerry Yu566c7812022-01-26 15:41:22 +08002436 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2437 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002438MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002439static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2440{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002441 int non_empty_certificate_msg = 0;
2442
Jerry Yu5cc35062022-01-28 16:16:08 +08002443 MBEDTLS_SSL_DEBUG_MSG( 1,
2444 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002445 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002446
Ronald Cron9df7c802022-03-08 18:38:54 +01002447#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002448 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002449 {
2450 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2451 if( ret != 0 )
2452 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002453
Ronald Cron7a94aca2022-03-09 07:44:27 +01002454 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2455 non_empty_certificate_msg = 1;
2456 }
2457 else
2458 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002459 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002460 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002461#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002462
Ronald Cron7a94aca2022-03-09 07:44:27 +01002463 if( non_empty_certificate_msg )
2464 {
2465 mbedtls_ssl_handshake_set_state( ssl,
2466 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2467 }
2468 else
Ronald Cron19385882022-06-15 16:26:13 +02002469 {
2470 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002471 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002472 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002473
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002474 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002475}
2476
Ronald Cron9df7c802022-03-08 18:38:54 +01002477#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002478/*
2479 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2480 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002481MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002482static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2483{
Ronald Crona8b38872022-03-09 07:59:25 +01002484 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2485
2486 if( ret == 0 )
2487 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2488
2489 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002490}
Jerry Yu90f152d2022-01-29 22:12:42 +08002491#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002492
2493/*
Jerry Yu687101b2021-09-14 16:03:56 +08002494 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2495 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002496MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002497static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002498{
XiaokangQian0fa66432021-11-15 03:33:57 +00002499 int ret;
2500
2501 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2502 if( ret != 0 )
2503 return( ret );
2504
Jerry Yu466dda82022-09-13 11:20:20 +08002505 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002506 if( ret != 0 )
2507 {
2508 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002509 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002510 return ( ret );
2511 }
2512
XiaokangQian0fa66432021-11-15 03:33:57 +00002513 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2514 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002515}
2516
2517/*
2518 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2519 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002520MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002521static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002522{
Jerry Yu378254d2021-10-30 21:44:47 +08002523 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002524 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002525 return( 0 );
2526}
2527
2528/*
2529 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2530 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002531MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002532static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002533{
Jerry Yu378254d2021-10-30 21:44:47 +08002534
2535 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2536
2537 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2538 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002539}
2540
Jerry Yuf8a49942022-07-07 11:32:32 +00002541#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2542
Jerry Yua0446a02022-07-13 11:22:55 +08002543MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002544static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2545 const unsigned char *buf,
2546 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002547{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002548 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002549
2550 ((void) ssl);
2551
2552 while( p < end )
2553 {
2554 unsigned int extension_type;
2555 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002556
Jerry Yuf8a49942022-07-07 11:32:32 +00002557 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2558 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2559 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2560 p += 4;
2561
2562 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002563
2564 switch( extension_type )
2565 {
2566 case MBEDTLS_TLS_EXT_EARLY_DATA:
2567 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2568 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002569
Jerry Yuf8a49942022-07-07 11:32:32 +00002570 default:
2571 break;
2572 }
2573 p += extension_data_len;
2574 }
2575
2576 return( 0 );
2577}
2578
2579/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002580 * From RFC8446, page 74
2581 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002582 * struct {
2583 * uint32 ticket_lifetime;
2584 * uint32 ticket_age_add;
2585 * opaque ticket_nonce<0..255>;
2586 * opaque ticket<1..2^16-1>;
2587 * Extension extensions<0..2^16-2>;
2588 * } NewSessionTicket;
2589 *
2590 */
Jerry Yua0446a02022-07-13 11:22:55 +08002591MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002592static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2593 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002594 unsigned char *end,
2595 unsigned char **ticket_nonce,
2596 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002597{
2598 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2599 unsigned char *p = buf;
2600 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002601 size_t ticket_len;
2602 unsigned char *ticket;
2603 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002604
Jerry Yucb3b1392022-07-12 06:09:38 +00002605 *ticket_nonce = NULL;
2606 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002607 /*
2608 * ticket_lifetime 4 bytes
2609 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002610 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002611 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002612 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002613
2614 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002615 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002616 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002617 ( unsigned int )session->ticket_lifetime ) );
2618
Jerry Yucb3b1392022-07-12 06:09:38 +00002619 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002620 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002621 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002622 ( unsigned int )session->ticket_age_add ) );
2623
Jerry Yucb3b1392022-07-12 06:09:38 +00002624 *ticket_nonce_len = p[8];
2625 p += 9;
2626
2627 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2628 *ticket_nonce = p;
2629 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2630 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002631
2632 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002633 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002634 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2635 p += 2;
2636 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002637 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2638
2639 /* Check if we previously received a ticket already. */
2640 if( session->ticket != NULL || session->ticket_len > 0 )
2641 {
2642 mbedtls_free( session->ticket );
2643 session->ticket = NULL;
2644 session->ticket_len = 0;
2645 }
2646
2647 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2648 {
2649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2650 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2651 }
2652 memcpy( ticket, p, ticket_len );
2653 p += ticket_len;
2654 session->ticket = ticket;
2655 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002656
Jerry Yucb3b1392022-07-12 06:09:38 +00002657 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002658 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2659 p += 2;
2660 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2661
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002662 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002663
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002664 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002665 if( ret != 0 )
2666 {
2667 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002668 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002669 ret );
2670 return( ret );
2671 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002672
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002673 /* session has been updated, allow export */
2674 session->exported = 0;
2675
Jerry Yucb3b1392022-07-12 06:09:38 +00002676 return( 0 );
2677}
2678
Jerry Yua0446a02022-07-13 11:22:55 +08002679MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002680static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2681 unsigned char *ticket_nonce,
2682 size_t ticket_nonce_len )
2683{
2684 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2685 mbedtls_ssl_session *session = ssl->session;
2686 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2687 psa_algorithm_t psa_hash_alg;
2688 int hash_length;
2689
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002690#if defined(MBEDTLS_HAVE_TIME)
2691 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002692 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002693#endif
2694
Jerry Yuf8a49942022-07-07 11:32:32 +00002695 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2696 if( ciphersuite_info == NULL )
2697 {
2698 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2699 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2700 }
2701
2702 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2703 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002704 if( hash_length == -1 ||
2705 ( size_t )hash_length > sizeof( session->resumption_key ) )
2706 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002707 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002708 }
2709
Jerry Yuf8a49942022-07-07 11:32:32 +00002710
2711 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2712 session->app_secrets.resumption_master_secret,
2713 hash_length );
2714
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002715 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002716 *
2717 * HKDF-Expand-Label( resumption_master_secret,
2718 * "resumption", ticket_nonce, Hash.length )
2719 */
2720 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2721 psa_hash_alg,
2722 session->app_secrets.resumption_master_secret,
2723 hash_length,
2724 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2725 ticket_nonce,
2726 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002727 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002728 hash_length );
2729
2730 if( ret != 0 )
2731 {
2732 MBEDTLS_SSL_DEBUG_RET( 2,
2733 "Creating the ticket-resumed PSK failed",
2734 ret );
2735 return( ret );
2736 }
2737
Jerry Yu0a430c82022-07-20 11:02:48 +08002738 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002739
2740 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002741 session->resumption_key,
2742 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002743
Jerry Yuf8a49942022-07-07 11:32:32 +00002744 return( 0 );
2745}
2746
2747/*
Jerry Yua357cf42022-07-12 05:36:45 +00002748 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002749 */
Jerry Yua0446a02022-07-13 11:22:55 +08002750MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002751static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2752{
2753 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2754 unsigned char *buf;
2755 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002756 unsigned char *ticket_nonce;
2757 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002758
2759 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2760
2761 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2762 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2763 &buf, &buf_len ) );
2764
Jerry Yucb3b1392022-07-12 06:09:38 +00002765 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2766 ssl, buf, buf + buf_len,
2767 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002768
Jerry Yucb3b1392022-07-12 06:09:38 +00002769 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2770 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002771
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002772 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2773
Jerry Yuf8a49942022-07-07 11:32:32 +00002774cleanup:
2775
2776 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2777 return( ret );
2778}
2779#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2780
Jerry Yu92c6b402021-08-27 16:59:09 +08002781int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002782{
Jerry Yu92c6b402021-08-27 16:59:09 +08002783 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002784
Jerry Yu92c6b402021-08-27 16:59:09 +08002785 switch( ssl->state )
2786 {
2787 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002788 * ssl->state is initialized as HELLO_REQUEST. It is the same
2789 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002790 */
2791 case MBEDTLS_SSL_HELLO_REQUEST:
2792 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002793 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002794 break;
2795
2796 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002797 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002798 break;
2799
2800 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002801 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002802 break;
2803
Jerry Yua93ac112021-10-27 16:31:48 +08002804#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002805 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2806 ret = ssl_tls13_process_certificate_request( ssl );
2807 break;
2808
Jerry Yu687101b2021-09-14 16:03:56 +08002809 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002810 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002811 break;
2812
2813 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002814 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002815 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002816#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002817
2818 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002819 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002820 break;
2821
Jerry Yu566c7812022-01-26 15:41:22 +08002822 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2823 ret = ssl_tls13_write_client_certificate( ssl );
2824 break;
2825
Ronald Cron9df7c802022-03-08 18:38:54 +01002826#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002827 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2828 ret = ssl_tls13_write_client_certificate_verify( ssl );
2829 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002830#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002831
Jerry Yu687101b2021-09-14 16:03:56 +08002832 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002833 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002834 break;
2835
2836 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002837 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002838 break;
2839
2840 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002841 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002842 break;
2843
Ronald Cron49ad6192021-11-24 16:25:31 +01002844 /*
2845 * Injection of dummy-CCS's for middlebox compatibility
2846 */
2847#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002848 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002849 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2850 if( ret == 0 )
2851 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2852 break;
2853
2854 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2855 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2856 if( ret == 0 )
2857 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002858 break;
2859#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2860
Jerry Yuf8a49942022-07-07 11:32:32 +00002861#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002862 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002863 ret = ssl_tls13_process_new_session_ticket( ssl );
2864 if( ret != 0 )
2865 break;
2866 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2867 break;
2868#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2869
Jerry Yu92c6b402021-08-27 16:59:09 +08002870 default:
2871 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2872 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2873 }
2874
2875 return( ret );
2876}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002877
Jerry Yufb4b6472022-01-27 15:03:26 +08002878#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002879
Jerry Yufb4b6472022-01-27 15:03:26 +08002880