blob: 8510d8f3e66290c65db7b17c6a63387b85b3b800 [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{
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400382#if defined(MBEDTLS_ECDH_C)
XiaokangQianb851da82022-01-14 04:03:11 +0000383 const mbedtls_ecp_curve_info *curve_info = NULL;
384 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000385 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000386 int found = 0;
387
388 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
389 if( group_list == NULL )
390 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
391
392 MBEDTLS_SSL_DEBUG_BUF( 3, "key_share extension", p, end - buf );
393
394 /* Read selected_group */
XiaokangQianb48894e2022-01-17 02:05:52 +0000395 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQiand59be772022-01-24 10:12:51 +0000396 selected_group = MBEDTLS_GET_UINT16_BE( p, 0 );
397 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_group ( %d )", selected_group ) );
XiaokangQianb851da82022-01-14 04:03:11 +0000398
399 /* Upon receipt of this extension in a HelloRetryRequest, the client
400 * MUST first verify that the selected_group field corresponds to a
401 * group which was provided in the "supported_groups" extension in the
402 * original ClientHello.
403 * The supported_group was based on the info in ssl->conf->group_list.
404 *
405 * If the server provided a key share that was not sent in the ClientHello
406 * then the client MUST abort the handshake with an "illegal_parameter" alert.
407 */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000408 for( ; *group_list != 0; group_list++ )
XiaokangQianb851da82022-01-14 04:03:11 +0000409 {
410 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
XiaokangQiand59be772022-01-24 10:12:51 +0000411 if( curve_info == NULL || curve_info->tls_id != selected_group )
XiaokangQianb851da82022-01-14 04:03:11 +0000412 continue;
413
414 /* We found a match */
415 found = 1;
416 break;
417 }
418
419 /* Client MUST verify that the selected_group field does not
420 * correspond to a group which was provided in the "key_share"
421 * extension in the original ClientHello. If the server sent an
422 * HRR message with a key share already provided in the
423 * ClientHello then the client MUST abort the handshake with
424 * an "illegal_parameter" alert.
425 */
XiaokangQiand59be772022-01-24 10:12:51 +0000426 if( found == 0 || selected_group == ssl->handshake->offered_group_id )
XiaokangQianb851da82022-01-14 04:03:11 +0000427 {
428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid key share in HRR" ) );
429 MBEDTLS_SSL_PEND_FATAL_ALERT(
430 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
431 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
432 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
433 }
434
435 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000436 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000437
438 return( 0 );
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400439#else
440 (void) ssl;
441 (void) buf;
442 (void) end;
443 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
444#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000445}
446
Jerry Yue1b9c292021-09-10 10:08:31 +0800447/*
Jerry Yub85277e2021-10-13 13:36:05 +0800448 * ssl_tls13_parse_key_share_ext()
449 * Parse key_share extension in Server Hello
450 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800451 * struct {
452 * KeyShareEntry server_share;
453 * } KeyShareServerHello;
454 * struct {
455 * NamedGroup group;
456 * opaque key_exchange<1..2^16-1>;
457 * } KeyShareEntry;
458 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200459MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +0800460static int ssl_tls13_parse_key_share_ext( mbedtls_ssl_context *ssl,
Jerry Yue1b9c292021-09-10 10:08:31 +0800461 const unsigned char *buf,
462 const unsigned char *end )
463{
Jerry Yub85277e2021-10-13 13:36:05 +0800464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800465 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800466 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800467
Jerry Yu4a173382021-10-11 21:45:31 +0800468 /* ...
469 * NamedGroup group; (2 bytes)
470 * ...
471 */
472 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
473 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +0800474 p += 2;
475
Jerry Yu4a173382021-10-11 21:45:31 +0800476 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800477 offered_group = ssl->handshake->offered_group_id;
Jerry Yu4a173382021-10-11 21:45:31 +0800478 if( offered_group != group )
Jerry Yue1b9c292021-09-10 10:08:31 +0800479 {
480 MBEDTLS_SSL_DEBUG_MSG( 1,
481 ( "Invalid server key share, our group %u, their group %u",
Jerry Yu4a173382021-10-11 21:45:31 +0800482 (unsigned) offered_group, (unsigned) group ) );
483 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
484 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
485 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yue1b9c292021-09-10 10:08:31 +0800486 }
487
488#if defined(MBEDTLS_ECDH_C)
Jerry Yu4a173382021-10-11 21:45:31 +0800489 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
Jerry Yue1b9c292021-09-10 10:08:31 +0800490 {
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100491 const mbedtls_ecp_curve_info *curve_info =
492 mbedtls_ecp_curve_info_from_tls_id( group );
493 if( curve_info == NULL )
494 {
495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid TLS curve group id" ) );
496 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
497 }
498
499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
500
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000501 ret = mbedtls_ssl_tls13_read_public_ecdhe_share( ssl, p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +0800502 if( ret != 0 )
503 return( ret );
504 }
Jerry Yub85277e2021-10-13 13:36:05 +0800505 else
Jerry Yue1b9c292021-09-10 10:08:31 +0800506#endif /* MBEDTLS_ECDH_C */
Jerry Yub85277e2021-10-13 13:36:05 +0800507 if( 0 /* other KEMs? */ )
Jerry Yue1b9c292021-09-10 10:08:31 +0800508 {
509 /* Do something */
510 }
511 else
512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
513
514 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
515 return( ret );
516}
517
XiaokangQiand59be772022-01-24 10:12:51 +0000518/*
519 * ssl_tls13_parse_cookie_ext()
520 * Parse cookie extension in Hello Retry Request
521 *
522 * struct {
523 * opaque cookie<1..2^16-1>;
524 * } Cookie;
525 *
526 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
527 * extension to the client (this is an exception to the usual rule that
528 * the only extensions that may be sent are those that appear in the
529 * ClientHello). When sending the new ClientHello, the client MUST copy
530 * the contents of the extension received in the HelloRetryRequest into
531 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
532 * cookies in their initial ClientHello in subsequent connections.
533 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200534MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian43550bd2022-01-21 04:32:58 +0000535static int ssl_tls13_parse_cookie_ext( mbedtls_ssl_context *ssl,
536 const unsigned char *buf,
537 const unsigned char *end )
538{
XiaokangQian25c9c902022-02-08 10:49:53 +0000539 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000540 const unsigned char *p = buf;
541 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
542
543 /* Retrieve length field of cookie */
544 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
545 cookie_len = MBEDTLS_GET_UINT16_BE( p, 0 );
546 p += 2;
547
548 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cookie_len );
549 MBEDTLS_SSL_DEBUG_BUF( 3, "cookie extension", p, cookie_len );
550
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000551 mbedtls_free( handshake->cookie );
XiaokangQian25c9c902022-02-08 10:49:53 +0000552 handshake->hrr_cookie_len = 0;
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000553 handshake->cookie = mbedtls_calloc( 1, cookie_len );
554 if( handshake->cookie == NULL )
XiaokangQian43550bd2022-01-21 04:32:58 +0000555 {
556 MBEDTLS_SSL_DEBUG_MSG( 1,
XiaokangQian25c9c902022-02-08 10:49:53 +0000557 ( "alloc failed ( %ud bytes )",
XiaokangQian43550bd2022-01-21 04:32:58 +0000558 cookie_len ) );
559 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
560 }
561
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000562 memcpy( handshake->cookie, p, cookie_len );
XiaokangQian25c9c902022-02-08 10:49:53 +0000563 handshake->hrr_cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000564
565 return( 0 );
566}
XiaokangQian43550bd2022-01-21 04:32:58 +0000567
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200568MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0b64eed2022-01-27 10:36:51 +0000569static int ssl_tls13_write_cookie_ext( mbedtls_ssl_context *ssl,
XiaokangQian233397e2022-02-07 08:32:16 +0000570 unsigned char *buf,
571 unsigned char *end,
XiaokangQian9deb90f2022-02-08 10:31:07 +0000572 size_t *out_len )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000573{
574 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000575 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000576 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000577
XiaokangQianc02768a2022-02-10 07:31:25 +0000578 if( handshake->cookie == NULL )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000579 {
580 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no cookie to send; skip extension" ) );
581 return( 0 );
582 }
583
584 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, cookie",
XiaokangQianc02768a2022-02-10 07:31:25 +0000585 handshake->cookie,
586 handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000587
XiaokangQianc02768a2022-02-10 07:31:25 +0000588 MBEDTLS_SSL_CHK_BUF_PTR( p, end, handshake->hrr_cookie_len + 6 );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000589
590 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding cookie extension" ) );
591
XiaokangQian0b64eed2022-01-27 10:36:51 +0000592 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_COOKIE, p, 0 );
XiaokangQianc02768a2022-02-10 07:31:25 +0000593 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len + 2, p, 2 );
594 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len, p, 4 );
XiaokangQian233397e2022-02-07 08:32:16 +0000595 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000596
597 /* Cookie */
XiaokangQianc02768a2022-02-10 07:31:25 +0000598 memcpy( p, handshake->cookie, handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000599
XiaokangQianc02768a2022-02-10 07:31:25 +0000600 *out_len = handshake->hrr_cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000601
602 return( 0 );
603}
604
XiaokangQianeb69aee2022-07-05 08:21:43 +0000605#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
606/*
607 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
608 *
609 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
610 *
611 * struct {
612 * PskKeyExchangeMode ke_modes<1..255>;
613 * } PskKeyExchangeModes;
614 */
XiaokangQian86981952022-07-19 09:51:50 +0000615MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616static int ssl_tls13_write_psk_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
617 unsigned char *buf,
618 unsigned char *end,
619 size_t *out_len )
620{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000621 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000622 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000623
XiaokangQian008d2bf2022-07-14 07:54:01 +0000624 ((void) ke_modes_len );
XiaokangQianeb69aee2022-07-05 08:21:43 +0000625 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000626
XiaokangQianeb69aee2022-07-05 08:21:43 +0000627 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000628 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000629 */
XiaokangQian86981952022-07-19 09:51:50 +0000630 if( !mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000631 {
632 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip psk_key_exchange_modes extension" ) );
633 return( 0 );
634 }
635
636 /* Require 7 bytes of data, otherwise fail,
637 * even if extension might be shorter.
638 */
639 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 );
640 MBEDTLS_SSL_DEBUG_MSG(
641 3, ( "client hello, adding psk_key_exchange_modes extension" ) );
642
XiaokangQianeb69aee2022-07-05 08:21:43 +0000643 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0 );
644
XiaokangQian008d2bf2022-07-14 07:54:01 +0000645 /* Skip extension length (2 bytes) and
646 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000647 */
648 p += 5;
649
650 if( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) )
651 {
652 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000653 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000654
655 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding pure PSK key exchange mode" ) );
656 }
657
658 if( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) )
659 {
660 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000661 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662
663 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding PSK-ECDHE key exchange mode" ) );
664 }
665
XiaokangQian008d2bf2022-07-14 07:54:01 +0000666 /* Now write the extension and ke_modes length */
667 MBEDTLS_PUT_UINT16_BE( ke_modes_len + 1, buf, 2 );
668 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000669
670 *out_len = p - buf;
671 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
672 return ( 0 );
673}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800674
Jerry Yua99cbfa2022-10-08 11:17:14 +0800675static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg( int ciphersuite )
Jerry Yuf7c12592022-09-28 22:09:38 +0800676{
Jerry Yu21f90952022-10-08 10:30:53 +0800677 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
678 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800679
Jerry Yua99cbfa2022-10-08 11:17:14 +0800680 if( ciphersuite_info != NULL )
681 return( mbedtls_psa_translate_md( ciphersuite_info->mac ) );
682
Jerry Yu21f90952022-10-08 10:30:53 +0800683 return( PSA_ALG_NONE );
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 +0800687static int ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl )
688{
Jerry Yuf7c12592022-09-28 22:09:38 +0800689 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu4f77ecf2022-10-10 22:10:08 +0800690 return( ssl->handshake->resume &&
691 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,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800696 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800697 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
Jerry Yu8b41e892022-09-30 10:00:20 +0800702 if( !ssl_tls13_has_configured_ticket( ssl ) )
703 return( -1 );
704
Jerry Yua99cbfa2022-10-08 11:17:14 +0800705 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800706 *identity = session->ticket;
707 *identity_len = session->ticket_len;
708 return( 0 );
709}
710
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800711MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800712static int ssl_tls13_ticket_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800713 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800714 const unsigned char **psk,
715 size_t *psk_len )
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800716{
717
718 mbedtls_ssl_session *session = ssl->session_negotiate;
719
Jerry Yu8b41e892022-09-30 10:00:20 +0800720 if( !ssl_tls13_has_configured_ticket( ssl ) )
721 return( -1 );
722
Jerry Yua99cbfa2022-10-08 11:17:14 +0800723 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800724 *psk = session->resumption_key;
725 *psk_len = session->resumption_key_len;
726
727 return( 0 );
728}
Jerry Yuf7c12592022-09-28 22:09:38 +0800729#endif /* MBEDTLS_SSL_SESSION_TICKETS */
730
Jerry Yua99cbfa2022-10-08 11:17:14 +0800731static int ssl_tls13_has_configured_psk( const mbedtls_ssl_config *conf )
Jerry Yuf75364b2022-09-30 10:30:31 +0800732{
Jerry Yua99cbfa2022-10-08 11:17:14 +0800733 return( conf->psk != NULL && conf->psk_identity != NULL );
Jerry Yuf75364b2022-09-30 10:30:31 +0800734}
735
Jerry Yuf7c12592022-09-28 22:09:38 +0800736MBEDTLS_CHECK_RETURN_CRITICAL
737static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800738 psa_algorithm_t *hash_alg,
Jerry Yuf7c12592022-09-28 22:09:38 +0800739 const unsigned char **identity,
740 size_t *identity_len )
741{
Jerry Yu8b41e892022-09-30 10:00:20 +0800742
Jerry Yua99cbfa2022-10-08 11:17:14 +0800743 if( !ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800744 return( -1 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800745
Jerry Yua99cbfa2022-10-08 11:17:14 +0800746 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800747 *identity = ssl->conf->psk_identity;
748 *identity_len = ssl->conf->psk_identity_len;
749 return( 0 );
750}
751
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800752MBEDTLS_CHECK_RETURN_CRITICAL
753static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800754 psa_algorithm_t *hash_alg,
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800755 const unsigned char **psk,
756 size_t *psk_len )
757{
Jerry Yu8b41e892022-09-30 10:00:20 +0800758
Jerry Yua99cbfa2022-10-08 11:17:14 +0800759 if( !ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800760 return( -1 );
761
Jerry Yua99cbfa2022-10-08 11:17:14 +0800762 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800763 *psk = ssl->conf->psk;
764 *psk_len = ssl->conf->psk_len;
765 return( 0 );
766}
767
Jerry Yuf75364b2022-09-30 10:30:31 +0800768static int ssl_tls13_get_configured_psk_count( mbedtls_ssl_context *ssl )
769{
770 int configured_psk_count = 0;
771#if defined(MBEDTLS_SSL_SESSION_TICKETS)
772 if( ssl_tls13_has_configured_ticket( ssl ) )
773 {
774 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Ticket is configured" ) );
775 configured_psk_count++;
776 }
777#endif
Jerry Yua99cbfa2022-10-08 11:17:14 +0800778 if( ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yuf75364b2022-09-30 10:30:31 +0800779 {
780 MBEDTLS_SSL_DEBUG_MSG( 3, ( "PSK is configured" ) );
781 configured_psk_count++;
782 }
783 return( configured_psk_count );
784}
785
Jerry Yuf7c12592022-09-28 22:09:38 +0800786MBEDTLS_CHECK_RETURN_CRITICAL
787static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
788 unsigned char *buf,
789 unsigned char *end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800790 const unsigned char *identity,
791 size_t identity_len,
792 uint32_t obfuscated_ticket_age,
793 size_t *out_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800794{
Jerry Yuf75364b2022-09-30 10:30:31 +0800795 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800796 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800797
798 /*
799 * - identity_len (2 bytes)
800 * - identity (psk_identity_len bytes)
801 * - obfuscated_ticket_age (4 bytes)
802 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800803 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800804
Jerry Yua99cbfa2022-10-08 11:17:14 +0800805 MBEDTLS_PUT_UINT16_BE( identity_len, buf, 0 );
806 memcpy( buf + 2, identity, identity_len );
807 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, buf, 2 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800808
Jerry Yua99cbfa2022-10-08 11:17:14 +0800809 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", buf, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800810
811 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800812
813 return( 0 );
814}
815
Jerry Yu8b41e892022-09-30 10:00:20 +0800816MBEDTLS_CHECK_RETURN_CRITICAL
817static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
818 unsigned char *buf,
819 unsigned char *end,
820 int psk_type,
Jerry Yu6183cc72022-09-30 11:08:57 +0800821 psa_algorithm_t hash_alg,
822 const unsigned char *psk,
823 size_t psk_len,
Jerry Yu8b41e892022-09-30 10:00:20 +0800824 size_t *out_len )
825{
826 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800827 unsigned char binder_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800828 unsigned char transcript[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Jerry Yu8b41e892022-09-30 10:00:20 +0800829 size_t transcript_len = 0;
830
831 *out_len = 0;
832
Jerry Yu6183cc72022-09-30 11:08:57 +0800833 binder_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yu8b41e892022-09-30 10:00:20 +0800834
835 /*
836 * - binder_len (1 bytes)
837 * - binder (binder_len bytes)
838 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800839 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800840
Jerry Yua99cbfa2022-10-08 11:17:14 +0800841 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800842
843 /* Get current state of handshake transcript. */
844 ret = mbedtls_ssl_get_handshake_transcript(
Jerry Yu6183cc72022-09-30 11:08:57 +0800845 ssl, mbedtls_hash_info_md_from_psa( hash_alg ),
Jerry Yu6916e702022-10-10 21:33:51 +0800846 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800847 if( ret != 0 )
848 return( ret );
849
Jerry Yu6183cc72022-09-30 11:08:57 +0800850 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800851 psk, psk_len, psk_type,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800852 transcript, buf + 1 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800853 if( ret != 0 )
854 {
855 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
856 return( ret );
857 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800858 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", buf, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800859
860 *out_len = 1 + binder_len;
861
Jerry Yu6916e702022-10-10 21:33:51 +0800862 return( 0 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800863}
864
865/*
866 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
867 *
868 * struct {
869 * opaque identity<1..2^16-1>;
870 * uint32 obfuscated_ticket_age;
871 * } PskIdentity;
872 *
873 * opaque PskBinderEntry<32..255>;
874 *
875 * struct {
876 * PskIdentity identities<7..2^16-1>;
877 * PskBinderEntry binders<33..2^16-1>;
878 * } OfferedPsks;
879 *
880 * struct {
881 * select (Handshake.msg_type) {
882 * case client_hello: OfferedPsks;
883 * ...
884 * };
885 * } PreSharedKeyExtension;
886 *
887 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000888int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Jerry Yuf75364b2022-09-30 10:30:31 +0800889 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
890 size_t *out_len, size_t *binders_len )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000891{
Jerry Yuf7c12592022-09-28 22:09:38 +0800892 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800893 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800894 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800895 psa_algorithm_t hash_alg;
896 const unsigned char *identity;
897 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800898 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800899 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800900
901 *out_len = 0;
902 *binders_len = 0;
903
904 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Jerry Yuf75364b2022-09-30 10:30:31 +0800905 configured_psk_count = ssl_tls13_get_configured_psk_count( ssl );
906 if( configured_psk_count == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800907 {
908 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
909 return( 0 );
910 }
911
912 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
Jerry Yuf75364b2022-09-30 10:30:31 +0800913 configured_psk_count ) );
914
Jerry Yuf7c12592022-09-28 22:09:38 +0800915 /* Check if we have space to write the extension, binders included.
916 * - extension_type (2 bytes)
917 * - extension_data_len (2 bytes)
918 * - identities_len (2 bytes)
919 */
920 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
921 p += 6;
922
Jerry Yuf75364b2022-09-30 10:30:31 +0800923#if defined(MBEDTLS_SSL_SESSION_TICKETS)
924 if( ssl_tls13_ticket_get_identity(
925 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800926 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800927#if defined(MBEDTLS_HAVE_TIME)
928 mbedtls_time_t now = mbedtls_time( NULL );
929 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800930 uint32_t obfuscated_ticket_age =
931 (uint32_t)( now - session->ticket_received );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800932
Jerry Yuf75364b2022-09-30 10:30:31 +0800933 obfuscated_ticket_age *= 1000;
934 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800935
Jerry Yuf7c12592022-09-28 22:09:38 +0800936 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800937 identity, identity_len,
938 obfuscated_ticket_age,
939 &output_len );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800940#else
941 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len,
942 0, &output_len );
943#endif /* MBEDTLS_HAVE_TIME */
Jerry Yuf7c12592022-09-28 22:09:38 +0800944 if( ret != 0 )
945 return( ret );
Jerry Yuf7c12592022-09-28 22:09:38 +0800946
Jerry Yuf75364b2022-09-30 10:30:31 +0800947 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800948 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf75364b2022-09-30 10:30:31 +0800949 }
950#endif /* MBEDTLS_SSL_SESSION_TICKETS */
951
952 if( ssl_tls13_psk_get_identity(
953 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800954 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800955
Jerry Yua99cbfa2022-10-08 11:17:14 +0800956 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len, 0,
Jerry Yuf75364b2022-09-30 10:30:31 +0800957 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800958 if( ret != 0 )
959 return( ret );
Jerry Yuf75364b2022-09-30 10:30:31 +0800960
Jerry Yuf7c12592022-09-28 22:09:38 +0800961 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800962 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf7c12592022-09-28 22:09:38 +0800963 }
964
965 MBEDTLS_SSL_DEBUG_MSG( 3,
966 ( "client hello, adding pre_shared_key extension, "
967 "omitting PSK binder list" ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800968
969 /* Take into account the two bytes for the length of the binders. */
970 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800971 /* Check if there is enough space for binders */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800972 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len );
973
Jerry Yuf7c12592022-09-28 22:09:38 +0800974 /*
975 * - extension_type (2 bytes)
976 * - extension_data_len (2 bytes)
977 * - identities_len (2 bytes)
978 */
979 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800980 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + l_binders_len , buf, 2 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800981 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
982
Jerry Yua99cbfa2022-10-08 11:17:14 +0800983 *out_len = ( p - buf ) + l_binders_len;
984 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800985
986 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
987
988 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
989
XiaokangQianeb69aee2022-07-05 08:21:43 +0000990 return( 0 );
991}
992
XiaokangQian86981952022-07-19 09:51:50 +0000993int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +0800994 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000995{
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800996 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
997 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +0800998 psa_algorithm_t hash_alg = PSA_ALG_NONE;
999 const unsigned char *psk;
1000 size_t psk_len;
1001 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001002
1003 /* Check if we have space to write binders_len.
1004 * - binders_len (2 bytes)
1005 */
1006 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1007 p += 2;
1008
Jerry Yu6183cc72022-09-30 11:08:57 +08001009#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1010 if( ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001011 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001012
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001013 ret = ssl_tls13_write_binder( ssl, p, end,
1014 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
Jerry Yu6183cc72022-09-30 11:08:57 +08001015 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001016 &output_len );
1017 if( ret != 0 )
1018 return( ret );
1019 p += output_len;
1020 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001021#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001022
Jerry Yu6183cc72022-09-30 11:08:57 +08001023 if( ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001024 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001025
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001026 ret = ssl_tls13_write_binder( ssl, p, end,
1027 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
Jerry Yu6183cc72022-09-30 11:08:57 +08001028 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001029 &output_len );
1030 if( ret != 0 )
1031 return( ret );
1032 p += output_len;
1033 }
1034
1035 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1036
1037 /*
1038 * - binders_len (2 bytes)
1039 */
1040 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1041
1042 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001043
1044 return( 0 );
1045}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001046
1047/*
1048 * struct {
1049 * opaque identity<1..2^16-1>;
1050 * uint32 obfuscated_ticket_age;
1051 * } PskIdentity;
1052 *
1053 * opaque PskBinderEntry<32..255>;
1054 *
1055 * struct {
1056 *
1057 * select (Handshake.msg_type) {
1058 * ...
1059 * case server_hello: uint16 selected_identity;
1060 * };
1061 *
1062 * } PreSharedKeyExtension;
1063 *
1064 */
1065MBEDTLS_CHECK_RETURN_CRITICAL
1066static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1067 const unsigned char *buf,
1068 const unsigned char *end )
1069{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001070 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001071 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001072 const unsigned char *psk;
1073 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001074 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001075
Jerry Yua99cbfa2022-10-08 11:17:14 +08001076 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Jerry Yub300e3c2022-09-28 22:12:07 +08001077 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001078
Jerry Yub300e3c2022-09-28 22:12:07 +08001079 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001080
Jerry Yu4a698342022-09-30 12:22:01 +08001081 if( selected_identity >= ssl_tls13_get_configured_psk_count( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001082 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001083 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid PSK identity." ) );
Jerry Yu4a698342022-09-30 12:22:01 +08001084
1085 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1086 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1087 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yub300e3c2022-09-28 22:12:07 +08001088 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001089
Jerry Yu4a698342022-09-30 12:22:01 +08001090#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1091 if( selected_identity == 0 && ssl_tls13_has_configured_ticket( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001092 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001093 ret = ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yu4a698342022-09-30 12:22:01 +08001094 }
1095 else
1096#endif
Jerry Yua99cbfa2022-10-08 11:17:14 +08001097 if( ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu4a698342022-09-30 12:22:01 +08001098 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001099 ret = ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001100 }
1101 else
1102 {
1103 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1104 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1105 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001106 if( ret != 0 )
1107 return( ret );
1108
1109 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1110 if( ret != 0 )
1111 {
1112 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
Jerry Yu6916e702022-10-10 21:33:51 +08001113 return( ret );
Jerry Yub300e3c2022-09-28 22:12:07 +08001114 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001115
Jerry Yu6916e702022-10-10 21:33:51 +08001116 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1117
1118 return( 0 );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001119}
1120
XiaokangQianeb69aee2022-07-05 08:21:43 +00001121#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1122
Ronald Cron3d580bf2022-02-18 17:24:56 +01001123int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1124 unsigned char *buf,
1125 unsigned char *end,
1126 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001127{
1128 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1129 unsigned char *p = buf;
1130 size_t ext_len;
1131
1132 *out_len = 0;
1133
1134 /* Write supported_versions extension
1135 *
1136 * Supported Versions Extension is mandatory with TLS 1.3.
1137 */
1138 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1139 if( ret != 0 )
1140 return( ret );
1141 p += ext_len;
1142
1143 /* Echo the cookie if the server provided one in its preceding
1144 * HelloRetryRequest message.
1145 */
1146 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1147 if( ret != 0 )
1148 return( ret );
1149 p += ext_len;
1150
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001151 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1152 {
1153 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1154 if( ret != 0 )
1155 return( ret );
1156 p += ext_len;
1157 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001158
XiaokangQianeb69aee2022-07-05 08:21:43 +00001159#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1160 /* For PSK-based key exchange we need the pre_shared_key extension
1161 * and the psk_key_exchange_modes extension.
1162 *
1163 * The pre_shared_key extension MUST be the last extension in the
1164 * ClientHello. Servers MUST check that it is the last extension and
1165 * otherwise fail the handshake with an "illegal_parameter" alert.
1166 *
1167 * Add the psk_key_exchange_modes extension.
1168 */
1169 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1170 if( ret != 0 )
1171 return( ret );
1172 p += ext_len;
1173#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1174
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001175 *out_len = p - buf;
1176
1177 return( 0 );
1178}
1179
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001180/*
Jerry Yu4a173382021-10-11 21:45:31 +08001181 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001182 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001183
Ronald Cronda41b382022-03-30 09:57:11 +02001184/**
1185 * \brief Detect if the ServerHello contains a supported_versions extension
1186 * or not.
1187 *
1188 * \param[in] ssl SSL context
1189 * \param[in] buf Buffer containing the ServerHello message
1190 * \param[in] end End of the buffer containing the ServerHello message
1191 *
1192 * \return 0 if the ServerHello does not contain a supported_versions extension
1193 * \return 1 if the ServerHello contains a supported_versions extension
1194 * \return A negative value if an error occurred while parsing the ServerHello.
1195 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001196MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001197static int ssl_tls13_is_supported_versions_ext_present(
1198 mbedtls_ssl_context *ssl,
1199 const unsigned char *buf,
1200 const unsigned char *end )
1201{
1202 const unsigned char *p = buf;
1203 size_t legacy_session_id_echo_len;
1204 size_t extensions_len;
1205 const unsigned char *extensions_end;
1206
1207 /*
1208 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001209 * length:
1210 * - legacy_version 2 bytes
1211 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1212 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001213 */
1214 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1215 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1216 legacy_session_id_echo_len = *p;
1217
1218 /*
1219 * Jump to the extensions, jumping over:
1220 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1221 * - cipher_suite 2 bytes
1222 * - legacy_compression_method 1 byte
1223 */
Ronald Cron28271062022-06-10 14:43:55 +02001224 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001225 p += legacy_session_id_echo_len + 4;
1226
1227 /* Case of no extension */
1228 if( p == end )
1229 return( 0 );
1230
1231 /* ...
1232 * Extension extensions<6..2^16-1>;
1233 * ...
1234 * struct {
1235 * ExtensionType extension_type; (2 bytes)
1236 * opaque extension_data<0..2^16-1>;
1237 * } Extension;
1238 */
1239 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1240 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1241 p += 2;
1242
1243 /* Check extensions do not go beyond the buffer of data. */
1244 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1245 extensions_end = p + extensions_len;
1246
1247 while( p < extensions_end )
1248 {
1249 unsigned int extension_type;
1250 size_t extension_data_len;
1251
1252 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1253 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1254 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1255 p += 4;
1256
1257 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1258 return( 1 );
1259
1260 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1261 p += extension_data_len;
1262 }
1263
1264 return( 0 );
1265}
1266
Jerry Yu7a186a02021-10-15 18:46:14 +08001267/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001268 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1269 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1270 * - 0 otherwise
1271 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001272MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001273static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1274 const unsigned char *buf,
1275 const unsigned char *end )
1276{
1277 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1278 static const unsigned char magic_downgrade_string[] =
1279 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1280 const unsigned char *last_eight_bytes_of_random;
1281 unsigned char last_byte_of_random;
1282
1283 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1284 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1285
1286 if( memcmp( last_eight_bytes_of_random,
1287 magic_downgrade_string,
1288 sizeof( magic_downgrade_string ) ) == 0 )
1289 {
1290 last_byte_of_random = last_eight_bytes_of_random[7];
1291 return( last_byte_of_random == 0 ||
1292 last_byte_of_random == 1 );
1293 }
1294
1295 return( 0 );
1296}
1297
1298/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001299 * - SSL_SERVER_HELLO or
1300 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001301 * to indicate which message is expected and to be parsed next.
1302 */
Ronald Cron828aff62022-05-31 12:04:31 +02001303#define SSL_SERVER_HELLO 0
1304#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001305MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001306static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1307 const unsigned char *buf,
1308 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001309{
Jerry Yue1b9c292021-09-10 10:08:31 +08001310
1311 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1312 *
Jerry Yu4a173382021-10-11 21:45:31 +08001313 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001314 * special value of the SHA-256 of "HelloRetryRequest".
1315 *
1316 * struct {
1317 * ProtocolVersion legacy_version = 0x0303;
1318 * Random random;
1319 * opaque legacy_session_id_echo<0..32>;
1320 * CipherSuite cipher_suite;
1321 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001322 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001323 * } ServerHello;
1324 *
1325 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001326 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1327 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001328
Jerry Yu93a13f22022-04-11 23:00:01 +08001329 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1330 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001331 {
Ronald Cron828aff62022-05-31 12:04:31 +02001332 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001333 }
1334
Ronald Cron828aff62022-05-31 12:04:31 +02001335 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001336}
1337
Ronald Cron828aff62022-05-31 12:04:31 +02001338/*
Jerry Yu745bb612021-10-13 22:01:04 +08001339 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001340 * - SSL_SERVER_HELLO or
1341 * - SSL_SERVER_HELLO_HRR or
1342 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001343 */
Ronald Cron828aff62022-05-31 12:04:31 +02001344#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001345MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001346static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001347 const unsigned char *buf,
1348 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001349{
Jerry Yu4a173382021-10-11 21:45:31 +08001350 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001351 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001352
Ronald Cron9f0fba32022-02-10 16:45:15 +01001353 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001354 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001355
Ronald Cron9f0fba32022-02-10 16:45:15 +01001356 if( ret == 0 )
1357 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001358 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001359 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001360
1361 /* If the server is negotiating TLS 1.2 or below and:
1362 * . we did not propose TLS 1.2 or
1363 * . the server responded it is TLS 1.3 capable but negotiating a lower
1364 * version of the protocol and thus we are under downgrade attack
1365 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001366 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001367 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001368 {
1369 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1370 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1371 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1372 }
1373
1374 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001375 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001376 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001377 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001378
1379 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1380 {
1381 ret = ssl_tls13_reset_key_share( ssl );
1382 if( ret != 0 )
1383 return( ret );
1384 }
1385
Ronald Cron828aff62022-05-31 12:04:31 +02001386 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001387 }
1388
Jerry Yua66fece2022-07-13 14:30:29 +08001389#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1390 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1391 ssl->session_negotiate->tls_version = ssl->tls_version;
1392#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1393
Ronald Cron5afb9042022-05-31 12:11:39 +02001394 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1395
Ronald Crondb5dfa12022-05-31 11:44:38 +02001396 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001397 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001398 {
Ronald Cron828aff62022-05-31 12:04:31 +02001399 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001400 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1401 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001402 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001403 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001404 /* If a client receives a second
1405 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1406 * was itself in response to a HelloRetryRequest), it MUST abort the
1407 * handshake with an "unexpected_message" alert.
1408 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001409 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001410 {
1411 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1412 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1413 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1414 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1415 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001416 /*
1417 * Clients must abort the handshake with an "illegal_parameter"
1418 * alert if the HelloRetryRequest would not result in any change
1419 * in the ClientHello.
1420 * In a PSK only key exchange that what we expect.
1421 */
1422 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1423 {
1424 MBEDTLS_SSL_DEBUG_MSG( 1,
1425 ( "Unexpected HRR in pure PSK key exchange." ) );
1426 MBEDTLS_SSL_PEND_FATAL_ALERT(
1427 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1428 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1429 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1430 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001431
Ronald Cron5afb9042022-05-31 12:11:39 +02001432 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001433
Jerry Yu745bb612021-10-13 22:01:04 +08001434 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001435 }
1436
1437cleanup:
1438
1439 return( ret );
1440}
1441
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001442MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001443static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1444 const unsigned char **buf,
1445 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001446{
1447 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001448 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001449
Jerry Yude4fb2c2021-09-19 18:05:08 +08001450 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001451 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001452
Jerry Yu4a173382021-10-11 21:45:31 +08001453 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001454
1455 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001456 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1457 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001458 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001459 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1460 ssl->session_negotiate->id,
1461 ssl->session_negotiate->id_len );
1462 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001463 legacy_session_id_echo_len );
1464
1465 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1466 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1467
Jerry Yue1b9c292021-09-10 10:08:31 +08001468 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1469 }
1470
Jerry Yu4a173382021-10-11 21:45:31 +08001471 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001472 *buf = p;
1473
1474 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001475 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001476 return( 0 );
1477}
1478
Jerry Yue1b9c292021-09-10 10:08:31 +08001479/* Parse ServerHello message and configure context
1480 *
1481 * struct {
1482 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1483 * Random random;
1484 * opaque legacy_session_id_echo<0..32>;
1485 * CipherSuite cipher_suite;
1486 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001487 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001488 * } ServerHello;
1489 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001490MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001491static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1492 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001493 const unsigned char *end,
1494 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001495{
Jerry Yub85277e2021-10-13 13:36:05 +08001496 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001497 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001498 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001499 size_t extensions_len;
1500 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001501 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001502 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001503 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001504
1505 /*
1506 * Check there is space for minimal fields
1507 *
1508 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001509 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001510 * - legacy_session_id_echo ( 1 byte ), minimum size
1511 * - cipher_suite ( 2 bytes)
1512 * - legacy_compression_method ( 1 byte )
1513 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001514 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001515
1516 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001517 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1518
Jerry Yu4a173382021-10-11 21:45:31 +08001519 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001520 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001521 * ...
1522 * with ProtocolVersion defined as:
1523 * uint16 ProtocolVersion;
1524 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001525 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1526 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001527 {
1528 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1529 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1530 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001531 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1532 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001533 }
1534 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001535
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001536 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001537 * Random random;
1538 * ...
1539 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001540 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001541 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001542 if( !is_hrr )
1543 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001544 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001545 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1546 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1547 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1548 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001549 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001550
Jerry Yu4a173382021-10-11 21:45:31 +08001551 /* ...
1552 * opaque legacy_session_id_echo<0..32>;
1553 * ...
1554 */
1555 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001556 {
XiaokangQian52da5582022-01-26 09:49:29 +00001557 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001558 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001559 }
1560
Jerry Yu4a173382021-10-11 21:45:31 +08001561 /* ...
1562 * CipherSuite cipher_suite;
1563 * ...
1564 * with CipherSuite defined as:
1565 * uint8 CipherSuite[2];
1566 */
1567 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001568 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1569 p += 2;
1570
Jerry Yu4a173382021-10-11 21:45:31 +08001571
XiaokangQian355e09a2022-01-20 11:14:50 +00001572 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001573 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001574 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001575 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001576 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1577 ssl->tls_version,
1578 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001579 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001580 {
XiaokangQian52da5582022-01-26 09:49:29 +00001581 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001582 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001583 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001584 * If we received an HRR before and that the proposed selected
1585 * ciphersuite in this server hello is not the same as the one
1586 * proposed in the HRR, we abort the handshake and send an
1587 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001588 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001589 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1590 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001591 {
XiaokangQian52da5582022-01-26 09:49:29 +00001592 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001593 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001594
XiaokangQian52da5582022-01-26 09:49:29 +00001595 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001596 {
1597 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1598 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001599 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001600 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001601
Jerry Yu4a173382021-10-11 21:45:31 +08001602 /* Configure ciphersuites */
1603 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1604
XiaokangQian355e09a2022-01-20 11:14:50 +00001605 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001606 ssl->session_negotiate->ciphersuite = cipher_suite;
1607
Jerry Yue1b9c292021-09-10 10:08:31 +08001608 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1609 cipher_suite, ciphersuite_info->name ) );
1610
1611#if defined(MBEDTLS_HAVE_TIME)
1612 ssl->session_negotiate->start = time( NULL );
1613#endif /* MBEDTLS_HAVE_TIME */
1614
Jerry Yu4a173382021-10-11 21:45:31 +08001615 /* ...
1616 * uint8 legacy_compression_method = 0;
1617 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001618 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001619 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001620 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001621 {
Jerry Yub85277e2021-10-13 13:36:05 +08001622 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001623 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001624 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001625 }
1626 p++;
1627
Jerry Yub85277e2021-10-13 13:36:05 +08001628 /* ...
1629 * Extension extensions<6..2^16-1>;
1630 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001631 * struct {
1632 * ExtensionType extension_type; (2 bytes)
1633 * opaque extension_data<0..2^16-1>;
1634 * } Extension;
1635 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001636 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001637 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001638 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001639
Jerry Yu4a173382021-10-11 21:45:31 +08001640 /* Check extensions do not go beyond the buffer of data. */
1641 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1642 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001643
Jerry Yu4a173382021-10-11 21:45:31 +08001644 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001645
Jerry Yu4a173382021-10-11 21:45:31 +08001646 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001647 {
1648 unsigned int extension_type;
1649 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001650 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001651
Jerry Yu4a173382021-10-11 21:45:31 +08001652 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001653 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1654 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1655 p += 4;
1656
Jerry Yu4a173382021-10-11 21:45:31 +08001657 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001658 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001659
1660 switch( extension_type )
1661 {
XiaokangQianb851da82022-01-14 04:03:11 +00001662 case MBEDTLS_TLS_EXT_COOKIE:
1663
XiaokangQiand9e068e2022-01-18 06:23:32 +00001664 if( !is_hrr )
1665 {
XiaokangQian52da5582022-01-26 09:49:29 +00001666 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001667 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001668 }
1669
XiaokangQian43550bd2022-01-21 04:32:58 +00001670 ret = ssl_tls13_parse_cookie_ext( ssl,
1671 p, extension_data_end );
1672 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001673 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001674 MBEDTLS_SSL_DEBUG_RET( 1,
1675 "ssl_tls13_parse_cookie_ext",
1676 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001677 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001678 }
XiaokangQianb851da82022-01-14 04:03:11 +00001679 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001680
Jerry Yue1b9c292021-09-10 10:08:31 +08001681 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001682 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001683 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001684 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001685 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001686 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001687 break;
1688
XiaokangQianeb69aee2022-07-05 08:21:43 +00001689#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001690 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001691 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1692 if( is_hrr )
1693 {
1694 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1695 goto cleanup;
1696 }
Jerry Yu4a173382021-10-11 21:45:31 +08001697
XiaokangQian86981952022-07-19 09:51:50 +00001698 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001699 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001700 {
1701 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001702 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001703 return( ret );
1704 }
1705 break;
1706#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001707
Jerry Yue1b9c292021-09-10 10:08:31 +08001708 case MBEDTLS_TLS_EXT_KEY_SHARE:
1709 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001710 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1711 {
XiaokangQian52da5582022-01-26 09:49:29 +00001712 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001713 goto cleanup;
1714 }
1715
XiaokangQian53f20b72022-01-18 10:47:33 +00001716 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001717 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001718 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001719 else
XiaokangQianb851da82022-01-14 04:03:11 +00001720 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001721 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001722 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001723 {
1724 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001725 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001726 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001727 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001728 }
1729 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001730
1731 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001732 MBEDTLS_SSL_DEBUG_MSG(
1733 3,
1734 ( "unknown extension found: %u ( ignoring )",
1735 extension_type ) );
1736
XiaokangQian52da5582022-01-26 09:49:29 +00001737 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001738 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001739 }
1740
1741 p += extension_data_len;
1742 }
1743
XiaokangQiand59be772022-01-24 10:12:51 +00001744cleanup:
1745
XiaokangQian52da5582022-01-26 09:49:29 +00001746 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001747 {
1748 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1749 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1750 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1751 }
XiaokangQian52da5582022-01-26 09:49:29 +00001752 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001753 {
1754 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1755 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1756 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1757 }
1758 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001759}
1760
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001761#if defined(MBEDTLS_DEBUG_C)
1762static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001763{
1764 switch( mode )
1765 {
1766 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1767 return "psk";
1768 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1769 return "ephemeral";
1770 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1771 return "psk_ephemeral";
1772 default:
1773 return "unknown mode";
1774 }
1775}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001776#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001777
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001778MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001779static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001780{
Jerry Yub85277e2021-10-13 13:36:05 +08001781 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001782 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001783
Jerry Yub85277e2021-10-13 13:36:05 +08001784 /* Determine the key exchange mode:
1785 * 1) If both the pre_shared_key and key_share extensions were received
1786 * then the key exchange mode is PSK with EPHEMERAL.
1787 * 2) If only the pre_shared_key extension was received then the key
1788 * exchange mode is PSK-only.
1789 * 3) If only the key_share extension was received then the key
1790 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001791 */
Jerry Yub85277e2021-10-13 13:36:05 +08001792 switch( handshake->extensions_present &
1793 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001794 {
Jerry Yu745bb612021-10-13 22:01:04 +08001795 /* Only the pre_shared_key extension was received */
1796 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001797 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001798 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001799
Jerry Yu745bb612021-10-13 22:01:04 +08001800 /* Only the key_share extension was received */
1801 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001802 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001803 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001804
Jerry Yu745bb612021-10-13 22:01:04 +08001805 /* Both the pre_shared_key and key_share extensions were received */
1806 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001807 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001808 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001809
Jerry Yu745bb612021-10-13 22:01:04 +08001810 /* Neither pre_shared_key nor key_share extension was received */
1811 default:
1812 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1813 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1814 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001815 }
1816
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001817 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1818 {
1819 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1820 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001821 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001822 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001823 goto cleanup;
1824 }
1825
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001826 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001827 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001828 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001829
Jerry Yu0b177842021-09-05 19:41:30 +08001830 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1831 *
1832 * TODO: We don't have to do this in case we offered 0-RTT and the
1833 * server accepted it. In this case, we could skip generating
1834 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001835 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001836 if( ret != 0 )
1837 {
Jerry Yue110d252022-05-05 10:19:22 +08001838 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001839 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001840 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001841 }
1842
Jerry Yuf86eb752022-05-06 11:16:55 +08001843 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001844 if( ret != 0 )
1845 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001846 MBEDTLS_SSL_DEBUG_RET( 1,
1847 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001848 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001849 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001850 }
1851
Jerry Yue110d252022-05-05 10:19:22 +08001852 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001853 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1854 ssl->session_in = ssl->session_negotiate;
1855
Jerry Yu4a173382021-10-11 21:45:31 +08001856cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001857 if( ret != 0 )
1858 {
Jerry Yu4a173382021-10-11 21:45:31 +08001859 MBEDTLS_SSL_PEND_FATAL_ALERT(
1860 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1861 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1862 }
Jerry Yue110d252022-05-05 10:19:22 +08001863
Jerry Yu4a173382021-10-11 21:45:31 +08001864 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001865}
1866
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001867MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001868static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001869{
1870 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1871
XiaokangQian78b1fa72022-01-19 06:56:30 +00001872 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001873
XiaokangQian78b1fa72022-01-19 06:56:30 +00001874 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001875 * We are going to re-generate a shared secret corresponding to the group
1876 * selected by the server, which is different from the group for which we
1877 * generated a shared secret in the first client hello.
1878 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001879 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001880 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001881 if( ret != 0 )
1882 return( ret );
1883
1884 return( 0 );
1885}
1886
Jerry Yue1b9c292021-09-10 10:08:31 +08001887/*
Jerry Yu4a173382021-10-11 21:45:31 +08001888 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001889 * Handler for MBEDTLS_SSL_SERVER_HELLO
1890 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001891MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001892static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001893{
Jerry Yu4a173382021-10-11 21:45:31 +08001894 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001895 unsigned char *buf = NULL;
1896 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001897 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001898
1899 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1900
Ronald Crondb5dfa12022-05-31 11:44:38 +02001901 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1902 MBEDTLS_SSL_HS_SERVER_HELLO,
1903 &buf, &buf_len ) );
1904
Ronald Cron828aff62022-05-31 12:04:31 +02001905 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001906 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001907 goto cleanup;
1908 else
Ronald Cron828aff62022-05-31 12:04:31 +02001909 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001910
Ronald Cron828aff62022-05-31 12:04:31 +02001911 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001912 {
1913 ret = 0;
1914 goto cleanup;
1915 }
1916
XiaokangQianb851da82022-01-14 04:03:11 +00001917 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001918 buf + buf_len,
1919 is_hrr ) );
1920 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001921 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1922
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001923 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1924 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001925
XiaokangQiand9e068e2022-01-18 06:23:32 +00001926 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001927 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001928 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001929#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1930 /* If not offering early data, the client sends a dummy CCS record
1931 * immediately before its second flight. This may either be before
1932 * its second ClientHello or before its encrypted handshake flight.
1933 */
1934 mbedtls_ssl_handshake_set_state( ssl,
1935 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1936#else
1937 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1938#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1939 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001940 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001941 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001942 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001943 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1944 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001945
1946cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001947 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1948 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08001949 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08001950}
1951
1952/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001953 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001954 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001955 *
1956 * The EncryptedExtensions message contains any extensions which
1957 * should be protected, i.e., any which are not needed to establish
1958 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001959 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001960
XiaokangQian08da26c2021-10-09 10:12:11 +00001961/* Parse EncryptedExtensions message
1962 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001963 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001964 * } EncryptedExtensions;
1965 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001966MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00001967static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
1968 const unsigned char *buf,
1969 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001970{
1971 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001972 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00001973 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00001974 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001975
XiaokangQian08da26c2021-10-09 10:12:11 +00001976 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00001977 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001978 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001979
XiaokangQian97799ac2021-10-11 10:05:54 +00001980 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00001981 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02001982 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001983
XiaokangQian8db25ff2021-10-13 05:56:18 +00001984 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001985 {
XiaokangQian08da26c2021-10-09 10:12:11 +00001986 unsigned int extension_type;
1987 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001988
XiaokangQian08da26c2021-10-09 10:12:11 +00001989 /*
1990 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001991 * ExtensionType extension_type; (2 bytes)
1992 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001993 * } Extension;
1994 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00001995 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001996 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1997 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1998 p += 4;
1999
XiaokangQian8db25ff2021-10-13 05:56:18 +00002000 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002001
XiaokangQian97799ac2021-10-11 10:05:54 +00002002 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002003 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00002004 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002005 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002006 switch( extension_type )
2007 {
Jerry Yu661dd942022-08-03 14:50:01 +08002008 case MBEDTLS_TLS_EXT_SERVERNAME:
2009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002010
Jerry Yu661dd942022-08-03 14:50:01 +08002011 /* The server_name extension should be an empty extension */
2012
2013 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002014 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2015 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2016 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002017
lhuang0486cacac2022-01-21 07:34:27 -08002018#if defined(MBEDTLS_SSL_ALPN)
2019 case MBEDTLS_TLS_EXT_ALPN:
2020 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2021
2022 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2023 {
2024 return( ret );
2025 }
2026
2027 break;
2028#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002029 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002030 MBEDTLS_SSL_DEBUG_MSG(
2031 3, ( "unsupported extension found: %u ", extension_type) );
2032 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002033 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002034 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2035 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002036 }
2037
XiaokangQian08da26c2021-10-09 10:12:11 +00002038 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002039 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002040
XiaokangQian97799ac2021-10-11 10:05:54 +00002041 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002042 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002043 {
2044 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002045 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002046 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002047 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002048 }
2049
2050 return( ret );
2051}
2052
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002053MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002054static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2055{
2056 int ret;
2057 unsigned char *buf;
2058 size_t buf_len;
2059
2060 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2061
2062 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2063 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2064 &buf, &buf_len ) );
2065
2066 /* Process the message contents */
2067 MBEDTLS_SSL_PROC_CHK(
2068 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2069
2070 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2071 buf, buf_len );
2072
Ronald Cronfb508b82022-05-31 14:49:55 +02002073#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002074 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002075 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2076 else
2077 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2078#else
2079 ((void) ssl);
2080 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2081#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002082
2083cleanup:
2084
2085 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2086 return( ret );
2087
2088}
2089
Jerry Yua93ac112021-10-27 16:31:48 +08002090#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002091/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002092 * STATE HANDLING: CertificateRequest
2093 *
Jerry Yud2674312021-10-29 10:08:19 +08002094 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002095#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2096#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002097/* Coordination:
2098 * Deals with the ambiguity of not knowing if a CertificateRequest
2099 * will be sent. Returns a negative code on failure, or
2100 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2101 * - SSL_CERTIFICATE_REQUEST_SKIP
2102 * indicating if a Certificate Request is expected or not.
2103 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002104MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002105static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002106{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002107 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002108
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002109 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002110 {
2111 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2112 return( ret );
2113 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002114 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002115
2116 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2117 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2118 {
Ronald Cron19385882022-06-15 16:26:13 +02002119 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002120 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002121 }
2122
Ronald Cron19385882022-06-15 16:26:13 +02002123 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2124
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002125 return( SSL_CERTIFICATE_REQUEST_SKIP );
2126}
2127
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002128/*
2129 * ssl_tls13_parse_certificate_request()
2130 * Parse certificate request
2131 * struct {
2132 * opaque certificate_request_context<0..2^8-1>;
2133 * Extension extensions<2..2^16-1>;
2134 * } CertificateRequest;
2135 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002136MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002137static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2138 const unsigned char *buf,
2139 const unsigned char *end )
2140{
2141 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2142 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002143 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002144 size_t extensions_len = 0;
2145 const unsigned char *extensions_end;
2146 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002147
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002148 /* ...
2149 * opaque certificate_request_context<0..2^8-1>
2150 * ...
2151 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002152 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2153 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002154 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002155
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002156 if( certificate_request_context_len > 0 )
2157 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002158 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002159 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2160 p, certificate_request_context_len );
2161
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002162 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002163 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002164 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002165 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002166 {
2167 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2168 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2169 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002170 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002171 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002172 p += certificate_request_context_len;
2173 }
2174
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002175 /* ...
2176 * Extension extensions<2..2^16-1>;
2177 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002178 */
2179 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2180 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2181 p += 2;
2182
2183 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2184 extensions_end = p + extensions_len;
2185
2186 while( p < extensions_end )
2187 {
2188 unsigned int extension_type;
2189 size_t extension_data_len;
2190
2191 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2192 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2193 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2194 p += 4;
2195
2196 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2197
2198 switch( extension_type )
2199 {
2200 case MBEDTLS_TLS_EXT_SIG_ALG:
2201 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002202 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002203 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002204 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002205 if( ret != 0 )
2206 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002207 if( ! sig_alg_ext_found )
2208 sig_alg_ext_found = 1;
2209 else
2210 {
2211 MBEDTLS_SSL_DEBUG_MSG( 3,
2212 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002213 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002214 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002215 break;
2216
2217 default:
2218 MBEDTLS_SSL_DEBUG_MSG(
2219 3,
2220 ( "unknown extension found: %u ( ignoring )",
2221 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002222 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002223 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002224 p += extension_data_len;
2225 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002226 /* Check that we consumed all the message. */
2227 if( p != end )
2228 {
2229 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002230 ( "CertificateRequest misaligned" ) );
2231 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002232 }
2233 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002234 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002235 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002236 MBEDTLS_SSL_DEBUG_MSG( 3,
2237 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002238 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002239 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002240
Jerry Yu7840f812022-01-29 10:26:51 +08002241 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002242 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002243
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002244decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002245 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2246 MBEDTLS_ERR_SSL_DECODE_ERROR );
2247 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002248}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002249
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002250/*
2251 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2252 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002253MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002254static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002255{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002256 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002257
2258 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2259
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002260 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2261
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002262 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2263 {
2264 unsigned char *buf;
2265 size_t buf_len;
2266
2267 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2268 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2269 &buf, &buf_len ) );
2270
2271 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2272 buf, buf + buf_len ) );
2273
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002274 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2275 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002276 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002277 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002278 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002279 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002280 }
2281 else
2282 {
2283 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002284 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2285 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002286 }
2287
Jerry Yud2674312021-10-29 10:08:19 +08002288 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2289
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002290cleanup:
2291
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002292 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2293 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002294}
2295
2296/*
Jerry Yu687101b2021-09-14 16:03:56 +08002297 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2298 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002299MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002300static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002301{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002302 int ret;
2303
2304 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002305 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002306 return( ret );
2307
Jerry Yu687101b2021-09-14 16:03:56 +08002308 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2309 return( 0 );
2310}
2311
2312/*
2313 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2314 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002315MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002316static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002317{
Jerry Yu30b071c2021-09-12 20:16:03 +08002318 int ret;
2319
2320 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2321 if( ret != 0 )
2322 return( ret );
2323
Jerry Yu687101b2021-09-14 16:03:56 +08002324 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2325 return( 0 );
2326}
Jerry Yua93ac112021-10-27 16:31:48 +08002327#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002328
Jerry Yu687101b2021-09-14 16:03:56 +08002329/*
2330 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2331 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002332MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002333static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002334{
XiaokangQianac0385c2021-11-03 06:40:11 +00002335 int ret;
2336
XiaokangQianc5c39d52021-11-09 11:55:10 +00002337 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002338 if( ret != 0 )
2339 return( ret );
2340
Jerry Yue3d67cb2022-05-19 15:33:10 +08002341 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2342 if( ret != 0 )
2343 {
2344 MBEDTLS_SSL_PEND_FATAL_ALERT(
2345 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2346 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2347 return( ret );
2348 }
2349
Ronald Cron49ad6192021-11-24 16:25:31 +01002350#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2351 mbedtls_ssl_handshake_set_state(
2352 ssl,
2353 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2354#else
Jerry Yuca133a32022-02-15 14:22:05 +08002355 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002356#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002357
XiaokangQianac0385c2021-11-03 06:40:11 +00002358 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002359}
2360
2361/*
Jerry Yu566c7812022-01-26 15:41:22 +08002362 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2363 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002364MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002365static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2366{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002367 int non_empty_certificate_msg = 0;
2368
Jerry Yu5cc35062022-01-28 16:16:08 +08002369 MBEDTLS_SSL_DEBUG_MSG( 1,
2370 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002371 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002372
Ronald Cron9df7c802022-03-08 18:38:54 +01002373#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002374 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002375 {
2376 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2377 if( ret != 0 )
2378 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002379
Ronald Cron7a94aca2022-03-09 07:44:27 +01002380 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2381 non_empty_certificate_msg = 1;
2382 }
2383 else
2384 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002385 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002386 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002387#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002388
Ronald Cron7a94aca2022-03-09 07:44:27 +01002389 if( non_empty_certificate_msg )
2390 {
2391 mbedtls_ssl_handshake_set_state( ssl,
2392 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2393 }
2394 else
Ronald Cron19385882022-06-15 16:26:13 +02002395 {
2396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002397 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002398 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002399
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002400 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002401}
2402
Ronald Cron9df7c802022-03-08 18:38:54 +01002403#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002404/*
2405 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2406 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002407MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002408static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2409{
Ronald Crona8b38872022-03-09 07:59:25 +01002410 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2411
2412 if( ret == 0 )
2413 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2414
2415 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002416}
Jerry Yu90f152d2022-01-29 22:12:42 +08002417#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002418
2419/*
Jerry Yu687101b2021-09-14 16:03:56 +08002420 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2421 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002422MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002423static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002424{
XiaokangQian0fa66432021-11-15 03:33:57 +00002425 int ret;
2426
2427 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2428 if( ret != 0 )
2429 return( ret );
2430
Jerry Yu466dda82022-09-13 11:20:20 +08002431 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002432 if( ret != 0 )
2433 {
2434 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002435 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002436 return ( ret );
2437 }
2438
XiaokangQian0fa66432021-11-15 03:33:57 +00002439 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2440 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002441}
2442
2443/*
2444 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2445 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002446MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002447static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002448{
Jerry Yu378254d2021-10-30 21:44:47 +08002449 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002450 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002451 return( 0 );
2452}
2453
2454/*
2455 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2456 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002457MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002458static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002459{
Jerry Yu378254d2021-10-30 21:44:47 +08002460
2461 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2462
2463 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2464 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002465}
2466
Jerry Yuf8a49942022-07-07 11:32:32 +00002467#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2468
Jerry Yua0446a02022-07-13 11:22:55 +08002469MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002470static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2471 const unsigned char *buf,
2472 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002473{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002474 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002475
2476 ((void) ssl);
2477
2478 while( p < end )
2479 {
2480 unsigned int extension_type;
2481 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002482
Jerry Yuf8a49942022-07-07 11:32:32 +00002483 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2484 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2485 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2486 p += 4;
2487
2488 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002489
2490 switch( extension_type )
2491 {
2492 case MBEDTLS_TLS_EXT_EARLY_DATA:
2493 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2494 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002495
Jerry Yuf8a49942022-07-07 11:32:32 +00002496 default:
2497 break;
2498 }
2499 p += extension_data_len;
2500 }
2501
2502 return( 0 );
2503}
2504
2505/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002506 * From RFC8446, page 74
2507 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002508 * struct {
2509 * uint32 ticket_lifetime;
2510 * uint32 ticket_age_add;
2511 * opaque ticket_nonce<0..255>;
2512 * opaque ticket<1..2^16-1>;
2513 * Extension extensions<0..2^16-2>;
2514 * } NewSessionTicket;
2515 *
2516 */
Jerry Yua0446a02022-07-13 11:22:55 +08002517MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002518static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2519 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002520 unsigned char *end,
2521 unsigned char **ticket_nonce,
2522 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002523{
2524 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2525 unsigned char *p = buf;
2526 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002527 size_t ticket_len;
2528 unsigned char *ticket;
2529 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002530
Jerry Yucb3b1392022-07-12 06:09:38 +00002531 *ticket_nonce = NULL;
2532 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002533 /*
2534 * ticket_lifetime 4 bytes
2535 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002536 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002537 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002538 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002539
2540 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002541 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002542 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002543 ( unsigned int )session->ticket_lifetime ) );
2544
Jerry Yucb3b1392022-07-12 06:09:38 +00002545 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002546 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002547 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002548 ( unsigned int )session->ticket_age_add ) );
2549
Jerry Yucb3b1392022-07-12 06:09:38 +00002550 *ticket_nonce_len = p[8];
2551 p += 9;
2552
2553 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2554 *ticket_nonce = p;
2555 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2556 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002557
2558 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002559 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002560 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2561 p += 2;
2562 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002563 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2564
2565 /* Check if we previously received a ticket already. */
2566 if( session->ticket != NULL || session->ticket_len > 0 )
2567 {
2568 mbedtls_free( session->ticket );
2569 session->ticket = NULL;
2570 session->ticket_len = 0;
2571 }
2572
2573 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2574 {
2575 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2576 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2577 }
2578 memcpy( ticket, p, ticket_len );
2579 p += ticket_len;
2580 session->ticket = ticket;
2581 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002582
Jerry Yucb3b1392022-07-12 06:09:38 +00002583 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002584 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2585 p += 2;
2586 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2587
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002588 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002589
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002590 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002591 if( ret != 0 )
2592 {
2593 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002594 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002595 ret );
2596 return( ret );
2597 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002598
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002599 /* session has been updated, allow export */
2600 session->exported = 0;
2601
Jerry Yucb3b1392022-07-12 06:09:38 +00002602 return( 0 );
2603}
2604
Jerry Yua0446a02022-07-13 11:22:55 +08002605MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002606static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2607 unsigned char *ticket_nonce,
2608 size_t ticket_nonce_len )
2609{
2610 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2611 mbedtls_ssl_session *session = ssl->session;
2612 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2613 psa_algorithm_t psa_hash_alg;
2614 int hash_length;
2615
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002616#if defined(MBEDTLS_HAVE_TIME)
2617 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002618 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002619#endif
2620
Jerry Yuf8a49942022-07-07 11:32:32 +00002621 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2622 if( ciphersuite_info == NULL )
2623 {
2624 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2625 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2626 }
2627
2628 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2629 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002630 if( hash_length == -1 ||
2631 ( size_t )hash_length > sizeof( session->resumption_key ) )
2632 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002633 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002634 }
2635
Jerry Yuf8a49942022-07-07 11:32:32 +00002636
2637 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2638 session->app_secrets.resumption_master_secret,
2639 hash_length );
2640
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002641 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002642 *
2643 * HKDF-Expand-Label( resumption_master_secret,
2644 * "resumption", ticket_nonce, Hash.length )
2645 */
2646 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2647 psa_hash_alg,
2648 session->app_secrets.resumption_master_secret,
2649 hash_length,
2650 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2651 ticket_nonce,
2652 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002653 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002654 hash_length );
2655
2656 if( ret != 0 )
2657 {
2658 MBEDTLS_SSL_DEBUG_RET( 2,
2659 "Creating the ticket-resumed PSK failed",
2660 ret );
2661 return( ret );
2662 }
2663
Jerry Yu0a430c82022-07-20 11:02:48 +08002664 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002665
2666 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002667 session->resumption_key,
2668 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002669
Jerry Yuf8a49942022-07-07 11:32:32 +00002670 return( 0 );
2671}
2672
2673/*
Jerry Yua357cf42022-07-12 05:36:45 +00002674 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002675 */
Jerry Yua0446a02022-07-13 11:22:55 +08002676MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002677static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2678{
2679 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2680 unsigned char *buf;
2681 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002682 unsigned char *ticket_nonce;
2683 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002684
2685 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2686
2687 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2688 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2689 &buf, &buf_len ) );
2690
Jerry Yucb3b1392022-07-12 06:09:38 +00002691 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2692 ssl, buf, buf + buf_len,
2693 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002694
Jerry Yucb3b1392022-07-12 06:09:38 +00002695 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2696 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002697
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002698 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2699
Jerry Yuf8a49942022-07-07 11:32:32 +00002700cleanup:
2701
2702 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2703 return( ret );
2704}
2705#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2706
Jerry Yu92c6b402021-08-27 16:59:09 +08002707int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002708{
Jerry Yu92c6b402021-08-27 16:59:09 +08002709 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002710
Jerry Yu92c6b402021-08-27 16:59:09 +08002711 switch( ssl->state )
2712 {
2713 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002714 * ssl->state is initialized as HELLO_REQUEST. It is the same
2715 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002716 */
2717 case MBEDTLS_SSL_HELLO_REQUEST:
2718 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002719 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002720 break;
2721
2722 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002723 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002724 break;
2725
2726 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002727 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002728 break;
2729
Jerry Yua93ac112021-10-27 16:31:48 +08002730#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002731 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2732 ret = ssl_tls13_process_certificate_request( ssl );
2733 break;
2734
Jerry Yu687101b2021-09-14 16:03:56 +08002735 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002736 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002737 break;
2738
2739 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002740 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002741 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002742#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002743
2744 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002745 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002746 break;
2747
Jerry Yu566c7812022-01-26 15:41:22 +08002748 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2749 ret = ssl_tls13_write_client_certificate( ssl );
2750 break;
2751
Ronald Cron9df7c802022-03-08 18:38:54 +01002752#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002753 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2754 ret = ssl_tls13_write_client_certificate_verify( ssl );
2755 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002756#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002757
Jerry Yu687101b2021-09-14 16:03:56 +08002758 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002759 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002760 break;
2761
2762 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002763 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002764 break;
2765
2766 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002767 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002768 break;
2769
Ronald Cron49ad6192021-11-24 16:25:31 +01002770 /*
2771 * Injection of dummy-CCS's for middlebox compatibility
2772 */
2773#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002774 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002775 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2776 if( ret == 0 )
2777 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2778 break;
2779
2780 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2781 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2782 if( ret == 0 )
2783 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002784 break;
2785#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2786
Jerry Yuf8a49942022-07-07 11:32:32 +00002787#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002788 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002789 ret = ssl_tls13_process_new_session_ticket( ssl );
2790 if( ret != 0 )
2791 break;
2792 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2793 break;
2794#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2795
Jerry Yu92c6b402021-08-27 16:59:09 +08002796 default:
2797 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2798 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2799 }
2800
2801 return( ret );
2802}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002803
Jerry Yufb4b6472022-01-27 15:03:26 +08002804#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002805
Jerry Yufb4b6472022-01-27 15:03:26 +08002806