blob: 8f932d9394434a31aa079e300703528e105dad4c [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
710static int ssl_tls13_session_tickets_get_identity(
711 mbedtls_ssl_context *ssl, psa_algorithm_t *psa_alg,
712 const unsigned char **identity, size_t *identity_len )
713{
714 mbedtls_ssl_session *session = ssl->session_negotiate;
715 *psa_alg = ssl_tls13_ciphersuite_to_alg( ssl, session->ciphersuite );
716 *identity = session->ticket;
717 *identity_len = session->ticket_len;
718 return( 0 );
719}
720
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800721MBEDTLS_CHECK_RETURN_CRITICAL
722static int ssl_tls13_session_tickets_get_psk( mbedtls_ssl_context *ssl,
723 psa_algorithm_t *psa_alg,
724 const unsigned char **psk,
725 size_t *psk_len )
726{
727
728 mbedtls_ssl_session *session = ssl->session_negotiate;
729
730 *psa_alg = ssl_tls13_ciphersuite_to_alg( ssl, session->ciphersuite );
731 *psk = session->resumption_key;
732 *psk_len = session->resumption_key_len;
733
734 return( 0 );
735}
736
Jerry Yuf7c12592022-09-28 22:09:38 +0800737#endif /* MBEDTLS_SSL_SESSION_TICKETS */
738
739MBEDTLS_CHECK_RETURN_CRITICAL
740static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
741 psa_algorithm_t *psa_alg,
742 const unsigned char **identity,
743 size_t *identity_len )
744{
745
746 *psa_alg = PSA_ALG_SHA_256;
747 *identity = ssl->conf->psk_identity;
748 *identity_len = ssl->conf->psk_identity_len;
749 return( 0 );
750}
751
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800752MBEDTLS_CHECK_RETURN_CRITICAL
753static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
754 psa_algorithm_t *psa_alg,
755 const unsigned char **psk,
756 size_t *psk_len )
757{
758 *psa_alg = PSA_ALG_SHA_256;
759 *psk = ssl->conf->psk;
760 *psk_len = ssl->conf->psk_len;
761 return( 0 );
762}
763
XiaokangQianeb69aee2022-07-05 08:21:43 +0000764/*
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800765 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
XiaokangQianeb69aee2022-07-05 08:21:43 +0000766 *
767 * struct {
768 * opaque identity<1..2^16-1>;
769 * uint32 obfuscated_ticket_age;
770 * } PskIdentity;
771 *
772 * opaque PskBinderEntry<32..255>;
773 *
774 * struct {
XiaokangQian86981952022-07-19 09:51:50 +0000775 * PskIdentity identities<7..2^16-1>;
776 * PskBinderEntry binders<33..2^16-1>;
777 * } OfferedPsks;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000778 *
XiaokangQian86981952022-07-19 09:51:50 +0000779 * struct {
780 * select (Handshake.msg_type) {
781 * case client_hello: OfferedPsks;
782 * ...
783 * };
XiaokangQianeb69aee2022-07-05 08:21:43 +0000784 * } PreSharedKeyExtension;
785 *
XiaokangQianeb69aee2022-07-05 08:21:43 +0000786 */
Jerry Yuf7c12592022-09-28 22:09:38 +0800787MBEDTLS_CHECK_RETURN_CRITICAL
788static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
789 unsigned char *buf,
790 unsigned char *end,
791 int psk_type,
792 size_t *out_len,
793 size_t *binder_len )
794{
795 unsigned char *p = buf;
796 psa_algorithm_t psa_alg;
797 const unsigned char *identity;
798 size_t identity_len;
799 uint32_t obfuscated_ticket_age = 0;
800 int hash_len;
801
802 *out_len = 0;
803 *binder_len = 0;
804
805 switch( psk_type )
806 {
807#if defined(MBEDTLS_SSL_SESSION_TICKETS)
808 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
809 if( ssl_tls13_session_tickets_get_identity(
810 ssl, &psa_alg, &identity, &identity_len ) == 0 )
811 {
812#if defined(MBEDTLS_HAVE_TIME)
813 mbedtls_time_t now = mbedtls_time( NULL );
814 mbedtls_ssl_session *session = ssl->session_negotiate;
815 obfuscated_ticket_age =
816 (uint32_t)( now - session->ticket_received );
817 obfuscated_ticket_age *= 1000;
818 obfuscated_ticket_age += session->ticket_age_add ;
819#endif /* MBEDTLS_HAVE_TIME */
820 }
821 else
822 {
823 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
824 }
825 break;
826#endif /* MBEDTLS_SSL_SESSION_TICKETS */
827 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
828 if( ssl_tls13_psk_get_identity(
829 ssl, &psa_alg, &identity, &identity_len ) != 0 )
830 {
831 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
832 }
833 break;
834 default:
835 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
836 }
837
838 hash_len = PSA_HASH_LENGTH( psa_alg );
839 if( hash_len == -1 )
840 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
841
842 /*
843 * - identity_len (2 bytes)
844 * - identity (psk_identity_len bytes)
845 * - obfuscated_ticket_age (4 bytes)
846 */
847 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 + identity_len );
848
849 MBEDTLS_PUT_UINT16_BE( identity_len, p, 0 );
850 memcpy( p + 2, identity, identity_len );
851 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, p, 2 + identity_len );
852
853 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", p, 6 + identity_len );
854
855 *out_len = 6 + identity_len;
856 *binder_len = 1 + hash_len;
857
858 return( 0 );
859}
860
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000861int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +0000862 mbedtls_ssl_context *ssl,
863 unsigned char *buf, unsigned char *end,
864 size_t *out_len, size_t *binders_len )
865{
Jerry Yuf7c12592022-09-28 22:09:38 +0800866 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
867 unsigned char *p = buf;
868 size_t l_binders_len = 0;
869
870 *out_len = 0;
871 *binders_len = 0;
872
873 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
874 if( !ssl_tls13_has_configured_psk( ssl ) &&
875 !ssl_tls13_has_configured_ticket( ssl ) )
876 {
877 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
878 return( 0 );
879 }
880
881 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
882 ssl_tls13_has_configured_psk( ssl ) +
883 ssl_tls13_has_configured_ticket( ssl ) ) );
884 /* Check if we have space to write the extension, binders included.
885 * - extension_type (2 bytes)
886 * - extension_data_len (2 bytes)
887 * - identities_len (2 bytes)
888 */
889 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
890 p += 6;
891
892 if( ssl_tls13_has_configured_ticket( ssl ) )
893 {
894 size_t output_len, binder_len;
895 ret = ssl_tls13_write_identity( ssl, p, end,
896 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
897 &output_len, &binder_len );
898 if( ret != 0 )
899 return( ret );
900 p += output_len;
901 l_binders_len += binder_len;
902 }
903
904 if( ssl_tls13_has_configured_psk( ssl ) )
905 {
906 size_t output_len, binder_len;
907 ret = ssl_tls13_write_identity( ssl, p, end,
908 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
909 &output_len, &binder_len );
910 if( ret != 0 )
911 return( ret );
912 p += output_len;
913 l_binders_len += binder_len;
914 }
915
916 MBEDTLS_SSL_DEBUG_MSG( 3,
917 ( "client hello, adding pre_shared_key extension, "
918 "omitting PSK binder list" ) );
919 /*
920 * - extension_type (2 bytes)
921 * - extension_data_len (2 bytes)
922 * - identities_len (2 bytes)
923 */
924 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
925 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + 2 + l_binders_len , buf, 2 );
926 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
927
928 /* Check if there are enough space for binders */
929 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len + 2 );
930
931 *out_len = ( p - buf ) + l_binders_len + 2;
932 *binders_len = l_binders_len + 2;
933
934 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
935
936 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
937
XiaokangQianeb69aee2022-07-05 08:21:43 +0000938 return( 0 );
939}
940
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800941MBEDTLS_CHECK_RETURN_CRITICAL
942static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
943 unsigned char *buf,
944 unsigned char *end,
945 int psk_type,
946 size_t *out_len )
947{
948 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
949 unsigned char *p = buf;
950 const unsigned char *psk;
951 psa_algorithm_t psa_alg = PSA_ALG_NONE;
952 size_t psk_len;
953 unsigned char binder_len;
954 unsigned char transcript[MBEDTLS_MD_MAX_SIZE];
955 size_t transcript_len = 0;
956
957 *out_len = 0;
958
959 switch( psk_type )
960 {
961#if defined(MBEDTLS_SSL_SESSION_TICKETS) && defined(MBEDTLS_HAVE_TIME)
962 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
963 if( ssl_tls13_session_tickets_get_psk(
964 ssl, &psa_alg, &psk, &psk_len ) != 0 )
965 {
966 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
967 }
968 break;
969#endif /* MBEDTLS_SSL_SESSION_TICKETS && MBEDTLS_HAVE_TIME*/
970 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
971 if( ssl_tls13_psk_get_psk( ssl, &psa_alg, &psk, &psk_len ) != 0 )
972 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
973 break;
974 default:
975 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
976 }
977
978 binder_len = PSA_HASH_LENGTH( psa_alg );
979 if( binder_len == 0 )
980 {
981 MBEDTLS_SSL_DEBUG_MSG( 3, ( "should never happen" ) );
982 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
983 }
984
985 /*
986 * - binder_len (1 bytes)
987 * - binder (binder_len bytes)
988 */
989 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + binder_len );
990
991 p[0] = binder_len;
992
993 /* Get current state of handshake transcript. */
994 ret = mbedtls_ssl_get_handshake_transcript(
995 ssl, mbedtls_hash_info_md_from_psa( psa_alg ),
996 transcript, MBEDTLS_MD_MAX_SIZE, &transcript_len );
997 if( ret != 0 )
998 return( ret );
999
1000
1001
1002 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, psa_alg,
1003 psk, psk_len, psk_type,
1004 transcript, p + 1 );
1005 if( ret != 0 )
1006 {
1007 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
1008 return( ret );
1009 }
1010 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", p, 1 + binder_len );
1011
1012 *out_len = 1 + binder_len;
1013
1014 return( ret );
1015}
1016
XiaokangQian86981952022-07-19 09:51:50 +00001017int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +08001018 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001019{
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001020 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1021 unsigned char *p = buf;
1022
1023 /* Check if we have space to write binders_len.
1024 * - binders_len (2 bytes)
1025 */
1026 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1027 p += 2;
1028
1029 if( ssl_tls13_has_configured_ticket( ssl ) )
1030 {
1031 size_t output_len;
1032 ret = ssl_tls13_write_binder( ssl, p, end,
1033 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
1034 &output_len );
1035 if( ret != 0 )
1036 return( ret );
1037 p += output_len;
1038 }
1039
1040 if( ssl_tls13_has_configured_psk( ssl ) )
1041 {
1042 size_t output_len;
1043 ret = ssl_tls13_write_binder( ssl, p, end,
1044 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
1045 &output_len );
1046 if( ret != 0 )
1047 return( ret );
1048 p += output_len;
1049 }
1050
1051 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1052
1053 /*
1054 * - binders_len (2 bytes)
1055 */
1056 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1057
1058 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001059
1060 return( 0 );
1061}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001062
1063/*
1064 * struct {
1065 * opaque identity<1..2^16-1>;
1066 * uint32 obfuscated_ticket_age;
1067 * } PskIdentity;
1068 *
1069 * opaque PskBinderEntry<32..255>;
1070 *
1071 * struct {
1072 *
1073 * select (Handshake.msg_type) {
1074 * ...
1075 * case server_hello: uint16 selected_identity;
1076 * };
1077 *
1078 * } PreSharedKeyExtension;
1079 *
1080 */
1081MBEDTLS_CHECK_RETURN_CRITICAL
1082static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1083 const unsigned char *buf,
1084 const unsigned char *end )
1085{
Jerry Yub300e3c2022-09-28 22:12:07 +08001086 int ret = 0;
1087 int selected_identity;
1088 int psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1089 const unsigned char *psk;
1090 size_t psk_len;
1091 psa_algorithm_t psa_alg;
1092
1093 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 2 );
1094 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
1095 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
1096
1097 if( ssl_tls13_has_configured_psk( ssl ) &&
1098 ssl_tls13_has_configured_ticket( ssl ) )
1099 {
1100 if( selected_identity >= 2 )
1101 {
1102 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1103 goto exit;
1104 }
1105 switch( selected_identity )
1106 {
1107 case 0:
1108 psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
1109 break;
1110 case 1:
1111 psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1112 break;
1113 }
1114 }
1115 else if( ssl_tls13_has_configured_psk( ssl ) ||
1116 ssl_tls13_has_configured_ticket( ssl ) )
1117 {
1118 if( selected_identity >= 1 )
1119 {
1120 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Out of range" ) );
1121 goto exit;
1122 }
1123
1124 if( ssl_tls13_has_configured_psk( ssl ) )
1125 psk_type = MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL;
1126 else if( ssl_tls13_has_configured_ticket( ssl ) )
1127 psk_type = MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION;
1128 }
1129 else
1130 {
1131 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1132 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1133 }
1134 switch( psk_type )
1135 {
1136#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1137 case MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION:
1138 ret = ssl_tls13_session_tickets_get_psk(
1139 ssl, &psa_alg, &psk, &psk_len );
1140 break;
1141#endif
1142 case MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL:
1143 ret = ssl_tls13_psk_get_psk(
1144 ssl, &psa_alg, &psk, &psk_len );
1145 break;
1146 default:
1147 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1148 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1149 }
1150 if( ret != 0 )
1151 return( ret );
1152
1153 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1154 if( ret != 0 )
1155 {
1156 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
1157 }
1158 else
1159 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1160
1161 return( ret );
1162
1163exit:
1164 MBEDTLS_SSL_DEBUG_MSG(
1165 1, ( "Invalid chosen PSK identity." ) );
1166
1167 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1168 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1169 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001170}
1171
XiaokangQianeb69aee2022-07-05 08:21:43 +00001172#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1173
Ronald Cron3d580bf2022-02-18 17:24:56 +01001174int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1175 unsigned char *buf,
1176 unsigned char *end,
1177 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001178{
1179 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1180 unsigned char *p = buf;
1181 size_t ext_len;
1182
1183 *out_len = 0;
1184
1185 /* Write supported_versions extension
1186 *
1187 * Supported Versions Extension is mandatory with TLS 1.3.
1188 */
1189 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1190 if( ret != 0 )
1191 return( ret );
1192 p += ext_len;
1193
1194 /* Echo the cookie if the server provided one in its preceding
1195 * HelloRetryRequest message.
1196 */
1197 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1198 if( ret != 0 )
1199 return( ret );
1200 p += ext_len;
1201
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001202 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1203 {
1204 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1205 if( ret != 0 )
1206 return( ret );
1207 p += ext_len;
1208 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001209
XiaokangQianeb69aee2022-07-05 08:21:43 +00001210#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1211 /* For PSK-based key exchange we need the pre_shared_key extension
1212 * and the psk_key_exchange_modes extension.
1213 *
1214 * The pre_shared_key extension MUST be the last extension in the
1215 * ClientHello. Servers MUST check that it is the last extension and
1216 * otherwise fail the handshake with an "illegal_parameter" alert.
1217 *
1218 * Add the psk_key_exchange_modes extension.
1219 */
1220 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1221 if( ret != 0 )
1222 return( ret );
1223 p += ext_len;
1224#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1225
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001226 *out_len = p - buf;
1227
1228 return( 0 );
1229}
1230
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001231/*
Jerry Yu4a173382021-10-11 21:45:31 +08001232 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001233 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001234
Ronald Cronda41b382022-03-30 09:57:11 +02001235/**
1236 * \brief Detect if the ServerHello contains a supported_versions extension
1237 * or not.
1238 *
1239 * \param[in] ssl SSL context
1240 * \param[in] buf Buffer containing the ServerHello message
1241 * \param[in] end End of the buffer containing the ServerHello message
1242 *
1243 * \return 0 if the ServerHello does not contain a supported_versions extension
1244 * \return 1 if the ServerHello contains a supported_versions extension
1245 * \return A negative value if an error occurred while parsing the ServerHello.
1246 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001247MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001248static int ssl_tls13_is_supported_versions_ext_present(
1249 mbedtls_ssl_context *ssl,
1250 const unsigned char *buf,
1251 const unsigned char *end )
1252{
1253 const unsigned char *p = buf;
1254 size_t legacy_session_id_echo_len;
1255 size_t extensions_len;
1256 const unsigned char *extensions_end;
1257
1258 /*
1259 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001260 * length:
1261 * - legacy_version 2 bytes
1262 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1263 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001264 */
1265 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1266 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1267 legacy_session_id_echo_len = *p;
1268
1269 /*
1270 * Jump to the extensions, jumping over:
1271 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1272 * - cipher_suite 2 bytes
1273 * - legacy_compression_method 1 byte
1274 */
Ronald Cron28271062022-06-10 14:43:55 +02001275 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001276 p += legacy_session_id_echo_len + 4;
1277
1278 /* Case of no extension */
1279 if( p == end )
1280 return( 0 );
1281
1282 /* ...
1283 * Extension extensions<6..2^16-1>;
1284 * ...
1285 * struct {
1286 * ExtensionType extension_type; (2 bytes)
1287 * opaque extension_data<0..2^16-1>;
1288 * } Extension;
1289 */
1290 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1291 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1292 p += 2;
1293
1294 /* Check extensions do not go beyond the buffer of data. */
1295 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1296 extensions_end = p + extensions_len;
1297
1298 while( p < extensions_end )
1299 {
1300 unsigned int extension_type;
1301 size_t extension_data_len;
1302
1303 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1304 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1305 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1306 p += 4;
1307
1308 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1309 return( 1 );
1310
1311 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1312 p += extension_data_len;
1313 }
1314
1315 return( 0 );
1316}
1317
Jerry Yu7a186a02021-10-15 18:46:14 +08001318/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001319 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1320 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1321 * - 0 otherwise
1322 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001323MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001324static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1325 const unsigned char *buf,
1326 const unsigned char *end )
1327{
1328 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1329 static const unsigned char magic_downgrade_string[] =
1330 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1331 const unsigned char *last_eight_bytes_of_random;
1332 unsigned char last_byte_of_random;
1333
1334 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1335 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1336
1337 if( memcmp( last_eight_bytes_of_random,
1338 magic_downgrade_string,
1339 sizeof( magic_downgrade_string ) ) == 0 )
1340 {
1341 last_byte_of_random = last_eight_bytes_of_random[7];
1342 return( last_byte_of_random == 0 ||
1343 last_byte_of_random == 1 );
1344 }
1345
1346 return( 0 );
1347}
1348
1349/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001350 * - SSL_SERVER_HELLO or
1351 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001352 * to indicate which message is expected and to be parsed next.
1353 */
Ronald Cron828aff62022-05-31 12:04:31 +02001354#define SSL_SERVER_HELLO 0
1355#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001356MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001357static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1358 const unsigned char *buf,
1359 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001360{
Jerry Yue1b9c292021-09-10 10:08:31 +08001361
1362 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1363 *
Jerry Yu4a173382021-10-11 21:45:31 +08001364 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001365 * special value of the SHA-256 of "HelloRetryRequest".
1366 *
1367 * struct {
1368 * ProtocolVersion legacy_version = 0x0303;
1369 * Random random;
1370 * opaque legacy_session_id_echo<0..32>;
1371 * CipherSuite cipher_suite;
1372 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001373 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001374 * } ServerHello;
1375 *
1376 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001377 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1378 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001379
Jerry Yu93a13f22022-04-11 23:00:01 +08001380 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1381 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001382 {
Ronald Cron828aff62022-05-31 12:04:31 +02001383 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001384 }
1385
Ronald Cron828aff62022-05-31 12:04:31 +02001386 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001387}
1388
Ronald Cron828aff62022-05-31 12:04:31 +02001389/*
Jerry Yu745bb612021-10-13 22:01:04 +08001390 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001391 * - SSL_SERVER_HELLO or
1392 * - SSL_SERVER_HELLO_HRR or
1393 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001394 */
Ronald Cron828aff62022-05-31 12:04:31 +02001395#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001396MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001397static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001398 const unsigned char *buf,
1399 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001400{
Jerry Yu4a173382021-10-11 21:45:31 +08001401 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001402 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001403
Ronald Cron9f0fba32022-02-10 16:45:15 +01001404 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001405 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001406
Ronald Cron9f0fba32022-02-10 16:45:15 +01001407 if( ret == 0 )
1408 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001409 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001410 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001411
1412 /* If the server is negotiating TLS 1.2 or below and:
1413 * . we did not propose TLS 1.2 or
1414 * . the server responded it is TLS 1.3 capable but negotiating a lower
1415 * version of the protocol and thus we are under downgrade attack
1416 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001417 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001418 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001419 {
1420 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1421 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1422 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1423 }
1424
1425 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001426 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001427 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001428 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001429
1430 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1431 {
1432 ret = ssl_tls13_reset_key_share( ssl );
1433 if( ret != 0 )
1434 return( ret );
1435 }
1436
Ronald Cron828aff62022-05-31 12:04:31 +02001437 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001438 }
1439
Jerry Yua66fece2022-07-13 14:30:29 +08001440#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1441 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1442 ssl->session_negotiate->tls_version = ssl->tls_version;
1443#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1444
Ronald Cron5afb9042022-05-31 12:11:39 +02001445 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1446
Ronald Crondb5dfa12022-05-31 11:44:38 +02001447 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001448 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001449 {
Ronald Cron828aff62022-05-31 12:04:31 +02001450 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001451 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1452 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001453 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001454 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001455 /* If a client receives a second
1456 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1457 * was itself in response to a HelloRetryRequest), it MUST abort the
1458 * handshake with an "unexpected_message" alert.
1459 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001460 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001461 {
1462 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1463 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1464 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1465 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1466 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001467 /*
1468 * Clients must abort the handshake with an "illegal_parameter"
1469 * alert if the HelloRetryRequest would not result in any change
1470 * in the ClientHello.
1471 * In a PSK only key exchange that what we expect.
1472 */
1473 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1474 {
1475 MBEDTLS_SSL_DEBUG_MSG( 1,
1476 ( "Unexpected HRR in pure PSK key exchange." ) );
1477 MBEDTLS_SSL_PEND_FATAL_ALERT(
1478 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1479 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1480 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1481 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001482
Ronald Cron5afb9042022-05-31 12:11:39 +02001483 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001484
Jerry Yu745bb612021-10-13 22:01:04 +08001485 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001486 }
1487
1488cleanup:
1489
1490 return( ret );
1491}
1492
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001493MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001494static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1495 const unsigned char **buf,
1496 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001497{
1498 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001499 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001500
Jerry Yude4fb2c2021-09-19 18:05:08 +08001501 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001502 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001503
Jerry Yu4a173382021-10-11 21:45:31 +08001504 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001505
1506 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001507 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1508 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001509 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001510 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1511 ssl->session_negotiate->id,
1512 ssl->session_negotiate->id_len );
1513 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001514 legacy_session_id_echo_len );
1515
1516 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1517 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1518
Jerry Yue1b9c292021-09-10 10:08:31 +08001519 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1520 }
1521
Jerry Yu4a173382021-10-11 21:45:31 +08001522 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001523 *buf = p;
1524
1525 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001526 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001527 return( 0 );
1528}
1529
Jerry Yue1b9c292021-09-10 10:08:31 +08001530/* Parse ServerHello message and configure context
1531 *
1532 * struct {
1533 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1534 * Random random;
1535 * opaque legacy_session_id_echo<0..32>;
1536 * CipherSuite cipher_suite;
1537 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001538 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001539 * } ServerHello;
1540 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001541MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001542static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1543 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001544 const unsigned char *end,
1545 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001546{
Jerry Yub85277e2021-10-13 13:36:05 +08001547 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001548 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001549 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001550 size_t extensions_len;
1551 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001552 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001553 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001554 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001555
1556 /*
1557 * Check there is space for minimal fields
1558 *
1559 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001560 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001561 * - legacy_session_id_echo ( 1 byte ), minimum size
1562 * - cipher_suite ( 2 bytes)
1563 * - legacy_compression_method ( 1 byte )
1564 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001565 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001566
1567 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001568 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1569
Jerry Yu4a173382021-10-11 21:45:31 +08001570 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001571 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001572 * ...
1573 * with ProtocolVersion defined as:
1574 * uint16 ProtocolVersion;
1575 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001576 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1577 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001578 {
1579 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1580 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1581 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001582 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1583 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001584 }
1585 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001586
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001587 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001588 * Random random;
1589 * ...
1590 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001591 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001592 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001593 if( !is_hrr )
1594 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001595 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001596 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1597 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1598 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1599 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001600 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001601
Jerry Yu4a173382021-10-11 21:45:31 +08001602 /* ...
1603 * opaque legacy_session_id_echo<0..32>;
1604 * ...
1605 */
1606 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001607 {
XiaokangQian52da5582022-01-26 09:49:29 +00001608 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001609 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001610 }
1611
Jerry Yu4a173382021-10-11 21:45:31 +08001612 /* ...
1613 * CipherSuite cipher_suite;
1614 * ...
1615 * with CipherSuite defined as:
1616 * uint8 CipherSuite[2];
1617 */
1618 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001619 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1620 p += 2;
1621
Jerry Yu4a173382021-10-11 21:45:31 +08001622
XiaokangQian355e09a2022-01-20 11:14:50 +00001623 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001624 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001625 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001626 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001627 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1628 ssl->tls_version,
1629 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001630 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001631 {
XiaokangQian52da5582022-01-26 09:49:29 +00001632 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001633 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001634 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001635 * If we received an HRR before and that the proposed selected
1636 * ciphersuite in this server hello is not the same as the one
1637 * proposed in the HRR, we abort the handshake and send an
1638 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001639 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001640 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1641 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001642 {
XiaokangQian52da5582022-01-26 09:49:29 +00001643 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001644 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001645
XiaokangQian52da5582022-01-26 09:49:29 +00001646 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001647 {
1648 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1649 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001650 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001651 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001652
Jerry Yu4a173382021-10-11 21:45:31 +08001653 /* Configure ciphersuites */
1654 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1655
XiaokangQian355e09a2022-01-20 11:14:50 +00001656 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001657 ssl->session_negotiate->ciphersuite = cipher_suite;
1658
Jerry Yue1b9c292021-09-10 10:08:31 +08001659 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1660 cipher_suite, ciphersuite_info->name ) );
1661
1662#if defined(MBEDTLS_HAVE_TIME)
1663 ssl->session_negotiate->start = time( NULL );
1664#endif /* MBEDTLS_HAVE_TIME */
1665
Jerry Yu4a173382021-10-11 21:45:31 +08001666 /* ...
1667 * uint8 legacy_compression_method = 0;
1668 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001669 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001670 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001671 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001672 {
Jerry Yub85277e2021-10-13 13:36:05 +08001673 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001674 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001675 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001676 }
1677 p++;
1678
Jerry Yub85277e2021-10-13 13:36:05 +08001679 /* ...
1680 * Extension extensions<6..2^16-1>;
1681 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001682 * struct {
1683 * ExtensionType extension_type; (2 bytes)
1684 * opaque extension_data<0..2^16-1>;
1685 * } Extension;
1686 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001687 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001688 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001689 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001690
Jerry Yu4a173382021-10-11 21:45:31 +08001691 /* Check extensions do not go beyond the buffer of data. */
1692 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1693 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001694
Jerry Yu4a173382021-10-11 21:45:31 +08001695 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001696
Jerry Yu4a173382021-10-11 21:45:31 +08001697 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001698 {
1699 unsigned int extension_type;
1700 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001701 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001702
Jerry Yu4a173382021-10-11 21:45:31 +08001703 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001704 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1705 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1706 p += 4;
1707
Jerry Yu4a173382021-10-11 21:45:31 +08001708 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001709 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001710
1711 switch( extension_type )
1712 {
XiaokangQianb851da82022-01-14 04:03:11 +00001713 case MBEDTLS_TLS_EXT_COOKIE:
1714
XiaokangQiand9e068e2022-01-18 06:23:32 +00001715 if( !is_hrr )
1716 {
XiaokangQian52da5582022-01-26 09:49:29 +00001717 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001718 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001719 }
1720
XiaokangQian43550bd2022-01-21 04:32:58 +00001721 ret = ssl_tls13_parse_cookie_ext( ssl,
1722 p, extension_data_end );
1723 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001724 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001725 MBEDTLS_SSL_DEBUG_RET( 1,
1726 "ssl_tls13_parse_cookie_ext",
1727 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001728 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001729 }
XiaokangQianb851da82022-01-14 04:03:11 +00001730 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001731
Jerry Yue1b9c292021-09-10 10:08:31 +08001732 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001733 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001734 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001735 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001736 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001737 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001738 break;
1739
XiaokangQianeb69aee2022-07-05 08:21:43 +00001740#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001741 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001742 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1743 if( is_hrr )
1744 {
1745 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1746 goto cleanup;
1747 }
Jerry Yu4a173382021-10-11 21:45:31 +08001748
XiaokangQian86981952022-07-19 09:51:50 +00001749 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001750 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001751 {
1752 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001753 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001754 return( ret );
1755 }
1756 break;
1757#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001758
Jerry Yue1b9c292021-09-10 10:08:31 +08001759 case MBEDTLS_TLS_EXT_KEY_SHARE:
1760 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001761 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1762 {
XiaokangQian52da5582022-01-26 09:49:29 +00001763 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001764 goto cleanup;
1765 }
1766
XiaokangQian53f20b72022-01-18 10:47:33 +00001767 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001768 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001769 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001770 else
XiaokangQianb851da82022-01-14 04:03:11 +00001771 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001772 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001773 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001774 {
1775 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001776 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001777 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001778 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001779 }
1780 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001781
1782 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001783 MBEDTLS_SSL_DEBUG_MSG(
1784 3,
1785 ( "unknown extension found: %u ( ignoring )",
1786 extension_type ) );
1787
XiaokangQian52da5582022-01-26 09:49:29 +00001788 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001789 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001790 }
1791
1792 p += extension_data_len;
1793 }
1794
XiaokangQiand59be772022-01-24 10:12:51 +00001795cleanup:
1796
XiaokangQian52da5582022-01-26 09:49:29 +00001797 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001798 {
1799 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1800 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1801 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1802 }
XiaokangQian52da5582022-01-26 09:49:29 +00001803 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001804 {
1805 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1806 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1807 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1808 }
1809 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001810}
1811
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001812#if defined(MBEDTLS_DEBUG_C)
1813static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001814{
1815 switch( mode )
1816 {
1817 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1818 return "psk";
1819 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1820 return "ephemeral";
1821 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1822 return "psk_ephemeral";
1823 default:
1824 return "unknown mode";
1825 }
1826}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001827#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001828
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001829MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001830static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001831{
Jerry Yub85277e2021-10-13 13:36:05 +08001832 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001833 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001834
Jerry Yub85277e2021-10-13 13:36:05 +08001835 /* Determine the key exchange mode:
1836 * 1) If both the pre_shared_key and key_share extensions were received
1837 * then the key exchange mode is PSK with EPHEMERAL.
1838 * 2) If only the pre_shared_key extension was received then the key
1839 * exchange mode is PSK-only.
1840 * 3) If only the key_share extension was received then the key
1841 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001842 */
Jerry Yub85277e2021-10-13 13:36:05 +08001843 switch( handshake->extensions_present &
1844 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001845 {
Jerry Yu745bb612021-10-13 22:01:04 +08001846 /* Only the pre_shared_key extension was received */
1847 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001848 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001849 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001850
Jerry Yu745bb612021-10-13 22:01:04 +08001851 /* Only the key_share extension was received */
1852 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001853 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001854 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001855
Jerry Yu745bb612021-10-13 22:01:04 +08001856 /* Both the pre_shared_key and key_share extensions were received */
1857 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001858 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001859 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001860
Jerry Yu745bb612021-10-13 22:01:04 +08001861 /* Neither pre_shared_key nor key_share extension was received */
1862 default:
1863 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1864 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1865 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001866 }
1867
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001868 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1869 {
1870 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1871 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001872 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001873 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001874 goto cleanup;
1875 }
1876
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001877 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001878 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001879 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001880
Jerry Yu0b177842021-09-05 19:41:30 +08001881 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1882 *
1883 * TODO: We don't have to do this in case we offered 0-RTT and the
1884 * server accepted it. In this case, we could skip generating
1885 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001886 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001887 if( ret != 0 )
1888 {
Jerry Yue110d252022-05-05 10:19:22 +08001889 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001890 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001891 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001892 }
1893
Jerry Yuf86eb752022-05-06 11:16:55 +08001894 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001895 if( ret != 0 )
1896 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001897 MBEDTLS_SSL_DEBUG_RET( 1,
1898 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001899 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001900 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001901 }
1902
Jerry Yue110d252022-05-05 10:19:22 +08001903 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001904 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1905 ssl->session_in = ssl->session_negotiate;
1906
Jerry Yu4a173382021-10-11 21:45:31 +08001907cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001908 if( ret != 0 )
1909 {
Jerry Yu4a173382021-10-11 21:45:31 +08001910 MBEDTLS_SSL_PEND_FATAL_ALERT(
1911 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1912 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1913 }
Jerry Yue110d252022-05-05 10:19:22 +08001914
Jerry Yu4a173382021-10-11 21:45:31 +08001915 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001916}
1917
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001918MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001919static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001920{
1921 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1922
XiaokangQian78b1fa72022-01-19 06:56:30 +00001923 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001924
XiaokangQian78b1fa72022-01-19 06:56:30 +00001925 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001926 * We are going to re-generate a shared secret corresponding to the group
1927 * selected by the server, which is different from the group for which we
1928 * generated a shared secret in the first client hello.
1929 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001930 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001931 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001932 if( ret != 0 )
1933 return( ret );
1934
1935 return( 0 );
1936}
1937
Jerry Yue1b9c292021-09-10 10:08:31 +08001938/*
Jerry Yu4a173382021-10-11 21:45:31 +08001939 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001940 * Handler for MBEDTLS_SSL_SERVER_HELLO
1941 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001942MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001943static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001944{
Jerry Yu4a173382021-10-11 21:45:31 +08001945 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001946 unsigned char *buf = NULL;
1947 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001948 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001949
1950 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1951
Ronald Crondb5dfa12022-05-31 11:44:38 +02001952 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1953 MBEDTLS_SSL_HS_SERVER_HELLO,
1954 &buf, &buf_len ) );
1955
Ronald Cron828aff62022-05-31 12:04:31 +02001956 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001957 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001958 goto cleanup;
1959 else
Ronald Cron828aff62022-05-31 12:04:31 +02001960 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001961
Ronald Cron828aff62022-05-31 12:04:31 +02001962 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001963 {
1964 ret = 0;
1965 goto cleanup;
1966 }
1967
XiaokangQianb851da82022-01-14 04:03:11 +00001968 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001969 buf + buf_len,
1970 is_hrr ) );
1971 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001972 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1973
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001974 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1975 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001976
XiaokangQiand9e068e2022-01-18 06:23:32 +00001977 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001978 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001979 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001980#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1981 /* If not offering early data, the client sends a dummy CCS record
1982 * immediately before its second flight. This may either be before
1983 * its second ClientHello or before its encrypted handshake flight.
1984 */
1985 mbedtls_ssl_handshake_set_state( ssl,
1986 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1987#else
1988 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1989#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1990 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001991 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001992 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001993 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001994 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1995 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001996
1997cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001998 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1999 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08002000 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08002001}
2002
2003/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002004 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02002005 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002006 *
2007 * The EncryptedExtensions message contains any extensions which
2008 * should be protected, i.e., any which are not needed to establish
2009 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08002010 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002011
XiaokangQian08da26c2021-10-09 10:12:11 +00002012/* Parse EncryptedExtensions message
2013 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002014 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002015 * } EncryptedExtensions;
2016 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002017MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00002018static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
2019 const unsigned char *buf,
2020 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002021{
2022 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00002023 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00002024 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00002025 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002026
XiaokangQian08da26c2021-10-09 10:12:11 +00002027 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00002028 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002029 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002030
XiaokangQian97799ac2021-10-11 10:05:54 +00002031 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00002032 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02002033 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002034
XiaokangQian8db25ff2021-10-13 05:56:18 +00002035 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002036 {
XiaokangQian08da26c2021-10-09 10:12:11 +00002037 unsigned int extension_type;
2038 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002039
XiaokangQian08da26c2021-10-09 10:12:11 +00002040 /*
2041 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00002042 * ExtensionType extension_type; (2 bytes)
2043 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00002044 * } Extension;
2045 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00002046 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00002047 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2048 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2049 p += 4;
2050
XiaokangQian8db25ff2021-10-13 05:56:18 +00002051 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002052
XiaokangQian97799ac2021-10-11 10:05:54 +00002053 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002054 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00002055 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002056 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002057 switch( extension_type )
2058 {
Jerry Yu661dd942022-08-03 14:50:01 +08002059 case MBEDTLS_TLS_EXT_SERVERNAME:
2060 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002061
Jerry Yu661dd942022-08-03 14:50:01 +08002062 /* The server_name extension should be an empty extension */
2063
2064 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002065 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2066 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2067 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002068
lhuang0486cacac2022-01-21 07:34:27 -08002069#if defined(MBEDTLS_SSL_ALPN)
2070 case MBEDTLS_TLS_EXT_ALPN:
2071 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2072
2073 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2074 {
2075 return( ret );
2076 }
2077
2078 break;
2079#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002080 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002081 MBEDTLS_SSL_DEBUG_MSG(
2082 3, ( "unsupported extension found: %u ", extension_type) );
2083 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002084 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002085 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2086 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002087 }
2088
XiaokangQian08da26c2021-10-09 10:12:11 +00002089 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002090 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002091
XiaokangQian97799ac2021-10-11 10:05:54 +00002092 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002093 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002094 {
2095 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002096 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002097 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002098 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002099 }
2100
2101 return( ret );
2102}
2103
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002104MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002105static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2106{
2107 int ret;
2108 unsigned char *buf;
2109 size_t buf_len;
2110
2111 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2112
2113 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2114 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2115 &buf, &buf_len ) );
2116
2117 /* Process the message contents */
2118 MBEDTLS_SSL_PROC_CHK(
2119 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2120
2121 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2122 buf, buf_len );
2123
Ronald Cronfb508b82022-05-31 14:49:55 +02002124#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002125 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002126 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2127 else
2128 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2129#else
2130 ((void) ssl);
2131 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2132#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002133
2134cleanup:
2135
2136 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2137 return( ret );
2138
2139}
2140
Jerry Yua93ac112021-10-27 16:31:48 +08002141#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002142/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002143 * STATE HANDLING: CertificateRequest
2144 *
Jerry Yud2674312021-10-29 10:08:19 +08002145 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002146#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2147#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002148/* Coordination:
2149 * Deals with the ambiguity of not knowing if a CertificateRequest
2150 * will be sent. Returns a negative code on failure, or
2151 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2152 * - SSL_CERTIFICATE_REQUEST_SKIP
2153 * indicating if a Certificate Request is expected or not.
2154 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002155MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002156static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002157{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002158 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002159
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002160 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002161 {
2162 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2163 return( ret );
2164 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002165 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002166
2167 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2168 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2169 {
Ronald Cron19385882022-06-15 16:26:13 +02002170 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002171 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002172 }
2173
Ronald Cron19385882022-06-15 16:26:13 +02002174 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2175
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002176 return( SSL_CERTIFICATE_REQUEST_SKIP );
2177}
2178
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002179/*
2180 * ssl_tls13_parse_certificate_request()
2181 * Parse certificate request
2182 * struct {
2183 * opaque certificate_request_context<0..2^8-1>;
2184 * Extension extensions<2..2^16-1>;
2185 * } CertificateRequest;
2186 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002187MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002188static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2189 const unsigned char *buf,
2190 const unsigned char *end )
2191{
2192 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2193 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002194 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002195 size_t extensions_len = 0;
2196 const unsigned char *extensions_end;
2197 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002198
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002199 /* ...
2200 * opaque certificate_request_context<0..2^8-1>
2201 * ...
2202 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002203 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2204 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002205 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002206
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002207 if( certificate_request_context_len > 0 )
2208 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002209 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002210 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2211 p, certificate_request_context_len );
2212
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002213 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002214 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002215 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002216 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002217 {
2218 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2219 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2220 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002221 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002222 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002223 p += certificate_request_context_len;
2224 }
2225
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002226 /* ...
2227 * Extension extensions<2..2^16-1>;
2228 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002229 */
2230 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2231 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2232 p += 2;
2233
2234 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2235 extensions_end = p + extensions_len;
2236
2237 while( p < extensions_end )
2238 {
2239 unsigned int extension_type;
2240 size_t extension_data_len;
2241
2242 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2243 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2244 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2245 p += 4;
2246
2247 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2248
2249 switch( extension_type )
2250 {
2251 case MBEDTLS_TLS_EXT_SIG_ALG:
2252 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002253 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002254 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002255 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002256 if( ret != 0 )
2257 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002258 if( ! sig_alg_ext_found )
2259 sig_alg_ext_found = 1;
2260 else
2261 {
2262 MBEDTLS_SSL_DEBUG_MSG( 3,
2263 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002264 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002265 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002266 break;
2267
2268 default:
2269 MBEDTLS_SSL_DEBUG_MSG(
2270 3,
2271 ( "unknown extension found: %u ( ignoring )",
2272 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002273 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002274 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002275 p += extension_data_len;
2276 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002277 /* Check that we consumed all the message. */
2278 if( p != end )
2279 {
2280 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002281 ( "CertificateRequest misaligned" ) );
2282 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002283 }
2284 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002285 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002286 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002287 MBEDTLS_SSL_DEBUG_MSG( 3,
2288 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002289 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002290 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002291
Jerry Yu7840f812022-01-29 10:26:51 +08002292 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002293 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002294
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002295decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002296 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2297 MBEDTLS_ERR_SSL_DECODE_ERROR );
2298 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002299}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002300
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002301/*
2302 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2303 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002304MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002305static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002306{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002307 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002308
2309 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2310
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002311 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2312
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002313 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2314 {
2315 unsigned char *buf;
2316 size_t buf_len;
2317
2318 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2319 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2320 &buf, &buf_len ) );
2321
2322 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2323 buf, buf + buf_len ) );
2324
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002325 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2326 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002327 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002328 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002329 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002330 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002331 }
2332 else
2333 {
2334 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002335 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2336 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002337 }
2338
Jerry Yud2674312021-10-29 10:08:19 +08002339 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2340
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002341cleanup:
2342
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002343 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2344 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002345}
2346
2347/*
Jerry Yu687101b2021-09-14 16:03:56 +08002348 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2349 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002350MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002351static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002352{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002353 int ret;
2354
2355 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002356 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002357 return( ret );
2358
Jerry Yu687101b2021-09-14 16:03:56 +08002359 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2360 return( 0 );
2361}
2362
2363/*
2364 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2365 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002366MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002367static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002368{
Jerry Yu30b071c2021-09-12 20:16:03 +08002369 int ret;
2370
2371 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2372 if( ret != 0 )
2373 return( ret );
2374
Jerry Yu687101b2021-09-14 16:03:56 +08002375 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2376 return( 0 );
2377}
Jerry Yua93ac112021-10-27 16:31:48 +08002378#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002379
Jerry Yu687101b2021-09-14 16:03:56 +08002380/*
2381 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2382 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002383MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002384static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002385{
XiaokangQianac0385c2021-11-03 06:40:11 +00002386 int ret;
2387
XiaokangQianc5c39d52021-11-09 11:55:10 +00002388 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002389 if( ret != 0 )
2390 return( ret );
2391
Jerry Yue3d67cb2022-05-19 15:33:10 +08002392 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2393 if( ret != 0 )
2394 {
2395 MBEDTLS_SSL_PEND_FATAL_ALERT(
2396 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2397 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2398 return( ret );
2399 }
2400
Ronald Cron49ad6192021-11-24 16:25:31 +01002401#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2402 mbedtls_ssl_handshake_set_state(
2403 ssl,
2404 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2405#else
Jerry Yuca133a32022-02-15 14:22:05 +08002406 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002407#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002408
XiaokangQianac0385c2021-11-03 06:40:11 +00002409 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002410}
2411
2412/*
Jerry Yu566c7812022-01-26 15:41:22 +08002413 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2414 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002415MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002416static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2417{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002418 int non_empty_certificate_msg = 0;
2419
Jerry Yu5cc35062022-01-28 16:16:08 +08002420 MBEDTLS_SSL_DEBUG_MSG( 1,
2421 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002422 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002423
Ronald Cron9df7c802022-03-08 18:38:54 +01002424#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002425 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002426 {
2427 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2428 if( ret != 0 )
2429 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002430
Ronald Cron7a94aca2022-03-09 07:44:27 +01002431 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2432 non_empty_certificate_msg = 1;
2433 }
2434 else
2435 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002436 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002437 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002438#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002439
Ronald Cron7a94aca2022-03-09 07:44:27 +01002440 if( non_empty_certificate_msg )
2441 {
2442 mbedtls_ssl_handshake_set_state( ssl,
2443 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2444 }
2445 else
Ronald Cron19385882022-06-15 16:26:13 +02002446 {
2447 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002448 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002449 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002450
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002451 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002452}
2453
Ronald Cron9df7c802022-03-08 18:38:54 +01002454#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002455/*
2456 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2457 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002458MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002459static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2460{
Ronald Crona8b38872022-03-09 07:59:25 +01002461 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2462
2463 if( ret == 0 )
2464 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2465
2466 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002467}
Jerry Yu90f152d2022-01-29 22:12:42 +08002468#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002469
2470/*
Jerry Yu687101b2021-09-14 16:03:56 +08002471 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2472 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002473MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002474static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002475{
XiaokangQian0fa66432021-11-15 03:33:57 +00002476 int ret;
2477
2478 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2479 if( ret != 0 )
2480 return( ret );
2481
Jerry Yu466dda82022-09-13 11:20:20 +08002482 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002483 if( ret != 0 )
2484 {
2485 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002486 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002487 return ( ret );
2488 }
2489
XiaokangQian0fa66432021-11-15 03:33:57 +00002490 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2491 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002492}
2493
2494/*
2495 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2496 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002497MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002498static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002499{
Jerry Yu378254d2021-10-30 21:44:47 +08002500 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002501 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002502 return( 0 );
2503}
2504
2505/*
2506 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2507 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002508MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002509static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002510{
Jerry Yu378254d2021-10-30 21:44:47 +08002511
2512 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2513
2514 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2515 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002516}
2517
Jerry Yuf8a49942022-07-07 11:32:32 +00002518#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2519
Jerry Yua0446a02022-07-13 11:22:55 +08002520MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002521static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2522 const unsigned char *buf,
2523 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002524{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002525 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002526
2527 ((void) ssl);
2528
2529 while( p < end )
2530 {
2531 unsigned int extension_type;
2532 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002533
Jerry Yuf8a49942022-07-07 11:32:32 +00002534 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2535 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2536 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2537 p += 4;
2538
2539 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002540
2541 switch( extension_type )
2542 {
2543 case MBEDTLS_TLS_EXT_EARLY_DATA:
2544 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2545 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002546
Jerry Yuf8a49942022-07-07 11:32:32 +00002547 default:
2548 break;
2549 }
2550 p += extension_data_len;
2551 }
2552
2553 return( 0 );
2554}
2555
2556/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002557 * From RFC8446, page 74
2558 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002559 * struct {
2560 * uint32 ticket_lifetime;
2561 * uint32 ticket_age_add;
2562 * opaque ticket_nonce<0..255>;
2563 * opaque ticket<1..2^16-1>;
2564 * Extension extensions<0..2^16-2>;
2565 * } NewSessionTicket;
2566 *
2567 */
Jerry Yua0446a02022-07-13 11:22:55 +08002568MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002569static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2570 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002571 unsigned char *end,
2572 unsigned char **ticket_nonce,
2573 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002574{
2575 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2576 unsigned char *p = buf;
2577 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002578 size_t ticket_len;
2579 unsigned char *ticket;
2580 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002581
Jerry Yucb3b1392022-07-12 06:09:38 +00002582 *ticket_nonce = NULL;
2583 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002584 /*
2585 * ticket_lifetime 4 bytes
2586 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002587 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002588 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002589 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002590
2591 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002592 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002593 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002594 ( unsigned int )session->ticket_lifetime ) );
2595
Jerry Yucb3b1392022-07-12 06:09:38 +00002596 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002597 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002598 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002599 ( unsigned int )session->ticket_age_add ) );
2600
Jerry Yucb3b1392022-07-12 06:09:38 +00002601 *ticket_nonce_len = p[8];
2602 p += 9;
2603
2604 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2605 *ticket_nonce = p;
2606 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2607 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002608
2609 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002610 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002611 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2612 p += 2;
2613 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002614 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2615
2616 /* Check if we previously received a ticket already. */
2617 if( session->ticket != NULL || session->ticket_len > 0 )
2618 {
2619 mbedtls_free( session->ticket );
2620 session->ticket = NULL;
2621 session->ticket_len = 0;
2622 }
2623
2624 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2625 {
2626 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2627 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2628 }
2629 memcpy( ticket, p, ticket_len );
2630 p += ticket_len;
2631 session->ticket = ticket;
2632 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002633
Jerry Yucb3b1392022-07-12 06:09:38 +00002634 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002635 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2636 p += 2;
2637 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2638
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002639 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002640
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002641 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002642 if( ret != 0 )
2643 {
2644 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002645 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002646 ret );
2647 return( ret );
2648 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002649
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002650 /* session has been updated, allow export */
2651 session->exported = 0;
2652
Jerry Yucb3b1392022-07-12 06:09:38 +00002653 return( 0 );
2654}
2655
Jerry Yua0446a02022-07-13 11:22:55 +08002656MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002657static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2658 unsigned char *ticket_nonce,
2659 size_t ticket_nonce_len )
2660{
2661 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2662 mbedtls_ssl_session *session = ssl->session;
2663 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2664 psa_algorithm_t psa_hash_alg;
2665 int hash_length;
2666
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002667#if defined(MBEDTLS_HAVE_TIME)
2668 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002669 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002670#endif
2671
Jerry Yuf8a49942022-07-07 11:32:32 +00002672 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2673 if( ciphersuite_info == NULL )
2674 {
2675 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2676 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2677 }
2678
2679 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2680 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002681 if( hash_length == -1 ||
2682 ( size_t )hash_length > sizeof( session->resumption_key ) )
2683 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002684 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002685 }
2686
Jerry Yuf8a49942022-07-07 11:32:32 +00002687
2688 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2689 session->app_secrets.resumption_master_secret,
2690 hash_length );
2691
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002692 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002693 *
2694 * HKDF-Expand-Label( resumption_master_secret,
2695 * "resumption", ticket_nonce, Hash.length )
2696 */
2697 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2698 psa_hash_alg,
2699 session->app_secrets.resumption_master_secret,
2700 hash_length,
2701 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2702 ticket_nonce,
2703 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002704 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002705 hash_length );
2706
2707 if( ret != 0 )
2708 {
2709 MBEDTLS_SSL_DEBUG_RET( 2,
2710 "Creating the ticket-resumed PSK failed",
2711 ret );
2712 return( ret );
2713 }
2714
Jerry Yu0a430c82022-07-20 11:02:48 +08002715 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002716
2717 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002718 session->resumption_key,
2719 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002720
Jerry Yuf8a49942022-07-07 11:32:32 +00002721 return( 0 );
2722}
2723
2724/*
Jerry Yua357cf42022-07-12 05:36:45 +00002725 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002726 */
Jerry Yua0446a02022-07-13 11:22:55 +08002727MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002728static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2729{
2730 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2731 unsigned char *buf;
2732 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002733 unsigned char *ticket_nonce;
2734 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002735
2736 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2737
2738 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2739 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2740 &buf, &buf_len ) );
2741
Jerry Yucb3b1392022-07-12 06:09:38 +00002742 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2743 ssl, buf, buf + buf_len,
2744 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002745
Jerry Yucb3b1392022-07-12 06:09:38 +00002746 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2747 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002748
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002749 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2750
Jerry Yuf8a49942022-07-07 11:32:32 +00002751cleanup:
2752
2753 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2754 return( ret );
2755}
2756#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2757
Jerry Yu92c6b402021-08-27 16:59:09 +08002758int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002759{
Jerry Yu92c6b402021-08-27 16:59:09 +08002760 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002761
Jerry Yu92c6b402021-08-27 16:59:09 +08002762 switch( ssl->state )
2763 {
2764 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002765 * ssl->state is initialized as HELLO_REQUEST. It is the same
2766 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002767 */
2768 case MBEDTLS_SSL_HELLO_REQUEST:
2769 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002770 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002771 break;
2772
2773 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002774 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002775 break;
2776
2777 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002778 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002779 break;
2780
Jerry Yua93ac112021-10-27 16:31:48 +08002781#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002782 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2783 ret = ssl_tls13_process_certificate_request( ssl );
2784 break;
2785
Jerry Yu687101b2021-09-14 16:03:56 +08002786 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002787 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002788 break;
2789
2790 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002791 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002792 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002793#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002794
2795 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002796 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002797 break;
2798
Jerry Yu566c7812022-01-26 15:41:22 +08002799 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2800 ret = ssl_tls13_write_client_certificate( ssl );
2801 break;
2802
Ronald Cron9df7c802022-03-08 18:38:54 +01002803#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002804 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2805 ret = ssl_tls13_write_client_certificate_verify( ssl );
2806 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002807#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002808
Jerry Yu687101b2021-09-14 16:03:56 +08002809 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002810 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002811 break;
2812
2813 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002814 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002815 break;
2816
2817 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002818 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002819 break;
2820
Ronald Cron49ad6192021-11-24 16:25:31 +01002821 /*
2822 * Injection of dummy-CCS's for middlebox compatibility
2823 */
2824#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002825 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002826 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2827 if( ret == 0 )
2828 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2829 break;
2830
2831 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2832 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2833 if( ret == 0 )
2834 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002835 break;
2836#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2837
Jerry Yuf8a49942022-07-07 11:32:32 +00002838#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002839 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002840 ret = ssl_tls13_process_new_session_ticket( ssl );
2841 if( ret != 0 )
2842 break;
2843 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2844 break;
2845#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2846
Jerry Yu92c6b402021-08-27 16:59:09 +08002847 default:
2848 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2849 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2850 }
2851
2852 return( ret );
2853}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002854
Jerry Yufb4b6472022-01-27 15:03:26 +08002855#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002856
Jerry Yufb4b6472022-01-27 15:03:26 +08002857