blob: 96a1e27b1e4abf5a8d539e321d84342597e492c0 [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yubdc71882021-09-14 19:30:36 +080035
Jerry Yubc20bdd2021-08-24 15:59:48 +080036/* Write extensions */
37
Jerry Yu92c6b402021-08-27 16:59:09 +080038/*
39 * ssl_tls13_write_supported_versions_ext():
40 *
41 * struct {
42 * ProtocolVersion versions<2..254>;
43 * } SupportedVersions;
44 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020045MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4436812021-08-26 22:59:56 +080046static int ssl_tls13_write_supported_versions_ext( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +080047 unsigned char *buf,
48 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +000049 size_t *out_len )
Jerry Yu92c6b402021-08-27 16:59:09 +080050{
51 unsigned char *p = buf;
Glenn Strausscd78df62022-04-07 19:07:11 -040052 unsigned char versions_len = ( ssl->handshake->min_tls_version <=
53 MBEDTLS_SSL_VERSION_TLS1_2 ) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080054
Xiaofei Baid25fab62021-12-02 06:36:27 +000055 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080056
Jerry Yu159c5a02021-08-31 12:51:25 +080057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported versions extension" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080058
Jerry Yu388bd0d2021-09-15 18:41:02 +080059 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080060 * - extension_type (2 bytes)
61 * - extension_data_length (2 bytes)
62 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020063 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080064 */
Ronald Crona77fc272022-03-30 17:20:47 +020065 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 5 + versions_len );
Ronald Crondbe87f02022-02-10 14:35:27 +010066
Jerry Yueecfbf02021-08-30 18:32:07 +080067 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0 );
Ronald Crondbe87f02022-02-10 14:35:27 +010068 MBEDTLS_PUT_UINT16_BE( versions_len + 1, p, 2 );
Jerry Yueecfbf02021-08-30 18:32:07 +080069 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080071 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010072 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080073
Jerry Yu0c63af62021-09-02 12:59:12 +080074 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080075 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010076 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080077 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -040078 mbedtls_ssl_write_version( p, MBEDTLS_SSL_TRANSPORT_STREAM,
79 MBEDTLS_SSL_VERSION_TLS1_3 );
Ronald Crondbe87f02022-02-10 14:35:27 +010080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:4]" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080081
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Glenn Strausscd78df62022-04-07 19:07:11 -040083 if( ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
Ronald Crondbe87f02022-02-10 14:35:27 +010084 {
Glenn Strausse3af4cb2022-03-15 03:23:42 -040085 mbedtls_ssl_write_version( p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2 );
Ronald Crondbe87f02022-02-10 14:35:27 +010087 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:3]" ) );
88 }
89
90 *out_len = 5 + versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080091
92 return( 0 );
93}
Jerry Yubc20bdd2021-08-24 15:59:48 +080094
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020095MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +080096static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
97 const unsigned char *buf,
Jerry Yub85277e2021-10-13 13:36:05 +080098 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +080099{
Jerry Yue1b9c292021-09-10 10:08:31 +0800100 ((void) ssl);
101
Ronald Cron98473382022-03-30 20:04:10 +0200102 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Glenn Strausse3af4cb2022-03-15 03:23:42 -0400103 if( mbedtls_ssl_read_version( buf, ssl->conf->transport ) !=
104 MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yue1b9c292021-09-10 10:08:31 +0800105 {
106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unexpected version" ) );
Jerry Yu4a173382021-10-11 21:45:31 +0800107
108 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
109 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
110 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue1b9c292021-09-10 10:08:31 +0800111 }
112
Ronald Cron98473382022-03-30 20:04:10 +0200113 if( &buf[2] != end )
114 {
115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "supported_versions ext data length incorrect" ) );
116 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
117 MBEDTLS_ERR_SSL_DECODE_ERROR );
118 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
119 }
120
Jerry Yue1b9c292021-09-10 10:08:31 +0800121 return( 0 );
122}
123
lhuang0486cacac2022-01-21 07:34:27 -0800124#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200125MBEDTLS_CHECK_RETURN_CRITICAL
lhuang0486cacac2022-01-21 07:34:27 -0800126static int ssl_tls13_parse_alpn_ext( mbedtls_ssl_context *ssl,
Ronald Cron81a334f2022-05-31 16:04:11 +0200127 const unsigned char *buf, size_t len )
lhuang0486cacac2022-01-21 07:34:27 -0800128{
lhuang0486cacac2022-01-21 07:34:27 -0800129 const unsigned char *p = buf;
130 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200131 size_t protocol_name_list_len, protocol_name_len;
132 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800133
134 /* If we didn't send it, the server shouldn't send it */
135 if( ssl->conf->alpn_list == NULL )
136 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
137
138 /*
139 * opaque ProtocolName<1..2^8-1>;
140 *
141 * struct {
142 * ProtocolName protocol_name_list<2..2^16-1>
143 * } ProtocolNameList;
144 *
145 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
146 */
147
Ronald Cron81a334f2022-05-31 16:04:11 +0200148 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
149 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
lhuang0486cacac2022-01-21 07:34:27 -0800150 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800151
Ronald Cron81a334f2022-05-31 16:04:11 +0200152 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
153 protocol_name_list_end = p + protocol_name_list_len;
154
155 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, 1 );
156 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800157
158 /* Check that the server chosen protocol was in our list and save it */
Ronald Cron81a334f2022-05-31 16:04:11 +0200159 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, protocol_name_len );
160 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
lhuang0486cacac2022-01-21 07:34:27 -0800161 {
Ronald Cron81a334f2022-05-31 16:04:11 +0200162 if( protocol_name_len == strlen( *alpn ) &&
163 memcmp( p, *alpn, protocol_name_len ) == 0 )
lhuang0486cacac2022-01-21 07:34:27 -0800164 {
165 ssl->alpn_chosen = *alpn;
166 return( 0 );
167 }
168 }
169
170 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian16acd4b2022-01-14 07:35:47 +0000175static int ssl_tls13_reset_key_share( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
XiaokangQian647719a2021-12-07 09:16:29 +0000179 if( group_id == 0 )
180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
181
XiaokangQian355e09a2022-01-20 11:14:50 +0000182#if defined(MBEDTLS_ECDH_C)
XiaokangQian647719a2021-12-07 09:16:29 +0000183 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
XiaokangQian78b1fa72022-01-19 06:56:30 +0000184 {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
189 status = psa_destroy_key( ssl->handshake->ecdh_psa_privkey );
190 if( status != PSA_SUCCESS )
191 {
192 ret = psa_ssl_status_to_mbedtls( status );
193 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
194 return( ret );
195 }
196
197 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
XiaokangQian78b1fa72022-01-19 06:56:30 +0000198 return( 0 );
199 }
XiaokangQian355e09a2022-01-20 11:14:50 +0000200 else
201#endif /* MBEDTLS_ECDH_C */
202 if( 0 /* other KEMs? */ )
XiaokangQian647719a2021-12-07 09:16:29 +0000203 {
204 /* Do something */
205 }
206
207 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
208}
209
210/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800211 * Functions for writing key_share extension.
212 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub60e3cf2021-09-08 16:41:02 +0800214static int ssl_tls13_get_default_group_id( mbedtls_ssl_context *ssl,
215 uint16_t *group_id )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800216{
217 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
218
Jerry Yu56fc07f2021-09-01 17:48:49 +0800219
Jerry Yu56fc07f2021-09-01 17:48:49 +0800220#if defined(MBEDTLS_ECDH_C)
Brett Warren14efd332021-10-06 09:32:11 +0100221 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Jerry Yu388bd0d2021-09-15 18:41:02 +0800222 /* Pick first available ECDHE group compatible with TLS 1.3 */
Brett Warren14efd332021-10-06 09:32:11 +0100223 if( group_list == NULL )
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
225
Brett Warren14efd332021-10-06 09:32:11 +0100226 for ( ; *group_list != 0; group_list++ )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800227 {
Xiaofei Baieef15042021-11-18 07:29:56 +0000228 const mbedtls_ecp_curve_info *curve_info;
229 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
230 if( curve_info != NULL &&
Brett Warren14efd332021-10-06 09:32:11 +0100231 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800232 {
Brett Warren14efd332021-10-06 09:32:11 +0100233 *group_id = *group_list;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800234 return( 0 );
235 }
236 }
237#else
238 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800239 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800240#endif /* MBEDTLS_ECDH_C */
241
242 /*
243 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800244 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 */
246
247 return( ret );
248}
249
250/*
251 * ssl_tls13_write_key_share_ext
252 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800253 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800254 *
255 * struct {
256 * NamedGroup group;
257 * opaque key_exchange<1..2^16-1>;
258 * } KeyShareEntry;
259 * struct {
260 * KeyShareEntry client_shares<0..2^16-1>;
261 * } KeyShareClientHello;
262 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200263MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
265 unsigned char *buf,
266 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000267 size_t *out_len )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268{
269 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000270 unsigned char *client_shares; /* Start of client_shares */
271 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
274
Xiaofei Baid25fab62021-12-02 06:36:27 +0000275 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800276
Jerry Yub60e3cf2021-09-08 16:41:02 +0800277 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 * - extension_type (2 bytes)
279 * - extension_data_length (2 bytes)
280 * - client_shares_length (2 bytes)
281 */
282 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
283 p += 6;
284
285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello: adding key share extension" ) );
286
287 /* HRR could already have requested something else. */
288 group_id = ssl->handshake->offered_group_id;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800289 if( !mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) &&
290 !mbedtls_ssl_tls13_named_group_is_dhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800291 {
Jerry Yub60e3cf2021-09-08 16:41:02 +0800292 MBEDTLS_SSL_PROC_CHK( ssl_tls13_get_default_group_id( ssl,
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 &group_id ) );
294 }
295
296 /*
297 * Dispatch to type-specific key generation function.
298 *
299 * So far, we're only supporting ECDHE. With the introduction
300 * of PQC KEMs, we'll want to have multiple branches, one per
301 * type of KEM, and dispatch to the corresponding crypto. And
302 * only one key share entry is allowed.
303 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000304 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800305#if defined(MBEDTLS_ECDH_C)
Jerry Yub60e3cf2021-09-08 16:41:02 +0800306 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800307 {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800308 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000309 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800310 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100311 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800312
313 /* Check there is space for header of KeyShareEntry
314 * - group (2 bytes)
315 * - key_exchange_length (2 bytes)
316 */
317 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 );
318 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800319 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
320 ssl, group_id, p, end, &key_exchange_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800321 p += key_exchange_len;
322 if( ret != 0 )
323 return( ret );
324
325 /* Write group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000326 MBEDTLS_PUT_UINT16_BE( group_id, group, 0 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Write key_exchange_length */
Xiaofei Baieef15042021-11-18 07:29:56 +0000328 MBEDTLS_PUT_UINT16_BE( key_exchange_len, group, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329 }
330 else
331#endif /* MBEDTLS_ECDH_C */
332 if( 0 /* other KEMs? */ )
333 {
334 /* Do something */
335 }
336 else
337 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
338
Jerry Yub60e3cf2021-09-08 16:41:02 +0800339 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000340 client_shares_len = p - client_shares;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800341 if( client_shares_len == 0)
342 {
343 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No key share defined." ) );
344 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu7c522d42021-09-08 17:55:09 +0800345 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800346 /* Write extension_type */
347 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
348 /* Write extension_data_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800349 MBEDTLS_PUT_UINT16_BE( client_shares_len + 2, buf, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350 /* Write client_shares_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800351 MBEDTLS_PUT_UINT16_BE( client_shares_len, buf, 4 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352
353 /* Update offered_group_id field */
354 ssl->handshake->offered_group_id = group_id;
355
356 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000357 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
Xiaofei Baid25fab62021-12-02 06:36:27 +0000359 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, key_share extension", buf, *out_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
361 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
362
363cleanup:
364
365 return( ret );
366}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800367
Jerry Yue1b9c292021-09-10 10:08:31 +0800368
XiaokangQiand59be772022-01-24 10:12:51 +0000369/*
370 * ssl_tls13_parse_hrr_key_share_ext()
371 * Parse key_share extension in Hello Retry Request
372 *
373 * struct {
374 * NamedGroup selected_group;
375 * } KeyShareHelloRetryRequest;
376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200377MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiand9e068e2022-01-18 06:23:32 +0000378static int ssl_tls13_parse_hrr_key_share_ext( mbedtls_ssl_context *ssl,
XiaokangQianb851da82022-01-14 04:03:11 +0000379 const unsigned char *buf,
380 const unsigned char *end )
381{
XiaokangQianb851da82022-01-14 04:03:11 +0000382 const mbedtls_ecp_curve_info *curve_info = NULL;
383 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000384 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000385 int found = 0;
386
387 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
388 if( group_list == NULL )
389 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
390
391 MBEDTLS_SSL_DEBUG_BUF( 3, "key_share extension", p, end - buf );
392
393 /* Read selected_group */
XiaokangQianb48894e2022-01-17 02:05:52 +0000394 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQiand59be772022-01-24 10:12:51 +0000395 selected_group = MBEDTLS_GET_UINT16_BE( p, 0 );
396 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_group ( %d )", selected_group ) );
XiaokangQianb851da82022-01-14 04:03:11 +0000397
398 /* Upon receipt of this extension in a HelloRetryRequest, the client
399 * MUST first verify that the selected_group field corresponds to a
400 * group which was provided in the "supported_groups" extension in the
401 * original ClientHello.
402 * The supported_group was based on the info in ssl->conf->group_list.
403 *
404 * If the server provided a key share that was not sent in the ClientHello
405 * then the client MUST abort the handshake with an "illegal_parameter" alert.
406 */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000407 for( ; *group_list != 0; group_list++ )
XiaokangQianb851da82022-01-14 04:03:11 +0000408 {
409 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
XiaokangQiand59be772022-01-24 10:12:51 +0000410 if( curve_info == NULL || curve_info->tls_id != selected_group )
XiaokangQianb851da82022-01-14 04:03:11 +0000411 continue;
412
413 /* We found a match */
414 found = 1;
415 break;
416 }
417
418 /* Client MUST verify that the selected_group field does not
419 * correspond to a group which was provided in the "key_share"
420 * extension in the original ClientHello. If the server sent an
421 * HRR message with a key share already provided in the
422 * ClientHello then the client MUST abort the handshake with
423 * an "illegal_parameter" alert.
424 */
XiaokangQiand59be772022-01-24 10:12:51 +0000425 if( found == 0 || selected_group == ssl->handshake->offered_group_id )
XiaokangQianb851da82022-01-14 04:03:11 +0000426 {
427 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid key share in HRR" ) );
428 MBEDTLS_SSL_PEND_FATAL_ALERT(
429 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
430 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
431 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
432 }
433
434 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000435 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000436
437 return( 0 );
438}
439
Jerry Yue1b9c292021-09-10 10:08:31 +0800440/*
Jerry Yub85277e2021-10-13 13:36:05 +0800441 * ssl_tls13_parse_key_share_ext()
442 * Parse key_share extension in Server Hello
443 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800444 * struct {
445 * KeyShareEntry server_share;
446 * } KeyShareServerHello;
447 * struct {
448 * NamedGroup group;
449 * opaque key_exchange<1..2^16-1>;
450 * } KeyShareEntry;
451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200452MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +0800453static int ssl_tls13_parse_key_share_ext( mbedtls_ssl_context *ssl,
Jerry Yue1b9c292021-09-10 10:08:31 +0800454 const unsigned char *buf,
455 const unsigned char *end )
456{
Jerry Yub85277e2021-10-13 13:36:05 +0800457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800458 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800459 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800460
Jerry Yu4a173382021-10-11 21:45:31 +0800461 /* ...
462 * NamedGroup group; (2 bytes)
463 * ...
464 */
465 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
466 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +0800467 p += 2;
468
Jerry Yu4a173382021-10-11 21:45:31 +0800469 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 offered_group = ssl->handshake->offered_group_id;
Jerry Yu4a173382021-10-11 21:45:31 +0800471 if( offered_group != group )
Jerry Yue1b9c292021-09-10 10:08:31 +0800472 {
473 MBEDTLS_SSL_DEBUG_MSG( 1,
474 ( "Invalid server key share, our group %u, their group %u",
Jerry Yu4a173382021-10-11 21:45:31 +0800475 (unsigned) offered_group, (unsigned) group ) );
476 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
477 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
478 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yue1b9c292021-09-10 10:08:31 +0800479 }
480
481#if defined(MBEDTLS_ECDH_C)
Jerry Yu4a173382021-10-11 21:45:31 +0800482 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
Jerry Yue1b9c292021-09-10 10:08:31 +0800483 {
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100484 const mbedtls_ecp_curve_info *curve_info =
485 mbedtls_ecp_curve_info_from_tls_id( group );
486 if( curve_info == NULL )
487 {
488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid TLS curve group id" ) );
489 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
490 }
491
492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
493
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000494 ret = mbedtls_ssl_tls13_read_public_ecdhe_share( ssl, p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +0800495 if( ret != 0 )
496 return( ret );
497 }
Jerry Yub85277e2021-10-13 13:36:05 +0800498 else
Jerry Yue1b9c292021-09-10 10:08:31 +0800499#endif /* MBEDTLS_ECDH_C */
Jerry Yub85277e2021-10-13 13:36:05 +0800500 if( 0 /* other KEMs? */ )
Jerry Yue1b9c292021-09-10 10:08:31 +0800501 {
502 /* Do something */
503 }
504 else
505 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
506
507 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
508 return( ret );
509}
510
XiaokangQiand59be772022-01-24 10:12:51 +0000511/*
512 * ssl_tls13_parse_cookie_ext()
513 * Parse cookie extension in Hello Retry Request
514 *
515 * struct {
516 * opaque cookie<1..2^16-1>;
517 * } Cookie;
518 *
519 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
520 * extension to the client (this is an exception to the usual rule that
521 * the only extensions that may be sent are those that appear in the
522 * ClientHello). When sending the new ClientHello, the client MUST copy
523 * the contents of the extension received in the HelloRetryRequest into
524 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
525 * cookies in their initial ClientHello in subsequent connections.
526 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200527MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian43550bd2022-01-21 04:32:58 +0000528static int ssl_tls13_parse_cookie_ext( mbedtls_ssl_context *ssl,
529 const unsigned char *buf,
530 const unsigned char *end )
531{
XiaokangQian25c9c902022-02-08 10:49:53 +0000532 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000533 const unsigned char *p = buf;
534 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
535
536 /* Retrieve length field of cookie */
537 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
538 cookie_len = MBEDTLS_GET_UINT16_BE( p, 0 );
539 p += 2;
540
541 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cookie_len );
542 MBEDTLS_SSL_DEBUG_BUF( 3, "cookie extension", p, cookie_len );
543
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000544 mbedtls_free( handshake->cookie );
XiaokangQian25c9c902022-02-08 10:49:53 +0000545 handshake->hrr_cookie_len = 0;
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000546 handshake->cookie = mbedtls_calloc( 1, cookie_len );
547 if( handshake->cookie == NULL )
XiaokangQian43550bd2022-01-21 04:32:58 +0000548 {
549 MBEDTLS_SSL_DEBUG_MSG( 1,
XiaokangQian25c9c902022-02-08 10:49:53 +0000550 ( "alloc failed ( %ud bytes )",
XiaokangQian43550bd2022-01-21 04:32:58 +0000551 cookie_len ) );
552 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
553 }
554
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000555 memcpy( handshake->cookie, p, cookie_len );
XiaokangQian25c9c902022-02-08 10:49:53 +0000556 handshake->hrr_cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000557
558 return( 0 );
559}
XiaokangQian43550bd2022-01-21 04:32:58 +0000560
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200561MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0b64eed2022-01-27 10:36:51 +0000562static int ssl_tls13_write_cookie_ext( mbedtls_ssl_context *ssl,
XiaokangQian233397e2022-02-07 08:32:16 +0000563 unsigned char *buf,
564 unsigned char *end,
XiaokangQian9deb90f2022-02-08 10:31:07 +0000565 size_t *out_len )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000566{
567 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000568 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000569 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000570
XiaokangQianc02768a2022-02-10 07:31:25 +0000571 if( handshake->cookie == NULL )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000572 {
573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no cookie to send; skip extension" ) );
574 return( 0 );
575 }
576
577 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, cookie",
XiaokangQianc02768a2022-02-10 07:31:25 +0000578 handshake->cookie,
579 handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000580
XiaokangQianc02768a2022-02-10 07:31:25 +0000581 MBEDTLS_SSL_CHK_BUF_PTR( p, end, handshake->hrr_cookie_len + 6 );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000582
583 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding cookie extension" ) );
584
XiaokangQian0b64eed2022-01-27 10:36:51 +0000585 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_COOKIE, p, 0 );
XiaokangQianc02768a2022-02-10 07:31:25 +0000586 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len + 2, p, 2 );
587 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len, p, 4 );
XiaokangQian233397e2022-02-07 08:32:16 +0000588 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000589
590 /* Cookie */
XiaokangQianc02768a2022-02-10 07:31:25 +0000591 memcpy( p, handshake->cookie, handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000592
XiaokangQianc02768a2022-02-10 07:31:25 +0000593 *out_len = handshake->hrr_cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000594
595 return( 0 );
596}
597
XiaokangQianeb69aee2022-07-05 08:21:43 +0000598#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
599/*
600 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
601 *
602 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
603 *
604 * struct {
605 * PskKeyExchangeMode ke_modes<1..255>;
606 * } PskKeyExchangeModes;
607 */
XiaokangQian86981952022-07-19 09:51:50 +0000608MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeb69aee2022-07-05 08:21:43 +0000609static int ssl_tls13_write_psk_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
610 unsigned char *buf,
611 unsigned char *end,
612 size_t *out_len )
613{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000615 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616
XiaokangQian008d2bf2022-07-14 07:54:01 +0000617 ((void) ke_modes_len );
XiaokangQianeb69aee2022-07-05 08:21:43 +0000618 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000619
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000621 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000622 */
XiaokangQian86981952022-07-19 09:51:50 +0000623 if( !mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000624 {
625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip psk_key_exchange_modes extension" ) );
626 return( 0 );
627 }
628
629 /* Require 7 bytes of data, otherwise fail,
630 * even if extension might be shorter.
631 */
632 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 );
633 MBEDTLS_SSL_DEBUG_MSG(
634 3, ( "client hello, adding psk_key_exchange_modes extension" ) );
635
XiaokangQianeb69aee2022-07-05 08:21:43 +0000636 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0 );
637
XiaokangQian008d2bf2022-07-14 07:54:01 +0000638 /* Skip extension length (2 bytes) and
639 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000640 */
641 p += 5;
642
643 if( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) )
644 {
645 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000646 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000647
648 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding pure PSK key exchange mode" ) );
649 }
650
651 if( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) )
652 {
653 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000654 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000655
656 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding PSK-ECDHE key exchange mode" ) );
657 }
658
XiaokangQian008d2bf2022-07-14 07:54:01 +0000659 /* Now write the extension and ke_modes length */
660 MBEDTLS_PUT_UINT16_BE( ke_modes_len + 1, buf, 2 );
661 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662
663 *out_len = p - buf;
664 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
665 return ( 0 );
666}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800667
Jerry Yuf7c12592022-09-28 22:09:38 +0800668static psa_algorithm_t ssl_tls13_ciphersuite_to_alg( mbedtls_ssl_context *ssl,
669 int ciphersuite )
670{
Jerry Yuf7c12592022-09-28 22:09:38 +0800671
Jerry Yu19ae6f62022-09-30 09:22:21 +0800672 psa_algorithm_t psa_alg;
673 if( mbedtls_ssl_tls13_ciphersuite_to_alg(
674 ssl, ciphersuite, &psa_alg ) != 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800675 {
Jerry Yu19ae6f62022-09-30 09:22:21 +0800676 /* ciphersuite is `ssl->session_negotiate->ciphersuite` or
677 * PSA_ALG_SHA256, both are validated before writting pre_shared_key.
678 */
679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "should never happen" ) );
680 return( PSA_ALG_NONE );
Jerry Yuf7c12592022-09-28 22:09:38 +0800681 }
Jerry Yu19ae6f62022-09-30 09:22:21 +0800682
683 return( psa_alg );
Jerry Yuf7c12592022-09-28 22:09:38 +0800684}
685
686static int ssl_tls13_has_configured_psk( mbedtls_ssl_context *ssl )
687{
688 return( ssl->conf->psk != NULL &&
689 ssl->conf->psk_len != 0 &&
690 ssl->conf->psk_identity != NULL &&
691 ssl->conf->psk_identity_len != 0 );
692}
693
694static int ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl )
695{
696
697#if defined(MBEDTLS_SSL_SESSION_TICKETS)
698 mbedtls_ssl_session *session = ssl->session_negotiate;
699 return( session != NULL &&
Jerry Yu19ae6f62022-09-30 09:22:21 +0800700 session->ticket != NULL );
Jerry Yuf7c12592022-09-28 22:09:38 +0800701#else
702 ((void) ssl);
703 return( 0 );
704#endif
705}
706
707#if defined(MBEDTLS_SSL_SESSION_TICKETS)
708
709MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800710static int ssl_tls13_ticket_get_identity( mbedtls_ssl_context *ssl,
711 psa_algorithm_t *psa_alg,
712 const unsigned char **identity,
713 size_t *identity_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800714{
715 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800716
717 *psa_alg = PSA_ALG_NONE;
718 *identity = NULL;
719 *identity_len = 0;
720
721 if( !ssl_tls13_has_configured_ticket( ssl ) )
722 return( -1 );
723
Jerry Yuf7c12592022-09-28 22:09:38 +0800724 *psa_alg = ssl_tls13_ciphersuite_to_alg( ssl, session->ciphersuite );
725 *identity = session->ticket;
726 *identity_len = session->ticket_len;
727 return( 0 );
728}
729
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800730MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800731static int ssl_tls13_ticket_get_psk( mbedtls_ssl_context *ssl,
732 psa_algorithm_t *psa_alg,
733 const unsigned char **psk,
734 size_t *psk_len )
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800735{
736
737 mbedtls_ssl_session *session = ssl->session_negotiate;
738
Jerry Yu8b41e892022-09-30 10:00:20 +0800739 *psa_alg = PSA_ALG_NONE;
740 *psk = NULL;
741 *psk_len = 0;
742
743 if( !ssl_tls13_has_configured_ticket( ssl ) )
744 return( -1 );
745
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800746 *psa_alg = ssl_tls13_ciphersuite_to_alg( ssl, session->ciphersuite );
747 *psk = session->resumption_key;
748 *psk_len = session->resumption_key_len;
749
750 return( 0 );
751}
752
Jerry Yuf7c12592022-09-28 22:09:38 +0800753#endif /* MBEDTLS_SSL_SESSION_TICKETS */
754
755MBEDTLS_CHECK_RETURN_CRITICAL
756static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
757 psa_algorithm_t *psa_alg,
758 const unsigned char **identity,
759 size_t *identity_len )
760{
Jerry Yu8b41e892022-09-30 10:00:20 +0800761 *psa_alg = PSA_ALG_NONE;
762 *identity = NULL;
763 *identity_len = 0;
764
765 if( !ssl_tls13_has_configured_psk( ssl ) )
766 return( -1 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800767
768 *psa_alg = PSA_ALG_SHA_256;
769 *identity = ssl->conf->psk_identity;
770 *identity_len = ssl->conf->psk_identity_len;
771 return( 0 );
772}
773
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800774MBEDTLS_CHECK_RETURN_CRITICAL
775static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
776 psa_algorithm_t *psa_alg,
777 const unsigned char **psk,
778 size_t *psk_len )
779{
Jerry Yu8b41e892022-09-30 10:00:20 +0800780 *psa_alg = PSA_ALG_NONE;
781 *psk = NULL;
782 *psk_len = 0;
783
784 if( !ssl_tls13_has_configured_psk( ssl ) )
785 return( -1 );
786
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800787 *psa_alg = PSA_ALG_SHA_256;
788 *psk = ssl->conf->psk;
789 *psk_len = ssl->conf->psk_len;
790 return( 0 );
791}
792
Jerry Yuf7c12592022-09-28 22:09:38 +0800793MBEDTLS_CHECK_RETURN_CRITICAL
794static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
795 unsigned char *buf,
796 unsigned char *end,
797 int psk_type,
798 size_t *out_len,
799 size_t *binder_len )
800{
801 unsigned char *p = buf;
802 psa_algorithm_t psa_alg;
803 const unsigned char *identity;
804 size_t identity_len;
805 uint32_t obfuscated_ticket_age = 0;
806 int hash_len;
807
808 *out_len = 0;
809 *binder_len = 0;
810
811 switch( psk_type )
812 {
813#if defined(MBEDTLS_SSL_SESSION_TICKETS)
814 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu8b41e892022-09-30 10:00:20 +0800815 if( ssl_tls13_ticket_get_identity(
Jerry Yuf7c12592022-09-28 22:09:38 +0800816 ssl, &psa_alg, &identity, &identity_len ) == 0 )
817 {
818#if defined(MBEDTLS_HAVE_TIME)
819 mbedtls_time_t now = mbedtls_time( NULL );
820 mbedtls_ssl_session *session = ssl->session_negotiate;
821 obfuscated_ticket_age =
822 (uint32_t)( now - session->ticket_received );
823 obfuscated_ticket_age *= 1000;
824 obfuscated_ticket_age += session->ticket_age_add ;
825#endif /* MBEDTLS_HAVE_TIME */
826 }
827 else
828 {
829 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
830 }
831 break;
832#endif /* MBEDTLS_SSL_SESSION_TICKETS */
833 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
834 if( ssl_tls13_psk_get_identity(
835 ssl, &psa_alg, &identity, &identity_len ) != 0 )
836 {
837 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
838 }
839 break;
840 default:
841 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
842 }
843
844 hash_len = PSA_HASH_LENGTH( psa_alg );
845 if( hash_len == -1 )
846 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
847
848 /*
849 * - identity_len (2 bytes)
850 * - identity (psk_identity_len bytes)
851 * - obfuscated_ticket_age (4 bytes)
852 */
853 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 + identity_len );
854
855 MBEDTLS_PUT_UINT16_BE( identity_len, p, 0 );
856 memcpy( p + 2, identity, identity_len );
857 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, p, 2 + identity_len );
858
859 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", p, 6 + identity_len );
860
861 *out_len = 6 + identity_len;
862 *binder_len = 1 + hash_len;
863
864 return( 0 );
865}
866
Jerry Yu8b41e892022-09-30 10:00:20 +0800867
868MBEDTLS_CHECK_RETURN_CRITICAL
869static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
870 unsigned char *buf,
871 unsigned char *end,
872 int psk_type,
873 size_t *out_len )
874{
875 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
876 unsigned char *p = buf;
877 const unsigned char *psk;
878 psa_algorithm_t psa_alg = PSA_ALG_NONE;
879 size_t psk_len;
880 unsigned char binder_len;
881 unsigned char transcript[MBEDTLS_MD_MAX_SIZE];
882 size_t transcript_len = 0;
883
884 *out_len = 0;
885
886 switch( psk_type )
887 {
888#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_HAVE_TIME)
889 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
890 if( ssl_tls13_ticket_get_psk( ssl, &psa_alg, &psk, &psk_len ) != 0 )
891 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
892 break;
893#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_HAVE_TIME*/
894 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
895 if( ssl_tls13_psk_get_psk( ssl, &psa_alg, &psk, &psk_len ) != 0 )
896 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
897 break;
898 default:
899 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
900 }
901
902 binder_len = PSA_HASH_LENGTH( psa_alg );
903 if( binder_len == 0 )
904 {
905 MBEDTLS_SSL_DEBUG_MSG( 3, ( "should never happen" ) );
906 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
907 }
908
909 /*
910 * - binder_len (1 bytes)
911 * - binder (binder_len bytes)
912 */
913 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + binder_len );
914
915 p[0] = binder_len;
916
917 /* Get current state of handshake transcript. */
918 ret = mbedtls_ssl_get_handshake_transcript(
919 ssl, mbedtls_hash_info_md_from_psa( psa_alg ),
920 transcript, MBEDTLS_MD_MAX_SIZE, &transcript_len );
921 if( ret != 0 )
922 return( ret );
923
924
925
926 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psa_alg,
927 psk, psk_len, psk_type,
928 transcript, p + 1 );
929 if( ret != 0 )
930 {
931 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
932 return( ret );
933 }
934 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", p, 1 + binder_len );
935
936 *out_len = 1 + binder_len;
937
938 return( ret );
939}
940
941/*
942 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
943 *
944 * struct {
945 * opaque identity<1..2^16-1>;
946 * uint32 obfuscated_ticket_age;
947 * } PskIdentity;
948 *
949 * opaque PskBinderEntry<32..255>;
950 *
951 * struct {
952 * PskIdentity identities<7..2^16-1>;
953 * PskBinderEntry binders<33..2^16-1>;
954 * } OfferedPsks;
955 *
956 * struct {
957 * select (Handshake.msg_type) {
958 * case client_hello: OfferedPsks;
959 * ...
960 * };
961 * } PreSharedKeyExtension;
962 *
963 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000964int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +0000965 mbedtls_ssl_context *ssl,
966 unsigned char *buf, unsigned char *end,
967 size_t *out_len, size_t *binders_len )
968{
Jerry Yuf7c12592022-09-28 22:09:38 +0800969 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
970 unsigned char *p = buf;
971 size_t l_binders_len = 0;
972
973 *out_len = 0;
974 *binders_len = 0;
975
976 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
977 if( !ssl_tls13_has_configured_psk( ssl ) &&
978 !ssl_tls13_has_configured_ticket( ssl ) )
979 {
980 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
981 return( 0 );
982 }
983
984 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
985 ssl_tls13_has_configured_psk( ssl ) +
986 ssl_tls13_has_configured_ticket( ssl ) ) );
987 /* Check if we have space to write the extension, binders included.
988 * - extension_type (2 bytes)
989 * - extension_data_len (2 bytes)
990 * - identities_len (2 bytes)
991 */
992 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
993 p += 6;
994
995 if( ssl_tls13_has_configured_ticket( ssl ) )
996 {
997 size_t output_len, binder_len;
998 ret = ssl_tls13_write_identity( ssl, p, end,
999 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1000 &output_len, &binder_len );
1001 if( ret != 0 )
1002 return( ret );
1003 p += output_len;
1004 l_binders_len += binder_len;
1005 }
1006
1007 if( ssl_tls13_has_configured_psk( ssl ) )
1008 {
1009 size_t output_len, binder_len;
1010 ret = ssl_tls13_write_identity( ssl, p, end,
1011 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1012 &output_len, &binder_len );
1013 if( ret != 0 )
1014 return( ret );
1015 p += output_len;
1016 l_binders_len += binder_len;
1017 }
1018
1019 MBEDTLS_SSL_DEBUG_MSG( 3,
1020 ( "client hello, adding pre_shared_key extension, "
1021 "omitting PSK binder list" ) );
1022 /*
1023 * - extension_type (2 bytes)
1024 * - extension_data_len (2 bytes)
1025 * - identities_len (2 bytes)
1026 */
1027 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
1028 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + 2 + l_binders_len , buf, 2 );
1029 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
1030
1031 /* Check if there are enough space for binders */
1032 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len + 2 );
1033
1034 *out_len = ( p - buf ) + l_binders_len + 2;
1035 *binders_len = l_binders_len + 2;
1036
1037 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
1038
1039 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1040
XiaokangQianeb69aee2022-07-05 08:21:43 +00001041 return( 0 );
1042}
1043
XiaokangQian86981952022-07-19 09:51:50 +00001044int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +08001045 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001046{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001047 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1048 unsigned char *p = buf;
1049
1050 /* Check if we have space to write binders_len.
1051 * - binders_len (2 bytes)
1052 */
1053 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1054 p += 2;
1055
1056 if( ssl_tls13_has_configured_ticket( ssl ) )
1057 {
1058 size_t output_len;
1059 ret = ssl_tls13_write_binder( ssl, p, end,
1060 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1061 &output_len );
1062 if( ret != 0 )
1063 return( ret );
1064 p += output_len;
1065 }
1066
1067 if( ssl_tls13_has_configured_psk( ssl ) )
1068 {
1069 size_t output_len;
1070 ret = ssl_tls13_write_binder( ssl, p, end,
1071 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1072 &output_len );
1073 if( ret != 0 )
1074 return( ret );
1075 p += output_len;
1076 }
1077
1078 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1079
1080 /*
1081 * - binders_len (2 bytes)
1082 */
1083 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1084
1085 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001086
1087 return( 0 );
1088}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001089
1090/*
1091 * struct {
1092 * opaque identity<1..2^16-1>;
1093 * uint32 obfuscated_ticket_age;
1094 * } PskIdentity;
1095 *
1096 * opaque PskBinderEntry<32..255>;
1097 *
1098 * struct {
1099 *
1100 * select (Handshake.msg_type) {
1101 * ...
1102 * case server_hello: uint16 selected_identity;
1103 * };
1104 *
1105 * } PreSharedKeyExtension;
1106 *
1107 */
1108MBEDTLS_CHECK_RETURN_CRITICAL
1109static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1110 const unsigned char *buf,
1111 const unsigned char *end )
1112{
Jerry Yub300e3c2022-09-28 22:12:07 +08001113 int ret = 0;
1114 int selected_identity;
1115 int psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1116 const unsigned char *psk;
1117 size_t psk_len;
1118 psa_algorithm_t psa_alg;
1119
1120 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 2 );
1121 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
1122 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
1123
1124 if( ssl_tls13_has_configured_psk( ssl ) &&
1125 ssl_tls13_has_configured_ticket( ssl ) )
1126 {
1127 if( selected_identity >= 2 )
1128 {
1129 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1130 goto exit;
1131 }
1132 switch( selected_identity )
1133 {
1134 case 0:
1135 psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
1136 break;
1137 case 1:
1138 psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1139 break;
1140 }
1141 }
1142 else if( ssl_tls13_has_configured_psk( ssl ) ||
1143 ssl_tls13_has_configured_ticket( ssl ) )
1144 {
1145 if( selected_identity >= 1 )
1146 {
1147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1148 goto exit;
1149 }
1150
1151 if( ssl_tls13_has_configured_psk( ssl ) )
1152 psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1153 else if( ssl_tls13_has_configured_ticket( ssl ) )
1154 psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
1155 }
1156 else
1157 {
1158 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1159 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1160 }
1161 switch( psk_type )
1162 {
1163#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1164 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
Jerry Yu8b41e892022-09-30 10:00:20 +08001165 ret = ssl_tls13_ticket_get_psk( ssl, &psa_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001166 break;
1167#endif
1168 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
1169 ret = ssl_tls13_psk_get_psk(
1170 ssl, &psa_alg, &psk, &psk_len );
1171 break;
1172 default:
1173 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1174 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1175 }
1176 if( ret != 0 )
1177 return( ret );
1178
1179 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1180 if( ret != 0 )
1181 {
1182 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
1183 }
1184 else
1185 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1186
1187 return( ret );
1188
1189exit:
1190 MBEDTLS_SSL_DEBUG_MSG(
1191 1, ( "Invalid chosen PSK identity." ) );
1192
1193 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1194 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1195 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001196}
1197
XiaokangQianeb69aee2022-07-05 08:21:43 +00001198#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1199
Ronald Cron3d580bf2022-02-18 17:24:56 +01001200int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1201 unsigned char *buf,
1202 unsigned char *end,
1203 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001204{
1205 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1206 unsigned char *p = buf;
1207 size_t ext_len;
1208
1209 *out_len = 0;
1210
1211 /* Write supported_versions extension
1212 *
1213 * Supported Versions Extension is mandatory with TLS 1.3.
1214 */
1215 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1216 if( ret != 0 )
1217 return( ret );
1218 p += ext_len;
1219
1220 /* Echo the cookie if the server provided one in its preceding
1221 * HelloRetryRequest message.
1222 */
1223 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1224 if( ret != 0 )
1225 return( ret );
1226 p += ext_len;
1227
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001228 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1229 {
1230 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1231 if( ret != 0 )
1232 return( ret );
1233 p += ext_len;
1234 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001235
XiaokangQianeb69aee2022-07-05 08:21:43 +00001236#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1237 /* For PSK-based key exchange we need the pre_shared_key extension
1238 * and the psk_key_exchange_modes extension.
1239 *
1240 * The pre_shared_key extension MUST be the last extension in the
1241 * ClientHello. Servers MUST check that it is the last extension and
1242 * otherwise fail the handshake with an "illegal_parameter" alert.
1243 *
1244 * Add the psk_key_exchange_modes extension.
1245 */
1246 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1247 if( ret != 0 )
1248 return( ret );
1249 p += ext_len;
1250#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1251
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001252 *out_len = p - buf;
1253
1254 return( 0 );
1255}
1256
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001257/*
Jerry Yu4a173382021-10-11 21:45:31 +08001258 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001259 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001260
Ronald Cronda41b382022-03-30 09:57:11 +02001261/**
1262 * \brief Detect if the ServerHello contains a supported_versions extension
1263 * or not.
1264 *
1265 * \param[in] ssl SSL context
1266 * \param[in] buf Buffer containing the ServerHello message
1267 * \param[in] end End of the buffer containing the ServerHello message
1268 *
1269 * \return 0 if the ServerHello does not contain a supported_versions extension
1270 * \return 1 if the ServerHello contains a supported_versions extension
1271 * \return A negative value if an error occurred while parsing the ServerHello.
1272 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001273MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001274static int ssl_tls13_is_supported_versions_ext_present(
1275 mbedtls_ssl_context *ssl,
1276 const unsigned char *buf,
1277 const unsigned char *end )
1278{
1279 const unsigned char *p = buf;
1280 size_t legacy_session_id_echo_len;
1281 size_t extensions_len;
1282 const unsigned char *extensions_end;
1283
1284 /*
1285 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001286 * length:
1287 * - legacy_version 2 bytes
1288 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1289 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001290 */
1291 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1292 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1293 legacy_session_id_echo_len = *p;
1294
1295 /*
1296 * Jump to the extensions, jumping over:
1297 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1298 * - cipher_suite 2 bytes
1299 * - legacy_compression_method 1 byte
1300 */
Ronald Cron28271062022-06-10 14:43:55 +02001301 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001302 p += legacy_session_id_echo_len + 4;
1303
1304 /* Case of no extension */
1305 if( p == end )
1306 return( 0 );
1307
1308 /* ...
1309 * Extension extensions<6..2^16-1>;
1310 * ...
1311 * struct {
1312 * ExtensionType extension_type; (2 bytes)
1313 * opaque extension_data<0..2^16-1>;
1314 * } Extension;
1315 */
1316 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1317 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1318 p += 2;
1319
1320 /* Check extensions do not go beyond the buffer of data. */
1321 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1322 extensions_end = p + extensions_len;
1323
1324 while( p < extensions_end )
1325 {
1326 unsigned int extension_type;
1327 size_t extension_data_len;
1328
1329 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1330 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1331 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1332 p += 4;
1333
1334 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1335 return( 1 );
1336
1337 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1338 p += extension_data_len;
1339 }
1340
1341 return( 0 );
1342}
1343
Jerry Yu7a186a02021-10-15 18:46:14 +08001344/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001345 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1346 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1347 * - 0 otherwise
1348 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001349MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001350static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1351 const unsigned char *buf,
1352 const unsigned char *end )
1353{
1354 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1355 static const unsigned char magic_downgrade_string[] =
1356 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1357 const unsigned char *last_eight_bytes_of_random;
1358 unsigned char last_byte_of_random;
1359
1360 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1361 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1362
1363 if( memcmp( last_eight_bytes_of_random,
1364 magic_downgrade_string,
1365 sizeof( magic_downgrade_string ) ) == 0 )
1366 {
1367 last_byte_of_random = last_eight_bytes_of_random[7];
1368 return( last_byte_of_random == 0 ||
1369 last_byte_of_random == 1 );
1370 }
1371
1372 return( 0 );
1373}
1374
1375/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001376 * - SSL_SERVER_HELLO or
1377 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001378 * to indicate which message is expected and to be parsed next.
1379 */
Ronald Cron828aff62022-05-31 12:04:31 +02001380#define SSL_SERVER_HELLO 0
1381#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001382MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001383static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1384 const unsigned char *buf,
1385 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001386{
Jerry Yue1b9c292021-09-10 10:08:31 +08001387
1388 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1389 *
Jerry Yu4a173382021-10-11 21:45:31 +08001390 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001391 * special value of the SHA-256 of "HelloRetryRequest".
1392 *
1393 * struct {
1394 * ProtocolVersion legacy_version = 0x0303;
1395 * Random random;
1396 * opaque legacy_session_id_echo<0..32>;
1397 * CipherSuite cipher_suite;
1398 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001399 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001400 * } ServerHello;
1401 *
1402 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001403 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1404 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001405
Jerry Yu93a13f22022-04-11 23:00:01 +08001406 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1407 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001408 {
Ronald Cron828aff62022-05-31 12:04:31 +02001409 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001410 }
1411
Ronald Cron828aff62022-05-31 12:04:31 +02001412 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001413}
1414
Ronald Cron828aff62022-05-31 12:04:31 +02001415/*
Jerry Yu745bb612021-10-13 22:01:04 +08001416 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001417 * - SSL_SERVER_HELLO or
1418 * - SSL_SERVER_HELLO_HRR or
1419 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001420 */
Ronald Cron828aff62022-05-31 12:04:31 +02001421#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001422MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001423static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001424 const unsigned char *buf,
1425 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001426{
Jerry Yu4a173382021-10-11 21:45:31 +08001427 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001428 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001429
Ronald Cron9f0fba32022-02-10 16:45:15 +01001430 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001431 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001432
Ronald Cron9f0fba32022-02-10 16:45:15 +01001433 if( ret == 0 )
1434 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001435 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001436 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001437
1438 /* If the server is negotiating TLS 1.2 or below and:
1439 * . we did not propose TLS 1.2 or
1440 * . the server responded it is TLS 1.3 capable but negotiating a lower
1441 * version of the protocol and thus we are under downgrade attack
1442 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001443 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001444 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001445 {
1446 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1447 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1448 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1449 }
1450
1451 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001452 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001453 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001454 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001455
1456 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1457 {
1458 ret = ssl_tls13_reset_key_share( ssl );
1459 if( ret != 0 )
1460 return( ret );
1461 }
1462
Ronald Cron828aff62022-05-31 12:04:31 +02001463 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001464 }
1465
Jerry Yua66fece2022-07-13 14:30:29 +08001466#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1467 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1468 ssl->session_negotiate->tls_version = ssl->tls_version;
1469#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1470
Ronald Cron5afb9042022-05-31 12:11:39 +02001471 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1472
Ronald Crondb5dfa12022-05-31 11:44:38 +02001473 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001474 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001475 {
Ronald Cron828aff62022-05-31 12:04:31 +02001476 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001477 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1478 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001479 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001480 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001481 /* If a client receives a second
1482 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1483 * was itself in response to a HelloRetryRequest), it MUST abort the
1484 * handshake with an "unexpected_message" alert.
1485 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001486 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001487 {
1488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1489 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1490 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1491 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1492 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001493 /*
1494 * Clients must abort the handshake with an "illegal_parameter"
1495 * alert if the HelloRetryRequest would not result in any change
1496 * in the ClientHello.
1497 * In a PSK only key exchange that what we expect.
1498 */
1499 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1500 {
1501 MBEDTLS_SSL_DEBUG_MSG( 1,
1502 ( "Unexpected HRR in pure PSK key exchange." ) );
1503 MBEDTLS_SSL_PEND_FATAL_ALERT(
1504 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1505 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1506 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1507 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001508
Ronald Cron5afb9042022-05-31 12:11:39 +02001509 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001510
Jerry Yu745bb612021-10-13 22:01:04 +08001511 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001512 }
1513
1514cleanup:
1515
1516 return( ret );
1517}
1518
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001519MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001520static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1521 const unsigned char **buf,
1522 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001523{
1524 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001525 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001526
Jerry Yude4fb2c2021-09-19 18:05:08 +08001527 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001528 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001529
Jerry Yu4a173382021-10-11 21:45:31 +08001530 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001531
1532 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001533 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1534 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001535 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001536 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1537 ssl->session_negotiate->id,
1538 ssl->session_negotiate->id_len );
1539 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001540 legacy_session_id_echo_len );
1541
1542 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1543 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1544
Jerry Yue1b9c292021-09-10 10:08:31 +08001545 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1546 }
1547
Jerry Yu4a173382021-10-11 21:45:31 +08001548 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001549 *buf = p;
1550
1551 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001552 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001553 return( 0 );
1554}
1555
Jerry Yue1b9c292021-09-10 10:08:31 +08001556/* Parse ServerHello message and configure context
1557 *
1558 * struct {
1559 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1560 * Random random;
1561 * opaque legacy_session_id_echo<0..32>;
1562 * CipherSuite cipher_suite;
1563 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001564 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001565 * } ServerHello;
1566 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001567MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001568static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1569 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001570 const unsigned char *end,
1571 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001572{
Jerry Yub85277e2021-10-13 13:36:05 +08001573 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001574 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001575 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001576 size_t extensions_len;
1577 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001578 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001579 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001580 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001581
1582 /*
1583 * Check there is space for minimal fields
1584 *
1585 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001586 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001587 * - legacy_session_id_echo ( 1 byte ), minimum size
1588 * - cipher_suite ( 2 bytes)
1589 * - legacy_compression_method ( 1 byte )
1590 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001591 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001592
1593 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001594 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1595
Jerry Yu4a173382021-10-11 21:45:31 +08001596 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001597 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001598 * ...
1599 * with ProtocolVersion defined as:
1600 * uint16 ProtocolVersion;
1601 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001602 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1603 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001604 {
1605 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1606 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1607 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001608 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1609 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001610 }
1611 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001612
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001613 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001614 * Random random;
1615 * ...
1616 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001617 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001618 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001619 if( !is_hrr )
1620 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001621 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001622 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1623 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1624 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1625 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001626 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001627
Jerry Yu4a173382021-10-11 21:45:31 +08001628 /* ...
1629 * opaque legacy_session_id_echo<0..32>;
1630 * ...
1631 */
1632 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001633 {
XiaokangQian52da5582022-01-26 09:49:29 +00001634 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001635 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001636 }
1637
Jerry Yu4a173382021-10-11 21:45:31 +08001638 /* ...
1639 * CipherSuite cipher_suite;
1640 * ...
1641 * with CipherSuite defined as:
1642 * uint8 CipherSuite[2];
1643 */
1644 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001645 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1646 p += 2;
1647
Jerry Yu4a173382021-10-11 21:45:31 +08001648
XiaokangQian355e09a2022-01-20 11:14:50 +00001649 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001650 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001651 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001652 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001653 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1654 ssl->tls_version,
1655 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001656 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001657 {
XiaokangQian52da5582022-01-26 09:49:29 +00001658 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001659 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001660 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001661 * If we received an HRR before and that the proposed selected
1662 * ciphersuite in this server hello is not the same as the one
1663 * proposed in the HRR, we abort the handshake and send an
1664 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001665 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001666 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1667 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001668 {
XiaokangQian52da5582022-01-26 09:49:29 +00001669 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001670 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001671
XiaokangQian52da5582022-01-26 09:49:29 +00001672 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001673 {
1674 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1675 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001676 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001677 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001678
Jerry Yu4a173382021-10-11 21:45:31 +08001679 /* Configure ciphersuites */
1680 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1681
XiaokangQian355e09a2022-01-20 11:14:50 +00001682 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001683 ssl->session_negotiate->ciphersuite = cipher_suite;
1684
Jerry Yue1b9c292021-09-10 10:08:31 +08001685 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1686 cipher_suite, ciphersuite_info->name ) );
1687
1688#if defined(MBEDTLS_HAVE_TIME)
1689 ssl->session_negotiate->start = time( NULL );
1690#endif /* MBEDTLS_HAVE_TIME */
1691
Jerry Yu4a173382021-10-11 21:45:31 +08001692 /* ...
1693 * uint8 legacy_compression_method = 0;
1694 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001695 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001696 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001697 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001698 {
Jerry Yub85277e2021-10-13 13:36:05 +08001699 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001700 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001701 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001702 }
1703 p++;
1704
Jerry Yub85277e2021-10-13 13:36:05 +08001705 /* ...
1706 * Extension extensions<6..2^16-1>;
1707 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001708 * struct {
1709 * ExtensionType extension_type; (2 bytes)
1710 * opaque extension_data<0..2^16-1>;
1711 * } Extension;
1712 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001713 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001714 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001715 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001716
Jerry Yu4a173382021-10-11 21:45:31 +08001717 /* Check extensions do not go beyond the buffer of data. */
1718 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1719 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001720
Jerry Yu4a173382021-10-11 21:45:31 +08001721 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001722
Jerry Yu4a173382021-10-11 21:45:31 +08001723 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001724 {
1725 unsigned int extension_type;
1726 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001727 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001728
Jerry Yu4a173382021-10-11 21:45:31 +08001729 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001730 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1731 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1732 p += 4;
1733
Jerry Yu4a173382021-10-11 21:45:31 +08001734 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001735 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001736
1737 switch( extension_type )
1738 {
XiaokangQianb851da82022-01-14 04:03:11 +00001739 case MBEDTLS_TLS_EXT_COOKIE:
1740
XiaokangQiand9e068e2022-01-18 06:23:32 +00001741 if( !is_hrr )
1742 {
XiaokangQian52da5582022-01-26 09:49:29 +00001743 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001744 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001745 }
1746
XiaokangQian43550bd2022-01-21 04:32:58 +00001747 ret = ssl_tls13_parse_cookie_ext( ssl,
1748 p, extension_data_end );
1749 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001750 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001751 MBEDTLS_SSL_DEBUG_RET( 1,
1752 "ssl_tls13_parse_cookie_ext",
1753 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001754 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001755 }
XiaokangQianb851da82022-01-14 04:03:11 +00001756 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001757
Jerry Yue1b9c292021-09-10 10:08:31 +08001758 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001759 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001760 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001761 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001762 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001763 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001764 break;
1765
XiaokangQianeb69aee2022-07-05 08:21:43 +00001766#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001767 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001768 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1769 if( is_hrr )
1770 {
1771 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1772 goto cleanup;
1773 }
Jerry Yu4a173382021-10-11 21:45:31 +08001774
XiaokangQian86981952022-07-19 09:51:50 +00001775 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001776 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001777 {
1778 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001779 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001780 return( ret );
1781 }
1782 break;
1783#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001784
Jerry Yue1b9c292021-09-10 10:08:31 +08001785 case MBEDTLS_TLS_EXT_KEY_SHARE:
1786 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001787 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1788 {
XiaokangQian52da5582022-01-26 09:49:29 +00001789 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001790 goto cleanup;
1791 }
1792
XiaokangQian53f20b72022-01-18 10:47:33 +00001793 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001794 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001795 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001796 else
XiaokangQianb851da82022-01-14 04:03:11 +00001797 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001798 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001799 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001800 {
1801 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001802 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001803 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001804 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001805 }
1806 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001807
1808 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001809 MBEDTLS_SSL_DEBUG_MSG(
1810 3,
1811 ( "unknown extension found: %u ( ignoring )",
1812 extension_type ) );
1813
XiaokangQian52da5582022-01-26 09:49:29 +00001814 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001815 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001816 }
1817
1818 p += extension_data_len;
1819 }
1820
XiaokangQiand59be772022-01-24 10:12:51 +00001821cleanup:
1822
XiaokangQian52da5582022-01-26 09:49:29 +00001823 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001824 {
1825 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1826 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1827 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1828 }
XiaokangQian52da5582022-01-26 09:49:29 +00001829 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001830 {
1831 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1832 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1833 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1834 }
1835 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001836}
1837
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001838#if defined(MBEDTLS_DEBUG_C)
1839static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001840{
1841 switch( mode )
1842 {
1843 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1844 return "psk";
1845 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1846 return "ephemeral";
1847 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1848 return "psk_ephemeral";
1849 default:
1850 return "unknown mode";
1851 }
1852}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001853#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001854
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001855MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001856static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001857{
Jerry Yub85277e2021-10-13 13:36:05 +08001858 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001859 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001860
Jerry Yub85277e2021-10-13 13:36:05 +08001861 /* Determine the key exchange mode:
1862 * 1) If both the pre_shared_key and key_share extensions were received
1863 * then the key exchange mode is PSK with EPHEMERAL.
1864 * 2) If only the pre_shared_key extension was received then the key
1865 * exchange mode is PSK-only.
1866 * 3) If only the key_share extension was received then the key
1867 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001868 */
Jerry Yub85277e2021-10-13 13:36:05 +08001869 switch( handshake->extensions_present &
1870 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001871 {
Jerry Yu745bb612021-10-13 22:01:04 +08001872 /* Only the pre_shared_key extension was received */
1873 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001874 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001875 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001876
Jerry Yu745bb612021-10-13 22:01:04 +08001877 /* Only the key_share extension was received */
1878 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001879 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001880 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001881
Jerry Yu745bb612021-10-13 22:01:04 +08001882 /* Both the pre_shared_key and key_share extensions were received */
1883 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001884 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001885 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001886
Jerry Yu745bb612021-10-13 22:01:04 +08001887 /* Neither pre_shared_key nor key_share extension was received */
1888 default:
1889 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1890 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1891 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001892 }
1893
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001894 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1895 {
1896 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1897 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001898 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001899 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001900 goto cleanup;
1901 }
1902
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001903 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001904 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001905 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001906
Jerry Yu0b177842021-09-05 19:41:30 +08001907 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1908 *
1909 * TODO: We don't have to do this in case we offered 0-RTT and the
1910 * server accepted it. In this case, we could skip generating
1911 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001912 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001913 if( ret != 0 )
1914 {
Jerry Yue110d252022-05-05 10:19:22 +08001915 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001916 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001917 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001918 }
1919
Jerry Yuf86eb752022-05-06 11:16:55 +08001920 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001921 if( ret != 0 )
1922 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001923 MBEDTLS_SSL_DEBUG_RET( 1,
1924 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001925 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001926 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001927 }
1928
Jerry Yue110d252022-05-05 10:19:22 +08001929 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001930 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1931 ssl->session_in = ssl->session_negotiate;
1932
Jerry Yu4a173382021-10-11 21:45:31 +08001933cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001934 if( ret != 0 )
1935 {
Jerry Yu4a173382021-10-11 21:45:31 +08001936 MBEDTLS_SSL_PEND_FATAL_ALERT(
1937 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1938 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1939 }
Jerry Yue110d252022-05-05 10:19:22 +08001940
Jerry Yu4a173382021-10-11 21:45:31 +08001941 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001942}
1943
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001944MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001945static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001946{
1947 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1948
XiaokangQian78b1fa72022-01-19 06:56:30 +00001949 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001950
XiaokangQian78b1fa72022-01-19 06:56:30 +00001951 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001952 * We are going to re-generate a shared secret corresponding to the group
1953 * selected by the server, which is different from the group for which we
1954 * generated a shared secret in the first client hello.
1955 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001956 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001957 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001958 if( ret != 0 )
1959 return( ret );
1960
1961 return( 0 );
1962}
1963
Jerry Yue1b9c292021-09-10 10:08:31 +08001964/*
Jerry Yu4a173382021-10-11 21:45:31 +08001965 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001966 * Handler for MBEDTLS_SSL_SERVER_HELLO
1967 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001968MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001969static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001970{
Jerry Yu4a173382021-10-11 21:45:31 +08001971 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001972 unsigned char *buf = NULL;
1973 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001974 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001975
1976 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1977
Ronald Crondb5dfa12022-05-31 11:44:38 +02001978 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1979 MBEDTLS_SSL_HS_SERVER_HELLO,
1980 &buf, &buf_len ) );
1981
Ronald Cron828aff62022-05-31 12:04:31 +02001982 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001983 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001984 goto cleanup;
1985 else
Ronald Cron828aff62022-05-31 12:04:31 +02001986 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001987
Ronald Cron828aff62022-05-31 12:04:31 +02001988 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001989 {
1990 ret = 0;
1991 goto cleanup;
1992 }
1993
XiaokangQianb851da82022-01-14 04:03:11 +00001994 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001995 buf + buf_len,
1996 is_hrr ) );
1997 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001998 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1999
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002000 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
2001 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00002002
XiaokangQiand9e068e2022-01-18 06:23:32 +00002003 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02002004 {
XiaokangQian355e09a2022-01-20 11:14:50 +00002005 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02002006#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2007 /* If not offering early data, the client sends a dummy CCS record
2008 * immediately before its second flight. This may either be before
2009 * its second ClientHello or before its encrypted handshake flight.
2010 */
2011 mbedtls_ssl_handshake_set_state( ssl,
2012 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
2013#else
2014 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2015#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2016 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00002017 else
Ronald Cronfb508b82022-05-31 14:49:55 +02002018 {
XiaokangQian355e09a2022-01-20 11:14:50 +00002019 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02002020 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
2021 }
Jerry Yue1b9c292021-09-10 10:08:31 +08002022
2023cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00002024 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
2025 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08002026 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08002027}
2028
2029/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002030 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002031 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002032 *
2033 * The EncryptedExtensions message contains any extensions which
2034 * should be protected, i.e., any which are not needed to establish
2035 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002036 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002037
XiaokangQian08da26c2021-10-09 10:12:11 +00002038/* Parse EncryptedExtensions message
2039 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002040 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002041 * } EncryptedExtensions;
2042 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002043MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00002044static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
2045 const unsigned char *buf,
2046 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002047{
2048 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002049 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002050 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002051 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002052
XiaokangQian08da26c2021-10-09 10:12:11 +00002053 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00002054 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002055 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002056
XiaokangQian97799ac2021-10-11 10:05:54 +00002057 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00002058 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02002059 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002060
XiaokangQian8db25ff2021-10-13 05:56:18 +00002061 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002062 {
XiaokangQian08da26c2021-10-09 10:12:11 +00002063 unsigned int extension_type;
2064 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002065
XiaokangQian08da26c2021-10-09 10:12:11 +00002066 /*
2067 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002068 * ExtensionType extension_type; (2 bytes)
2069 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002070 * } Extension;
2071 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00002072 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002073 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2074 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2075 p += 4;
2076
XiaokangQian8db25ff2021-10-13 05:56:18 +00002077 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002078
XiaokangQian97799ac2021-10-11 10:05:54 +00002079 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002080 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00002081 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002082 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002083 switch( extension_type )
2084 {
Jerry Yu661dd942022-08-03 14:50:01 +08002085 case MBEDTLS_TLS_EXT_SERVERNAME:
2086 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002087
Jerry Yu661dd942022-08-03 14:50:01 +08002088 /* The server_name extension should be an empty extension */
2089
2090 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002091 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2092 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2093 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002094
lhuang0486cacac2022-01-21 07:34:27 -08002095#if defined(MBEDTLS_SSL_ALPN)
2096 case MBEDTLS_TLS_EXT_ALPN:
2097 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2098
2099 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2100 {
2101 return( ret );
2102 }
2103
2104 break;
2105#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002106 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002107 MBEDTLS_SSL_DEBUG_MSG(
2108 3, ( "unsupported extension found: %u ", extension_type) );
2109 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002110 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002111 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2112 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002113 }
2114
XiaokangQian08da26c2021-10-09 10:12:11 +00002115 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002116 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002117
XiaokangQian97799ac2021-10-11 10:05:54 +00002118 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002119 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002120 {
2121 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002122 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002123 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002124 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002125 }
2126
2127 return( ret );
2128}
2129
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002130MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002131static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2132{
2133 int ret;
2134 unsigned char *buf;
2135 size_t buf_len;
2136
2137 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2138
2139 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2140 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2141 &buf, &buf_len ) );
2142
2143 /* Process the message contents */
2144 MBEDTLS_SSL_PROC_CHK(
2145 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2146
2147 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2148 buf, buf_len );
2149
Ronald Cronfb508b82022-05-31 14:49:55 +02002150#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002151 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002152 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2153 else
2154 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2155#else
2156 ((void) ssl);
2157 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2158#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002159
2160cleanup:
2161
2162 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2163 return( ret );
2164
2165}
2166
Jerry Yua93ac112021-10-27 16:31:48 +08002167#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002168/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002169 * STATE HANDLING: CertificateRequest
2170 *
Jerry Yud2674312021-10-29 10:08:19 +08002171 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002172#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2173#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002174/* Coordination:
2175 * Deals with the ambiguity of not knowing if a CertificateRequest
2176 * will be sent. Returns a negative code on failure, or
2177 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2178 * - SSL_CERTIFICATE_REQUEST_SKIP
2179 * indicating if a Certificate Request is expected or not.
2180 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002181MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002182static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002183{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002184 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002185
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002186 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002187 {
2188 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2189 return( ret );
2190 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002191 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002192
2193 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2194 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2195 {
Ronald Cron19385882022-06-15 16:26:13 +02002196 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002197 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002198 }
2199
Ronald Cron19385882022-06-15 16:26:13 +02002200 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2201
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002202 return( SSL_CERTIFICATE_REQUEST_SKIP );
2203}
2204
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002205/*
2206 * ssl_tls13_parse_certificate_request()
2207 * Parse certificate request
2208 * struct {
2209 * opaque certificate_request_context<0..2^8-1>;
2210 * Extension extensions<2..2^16-1>;
2211 * } CertificateRequest;
2212 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002213MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002214static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2215 const unsigned char *buf,
2216 const unsigned char *end )
2217{
2218 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2219 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002220 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002221 size_t extensions_len = 0;
2222 const unsigned char *extensions_end;
2223 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002224
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002225 /* ...
2226 * opaque certificate_request_context<0..2^8-1>
2227 * ...
2228 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002229 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2230 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002231 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002232
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002233 if( certificate_request_context_len > 0 )
2234 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002235 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002236 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2237 p, certificate_request_context_len );
2238
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002239 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002240 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002241 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002242 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002243 {
2244 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2245 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2246 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002247 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002248 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002249 p += certificate_request_context_len;
2250 }
2251
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002252 /* ...
2253 * Extension extensions<2..2^16-1>;
2254 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002255 */
2256 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2257 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2258 p += 2;
2259
2260 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2261 extensions_end = p + extensions_len;
2262
2263 while( p < extensions_end )
2264 {
2265 unsigned int extension_type;
2266 size_t extension_data_len;
2267
2268 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2269 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2270 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2271 p += 4;
2272
2273 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2274
2275 switch( extension_type )
2276 {
2277 case MBEDTLS_TLS_EXT_SIG_ALG:
2278 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002279 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002280 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002281 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002282 if( ret != 0 )
2283 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002284 if( ! sig_alg_ext_found )
2285 sig_alg_ext_found = 1;
2286 else
2287 {
2288 MBEDTLS_SSL_DEBUG_MSG( 3,
2289 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002290 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002291 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002292 break;
2293
2294 default:
2295 MBEDTLS_SSL_DEBUG_MSG(
2296 3,
2297 ( "unknown extension found: %u ( ignoring )",
2298 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002299 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002300 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002301 p += extension_data_len;
2302 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002303 /* Check that we consumed all the message. */
2304 if( p != end )
2305 {
2306 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002307 ( "CertificateRequest misaligned" ) );
2308 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002309 }
2310 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002311 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002312 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002313 MBEDTLS_SSL_DEBUG_MSG( 3,
2314 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002315 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002316 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002317
Jerry Yu7840f812022-01-29 10:26:51 +08002318 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002319 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002320
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002321decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002322 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2323 MBEDTLS_ERR_SSL_DECODE_ERROR );
2324 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002325}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002326
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002327/*
2328 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2329 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002330MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002331static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002332{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002333 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002334
2335 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2336
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002337 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2338
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002339 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2340 {
2341 unsigned char *buf;
2342 size_t buf_len;
2343
2344 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2345 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2346 &buf, &buf_len ) );
2347
2348 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2349 buf, buf + buf_len ) );
2350
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002351 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2352 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002353 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002354 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002355 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002356 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002357 }
2358 else
2359 {
2360 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002361 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2362 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002363 }
2364
Jerry Yud2674312021-10-29 10:08:19 +08002365 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2366
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002367cleanup:
2368
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002369 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2370 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002371}
2372
2373/*
Jerry Yu687101b2021-09-14 16:03:56 +08002374 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2375 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002376MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002377static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002378{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002379 int ret;
2380
2381 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002382 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002383 return( ret );
2384
Jerry Yu687101b2021-09-14 16:03:56 +08002385 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2386 return( 0 );
2387}
2388
2389/*
2390 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2391 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002392MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002393static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002394{
Jerry Yu30b071c2021-09-12 20:16:03 +08002395 int ret;
2396
2397 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2398 if( ret != 0 )
2399 return( ret );
2400
Jerry Yu687101b2021-09-14 16:03:56 +08002401 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2402 return( 0 );
2403}
Jerry Yua93ac112021-10-27 16:31:48 +08002404#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002405
Jerry Yu687101b2021-09-14 16:03:56 +08002406/*
2407 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2408 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002409MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002410static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002411{
XiaokangQianac0385c2021-11-03 06:40:11 +00002412 int ret;
2413
XiaokangQianc5c39d52021-11-09 11:55:10 +00002414 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002415 if( ret != 0 )
2416 return( ret );
2417
Jerry Yue3d67cb2022-05-19 15:33:10 +08002418 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2419 if( ret != 0 )
2420 {
2421 MBEDTLS_SSL_PEND_FATAL_ALERT(
2422 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2423 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2424 return( ret );
2425 }
2426
Ronald Cron49ad6192021-11-24 16:25:31 +01002427#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2428 mbedtls_ssl_handshake_set_state(
2429 ssl,
2430 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2431#else
Jerry Yuca133a32022-02-15 14:22:05 +08002432 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002433#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002434
XiaokangQianac0385c2021-11-03 06:40:11 +00002435 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002436}
2437
2438/*
Jerry Yu566c7812022-01-26 15:41:22 +08002439 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2440 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002441MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002442static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2443{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002444 int non_empty_certificate_msg = 0;
2445
Jerry Yu5cc35062022-01-28 16:16:08 +08002446 MBEDTLS_SSL_DEBUG_MSG( 1,
2447 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002448 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002449
Ronald Cron9df7c802022-03-08 18:38:54 +01002450#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002451 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002452 {
2453 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2454 if( ret != 0 )
2455 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002456
Ronald Cron7a94aca2022-03-09 07:44:27 +01002457 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2458 non_empty_certificate_msg = 1;
2459 }
2460 else
2461 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002462 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002463 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002464#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002465
Ronald Cron7a94aca2022-03-09 07:44:27 +01002466 if( non_empty_certificate_msg )
2467 {
2468 mbedtls_ssl_handshake_set_state( ssl,
2469 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2470 }
2471 else
Ronald Cron19385882022-06-15 16:26:13 +02002472 {
2473 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002474 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002475 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002476
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002477 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002478}
2479
Ronald Cron9df7c802022-03-08 18:38:54 +01002480#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002481/*
2482 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2483 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002484MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002485static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2486{
Ronald Crona8b38872022-03-09 07:59:25 +01002487 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2488
2489 if( ret == 0 )
2490 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2491
2492 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002493}
Jerry Yu90f152d2022-01-29 22:12:42 +08002494#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002495
2496/*
Jerry Yu687101b2021-09-14 16:03:56 +08002497 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2498 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002499MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002500static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002501{
XiaokangQian0fa66432021-11-15 03:33:57 +00002502 int ret;
2503
2504 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2505 if( ret != 0 )
2506 return( ret );
2507
Jerry Yu466dda82022-09-13 11:20:20 +08002508 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002509 if( ret != 0 )
2510 {
2511 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002512 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002513 return ( ret );
2514 }
2515
XiaokangQian0fa66432021-11-15 03:33:57 +00002516 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2517 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002518}
2519
2520/*
2521 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2522 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002523MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002524static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002525{
Jerry Yu378254d2021-10-30 21:44:47 +08002526 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002527 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002528 return( 0 );
2529}
2530
2531/*
2532 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2533 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002534MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002535static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002536{
Jerry Yu378254d2021-10-30 21:44:47 +08002537
2538 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2539
2540 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2541 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002542}
2543
Jerry Yuf8a49942022-07-07 11:32:32 +00002544#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2545
Jerry Yua0446a02022-07-13 11:22:55 +08002546MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002547static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2548 const unsigned char *buf,
2549 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002550{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002551 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002552
2553 ((void) ssl);
2554
2555 while( p < end )
2556 {
2557 unsigned int extension_type;
2558 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002559
Jerry Yuf8a49942022-07-07 11:32:32 +00002560 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2561 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2562 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2563 p += 4;
2564
2565 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002566
2567 switch( extension_type )
2568 {
2569 case MBEDTLS_TLS_EXT_EARLY_DATA:
2570 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2571 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002572
Jerry Yuf8a49942022-07-07 11:32:32 +00002573 default:
2574 break;
2575 }
2576 p += extension_data_len;
2577 }
2578
2579 return( 0 );
2580}
2581
2582/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002583 * From RFC8446, page 74
2584 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002585 * struct {
2586 * uint32 ticket_lifetime;
2587 * uint32 ticket_age_add;
2588 * opaque ticket_nonce<0..255>;
2589 * opaque ticket<1..2^16-1>;
2590 * Extension extensions<0..2^16-2>;
2591 * } NewSessionTicket;
2592 *
2593 */
Jerry Yua0446a02022-07-13 11:22:55 +08002594MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002595static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2596 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002597 unsigned char *end,
2598 unsigned char **ticket_nonce,
2599 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002600{
2601 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2602 unsigned char *p = buf;
2603 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002604 size_t ticket_len;
2605 unsigned char *ticket;
2606 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002607
Jerry Yucb3b1392022-07-12 06:09:38 +00002608 *ticket_nonce = NULL;
2609 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002610 /*
2611 * ticket_lifetime 4 bytes
2612 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002613 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002614 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002615 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002616
2617 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002618 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002619 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002620 ( unsigned int )session->ticket_lifetime ) );
2621
Jerry Yucb3b1392022-07-12 06:09:38 +00002622 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002623 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002624 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002625 ( unsigned int )session->ticket_age_add ) );
2626
Jerry Yucb3b1392022-07-12 06:09:38 +00002627 *ticket_nonce_len = p[8];
2628 p += 9;
2629
2630 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2631 *ticket_nonce = p;
2632 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2633 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002634
2635 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002636 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002637 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2638 p += 2;
2639 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002640 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2641
2642 /* Check if we previously received a ticket already. */
2643 if( session->ticket != NULL || session->ticket_len > 0 )
2644 {
2645 mbedtls_free( session->ticket );
2646 session->ticket = NULL;
2647 session->ticket_len = 0;
2648 }
2649
2650 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2651 {
2652 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2653 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2654 }
2655 memcpy( ticket, p, ticket_len );
2656 p += ticket_len;
2657 session->ticket = ticket;
2658 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002659
Jerry Yucb3b1392022-07-12 06:09:38 +00002660 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002661 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2662 p += 2;
2663 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2664
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002665 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002666
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002667 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002668 if( ret != 0 )
2669 {
2670 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002671 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002672 ret );
2673 return( ret );
2674 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002675
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002676 /* session has been updated, allow export */
2677 session->exported = 0;
2678
Jerry Yucb3b1392022-07-12 06:09:38 +00002679 return( 0 );
2680}
2681
Jerry Yua0446a02022-07-13 11:22:55 +08002682MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002683static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2684 unsigned char *ticket_nonce,
2685 size_t ticket_nonce_len )
2686{
2687 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2688 mbedtls_ssl_session *session = ssl->session;
2689 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2690 psa_algorithm_t psa_hash_alg;
2691 int hash_length;
2692
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002693#if defined(MBEDTLS_HAVE_TIME)
2694 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002695 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002696#endif
2697
Jerry Yuf8a49942022-07-07 11:32:32 +00002698 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2699 if( ciphersuite_info == NULL )
2700 {
2701 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2702 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2703 }
2704
2705 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2706 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002707 if( hash_length == -1 ||
2708 ( size_t )hash_length > sizeof( session->resumption_key ) )
2709 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002710 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002711 }
2712
Jerry Yuf8a49942022-07-07 11:32:32 +00002713
2714 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2715 session->app_secrets.resumption_master_secret,
2716 hash_length );
2717
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002718 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002719 *
2720 * HKDF-Expand-Label( resumption_master_secret,
2721 * "resumption", ticket_nonce, Hash.length )
2722 */
2723 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2724 psa_hash_alg,
2725 session->app_secrets.resumption_master_secret,
2726 hash_length,
2727 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2728 ticket_nonce,
2729 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002730 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002731 hash_length );
2732
2733 if( ret != 0 )
2734 {
2735 MBEDTLS_SSL_DEBUG_RET( 2,
2736 "Creating the ticket-resumed PSK failed",
2737 ret );
2738 return( ret );
2739 }
2740
Jerry Yu0a430c82022-07-20 11:02:48 +08002741 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002742
2743 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002744 session->resumption_key,
2745 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002746
Jerry Yuf8a49942022-07-07 11:32:32 +00002747 return( 0 );
2748}
2749
2750/*
Jerry Yua357cf42022-07-12 05:36:45 +00002751 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002752 */
Jerry Yua0446a02022-07-13 11:22:55 +08002753MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002754static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2755{
2756 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2757 unsigned char *buf;
2758 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002759 unsigned char *ticket_nonce;
2760 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002761
2762 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2763
2764 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2765 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2766 &buf, &buf_len ) );
2767
Jerry Yucb3b1392022-07-12 06:09:38 +00002768 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2769 ssl, buf, buf + buf_len,
2770 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002771
Jerry Yucb3b1392022-07-12 06:09:38 +00002772 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2773 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002774
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002775 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2776
Jerry Yuf8a49942022-07-07 11:32:32 +00002777cleanup:
2778
2779 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2780 return( ret );
2781}
2782#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2783
Jerry Yu92c6b402021-08-27 16:59:09 +08002784int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002785{
Jerry Yu92c6b402021-08-27 16:59:09 +08002786 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002787
Jerry Yu92c6b402021-08-27 16:59:09 +08002788 switch( ssl->state )
2789 {
2790 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002791 * ssl->state is initialized as HELLO_REQUEST. It is the same
2792 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002793 */
2794 case MBEDTLS_SSL_HELLO_REQUEST:
2795 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002796 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002797 break;
2798
2799 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002800 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002801 break;
2802
2803 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002804 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002805 break;
2806
Jerry Yua93ac112021-10-27 16:31:48 +08002807#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002808 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2809 ret = ssl_tls13_process_certificate_request( ssl );
2810 break;
2811
Jerry Yu687101b2021-09-14 16:03:56 +08002812 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002813 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002814 break;
2815
2816 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002817 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002818 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002819#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002820
2821 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002822 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002823 break;
2824
Jerry Yu566c7812022-01-26 15:41:22 +08002825 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2826 ret = ssl_tls13_write_client_certificate( ssl );
2827 break;
2828
Ronald Cron9df7c802022-03-08 18:38:54 +01002829#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002830 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2831 ret = ssl_tls13_write_client_certificate_verify( ssl );
2832 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002833#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002834
Jerry Yu687101b2021-09-14 16:03:56 +08002835 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002836 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002837 break;
2838
2839 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002840 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002841 break;
2842
2843 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002844 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002845 break;
2846
Ronald Cron49ad6192021-11-24 16:25:31 +01002847 /*
2848 * Injection of dummy-CCS's for middlebox compatibility
2849 */
2850#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002851 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002852 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2853 if( ret == 0 )
2854 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2855 break;
2856
2857 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2858 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2859 if( ret == 0 )
2860 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002861 break;
2862#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2863
Jerry Yuf8a49942022-07-07 11:32:32 +00002864#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002865 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002866 ret = ssl_tls13_process_new_session_ticket( ssl );
2867 if( ret != 0 )
2868 break;
2869 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2870 break;
2871#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2872
Jerry Yu92c6b402021-08-27 16:59:09 +08002873 default:
2874 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2875 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2876 }
2877
2878 return( ret );
2879}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002880
Jerry Yufb4b6472022-01-27 15:03:26 +08002881#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002882
Jerry Yufb4b6472022-01-27 15:03:26 +08002883