blob: 7b85c70e5712158e3aa79c93025767aa06d585b0 [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,
Jerry Yu6183cc72022-09-30 11:08:57 +0800841 psa_algorithm_t hash_alg,
842 const unsigned char *psk,
843 size_t psk_len,
Jerry Yu8b41e892022-09-30 10:00:20 +0800844 size_t *out_len )
845{
846 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
847 unsigned char *p = buf;
Jerry Yu8b41e892022-09-30 10:00:20 +0800848 unsigned char binder_len;
849 unsigned char transcript[MBEDTLS_MD_MAX_SIZE];
850 size_t transcript_len = 0;
851
852 *out_len = 0;
853
Jerry Yu6183cc72022-09-30 11:08:57 +0800854 binder_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yu8b41e892022-09-30 10:00:20 +0800855 if( binder_len == 0 )
856 {
857 MBEDTLS_SSL_DEBUG_MSG( 3, ( "should never happen" ) );
858 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
859 }
860
861 /*
862 * - binder_len (1 bytes)
863 * - binder (binder_len bytes)
864 */
865 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + binder_len );
866
867 p[0] = binder_len;
868
869 /* Get current state of handshake transcript. */
870 ret = mbedtls_ssl_get_handshake_transcript(
Jerry Yu6183cc72022-09-30 11:08:57 +0800871 ssl, mbedtls_hash_info_md_from_psa( hash_alg ),
Jerry Yu8b41e892022-09-30 10:00:20 +0800872 transcript, MBEDTLS_MD_MAX_SIZE, &transcript_len );
873 if( ret != 0 )
874 return( ret );
875
Jerry Yu6183cc72022-09-30 11:08:57 +0800876 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800877 psk, psk_len, psk_type,
878 transcript, p + 1 );
879 if( ret != 0 )
880 {
881 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
882 return( ret );
883 }
884 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", p, 1 + binder_len );
885
886 *out_len = 1 + binder_len;
887
888 return( ret );
889}
890
891/*
892 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
893 *
894 * struct {
895 * opaque identity<1..2^16-1>;
896 * uint32 obfuscated_ticket_age;
897 * } PskIdentity;
898 *
899 * opaque PskBinderEntry<32..255>;
900 *
901 * struct {
902 * PskIdentity identities<7..2^16-1>;
903 * PskBinderEntry binders<33..2^16-1>;
904 * } OfferedPsks;
905 *
906 * struct {
907 * select (Handshake.msg_type) {
908 * case client_hello: OfferedPsks;
909 * ...
910 * };
911 * } PreSharedKeyExtension;
912 *
913 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000914int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Jerry Yuf75364b2022-09-30 10:30:31 +0800915 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
916 size_t *out_len, size_t *binders_len )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000917{
Jerry Yuf7c12592022-09-28 22:09:38 +0800918 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800919 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800920 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800921 psa_algorithm_t hash_alg;
922 const unsigned char *identity;
923 size_t identity_len;
924 uint32_t obfuscated_ticket_age = 0;
925 int hash_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800926 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800927 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800928
929 *out_len = 0;
930 *binders_len = 0;
931
Jerry Yuf75364b2022-09-30 10:30:31 +0800932
Jerry Yuf7c12592022-09-28 22:09:38 +0800933 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Jerry Yuf75364b2022-09-30 10:30:31 +0800934 configured_psk_count = ssl_tls13_get_configured_psk_count( ssl );
935 if( configured_psk_count == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800936 {
937 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
938 return( 0 );
939 }
940
941 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
Jerry Yuf75364b2022-09-30 10:30:31 +0800942 configured_psk_count ) );
943
Jerry Yuf7c12592022-09-28 22:09:38 +0800944 /* Check if we have space to write the extension, binders included.
945 * - extension_type (2 bytes)
946 * - extension_data_len (2 bytes)
947 * - identities_len (2 bytes)
948 */
949 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
950 p += 6;
951
Jerry Yuf75364b2022-09-30 10:30:31 +0800952#if defined(MBEDTLS_SSL_SESSION_TICKETS)
953 if( ssl_tls13_ticket_get_identity(
954 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800955 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800956#if defined(MBEDTLS_HAVE_TIME)
957 mbedtls_time_t now = mbedtls_time( NULL );
958 mbedtls_ssl_session *session = ssl->session_negotiate;
959 obfuscated_ticket_age = (uint32_t)( now - session->ticket_received );
960 obfuscated_ticket_age *= 1000;
961 obfuscated_ticket_age += session->ticket_age_add;
962#endif /* MBEDTLS_HAVE_TIME */
Jerry Yuf7c12592022-09-28 22:09:38 +0800963 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800964 identity, identity_len,
965 obfuscated_ticket_age,
966 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800967 if( ret != 0 )
968 return( ret );
Jerry Yuf7c12592022-09-28 22:09:38 +0800969
Jerry Yuf75364b2022-09-30 10:30:31 +0800970 hash_len = PSA_HASH_LENGTH( hash_alg );
971 if( hash_len == 0 )
972 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
973
974 p += output_len;
975 l_binders_len += 1 + hash_len;
976 }
977#endif /* MBEDTLS_SSL_SESSION_TICKETS */
978
979 if( ssl_tls13_psk_get_identity(
980 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800981 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800982
Jerry Yuf7c12592022-09-28 22:09:38 +0800983 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800984 identity, identity_len,
985 obfuscated_ticket_age,
986 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800987 if( ret != 0 )
988 return( ret );
Jerry Yuf75364b2022-09-30 10:30:31 +0800989
990 hash_len = PSA_HASH_LENGTH( hash_alg );
991 if( hash_len == 0 )
992 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
993
Jerry Yuf7c12592022-09-28 22:09:38 +0800994 p += output_len;
Jerry Yuf75364b2022-09-30 10:30:31 +0800995 l_binders_len += 1 + hash_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800996 }
997
998 MBEDTLS_SSL_DEBUG_MSG( 3,
999 ( "client hello, adding pre_shared_key extension, "
1000 "omitting PSK binder list" ) );
1001 /*
1002 * - extension_type (2 bytes)
1003 * - extension_data_len (2 bytes)
1004 * - identities_len (2 bytes)
1005 */
1006 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
1007 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + 2 + l_binders_len , buf, 2 );
1008 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
1009
1010 /* Check if there are enough space for binders */
1011 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len + 2 );
1012
1013 *out_len = ( p - buf ) + l_binders_len + 2;
1014 *binders_len = l_binders_len + 2;
1015
1016 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
1017
1018 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1019
XiaokangQianeb69aee2022-07-05 08:21:43 +00001020 return( 0 );
1021}
1022
XiaokangQian86981952022-07-19 09:51:50 +00001023int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +08001024 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001025{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001026 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1027 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +08001028 psa_algorithm_t hash_alg = PSA_ALG_NONE;
1029 const unsigned char *psk;
1030 size_t psk_len;
1031 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001032
1033 /* Check if we have space to write binders_len.
1034 * - binders_len (2 bytes)
1035 */
1036 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1037 p += 2;
1038
Jerry Yu6183cc72022-09-30 11:08:57 +08001039#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1040 if( ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001041 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001042
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001043 ret = ssl_tls13_write_binder( ssl, p, end,
1044 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
Jerry Yu6183cc72022-09-30 11:08:57 +08001045 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001046 &output_len );
1047 if( ret != 0 )
1048 return( ret );
1049 p += output_len;
1050 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001051#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001052
Jerry Yu6183cc72022-09-30 11:08:57 +08001053 if( ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001054 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001055
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001056 ret = ssl_tls13_write_binder( ssl, p, end,
1057 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
Jerry Yu6183cc72022-09-30 11:08:57 +08001058 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001059 &output_len );
1060 if( ret != 0 )
1061 return( ret );
1062 p += output_len;
1063 }
1064
1065 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1066
1067 /*
1068 * - binders_len (2 bytes)
1069 */
1070 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1071
1072 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001073
1074 return( 0 );
1075}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001076
1077/*
1078 * struct {
1079 * opaque identity<1..2^16-1>;
1080 * uint32 obfuscated_ticket_age;
1081 * } PskIdentity;
1082 *
1083 * opaque PskBinderEntry<32..255>;
1084 *
1085 * struct {
1086 *
1087 * select (Handshake.msg_type) {
1088 * ...
1089 * case server_hello: uint16 selected_identity;
1090 * };
1091 *
1092 * } PreSharedKeyExtension;
1093 *
1094 */
1095MBEDTLS_CHECK_RETURN_CRITICAL
1096static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1097 const unsigned char *buf,
1098 const unsigned char *end )
1099{
Jerry Yub300e3c2022-09-28 22:12:07 +08001100 int ret = 0;
1101 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001102 const unsigned char *psk;
1103 size_t psk_len;
1104 psa_algorithm_t psa_alg;
1105
1106 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 2 );
1107 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
1108 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
Jerry Yu4a698342022-09-30 12:22:01 +08001109 if( selected_identity >= ssl_tls13_get_configured_psk_count( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001110 {
Jerry Yu4a698342022-09-30 12:22:01 +08001111 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1112 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid chosen PSK identity." ) );
1113
1114 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1115 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1116 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yub300e3c2022-09-28 22:12:07 +08001117 }
Jerry Yu4a698342022-09-30 12:22:01 +08001118#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1119 if( selected_identity == 0 && ssl_tls13_has_configured_ticket( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001120 {
Jerry Yu4a698342022-09-30 12:22:01 +08001121 ret = ssl_tls13_ticket_get_psk( ssl, &psa_alg, &psk, &psk_len );
1122 }
1123 else
1124#endif
1125 if( ssl_tls13_has_configured_psk( ssl ) )
1126 {
1127 ret = ssl_tls13_psk_get_psk( ssl, &psa_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001128 }
1129 else
1130 {
1131 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1132 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1133 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001134 if( ret != 0 )
1135 return( ret );
1136
1137 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1138 if( ret != 0 )
1139 {
1140 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
1141 }
1142 else
1143 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1144
1145 return( ret );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001146}
1147
XiaokangQianeb69aee2022-07-05 08:21:43 +00001148#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1149
Ronald Cron3d580bf2022-02-18 17:24:56 +01001150int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1151 unsigned char *buf,
1152 unsigned char *end,
1153 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001154{
1155 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1156 unsigned char *p = buf;
1157 size_t ext_len;
1158
1159 *out_len = 0;
1160
1161 /* Write supported_versions extension
1162 *
1163 * Supported Versions Extension is mandatory with TLS 1.3.
1164 */
1165 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1166 if( ret != 0 )
1167 return( ret );
1168 p += ext_len;
1169
1170 /* Echo the cookie if the server provided one in its preceding
1171 * HelloRetryRequest message.
1172 */
1173 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1174 if( ret != 0 )
1175 return( ret );
1176 p += ext_len;
1177
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001178 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1179 {
1180 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1181 if( ret != 0 )
1182 return( ret );
1183 p += ext_len;
1184 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001185
XiaokangQianeb69aee2022-07-05 08:21:43 +00001186#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1187 /* For PSK-based key exchange we need the pre_shared_key extension
1188 * and the psk_key_exchange_modes extension.
1189 *
1190 * The pre_shared_key extension MUST be the last extension in the
1191 * ClientHello. Servers MUST check that it is the last extension and
1192 * otherwise fail the handshake with an "illegal_parameter" alert.
1193 *
1194 * Add the psk_key_exchange_modes extension.
1195 */
1196 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1197 if( ret != 0 )
1198 return( ret );
1199 p += ext_len;
1200#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1201
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001202 *out_len = p - buf;
1203
1204 return( 0 );
1205}
1206
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001207/*
Jerry Yu4a173382021-10-11 21:45:31 +08001208 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001209 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001210
Ronald Cronda41b382022-03-30 09:57:11 +02001211/**
1212 * \brief Detect if the ServerHello contains a supported_versions extension
1213 * or not.
1214 *
1215 * \param[in] ssl SSL context
1216 * \param[in] buf Buffer containing the ServerHello message
1217 * \param[in] end End of the buffer containing the ServerHello message
1218 *
1219 * \return 0 if the ServerHello does not contain a supported_versions extension
1220 * \return 1 if the ServerHello contains a supported_versions extension
1221 * \return A negative value if an error occurred while parsing the ServerHello.
1222 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001223MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001224static int ssl_tls13_is_supported_versions_ext_present(
1225 mbedtls_ssl_context *ssl,
1226 const unsigned char *buf,
1227 const unsigned char *end )
1228{
1229 const unsigned char *p = buf;
1230 size_t legacy_session_id_echo_len;
1231 size_t extensions_len;
1232 const unsigned char *extensions_end;
1233
1234 /*
1235 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001236 * length:
1237 * - legacy_version 2 bytes
1238 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1239 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001240 */
1241 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1242 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1243 legacy_session_id_echo_len = *p;
1244
1245 /*
1246 * Jump to the extensions, jumping over:
1247 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1248 * - cipher_suite 2 bytes
1249 * - legacy_compression_method 1 byte
1250 */
Ronald Cron28271062022-06-10 14:43:55 +02001251 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001252 p += legacy_session_id_echo_len + 4;
1253
1254 /* Case of no extension */
1255 if( p == end )
1256 return( 0 );
1257
1258 /* ...
1259 * Extension extensions<6..2^16-1>;
1260 * ...
1261 * struct {
1262 * ExtensionType extension_type; (2 bytes)
1263 * opaque extension_data<0..2^16-1>;
1264 * } Extension;
1265 */
1266 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1267 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1268 p += 2;
1269
1270 /* Check extensions do not go beyond the buffer of data. */
1271 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1272 extensions_end = p + extensions_len;
1273
1274 while( p < extensions_end )
1275 {
1276 unsigned int extension_type;
1277 size_t extension_data_len;
1278
1279 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1280 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1281 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1282 p += 4;
1283
1284 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1285 return( 1 );
1286
1287 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1288 p += extension_data_len;
1289 }
1290
1291 return( 0 );
1292}
1293
Jerry Yu7a186a02021-10-15 18:46:14 +08001294/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001295 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1296 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1297 * - 0 otherwise
1298 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001299MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001300static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1301 const unsigned char *buf,
1302 const unsigned char *end )
1303{
1304 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1305 static const unsigned char magic_downgrade_string[] =
1306 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1307 const unsigned char *last_eight_bytes_of_random;
1308 unsigned char last_byte_of_random;
1309
1310 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1311 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1312
1313 if( memcmp( last_eight_bytes_of_random,
1314 magic_downgrade_string,
1315 sizeof( magic_downgrade_string ) ) == 0 )
1316 {
1317 last_byte_of_random = last_eight_bytes_of_random[7];
1318 return( last_byte_of_random == 0 ||
1319 last_byte_of_random == 1 );
1320 }
1321
1322 return( 0 );
1323}
1324
1325/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001326 * - SSL_SERVER_HELLO or
1327 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001328 * to indicate which message is expected and to be parsed next.
1329 */
Ronald Cron828aff62022-05-31 12:04:31 +02001330#define SSL_SERVER_HELLO 0
1331#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001332MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001333static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1334 const unsigned char *buf,
1335 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001336{
Jerry Yue1b9c292021-09-10 10:08:31 +08001337
1338 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1339 *
Jerry Yu4a173382021-10-11 21:45:31 +08001340 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001341 * special value of the SHA-256 of "HelloRetryRequest".
1342 *
1343 * struct {
1344 * ProtocolVersion legacy_version = 0x0303;
1345 * Random random;
1346 * opaque legacy_session_id_echo<0..32>;
1347 * CipherSuite cipher_suite;
1348 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001349 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001350 * } ServerHello;
1351 *
1352 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001353 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1354 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001355
Jerry Yu93a13f22022-04-11 23:00:01 +08001356 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1357 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001358 {
Ronald Cron828aff62022-05-31 12:04:31 +02001359 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001360 }
1361
Ronald Cron828aff62022-05-31 12:04:31 +02001362 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001363}
1364
Ronald Cron828aff62022-05-31 12:04:31 +02001365/*
Jerry Yu745bb612021-10-13 22:01:04 +08001366 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001367 * - SSL_SERVER_HELLO or
1368 * - SSL_SERVER_HELLO_HRR or
1369 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001370 */
Ronald Cron828aff62022-05-31 12:04:31 +02001371#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001372MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001373static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001374 const unsigned char *buf,
1375 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001376{
Jerry Yu4a173382021-10-11 21:45:31 +08001377 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001378 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001379
Ronald Cron9f0fba32022-02-10 16:45:15 +01001380 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001381 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001382
Ronald Cron9f0fba32022-02-10 16:45:15 +01001383 if( ret == 0 )
1384 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001385 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001386 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001387
1388 /* If the server is negotiating TLS 1.2 or below and:
1389 * . we did not propose TLS 1.2 or
1390 * . the server responded it is TLS 1.3 capable but negotiating a lower
1391 * version of the protocol and thus we are under downgrade attack
1392 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001393 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001394 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001395 {
1396 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1397 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1398 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1399 }
1400
1401 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001402 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001403 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001404 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001405
1406 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1407 {
1408 ret = ssl_tls13_reset_key_share( ssl );
1409 if( ret != 0 )
1410 return( ret );
1411 }
1412
Ronald Cron828aff62022-05-31 12:04:31 +02001413 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001414 }
1415
Jerry Yua66fece2022-07-13 14:30:29 +08001416#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1417 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1418 ssl->session_negotiate->tls_version = ssl->tls_version;
1419#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1420
Ronald Cron5afb9042022-05-31 12:11:39 +02001421 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1422
Ronald Crondb5dfa12022-05-31 11:44:38 +02001423 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001424 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001425 {
Ronald Cron828aff62022-05-31 12:04:31 +02001426 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001427 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1428 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001429 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001431 /* If a client receives a second
1432 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1433 * was itself in response to a HelloRetryRequest), it MUST abort the
1434 * handshake with an "unexpected_message" alert.
1435 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001436 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001437 {
1438 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1439 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1440 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1441 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1442 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001443 /*
1444 * Clients must abort the handshake with an "illegal_parameter"
1445 * alert if the HelloRetryRequest would not result in any change
1446 * in the ClientHello.
1447 * In a PSK only key exchange that what we expect.
1448 */
1449 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1450 {
1451 MBEDTLS_SSL_DEBUG_MSG( 1,
1452 ( "Unexpected HRR in pure PSK key exchange." ) );
1453 MBEDTLS_SSL_PEND_FATAL_ALERT(
1454 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1455 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1456 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1457 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001458
Ronald Cron5afb9042022-05-31 12:11:39 +02001459 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001460
Jerry Yu745bb612021-10-13 22:01:04 +08001461 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001462 }
1463
1464cleanup:
1465
1466 return( ret );
1467}
1468
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001469MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001470static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1471 const unsigned char **buf,
1472 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001473{
1474 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001475 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001476
Jerry Yude4fb2c2021-09-19 18:05:08 +08001477 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001478 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001479
Jerry Yu4a173382021-10-11 21:45:31 +08001480 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001481
1482 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001483 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1484 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001485 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001486 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1487 ssl->session_negotiate->id,
1488 ssl->session_negotiate->id_len );
1489 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001490 legacy_session_id_echo_len );
1491
1492 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1493 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1494
Jerry Yue1b9c292021-09-10 10:08:31 +08001495 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1496 }
1497
Jerry Yu4a173382021-10-11 21:45:31 +08001498 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001499 *buf = p;
1500
1501 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001502 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001503 return( 0 );
1504}
1505
Jerry Yue1b9c292021-09-10 10:08:31 +08001506/* Parse ServerHello message and configure context
1507 *
1508 * struct {
1509 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1510 * Random random;
1511 * opaque legacy_session_id_echo<0..32>;
1512 * CipherSuite cipher_suite;
1513 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001514 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001515 * } ServerHello;
1516 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001517MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001518static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1519 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001520 const unsigned char *end,
1521 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001522{
Jerry Yub85277e2021-10-13 13:36:05 +08001523 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001524 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001525 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001526 size_t extensions_len;
1527 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001528 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001529 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001530 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001531
1532 /*
1533 * Check there is space for minimal fields
1534 *
1535 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001536 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001537 * - legacy_session_id_echo ( 1 byte ), minimum size
1538 * - cipher_suite ( 2 bytes)
1539 * - legacy_compression_method ( 1 byte )
1540 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001541 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001542
1543 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001544 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1545
Jerry Yu4a173382021-10-11 21:45:31 +08001546 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001547 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001548 * ...
1549 * with ProtocolVersion defined as:
1550 * uint16 ProtocolVersion;
1551 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001552 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1553 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001554 {
1555 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1556 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1557 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001558 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1559 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001560 }
1561 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001562
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001563 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001564 * Random random;
1565 * ...
1566 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001567 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001568 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001569 if( !is_hrr )
1570 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001571 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001572 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1573 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1574 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1575 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001576 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001577
Jerry Yu4a173382021-10-11 21:45:31 +08001578 /* ...
1579 * opaque legacy_session_id_echo<0..32>;
1580 * ...
1581 */
1582 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001583 {
XiaokangQian52da5582022-01-26 09:49:29 +00001584 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001585 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001586 }
1587
Jerry Yu4a173382021-10-11 21:45:31 +08001588 /* ...
1589 * CipherSuite cipher_suite;
1590 * ...
1591 * with CipherSuite defined as:
1592 * uint8 CipherSuite[2];
1593 */
1594 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001595 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1596 p += 2;
1597
Jerry Yu4a173382021-10-11 21:45:31 +08001598
XiaokangQian355e09a2022-01-20 11:14:50 +00001599 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001600 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001601 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001602 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001603 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1604 ssl->tls_version,
1605 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001606 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001607 {
XiaokangQian52da5582022-01-26 09:49:29 +00001608 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001609 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001610 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001611 * If we received an HRR before and that the proposed selected
1612 * ciphersuite in this server hello is not the same as the one
1613 * proposed in the HRR, we abort the handshake and send an
1614 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001615 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001616 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1617 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001618 {
XiaokangQian52da5582022-01-26 09:49:29 +00001619 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001620 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001621
XiaokangQian52da5582022-01-26 09:49:29 +00001622 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001623 {
1624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1625 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001626 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001627 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001628
Jerry Yu4a173382021-10-11 21:45:31 +08001629 /* Configure ciphersuites */
1630 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1631
XiaokangQian355e09a2022-01-20 11:14:50 +00001632 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001633 ssl->session_negotiate->ciphersuite = cipher_suite;
1634
Jerry Yue1b9c292021-09-10 10:08:31 +08001635 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1636 cipher_suite, ciphersuite_info->name ) );
1637
1638#if defined(MBEDTLS_HAVE_TIME)
1639 ssl->session_negotiate->start = time( NULL );
1640#endif /* MBEDTLS_HAVE_TIME */
1641
Jerry Yu4a173382021-10-11 21:45:31 +08001642 /* ...
1643 * uint8 legacy_compression_method = 0;
1644 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001645 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001646 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001647 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001648 {
Jerry Yub85277e2021-10-13 13:36:05 +08001649 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001650 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001651 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001652 }
1653 p++;
1654
Jerry Yub85277e2021-10-13 13:36:05 +08001655 /* ...
1656 * Extension extensions<6..2^16-1>;
1657 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001658 * struct {
1659 * ExtensionType extension_type; (2 bytes)
1660 * opaque extension_data<0..2^16-1>;
1661 * } Extension;
1662 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001663 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001664 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001665 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001666
Jerry Yu4a173382021-10-11 21:45:31 +08001667 /* Check extensions do not go beyond the buffer of data. */
1668 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1669 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001670
Jerry Yu4a173382021-10-11 21:45:31 +08001671 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001672
Jerry Yu4a173382021-10-11 21:45:31 +08001673 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001674 {
1675 unsigned int extension_type;
1676 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001677 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001678
Jerry Yu4a173382021-10-11 21:45:31 +08001679 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001680 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1681 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1682 p += 4;
1683
Jerry Yu4a173382021-10-11 21:45:31 +08001684 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001685 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001686
1687 switch( extension_type )
1688 {
XiaokangQianb851da82022-01-14 04:03:11 +00001689 case MBEDTLS_TLS_EXT_COOKIE:
1690
XiaokangQiand9e068e2022-01-18 06:23:32 +00001691 if( !is_hrr )
1692 {
XiaokangQian52da5582022-01-26 09:49:29 +00001693 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001694 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001695 }
1696
XiaokangQian43550bd2022-01-21 04:32:58 +00001697 ret = ssl_tls13_parse_cookie_ext( ssl,
1698 p, extension_data_end );
1699 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001700 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001701 MBEDTLS_SSL_DEBUG_RET( 1,
1702 "ssl_tls13_parse_cookie_ext",
1703 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001704 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001705 }
XiaokangQianb851da82022-01-14 04:03:11 +00001706 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001707
Jerry Yue1b9c292021-09-10 10:08:31 +08001708 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001709 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001710 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001711 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001712 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001713 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001714 break;
1715
XiaokangQianeb69aee2022-07-05 08:21:43 +00001716#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001717 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001718 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1719 if( is_hrr )
1720 {
1721 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1722 goto cleanup;
1723 }
Jerry Yu4a173382021-10-11 21:45:31 +08001724
XiaokangQian86981952022-07-19 09:51:50 +00001725 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001726 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001727 {
1728 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001729 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001730 return( ret );
1731 }
1732 break;
1733#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001734
Jerry Yue1b9c292021-09-10 10:08:31 +08001735 case MBEDTLS_TLS_EXT_KEY_SHARE:
1736 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001737 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1738 {
XiaokangQian52da5582022-01-26 09:49:29 +00001739 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001740 goto cleanup;
1741 }
1742
XiaokangQian53f20b72022-01-18 10:47:33 +00001743 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001744 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001745 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001746 else
XiaokangQianb851da82022-01-14 04:03:11 +00001747 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001748 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001749 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001750 {
1751 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001752 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001753 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001754 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001755 }
1756 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001757
1758 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001759 MBEDTLS_SSL_DEBUG_MSG(
1760 3,
1761 ( "unknown extension found: %u ( ignoring )",
1762 extension_type ) );
1763
XiaokangQian52da5582022-01-26 09:49:29 +00001764 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001765 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001766 }
1767
1768 p += extension_data_len;
1769 }
1770
XiaokangQiand59be772022-01-24 10:12:51 +00001771cleanup:
1772
XiaokangQian52da5582022-01-26 09:49:29 +00001773 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001774 {
1775 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1776 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1777 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1778 }
XiaokangQian52da5582022-01-26 09:49:29 +00001779 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001780 {
1781 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1782 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1783 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1784 }
1785 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001786}
1787
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001788#if defined(MBEDTLS_DEBUG_C)
1789static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001790{
1791 switch( mode )
1792 {
1793 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1794 return "psk";
1795 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1796 return "ephemeral";
1797 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1798 return "psk_ephemeral";
1799 default:
1800 return "unknown mode";
1801 }
1802}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001803#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001804
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001805MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001806static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001807{
Jerry Yub85277e2021-10-13 13:36:05 +08001808 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001809 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001810
Jerry Yub85277e2021-10-13 13:36:05 +08001811 /* Determine the key exchange mode:
1812 * 1) If both the pre_shared_key and key_share extensions were received
1813 * then the key exchange mode is PSK with EPHEMERAL.
1814 * 2) If only the pre_shared_key extension was received then the key
1815 * exchange mode is PSK-only.
1816 * 3) If only the key_share extension was received then the key
1817 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001818 */
Jerry Yub85277e2021-10-13 13:36:05 +08001819 switch( handshake->extensions_present &
1820 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001821 {
Jerry Yu745bb612021-10-13 22:01:04 +08001822 /* Only the pre_shared_key extension was received */
1823 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001824 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001825 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001826
Jerry Yu745bb612021-10-13 22:01:04 +08001827 /* Only the key_share extension was received */
1828 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001829 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001830 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001831
Jerry Yu745bb612021-10-13 22:01:04 +08001832 /* Both the pre_shared_key and key_share extensions were received */
1833 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001834 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001835 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001836
Jerry Yu745bb612021-10-13 22:01:04 +08001837 /* Neither pre_shared_key nor key_share extension was received */
1838 default:
1839 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1840 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1841 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001842 }
1843
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001844 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1845 {
1846 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1847 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001848 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001849 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001850 goto cleanup;
1851 }
1852
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001853 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001854 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001855 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001856
Jerry Yu0b177842021-09-05 19:41:30 +08001857 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1858 *
1859 * TODO: We don't have to do this in case we offered 0-RTT and the
1860 * server accepted it. In this case, we could skip generating
1861 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001862 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001863 if( ret != 0 )
1864 {
Jerry Yue110d252022-05-05 10:19:22 +08001865 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001866 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001867 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001868 }
1869
Jerry Yuf86eb752022-05-06 11:16:55 +08001870 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001871 if( ret != 0 )
1872 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001873 MBEDTLS_SSL_DEBUG_RET( 1,
1874 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001875 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001876 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001877 }
1878
Jerry Yue110d252022-05-05 10:19:22 +08001879 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001880 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1881 ssl->session_in = ssl->session_negotiate;
1882
Jerry Yu4a173382021-10-11 21:45:31 +08001883cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001884 if( ret != 0 )
1885 {
Jerry Yu4a173382021-10-11 21:45:31 +08001886 MBEDTLS_SSL_PEND_FATAL_ALERT(
1887 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1888 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1889 }
Jerry Yue110d252022-05-05 10:19:22 +08001890
Jerry Yu4a173382021-10-11 21:45:31 +08001891 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001892}
1893
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001894MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001895static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001896{
1897 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1898
XiaokangQian78b1fa72022-01-19 06:56:30 +00001899 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001900
XiaokangQian78b1fa72022-01-19 06:56:30 +00001901 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001902 * We are going to re-generate a shared secret corresponding to the group
1903 * selected by the server, which is different from the group for which we
1904 * generated a shared secret in the first client hello.
1905 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001906 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001907 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001908 if( ret != 0 )
1909 return( ret );
1910
1911 return( 0 );
1912}
1913
Jerry Yue1b9c292021-09-10 10:08:31 +08001914/*
Jerry Yu4a173382021-10-11 21:45:31 +08001915 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001916 * Handler for MBEDTLS_SSL_SERVER_HELLO
1917 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001918MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001919static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001920{
Jerry Yu4a173382021-10-11 21:45:31 +08001921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001922 unsigned char *buf = NULL;
1923 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001924 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001925
1926 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1927
Ronald Crondb5dfa12022-05-31 11:44:38 +02001928 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1929 MBEDTLS_SSL_HS_SERVER_HELLO,
1930 &buf, &buf_len ) );
1931
Ronald Cron828aff62022-05-31 12:04:31 +02001932 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001933 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001934 goto cleanup;
1935 else
Ronald Cron828aff62022-05-31 12:04:31 +02001936 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001937
Ronald Cron828aff62022-05-31 12:04:31 +02001938 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001939 {
1940 ret = 0;
1941 goto cleanup;
1942 }
1943
XiaokangQianb851da82022-01-14 04:03:11 +00001944 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001945 buf + buf_len,
1946 is_hrr ) );
1947 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001948 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1949
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001950 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1951 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001952
XiaokangQiand9e068e2022-01-18 06:23:32 +00001953 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001954 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001955 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001956#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1957 /* If not offering early data, the client sends a dummy CCS record
1958 * immediately before its second flight. This may either be before
1959 * its second ClientHello or before its encrypted handshake flight.
1960 */
1961 mbedtls_ssl_handshake_set_state( ssl,
1962 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1963#else
1964 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1965#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1966 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001967 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001968 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001969 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001970 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1971 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001972
1973cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001974 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1975 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08001976 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08001977}
1978
1979/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001980 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001981 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001982 *
1983 * The EncryptedExtensions message contains any extensions which
1984 * should be protected, i.e., any which are not needed to establish
1985 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001986 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001987
XiaokangQian08da26c2021-10-09 10:12:11 +00001988/* Parse EncryptedExtensions message
1989 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001990 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001991 * } EncryptedExtensions;
1992 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001993MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00001994static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
1995 const unsigned char *buf,
1996 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001997{
1998 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001999 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002000 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002001 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002002
XiaokangQian08da26c2021-10-09 10:12:11 +00002003 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00002004 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002005 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002006
XiaokangQian97799ac2021-10-11 10:05:54 +00002007 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00002008 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02002009 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002010
XiaokangQian8db25ff2021-10-13 05:56:18 +00002011 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002012 {
XiaokangQian08da26c2021-10-09 10:12:11 +00002013 unsigned int extension_type;
2014 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002015
XiaokangQian08da26c2021-10-09 10:12:11 +00002016 /*
2017 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002018 * ExtensionType extension_type; (2 bytes)
2019 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002020 * } Extension;
2021 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00002022 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002023 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2024 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2025 p += 4;
2026
XiaokangQian8db25ff2021-10-13 05:56:18 +00002027 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002028
XiaokangQian97799ac2021-10-11 10:05:54 +00002029 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002030 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00002031 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002032 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002033 switch( extension_type )
2034 {
Jerry Yu661dd942022-08-03 14:50:01 +08002035 case MBEDTLS_TLS_EXT_SERVERNAME:
2036 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002037
Jerry Yu661dd942022-08-03 14:50:01 +08002038 /* The server_name extension should be an empty extension */
2039
2040 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002041 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2042 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2043 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002044
lhuang0486cacac2022-01-21 07:34:27 -08002045#if defined(MBEDTLS_SSL_ALPN)
2046 case MBEDTLS_TLS_EXT_ALPN:
2047 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2048
2049 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2050 {
2051 return( ret );
2052 }
2053
2054 break;
2055#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002056 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002057 MBEDTLS_SSL_DEBUG_MSG(
2058 3, ( "unsupported extension found: %u ", extension_type) );
2059 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002060 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002061 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2062 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002063 }
2064
XiaokangQian08da26c2021-10-09 10:12:11 +00002065 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002066 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002067
XiaokangQian97799ac2021-10-11 10:05:54 +00002068 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002069 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002070 {
2071 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002072 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002073 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002074 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002075 }
2076
2077 return( ret );
2078}
2079
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002080MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002081static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2082{
2083 int ret;
2084 unsigned char *buf;
2085 size_t buf_len;
2086
2087 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2088
2089 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2090 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2091 &buf, &buf_len ) );
2092
2093 /* Process the message contents */
2094 MBEDTLS_SSL_PROC_CHK(
2095 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2096
2097 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2098 buf, buf_len );
2099
Ronald Cronfb508b82022-05-31 14:49:55 +02002100#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002101 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002102 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2103 else
2104 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2105#else
2106 ((void) ssl);
2107 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2108#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002109
2110cleanup:
2111
2112 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2113 return( ret );
2114
2115}
2116
Jerry Yua93ac112021-10-27 16:31:48 +08002117#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002118/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002119 * STATE HANDLING: CertificateRequest
2120 *
Jerry Yud2674312021-10-29 10:08:19 +08002121 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002122#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2123#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002124/* Coordination:
2125 * Deals with the ambiguity of not knowing if a CertificateRequest
2126 * will be sent. Returns a negative code on failure, or
2127 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2128 * - SSL_CERTIFICATE_REQUEST_SKIP
2129 * indicating if a Certificate Request is expected or not.
2130 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002132static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002133{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002135
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002136 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002137 {
2138 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2139 return( ret );
2140 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002141 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002142
2143 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2144 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2145 {
Ronald Cron19385882022-06-15 16:26:13 +02002146 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002147 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002148 }
2149
Ronald Cron19385882022-06-15 16:26:13 +02002150 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2151
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002152 return( SSL_CERTIFICATE_REQUEST_SKIP );
2153}
2154
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002155/*
2156 * ssl_tls13_parse_certificate_request()
2157 * Parse certificate request
2158 * struct {
2159 * opaque certificate_request_context<0..2^8-1>;
2160 * Extension extensions<2..2^16-1>;
2161 * } CertificateRequest;
2162 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002163MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002164static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2165 const unsigned char *buf,
2166 const unsigned char *end )
2167{
2168 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2169 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002170 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002171 size_t extensions_len = 0;
2172 const unsigned char *extensions_end;
2173 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002174
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002175 /* ...
2176 * opaque certificate_request_context<0..2^8-1>
2177 * ...
2178 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002179 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2180 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002181 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002182
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002183 if( certificate_request_context_len > 0 )
2184 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002185 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002186 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2187 p, certificate_request_context_len );
2188
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002189 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002190 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002191 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002192 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002193 {
2194 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2195 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2196 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002197 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002198 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002199 p += certificate_request_context_len;
2200 }
2201
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002202 /* ...
2203 * Extension extensions<2..2^16-1>;
2204 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002205 */
2206 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2207 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2208 p += 2;
2209
2210 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2211 extensions_end = p + extensions_len;
2212
2213 while( p < extensions_end )
2214 {
2215 unsigned int extension_type;
2216 size_t extension_data_len;
2217
2218 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2219 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2220 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2221 p += 4;
2222
2223 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2224
2225 switch( extension_type )
2226 {
2227 case MBEDTLS_TLS_EXT_SIG_ALG:
2228 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002229 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002230 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002231 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002232 if( ret != 0 )
2233 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002234 if( ! sig_alg_ext_found )
2235 sig_alg_ext_found = 1;
2236 else
2237 {
2238 MBEDTLS_SSL_DEBUG_MSG( 3,
2239 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002240 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002241 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002242 break;
2243
2244 default:
2245 MBEDTLS_SSL_DEBUG_MSG(
2246 3,
2247 ( "unknown extension found: %u ( ignoring )",
2248 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002249 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002250 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002251 p += extension_data_len;
2252 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002253 /* Check that we consumed all the message. */
2254 if( p != end )
2255 {
2256 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002257 ( "CertificateRequest misaligned" ) );
2258 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002259 }
2260 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002261 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002262 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002263 MBEDTLS_SSL_DEBUG_MSG( 3,
2264 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002265 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002266 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002267
Jerry Yu7840f812022-01-29 10:26:51 +08002268 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002269 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002270
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002271decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002272 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2273 MBEDTLS_ERR_SSL_DECODE_ERROR );
2274 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002275}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002276
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002277/*
2278 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2279 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002280MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002281static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002282{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002283 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002284
2285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2286
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002287 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2288
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002289 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2290 {
2291 unsigned char *buf;
2292 size_t buf_len;
2293
2294 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2295 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2296 &buf, &buf_len ) );
2297
2298 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2299 buf, buf + buf_len ) );
2300
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002301 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2302 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002303 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002304 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002305 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002306 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002307 }
2308 else
2309 {
2310 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002311 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2312 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002313 }
2314
Jerry Yud2674312021-10-29 10:08:19 +08002315 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2316
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002317cleanup:
2318
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002319 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2320 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002321}
2322
2323/*
Jerry Yu687101b2021-09-14 16:03:56 +08002324 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2325 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002326MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002327static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002328{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002329 int ret;
2330
2331 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002332 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002333 return( ret );
2334
Jerry Yu687101b2021-09-14 16:03:56 +08002335 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2336 return( 0 );
2337}
2338
2339/*
2340 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2341 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002342MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002343static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002344{
Jerry Yu30b071c2021-09-12 20:16:03 +08002345 int ret;
2346
2347 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2348 if( ret != 0 )
2349 return( ret );
2350
Jerry Yu687101b2021-09-14 16:03:56 +08002351 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2352 return( 0 );
2353}
Jerry Yua93ac112021-10-27 16:31:48 +08002354#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002355
Jerry Yu687101b2021-09-14 16:03:56 +08002356/*
2357 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2358 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002359MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002360static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002361{
XiaokangQianac0385c2021-11-03 06:40:11 +00002362 int ret;
2363
XiaokangQianc5c39d52021-11-09 11:55:10 +00002364 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002365 if( ret != 0 )
2366 return( ret );
2367
Jerry Yue3d67cb2022-05-19 15:33:10 +08002368 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2369 if( ret != 0 )
2370 {
2371 MBEDTLS_SSL_PEND_FATAL_ALERT(
2372 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2373 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2374 return( ret );
2375 }
2376
Ronald Cron49ad6192021-11-24 16:25:31 +01002377#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2378 mbedtls_ssl_handshake_set_state(
2379 ssl,
2380 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2381#else
Jerry Yuca133a32022-02-15 14:22:05 +08002382 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002383#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002384
XiaokangQianac0385c2021-11-03 06:40:11 +00002385 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002386}
2387
2388/*
Jerry Yu566c7812022-01-26 15:41:22 +08002389 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2390 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002391MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002392static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2393{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002394 int non_empty_certificate_msg = 0;
2395
Jerry Yu5cc35062022-01-28 16:16:08 +08002396 MBEDTLS_SSL_DEBUG_MSG( 1,
2397 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002398 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002399
Ronald Cron9df7c802022-03-08 18:38:54 +01002400#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002401 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002402 {
2403 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2404 if( ret != 0 )
2405 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002406
Ronald Cron7a94aca2022-03-09 07:44:27 +01002407 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2408 non_empty_certificate_msg = 1;
2409 }
2410 else
2411 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002412 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002413 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002414#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002415
Ronald Cron7a94aca2022-03-09 07:44:27 +01002416 if( non_empty_certificate_msg )
2417 {
2418 mbedtls_ssl_handshake_set_state( ssl,
2419 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2420 }
2421 else
Ronald Cron19385882022-06-15 16:26:13 +02002422 {
2423 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002424 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002425 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002426
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002427 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002428}
2429
Ronald Cron9df7c802022-03-08 18:38:54 +01002430#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002431/*
2432 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2433 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002434MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002435static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2436{
Ronald Crona8b38872022-03-09 07:59:25 +01002437 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2438
2439 if( ret == 0 )
2440 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2441
2442 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002443}
Jerry Yu90f152d2022-01-29 22:12:42 +08002444#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002445
2446/*
Jerry Yu687101b2021-09-14 16:03:56 +08002447 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2448 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002449MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002450static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002451{
XiaokangQian0fa66432021-11-15 03:33:57 +00002452 int ret;
2453
2454 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2455 if( ret != 0 )
2456 return( ret );
2457
Jerry Yu466dda82022-09-13 11:20:20 +08002458 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002459 if( ret != 0 )
2460 {
2461 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002462 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002463 return ( ret );
2464 }
2465
XiaokangQian0fa66432021-11-15 03:33:57 +00002466 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2467 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002468}
2469
2470/*
2471 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2472 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002473MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002474static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002475{
Jerry Yu378254d2021-10-30 21:44:47 +08002476 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002477 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002478 return( 0 );
2479}
2480
2481/*
2482 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2483 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002484MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002485static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002486{
Jerry Yu378254d2021-10-30 21:44:47 +08002487
2488 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2489
2490 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2491 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002492}
2493
Jerry Yuf8a49942022-07-07 11:32:32 +00002494#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2495
Jerry Yua0446a02022-07-13 11:22:55 +08002496MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002497static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2498 const unsigned char *buf,
2499 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002500{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002501 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002502
2503 ((void) ssl);
2504
2505 while( p < end )
2506 {
2507 unsigned int extension_type;
2508 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002509
Jerry Yuf8a49942022-07-07 11:32:32 +00002510 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2511 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2512 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2513 p += 4;
2514
2515 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002516
2517 switch( extension_type )
2518 {
2519 case MBEDTLS_TLS_EXT_EARLY_DATA:
2520 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2521 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002522
Jerry Yuf8a49942022-07-07 11:32:32 +00002523 default:
2524 break;
2525 }
2526 p += extension_data_len;
2527 }
2528
2529 return( 0 );
2530}
2531
2532/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002533 * From RFC8446, page 74
2534 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002535 * struct {
2536 * uint32 ticket_lifetime;
2537 * uint32 ticket_age_add;
2538 * opaque ticket_nonce<0..255>;
2539 * opaque ticket<1..2^16-1>;
2540 * Extension extensions<0..2^16-2>;
2541 * } NewSessionTicket;
2542 *
2543 */
Jerry Yua0446a02022-07-13 11:22:55 +08002544MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002545static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2546 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002547 unsigned char *end,
2548 unsigned char **ticket_nonce,
2549 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002550{
2551 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2552 unsigned char *p = buf;
2553 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002554 size_t ticket_len;
2555 unsigned char *ticket;
2556 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002557
Jerry Yucb3b1392022-07-12 06:09:38 +00002558 *ticket_nonce = NULL;
2559 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002560 /*
2561 * ticket_lifetime 4 bytes
2562 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002563 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002564 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002565 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002566
2567 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002568 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002569 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002570 ( unsigned int )session->ticket_lifetime ) );
2571
Jerry Yucb3b1392022-07-12 06:09:38 +00002572 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002573 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002574 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002575 ( unsigned int )session->ticket_age_add ) );
2576
Jerry Yucb3b1392022-07-12 06:09:38 +00002577 *ticket_nonce_len = p[8];
2578 p += 9;
2579
2580 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2581 *ticket_nonce = p;
2582 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2583 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002584
2585 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002586 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002587 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2588 p += 2;
2589 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002590 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2591
2592 /* Check if we previously received a ticket already. */
2593 if( session->ticket != NULL || session->ticket_len > 0 )
2594 {
2595 mbedtls_free( session->ticket );
2596 session->ticket = NULL;
2597 session->ticket_len = 0;
2598 }
2599
2600 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2601 {
2602 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2603 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2604 }
2605 memcpy( ticket, p, ticket_len );
2606 p += ticket_len;
2607 session->ticket = ticket;
2608 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002609
Jerry Yucb3b1392022-07-12 06:09:38 +00002610 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002611 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2612 p += 2;
2613 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2614
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002615 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002616
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002617 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002618 if( ret != 0 )
2619 {
2620 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002621 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002622 ret );
2623 return( ret );
2624 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002625
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002626 /* session has been updated, allow export */
2627 session->exported = 0;
2628
Jerry Yucb3b1392022-07-12 06:09:38 +00002629 return( 0 );
2630}
2631
Jerry Yua0446a02022-07-13 11:22:55 +08002632MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002633static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2634 unsigned char *ticket_nonce,
2635 size_t ticket_nonce_len )
2636{
2637 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2638 mbedtls_ssl_session *session = ssl->session;
2639 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2640 psa_algorithm_t psa_hash_alg;
2641 int hash_length;
2642
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002643#if defined(MBEDTLS_HAVE_TIME)
2644 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002645 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002646#endif
2647
Jerry Yuf8a49942022-07-07 11:32:32 +00002648 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2649 if( ciphersuite_info == NULL )
2650 {
2651 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2652 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2653 }
2654
2655 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2656 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002657 if( hash_length == -1 ||
2658 ( size_t )hash_length > sizeof( session->resumption_key ) )
2659 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002660 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002661 }
2662
Jerry Yuf8a49942022-07-07 11:32:32 +00002663
2664 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2665 session->app_secrets.resumption_master_secret,
2666 hash_length );
2667
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002668 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002669 *
2670 * HKDF-Expand-Label( resumption_master_secret,
2671 * "resumption", ticket_nonce, Hash.length )
2672 */
2673 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2674 psa_hash_alg,
2675 session->app_secrets.resumption_master_secret,
2676 hash_length,
2677 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2678 ticket_nonce,
2679 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002680 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002681 hash_length );
2682
2683 if( ret != 0 )
2684 {
2685 MBEDTLS_SSL_DEBUG_RET( 2,
2686 "Creating the ticket-resumed PSK failed",
2687 ret );
2688 return( ret );
2689 }
2690
Jerry Yu0a430c82022-07-20 11:02:48 +08002691 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002692
2693 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002694 session->resumption_key,
2695 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002696
Jerry Yuf8a49942022-07-07 11:32:32 +00002697 return( 0 );
2698}
2699
2700/*
Jerry Yua357cf42022-07-12 05:36:45 +00002701 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002702 */
Jerry Yua0446a02022-07-13 11:22:55 +08002703MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002704static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2705{
2706 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2707 unsigned char *buf;
2708 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002709 unsigned char *ticket_nonce;
2710 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002711
2712 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2713
2714 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2715 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2716 &buf, &buf_len ) );
2717
Jerry Yucb3b1392022-07-12 06:09:38 +00002718 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2719 ssl, buf, buf + buf_len,
2720 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002721
Jerry Yucb3b1392022-07-12 06:09:38 +00002722 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2723 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002724
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002725 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2726
Jerry Yuf8a49942022-07-07 11:32:32 +00002727cleanup:
2728
2729 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2730 return( ret );
2731}
2732#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2733
Jerry Yu92c6b402021-08-27 16:59:09 +08002734int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002735{
Jerry Yu92c6b402021-08-27 16:59:09 +08002736 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002737
Jerry Yu92c6b402021-08-27 16:59:09 +08002738 switch( ssl->state )
2739 {
2740 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002741 * ssl->state is initialized as HELLO_REQUEST. It is the same
2742 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002743 */
2744 case MBEDTLS_SSL_HELLO_REQUEST:
2745 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002746 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002747 break;
2748
2749 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002750 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002751 break;
2752
2753 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002754 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002755 break;
2756
Jerry Yua93ac112021-10-27 16:31:48 +08002757#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002758 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2759 ret = ssl_tls13_process_certificate_request( ssl );
2760 break;
2761
Jerry Yu687101b2021-09-14 16:03:56 +08002762 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002763 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002764 break;
2765
2766 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002767 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002768 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002769#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002770
2771 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002772 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002773 break;
2774
Jerry Yu566c7812022-01-26 15:41:22 +08002775 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2776 ret = ssl_tls13_write_client_certificate( ssl );
2777 break;
2778
Ronald Cron9df7c802022-03-08 18:38:54 +01002779#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002780 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2781 ret = ssl_tls13_write_client_certificate_verify( ssl );
2782 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002783#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002784
Jerry Yu687101b2021-09-14 16:03:56 +08002785 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002786 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002787 break;
2788
2789 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002790 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002791 break;
2792
2793 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002794 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002795 break;
2796
Ronald Cron49ad6192021-11-24 16:25:31 +01002797 /*
2798 * Injection of dummy-CCS's for middlebox compatibility
2799 */
2800#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002801 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002802 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2803 if( ret == 0 )
2804 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2805 break;
2806
2807 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2808 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2809 if( ret == 0 )
2810 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002811 break;
2812#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2813
Jerry Yuf8a49942022-07-07 11:32:32 +00002814#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002815 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002816 ret = ssl_tls13_process_new_session_ticket( ssl );
2817 if( ret != 0 )
2818 break;
2819 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2820 break;
2821#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2822
Jerry Yu92c6b402021-08-27 16:59:09 +08002823 default:
2824 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2825 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2826 }
2827
2828 return( ret );
2829}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002830
Jerry Yufb4b6472022-01-27 15:03:26 +08002831#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002832
Jerry Yufb4b6472022-01-27 15:03:26 +08002833