blob: 2b59b4aae1c89cc93d21076c3338db954cc7d015 [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 Yua99cbfa2022-10-08 11:17:14 +0800668static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg( int ciphersuite )
Jerry Yuf7c12592022-09-28 22:09:38 +0800669{
Jerry Yu21f90952022-10-08 10:30:53 +0800670 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
671 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800672
Jerry Yua99cbfa2022-10-08 11:17:14 +0800673 if( ciphersuite_info != NULL )
674 return( mbedtls_psa_translate_md( ciphersuite_info->mac ) );
675
Jerry Yu21f90952022-10-08 10:30:53 +0800676 return( PSA_ALG_NONE );
Jerry Yuf7c12592022-09-28 22:09:38 +0800677}
678
Jerry Yuf75364b2022-09-30 10:30:31 +0800679#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf7c12592022-09-28 22:09:38 +0800680static int ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl )
681{
Jerry Yuf7c12592022-09-28 22:09:38 +0800682 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu4f77ecf2022-10-10 22:10:08 +0800683 return( ssl->handshake->resume &&
684 session != NULL && session->ticket != NULL );
Jerry Yuf7c12592022-09-28 22:09:38 +0800685}
686
Jerry Yuf7c12592022-09-28 22:09:38 +0800687MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800688static int ssl_tls13_ticket_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800689 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800690 const unsigned char **identity,
691 size_t *identity_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800692{
693 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800694
Jerry Yu8b41e892022-09-30 10:00:20 +0800695 if( !ssl_tls13_has_configured_ticket( ssl ) )
696 return( -1 );
697
Jerry Yua99cbfa2022-10-08 11:17:14 +0800698 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800699 *identity = session->ticket;
700 *identity_len = session->ticket_len;
701 return( 0 );
702}
703
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800704MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800705static int ssl_tls13_ticket_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800706 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800707 const unsigned char **psk,
708 size_t *psk_len )
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800709{
710
711 mbedtls_ssl_session *session = ssl->session_negotiate;
712
Jerry Yu8b41e892022-09-30 10:00:20 +0800713 if( !ssl_tls13_has_configured_ticket( ssl ) )
714 return( -1 );
715
Jerry Yua99cbfa2022-10-08 11:17:14 +0800716 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800717 *psk = session->resumption_key;
718 *psk_len = session->resumption_key_len;
719
720 return( 0 );
721}
Jerry Yuf7c12592022-09-28 22:09:38 +0800722#endif /* MBEDTLS_SSL_SESSION_TICKETS */
723
Jerry Yua99cbfa2022-10-08 11:17:14 +0800724static int ssl_tls13_has_configured_psk( const mbedtls_ssl_config *conf )
Jerry Yuf75364b2022-09-30 10:30:31 +0800725{
Jerry Yua99cbfa2022-10-08 11:17:14 +0800726 return( conf->psk != NULL && conf->psk_identity != NULL );
Jerry Yuf75364b2022-09-30 10:30:31 +0800727}
728
Jerry Yuf7c12592022-09-28 22:09:38 +0800729MBEDTLS_CHECK_RETURN_CRITICAL
730static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800731 psa_algorithm_t *hash_alg,
Jerry Yuf7c12592022-09-28 22:09:38 +0800732 const unsigned char **identity,
733 size_t *identity_len )
734{
Jerry Yu8b41e892022-09-30 10:00:20 +0800735
Jerry Yua99cbfa2022-10-08 11:17:14 +0800736 if( !ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800737 return( -1 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800738
Jerry Yua99cbfa2022-10-08 11:17:14 +0800739 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800740 *identity = ssl->conf->psk_identity;
741 *identity_len = ssl->conf->psk_identity_len;
742 return( 0 );
743}
744
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800745MBEDTLS_CHECK_RETURN_CRITICAL
746static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800747 psa_algorithm_t *hash_alg,
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800748 const unsigned char **psk,
749 size_t *psk_len )
750{
Jerry Yu8b41e892022-09-30 10:00:20 +0800751
Jerry Yua99cbfa2022-10-08 11:17:14 +0800752 if( !ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800753 return( -1 );
754
Jerry Yua99cbfa2022-10-08 11:17:14 +0800755 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800756 *psk = ssl->conf->psk;
757 *psk_len = ssl->conf->psk_len;
758 return( 0 );
759}
760
Jerry Yuf75364b2022-09-30 10:30:31 +0800761static int ssl_tls13_get_configured_psk_count( mbedtls_ssl_context *ssl )
762{
763 int configured_psk_count = 0;
764#if defined(MBEDTLS_SSL_SESSION_TICKETS)
765 if( ssl_tls13_has_configured_ticket( ssl ) )
766 {
767 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Ticket is configured" ) );
768 configured_psk_count++;
769 }
770#endif
Jerry Yua99cbfa2022-10-08 11:17:14 +0800771 if( ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yuf75364b2022-09-30 10:30:31 +0800772 {
773 MBEDTLS_SSL_DEBUG_MSG( 3, ( "PSK is configured" ) );
774 configured_psk_count++;
775 }
776 return( configured_psk_count );
777}
778
Jerry Yuf7c12592022-09-28 22:09:38 +0800779MBEDTLS_CHECK_RETURN_CRITICAL
780static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
781 unsigned char *buf,
782 unsigned char *end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800783 const unsigned char *identity,
784 size_t identity_len,
785 uint32_t obfuscated_ticket_age,
786 size_t *out_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800787{
Jerry Yuf75364b2022-09-30 10:30:31 +0800788 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800789 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800790
791 /*
792 * - identity_len (2 bytes)
793 * - identity (psk_identity_len bytes)
794 * - obfuscated_ticket_age (4 bytes)
795 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800796 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800797
Jerry Yua99cbfa2022-10-08 11:17:14 +0800798 MBEDTLS_PUT_UINT16_BE( identity_len, buf, 0 );
799 memcpy( buf + 2, identity, identity_len );
800 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, buf, 2 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800801
Jerry Yua99cbfa2022-10-08 11:17:14 +0800802 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", buf, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800803
804 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800805
806 return( 0 );
807}
808
Jerry Yu8b41e892022-09-30 10:00:20 +0800809MBEDTLS_CHECK_RETURN_CRITICAL
810static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
811 unsigned char *buf,
812 unsigned char *end,
813 int psk_type,
Jerry Yu6183cc72022-09-30 11:08:57 +0800814 psa_algorithm_t hash_alg,
815 const unsigned char *psk,
816 size_t psk_len,
Jerry Yu8b41e892022-09-30 10:00:20 +0800817 size_t *out_len )
818{
819 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800820 unsigned char binder_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800821 unsigned char transcript[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Jerry Yu8b41e892022-09-30 10:00:20 +0800822 size_t transcript_len = 0;
823
824 *out_len = 0;
825
Jerry Yu6183cc72022-09-30 11:08:57 +0800826 binder_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yu8b41e892022-09-30 10:00:20 +0800827
828 /*
829 * - binder_len (1 bytes)
830 * - binder (binder_len bytes)
831 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800832 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800833
Jerry Yua99cbfa2022-10-08 11:17:14 +0800834 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800835
836 /* Get current state of handshake transcript. */
837 ret = mbedtls_ssl_get_handshake_transcript(
Jerry Yu6183cc72022-09-30 11:08:57 +0800838 ssl, mbedtls_hash_info_md_from_psa( hash_alg ),
Jerry Yu6916e702022-10-10 21:33:51 +0800839 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800840 if( ret != 0 )
841 return( ret );
842
Jerry Yu6183cc72022-09-30 11:08:57 +0800843 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800844 psk, psk_len, psk_type,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800845 transcript, buf + 1 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800846 if( ret != 0 )
847 {
848 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
849 return( ret );
850 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800851 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", buf, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800852
853 *out_len = 1 + binder_len;
854
Jerry Yu6916e702022-10-10 21:33:51 +0800855 return( 0 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800856}
857
858/*
859 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
860 *
861 * struct {
862 * opaque identity<1..2^16-1>;
863 * uint32 obfuscated_ticket_age;
864 * } PskIdentity;
865 *
866 * opaque PskBinderEntry<32..255>;
867 *
868 * struct {
869 * PskIdentity identities<7..2^16-1>;
870 * PskBinderEntry binders<33..2^16-1>;
871 * } OfferedPsks;
872 *
873 * struct {
874 * select (Handshake.msg_type) {
875 * case client_hello: OfferedPsks;
876 * ...
877 * };
878 * } PreSharedKeyExtension;
879 *
880 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000881int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Jerry Yuf75364b2022-09-30 10:30:31 +0800882 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
883 size_t *out_len, size_t *binders_len )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000884{
Jerry Yuf7c12592022-09-28 22:09:38 +0800885 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800886 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800887 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800888 psa_algorithm_t hash_alg;
889 const unsigned char *identity;
890 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800891 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800892 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800893
894 *out_len = 0;
895 *binders_len = 0;
896
897 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Jerry Yuf75364b2022-09-30 10:30:31 +0800898 configured_psk_count = ssl_tls13_get_configured_psk_count( ssl );
899 if( configured_psk_count == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800900 {
901 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
902 return( 0 );
903 }
904
905 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
Jerry Yuf75364b2022-09-30 10:30:31 +0800906 configured_psk_count ) );
907
Jerry Yuf7c12592022-09-28 22:09:38 +0800908 /* Check if we have space to write the extension, binders included.
909 * - extension_type (2 bytes)
910 * - extension_data_len (2 bytes)
911 * - identities_len (2 bytes)
912 */
913 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
914 p += 6;
915
Jerry Yuf75364b2022-09-30 10:30:31 +0800916#if defined(MBEDTLS_SSL_SESSION_TICKETS)
917 if( ssl_tls13_ticket_get_identity(
918 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800919 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800920#if defined(MBEDTLS_HAVE_TIME)
921 mbedtls_time_t now = mbedtls_time( NULL );
922 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800923 uint32_t obfuscated_ticket_age =
924 (uint32_t)( now - session->ticket_received );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800925
Jerry Yuf75364b2022-09-30 10:30:31 +0800926 obfuscated_ticket_age *= 1000;
927 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800928
Jerry Yuf7c12592022-09-28 22:09:38 +0800929 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800930 identity, identity_len,
931 obfuscated_ticket_age,
932 &output_len );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800933#else
934 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len,
935 0, &output_len );
936#endif /* MBEDTLS_HAVE_TIME */
Jerry Yuf7c12592022-09-28 22:09:38 +0800937 if( ret != 0 )
938 return( ret );
Jerry Yuf7c12592022-09-28 22:09:38 +0800939
Jerry Yuf75364b2022-09-30 10:30:31 +0800940 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800941 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf75364b2022-09-30 10:30:31 +0800942 }
943#endif /* MBEDTLS_SSL_SESSION_TICKETS */
944
945 if( ssl_tls13_psk_get_identity(
946 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800947 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800948
Jerry Yua99cbfa2022-10-08 11:17:14 +0800949 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len, 0,
Jerry Yuf75364b2022-09-30 10:30:31 +0800950 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800951 if( ret != 0 )
952 return( ret );
Jerry Yuf75364b2022-09-30 10:30:31 +0800953
Jerry Yuf7c12592022-09-28 22:09:38 +0800954 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800955 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf7c12592022-09-28 22:09:38 +0800956 }
957
958 MBEDTLS_SSL_DEBUG_MSG( 3,
959 ( "client hello, adding pre_shared_key extension, "
960 "omitting PSK binder list" ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800961
962 /* Take into account the two bytes for the length of the binders. */
963 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800964 /* Check if there is enough space for binders */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800965 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len );
966
Jerry Yuf7c12592022-09-28 22:09:38 +0800967 /*
968 * - extension_type (2 bytes)
969 * - extension_data_len (2 bytes)
970 * - identities_len (2 bytes)
971 */
972 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800973 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + l_binders_len , buf, 2 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800974 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
975
Jerry Yua99cbfa2022-10-08 11:17:14 +0800976 *out_len = ( p - buf ) + l_binders_len;
977 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800978
979 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
980
981 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
982
XiaokangQianeb69aee2022-07-05 08:21:43 +0000983 return( 0 );
984}
985
XiaokangQian86981952022-07-19 09:51:50 +0000986int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +0800987 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000988{
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800989 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
990 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +0800991 psa_algorithm_t hash_alg = PSA_ALG_NONE;
992 const unsigned char *psk;
993 size_t psk_len;
994 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800995
996 /* Check if we have space to write binders_len.
997 * - binders_len (2 bytes)
998 */
999 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1000 p += 2;
1001
Jerry Yu6183cc72022-09-30 11:08:57 +08001002#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1003 if( ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001004 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001005
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001006 ret = ssl_tls13_write_binder( ssl, p, end,
1007 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
Jerry Yu6183cc72022-09-30 11:08:57 +08001008 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001009 &output_len );
1010 if( ret != 0 )
1011 return( ret );
1012 p += output_len;
1013 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001014#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001015
Jerry Yu6183cc72022-09-30 11:08:57 +08001016 if( ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001017 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001018
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001019 ret = ssl_tls13_write_binder( ssl, p, end,
1020 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
Jerry Yu6183cc72022-09-30 11:08:57 +08001021 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001022 &output_len );
1023 if( ret != 0 )
1024 return( ret );
1025 p += output_len;
1026 }
1027
1028 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1029
1030 /*
1031 * - binders_len (2 bytes)
1032 */
1033 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1034
1035 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001036
1037 return( 0 );
1038}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001039
1040/*
1041 * struct {
1042 * opaque identity<1..2^16-1>;
1043 * uint32 obfuscated_ticket_age;
1044 * } PskIdentity;
1045 *
1046 * opaque PskBinderEntry<32..255>;
1047 *
1048 * struct {
1049 *
1050 * select (Handshake.msg_type) {
1051 * ...
1052 * case server_hello: uint16 selected_identity;
1053 * };
1054 *
1055 * } PreSharedKeyExtension;
1056 *
1057 */
1058MBEDTLS_CHECK_RETURN_CRITICAL
1059static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1060 const unsigned char *buf,
1061 const unsigned char *end )
1062{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001063 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001064 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001065 const unsigned char *psk;
1066 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001067 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001068
Jerry Yua99cbfa2022-10-08 11:17:14 +08001069 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Jerry Yub300e3c2022-09-28 22:12:07 +08001070 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001071
Jerry Yub300e3c2022-09-28 22:12:07 +08001072 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001073
Jerry Yu4a698342022-09-30 12:22:01 +08001074 if( selected_identity >= ssl_tls13_get_configured_psk_count( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001075 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001076 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid PSK identity." ) );
Jerry Yu4a698342022-09-30 12:22:01 +08001077
1078 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1079 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1080 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yub300e3c2022-09-28 22:12:07 +08001081 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001082
Jerry Yu4a698342022-09-30 12:22:01 +08001083#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1084 if( selected_identity == 0 && ssl_tls13_has_configured_ticket( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001085 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001086 ret = ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yu4a698342022-09-30 12:22:01 +08001087 }
1088 else
1089#endif
Jerry Yua99cbfa2022-10-08 11:17:14 +08001090 if( ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu4a698342022-09-30 12:22:01 +08001091 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001092 ret = ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001093 }
1094 else
1095 {
1096 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1097 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1098 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001099 if( ret != 0 )
1100 return( ret );
1101
1102 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1103 if( ret != 0 )
1104 {
1105 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
Jerry Yu6916e702022-10-10 21:33:51 +08001106 return( ret );
Jerry Yub300e3c2022-09-28 22:12:07 +08001107 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001108
Jerry Yu6916e702022-10-10 21:33:51 +08001109 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1110
1111 return( 0 );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001112}
1113
XiaokangQianeb69aee2022-07-05 08:21:43 +00001114#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1115
Ronald Cron3d580bf2022-02-18 17:24:56 +01001116int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1117 unsigned char *buf,
1118 unsigned char *end,
1119 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001120{
1121 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1122 unsigned char *p = buf;
1123 size_t ext_len;
1124
1125 *out_len = 0;
1126
1127 /* Write supported_versions extension
1128 *
1129 * Supported Versions Extension is mandatory with TLS 1.3.
1130 */
1131 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1132 if( ret != 0 )
1133 return( ret );
1134 p += ext_len;
1135
1136 /* Echo the cookie if the server provided one in its preceding
1137 * HelloRetryRequest message.
1138 */
1139 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1140 if( ret != 0 )
1141 return( ret );
1142 p += ext_len;
1143
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001144 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1145 {
1146 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1147 if( ret != 0 )
1148 return( ret );
1149 p += ext_len;
1150 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001151
XiaokangQianeb69aee2022-07-05 08:21:43 +00001152#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1153 /* For PSK-based key exchange we need the pre_shared_key extension
1154 * and the psk_key_exchange_modes extension.
1155 *
1156 * The pre_shared_key extension MUST be the last extension in the
1157 * ClientHello. Servers MUST check that it is the last extension and
1158 * otherwise fail the handshake with an "illegal_parameter" alert.
1159 *
1160 * Add the psk_key_exchange_modes extension.
1161 */
1162 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1163 if( ret != 0 )
1164 return( ret );
1165 p += ext_len;
1166#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1167
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001168 *out_len = p - buf;
1169
1170 return( 0 );
1171}
1172
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001173/*
Jerry Yu4a173382021-10-11 21:45:31 +08001174 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001175 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001176
Ronald Cronda41b382022-03-30 09:57:11 +02001177/**
1178 * \brief Detect if the ServerHello contains a supported_versions extension
1179 * or not.
1180 *
1181 * \param[in] ssl SSL context
1182 * \param[in] buf Buffer containing the ServerHello message
1183 * \param[in] end End of the buffer containing the ServerHello message
1184 *
1185 * \return 0 if the ServerHello does not contain a supported_versions extension
1186 * \return 1 if the ServerHello contains a supported_versions extension
1187 * \return A negative value if an error occurred while parsing the ServerHello.
1188 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001189MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001190static int ssl_tls13_is_supported_versions_ext_present(
1191 mbedtls_ssl_context *ssl,
1192 const unsigned char *buf,
1193 const unsigned char *end )
1194{
1195 const unsigned char *p = buf;
1196 size_t legacy_session_id_echo_len;
1197 size_t extensions_len;
1198 const unsigned char *extensions_end;
1199
1200 /*
1201 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001202 * length:
1203 * - legacy_version 2 bytes
1204 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1205 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001206 */
1207 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1208 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1209 legacy_session_id_echo_len = *p;
1210
1211 /*
1212 * Jump to the extensions, jumping over:
1213 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1214 * - cipher_suite 2 bytes
1215 * - legacy_compression_method 1 byte
1216 */
Ronald Cron28271062022-06-10 14:43:55 +02001217 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001218 p += legacy_session_id_echo_len + 4;
1219
1220 /* Case of no extension */
1221 if( p == end )
1222 return( 0 );
1223
1224 /* ...
1225 * Extension extensions<6..2^16-1>;
1226 * ...
1227 * struct {
1228 * ExtensionType extension_type; (2 bytes)
1229 * opaque extension_data<0..2^16-1>;
1230 * } Extension;
1231 */
1232 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1233 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1234 p += 2;
1235
1236 /* Check extensions do not go beyond the buffer of data. */
1237 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1238 extensions_end = p + extensions_len;
1239
1240 while( p < extensions_end )
1241 {
1242 unsigned int extension_type;
1243 size_t extension_data_len;
1244
1245 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1246 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1247 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1248 p += 4;
1249
1250 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1251 return( 1 );
1252
1253 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1254 p += extension_data_len;
1255 }
1256
1257 return( 0 );
1258}
1259
Jerry Yu7a186a02021-10-15 18:46:14 +08001260/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001261 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1262 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1263 * - 0 otherwise
1264 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001265MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001266static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1267 const unsigned char *buf,
1268 const unsigned char *end )
1269{
1270 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1271 static const unsigned char magic_downgrade_string[] =
1272 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1273 const unsigned char *last_eight_bytes_of_random;
1274 unsigned char last_byte_of_random;
1275
1276 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1277 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1278
1279 if( memcmp( last_eight_bytes_of_random,
1280 magic_downgrade_string,
1281 sizeof( magic_downgrade_string ) ) == 0 )
1282 {
1283 last_byte_of_random = last_eight_bytes_of_random[7];
1284 return( last_byte_of_random == 0 ||
1285 last_byte_of_random == 1 );
1286 }
1287
1288 return( 0 );
1289}
1290
1291/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001292 * - SSL_SERVER_HELLO or
1293 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001294 * to indicate which message is expected and to be parsed next.
1295 */
Ronald Cron828aff62022-05-31 12:04:31 +02001296#define SSL_SERVER_HELLO 0
1297#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001298MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001299static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1300 const unsigned char *buf,
1301 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001302{
Jerry Yue1b9c292021-09-10 10:08:31 +08001303
1304 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1305 *
Jerry Yu4a173382021-10-11 21:45:31 +08001306 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001307 * special value of the SHA-256 of "HelloRetryRequest".
1308 *
1309 * struct {
1310 * ProtocolVersion legacy_version = 0x0303;
1311 * Random random;
1312 * opaque legacy_session_id_echo<0..32>;
1313 * CipherSuite cipher_suite;
1314 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001315 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001316 * } ServerHello;
1317 *
1318 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001319 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1320 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001321
Jerry Yu93a13f22022-04-11 23:00:01 +08001322 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1323 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001324 {
Ronald Cron828aff62022-05-31 12:04:31 +02001325 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001326 }
1327
Ronald Cron828aff62022-05-31 12:04:31 +02001328 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001329}
1330
Ronald Cron828aff62022-05-31 12:04:31 +02001331/*
Jerry Yu745bb612021-10-13 22:01:04 +08001332 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001333 * - SSL_SERVER_HELLO or
1334 * - SSL_SERVER_HELLO_HRR or
1335 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001336 */
Ronald Cron828aff62022-05-31 12:04:31 +02001337#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001338MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001339static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001340 const unsigned char *buf,
1341 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001342{
Jerry Yu4a173382021-10-11 21:45:31 +08001343 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001344 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001345
Ronald Cron9f0fba32022-02-10 16:45:15 +01001346 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001347 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001348
Ronald Cron9f0fba32022-02-10 16:45:15 +01001349 if( ret == 0 )
1350 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001351 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001352 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001353
1354 /* If the server is negotiating TLS 1.2 or below and:
1355 * . we did not propose TLS 1.2 or
1356 * . the server responded it is TLS 1.3 capable but negotiating a lower
1357 * version of the protocol and thus we are under downgrade attack
1358 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001359 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001360 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361 {
1362 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1363 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1364 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1365 }
1366
1367 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001368 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001369 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001370 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001371
1372 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1373 {
1374 ret = ssl_tls13_reset_key_share( ssl );
1375 if( ret != 0 )
1376 return( ret );
1377 }
1378
Ronald Cron828aff62022-05-31 12:04:31 +02001379 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001380 }
1381
Jerry Yua66fece2022-07-13 14:30:29 +08001382#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1383 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1384 ssl->session_negotiate->tls_version = ssl->tls_version;
1385#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1386
Ronald Cron5afb9042022-05-31 12:11:39 +02001387 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1388
Ronald Crondb5dfa12022-05-31 11:44:38 +02001389 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001390 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001391 {
Ronald Cron828aff62022-05-31 12:04:31 +02001392 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001393 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1394 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001395 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001396 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001397 /* If a client receives a second
1398 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1399 * was itself in response to a HelloRetryRequest), it MUST abort the
1400 * handshake with an "unexpected_message" alert.
1401 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001402 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001403 {
1404 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1405 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1406 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1407 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1408 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001409 /*
1410 * Clients must abort the handshake with an "illegal_parameter"
1411 * alert if the HelloRetryRequest would not result in any change
1412 * in the ClientHello.
1413 * In a PSK only key exchange that what we expect.
1414 */
1415 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1416 {
1417 MBEDTLS_SSL_DEBUG_MSG( 1,
1418 ( "Unexpected HRR in pure PSK key exchange." ) );
1419 MBEDTLS_SSL_PEND_FATAL_ALERT(
1420 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1421 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1422 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1423 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001424
Ronald Cron5afb9042022-05-31 12:11:39 +02001425 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001426
Jerry Yu745bb612021-10-13 22:01:04 +08001427 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001428 }
1429
1430cleanup:
1431
1432 return( ret );
1433}
1434
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001435MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001436static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1437 const unsigned char **buf,
1438 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001439{
1440 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001441 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001442
Jerry Yude4fb2c2021-09-19 18:05:08 +08001443 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001444 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001445
Jerry Yu4a173382021-10-11 21:45:31 +08001446 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001447
1448 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001449 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1450 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001451 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001452 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1453 ssl->session_negotiate->id,
1454 ssl->session_negotiate->id_len );
1455 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001456 legacy_session_id_echo_len );
1457
1458 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1459 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1460
Jerry Yue1b9c292021-09-10 10:08:31 +08001461 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1462 }
1463
Jerry Yu4a173382021-10-11 21:45:31 +08001464 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001465 *buf = p;
1466
1467 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001468 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001469 return( 0 );
1470}
1471
Jerry Yue1b9c292021-09-10 10:08:31 +08001472/* Parse ServerHello message and configure context
1473 *
1474 * struct {
1475 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1476 * Random random;
1477 * opaque legacy_session_id_echo<0..32>;
1478 * CipherSuite cipher_suite;
1479 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001480 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001481 * } ServerHello;
1482 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001483MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001484static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1485 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001486 const unsigned char *end,
1487 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001488{
Jerry Yub85277e2021-10-13 13:36:05 +08001489 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001490 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001491 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001492 size_t extensions_len;
1493 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001494 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001495 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001496 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001497
1498 /*
1499 * Check there is space for minimal fields
1500 *
1501 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001502 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001503 * - legacy_session_id_echo ( 1 byte ), minimum size
1504 * - cipher_suite ( 2 bytes)
1505 * - legacy_compression_method ( 1 byte )
1506 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001507 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001508
1509 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001510 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1511
Jerry Yu4a173382021-10-11 21:45:31 +08001512 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001513 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001514 * ...
1515 * with ProtocolVersion defined as:
1516 * uint16 ProtocolVersion;
1517 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001518 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1519 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001520 {
1521 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1522 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1523 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001524 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1525 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001526 }
1527 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001528
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001529 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001530 * Random random;
1531 * ...
1532 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001533 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001534 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001535 if( !is_hrr )
1536 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001537 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001538 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1539 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1540 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1541 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001542 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001543
Jerry Yu4a173382021-10-11 21:45:31 +08001544 /* ...
1545 * opaque legacy_session_id_echo<0..32>;
1546 * ...
1547 */
1548 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001549 {
XiaokangQian52da5582022-01-26 09:49:29 +00001550 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001551 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001552 }
1553
Jerry Yu4a173382021-10-11 21:45:31 +08001554 /* ...
1555 * CipherSuite cipher_suite;
1556 * ...
1557 * with CipherSuite defined as:
1558 * uint8 CipherSuite[2];
1559 */
1560 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001561 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1562 p += 2;
1563
Jerry Yu4a173382021-10-11 21:45:31 +08001564
XiaokangQian355e09a2022-01-20 11:14:50 +00001565 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001566 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001567 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001568 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001569 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1570 ssl->tls_version,
1571 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001572 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001573 {
XiaokangQian52da5582022-01-26 09:49:29 +00001574 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001575 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001576 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001577 * If we received an HRR before and that the proposed selected
1578 * ciphersuite in this server hello is not the same as the one
1579 * proposed in the HRR, we abort the handshake and send an
1580 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001581 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001582 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1583 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001584 {
XiaokangQian52da5582022-01-26 09:49:29 +00001585 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001586 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001587
XiaokangQian52da5582022-01-26 09:49:29 +00001588 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001589 {
1590 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1591 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001592 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001593 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001594
Jerry Yu4a173382021-10-11 21:45:31 +08001595 /* Configure ciphersuites */
1596 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1597
XiaokangQian355e09a2022-01-20 11:14:50 +00001598 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001599 ssl->session_negotiate->ciphersuite = cipher_suite;
1600
Jerry Yue1b9c292021-09-10 10:08:31 +08001601 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1602 cipher_suite, ciphersuite_info->name ) );
1603
1604#if defined(MBEDTLS_HAVE_TIME)
1605 ssl->session_negotiate->start = time( NULL );
1606#endif /* MBEDTLS_HAVE_TIME */
1607
Jerry Yu4a173382021-10-11 21:45:31 +08001608 /* ...
1609 * uint8 legacy_compression_method = 0;
1610 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001611 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001612 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001613 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001614 {
Jerry Yub85277e2021-10-13 13:36:05 +08001615 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001616 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001617 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001618 }
1619 p++;
1620
Jerry Yub85277e2021-10-13 13:36:05 +08001621 /* ...
1622 * Extension extensions<6..2^16-1>;
1623 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001624 * struct {
1625 * ExtensionType extension_type; (2 bytes)
1626 * opaque extension_data<0..2^16-1>;
1627 * } Extension;
1628 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001629 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001630 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001631 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001632
Jerry Yu4a173382021-10-11 21:45:31 +08001633 /* Check extensions do not go beyond the buffer of data. */
1634 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1635 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001636
Jerry Yu4a173382021-10-11 21:45:31 +08001637 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001638
Jerry Yu4a173382021-10-11 21:45:31 +08001639 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001640 {
1641 unsigned int extension_type;
1642 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001643 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001644
Jerry Yu4a173382021-10-11 21:45:31 +08001645 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001646 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1647 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1648 p += 4;
1649
Jerry Yu4a173382021-10-11 21:45:31 +08001650 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001651 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001652
1653 switch( extension_type )
1654 {
XiaokangQianb851da82022-01-14 04:03:11 +00001655 case MBEDTLS_TLS_EXT_COOKIE:
1656
XiaokangQiand9e068e2022-01-18 06:23:32 +00001657 if( !is_hrr )
1658 {
XiaokangQian52da5582022-01-26 09:49:29 +00001659 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001660 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001661 }
1662
XiaokangQian43550bd2022-01-21 04:32:58 +00001663 ret = ssl_tls13_parse_cookie_ext( ssl,
1664 p, extension_data_end );
1665 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001666 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001667 MBEDTLS_SSL_DEBUG_RET( 1,
1668 "ssl_tls13_parse_cookie_ext",
1669 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001670 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001671 }
XiaokangQianb851da82022-01-14 04:03:11 +00001672 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001673
Jerry Yue1b9c292021-09-10 10:08:31 +08001674 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001675 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001676 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001677 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001678 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001679 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001680 break;
1681
XiaokangQianeb69aee2022-07-05 08:21:43 +00001682#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001683 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001684 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1685 if( is_hrr )
1686 {
1687 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1688 goto cleanup;
1689 }
Jerry Yu4a173382021-10-11 21:45:31 +08001690
XiaokangQian86981952022-07-19 09:51:50 +00001691 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001692 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001693 {
1694 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001695 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001696 return( ret );
1697 }
1698 break;
1699#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001700
Jerry Yue1b9c292021-09-10 10:08:31 +08001701 case MBEDTLS_TLS_EXT_KEY_SHARE:
1702 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001703 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1704 {
XiaokangQian52da5582022-01-26 09:49:29 +00001705 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001706 goto cleanup;
1707 }
1708
XiaokangQian53f20b72022-01-18 10:47:33 +00001709 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001710 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001711 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001712 else
XiaokangQianb851da82022-01-14 04:03:11 +00001713 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001714 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001715 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001716 {
1717 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001718 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001719 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001720 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001721 }
1722 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001723
1724 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001725 MBEDTLS_SSL_DEBUG_MSG(
1726 3,
1727 ( "unknown extension found: %u ( ignoring )",
1728 extension_type ) );
1729
XiaokangQian52da5582022-01-26 09:49:29 +00001730 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001731 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001732 }
1733
1734 p += extension_data_len;
1735 }
1736
XiaokangQiand59be772022-01-24 10:12:51 +00001737cleanup:
1738
XiaokangQian52da5582022-01-26 09:49:29 +00001739 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001740 {
1741 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1742 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1743 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1744 }
XiaokangQian52da5582022-01-26 09:49:29 +00001745 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001746 {
1747 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1748 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1749 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1750 }
1751 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001752}
1753
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001754#if defined(MBEDTLS_DEBUG_C)
1755static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001756{
1757 switch( mode )
1758 {
1759 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1760 return "psk";
1761 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1762 return "ephemeral";
1763 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1764 return "psk_ephemeral";
1765 default:
1766 return "unknown mode";
1767 }
1768}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001769#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001770
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001771MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001772static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001773{
Jerry Yub85277e2021-10-13 13:36:05 +08001774 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001775 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001776
Jerry Yub85277e2021-10-13 13:36:05 +08001777 /* Determine the key exchange mode:
1778 * 1) If both the pre_shared_key and key_share extensions were received
1779 * then the key exchange mode is PSK with EPHEMERAL.
1780 * 2) If only the pre_shared_key extension was received then the key
1781 * exchange mode is PSK-only.
1782 * 3) If only the key_share extension was received then the key
1783 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001784 */
Jerry Yub85277e2021-10-13 13:36:05 +08001785 switch( handshake->extensions_present &
1786 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001787 {
Jerry Yu745bb612021-10-13 22:01:04 +08001788 /* Only the pre_shared_key extension was received */
1789 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001790 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001791 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001792
Jerry Yu745bb612021-10-13 22:01:04 +08001793 /* Only the key_share extension was received */
1794 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001795 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001796 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001797
Jerry Yu745bb612021-10-13 22:01:04 +08001798 /* Both the pre_shared_key and key_share extensions were received */
1799 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001800 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001801 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001802
Jerry Yu745bb612021-10-13 22:01:04 +08001803 /* Neither pre_shared_key nor key_share extension was received */
1804 default:
1805 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1806 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1807 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001808 }
1809
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001810 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1811 {
1812 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1813 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001814 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001815 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001816 goto cleanup;
1817 }
1818
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001819 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001820 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001821 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001822
Jerry Yu0b177842021-09-05 19:41:30 +08001823 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1824 *
1825 * TODO: We don't have to do this in case we offered 0-RTT and the
1826 * server accepted it. In this case, we could skip generating
1827 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001828 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001829 if( ret != 0 )
1830 {
Jerry Yue110d252022-05-05 10:19:22 +08001831 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001832 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001833 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001834 }
1835
Jerry Yuf86eb752022-05-06 11:16:55 +08001836 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001837 if( ret != 0 )
1838 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001839 MBEDTLS_SSL_DEBUG_RET( 1,
1840 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001841 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001842 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001843 }
1844
Jerry Yue110d252022-05-05 10:19:22 +08001845 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001846 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1847 ssl->session_in = ssl->session_negotiate;
1848
Jerry Yu4a173382021-10-11 21:45:31 +08001849cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001850 if( ret != 0 )
1851 {
Jerry Yu4a173382021-10-11 21:45:31 +08001852 MBEDTLS_SSL_PEND_FATAL_ALERT(
1853 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1854 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1855 }
Jerry Yue110d252022-05-05 10:19:22 +08001856
Jerry Yu4a173382021-10-11 21:45:31 +08001857 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001858}
1859
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001860MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001861static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001862{
1863 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1864
XiaokangQian78b1fa72022-01-19 06:56:30 +00001865 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001866
XiaokangQian78b1fa72022-01-19 06:56:30 +00001867 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001868 * We are going to re-generate a shared secret corresponding to the group
1869 * selected by the server, which is different from the group for which we
1870 * generated a shared secret in the first client hello.
1871 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001872 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001873 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001874 if( ret != 0 )
1875 return( ret );
1876
1877 return( 0 );
1878}
1879
Jerry Yue1b9c292021-09-10 10:08:31 +08001880/*
Jerry Yu4a173382021-10-11 21:45:31 +08001881 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001882 * Handler for MBEDTLS_SSL_SERVER_HELLO
1883 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001884MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001885static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001886{
Jerry Yu4a173382021-10-11 21:45:31 +08001887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001888 unsigned char *buf = NULL;
1889 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001890 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001891
1892 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1893
Ronald Crondb5dfa12022-05-31 11:44:38 +02001894 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1895 MBEDTLS_SSL_HS_SERVER_HELLO,
1896 &buf, &buf_len ) );
1897
Ronald Cron828aff62022-05-31 12:04:31 +02001898 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001899 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001900 goto cleanup;
1901 else
Ronald Cron828aff62022-05-31 12:04:31 +02001902 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001903
Ronald Cron828aff62022-05-31 12:04:31 +02001904 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001905 {
1906 ret = 0;
1907 goto cleanup;
1908 }
1909
XiaokangQianb851da82022-01-14 04:03:11 +00001910 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001911 buf + buf_len,
1912 is_hrr ) );
1913 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001914 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1915
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001916 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1917 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001918
XiaokangQiand9e068e2022-01-18 06:23:32 +00001919 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001920 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001921 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001922#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1923 /* If not offering early data, the client sends a dummy CCS record
1924 * immediately before its second flight. This may either be before
1925 * its second ClientHello or before its encrypted handshake flight.
1926 */
1927 mbedtls_ssl_handshake_set_state( ssl,
1928 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1929#else
1930 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1931#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1932 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001933 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001934 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001935 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001936 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1937 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001938
1939cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001940 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1941 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08001942 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08001943}
1944
1945/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001946 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001947 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001948 *
1949 * The EncryptedExtensions message contains any extensions which
1950 * should be protected, i.e., any which are not needed to establish
1951 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001952 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001953
XiaokangQian08da26c2021-10-09 10:12:11 +00001954/* Parse EncryptedExtensions message
1955 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001956 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001957 * } EncryptedExtensions;
1958 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001959MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00001960static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
1961 const unsigned char *buf,
1962 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001963{
1964 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001965 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00001966 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00001967 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001968
XiaokangQian08da26c2021-10-09 10:12:11 +00001969 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00001970 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001971 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001972
XiaokangQian97799ac2021-10-11 10:05:54 +00001973 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00001974 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02001975 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001976
XiaokangQian8db25ff2021-10-13 05:56:18 +00001977 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001978 {
XiaokangQian08da26c2021-10-09 10:12:11 +00001979 unsigned int extension_type;
1980 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001981
XiaokangQian08da26c2021-10-09 10:12:11 +00001982 /*
1983 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001984 * ExtensionType extension_type; (2 bytes)
1985 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001986 * } Extension;
1987 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00001988 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001989 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1990 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1991 p += 4;
1992
XiaokangQian8db25ff2021-10-13 05:56:18 +00001993 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001994
XiaokangQian97799ac2021-10-11 10:05:54 +00001995 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001996 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00001997 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001998 */
XiaokangQian08da26c2021-10-09 10:12:11 +00001999 switch( extension_type )
2000 {
Jerry Yu661dd942022-08-03 14:50:01 +08002001 case MBEDTLS_TLS_EXT_SERVERNAME:
2002 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002003
Jerry Yu661dd942022-08-03 14:50:01 +08002004 /* The server_name extension should be an empty extension */
2005
2006 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002007 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2008 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2009 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002010
lhuang0486cacac2022-01-21 07:34:27 -08002011#if defined(MBEDTLS_SSL_ALPN)
2012 case MBEDTLS_TLS_EXT_ALPN:
2013 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2014
2015 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2016 {
2017 return( ret );
2018 }
2019
2020 break;
2021#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002022 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002023 MBEDTLS_SSL_DEBUG_MSG(
2024 3, ( "unsupported extension found: %u ", extension_type) );
2025 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002026 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002027 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2028 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002029 }
2030
XiaokangQian08da26c2021-10-09 10:12:11 +00002031 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002032 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002033
XiaokangQian97799ac2021-10-11 10:05:54 +00002034 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002035 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002036 {
2037 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002038 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002039 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002040 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002041 }
2042
2043 return( ret );
2044}
2045
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002046MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002047static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2048{
2049 int ret;
2050 unsigned char *buf;
2051 size_t buf_len;
2052
2053 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2054
2055 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2056 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2057 &buf, &buf_len ) );
2058
2059 /* Process the message contents */
2060 MBEDTLS_SSL_PROC_CHK(
2061 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2062
2063 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2064 buf, buf_len );
2065
Ronald Cronfb508b82022-05-31 14:49:55 +02002066#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002067 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002068 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2069 else
2070 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2071#else
2072 ((void) ssl);
2073 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2074#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002075
2076cleanup:
2077
2078 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2079 return( ret );
2080
2081}
2082
Jerry Yua93ac112021-10-27 16:31:48 +08002083#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002084/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002085 * STATE HANDLING: CertificateRequest
2086 *
Jerry Yud2674312021-10-29 10:08:19 +08002087 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002088#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2089#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002090/* Coordination:
2091 * Deals with the ambiguity of not knowing if a CertificateRequest
2092 * will be sent. Returns a negative code on failure, or
2093 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2094 * - SSL_CERTIFICATE_REQUEST_SKIP
2095 * indicating if a Certificate Request is expected or not.
2096 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002097MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002098static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002099{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002100 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002101
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002102 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002103 {
2104 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2105 return( ret );
2106 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002107 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002108
2109 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2110 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2111 {
Ronald Cron19385882022-06-15 16:26:13 +02002112 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002113 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002114 }
2115
Ronald Cron19385882022-06-15 16:26:13 +02002116 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2117
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002118 return( SSL_CERTIFICATE_REQUEST_SKIP );
2119}
2120
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002121/*
2122 * ssl_tls13_parse_certificate_request()
2123 * Parse certificate request
2124 * struct {
2125 * opaque certificate_request_context<0..2^8-1>;
2126 * Extension extensions<2..2^16-1>;
2127 * } CertificateRequest;
2128 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002129MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002130static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2131 const unsigned char *buf,
2132 const unsigned char *end )
2133{
2134 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2135 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002136 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002137 size_t extensions_len = 0;
2138 const unsigned char *extensions_end;
2139 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002140
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002141 /* ...
2142 * opaque certificate_request_context<0..2^8-1>
2143 * ...
2144 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002145 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2146 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002147 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002148
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002149 if( certificate_request_context_len > 0 )
2150 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002151 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002152 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2153 p, certificate_request_context_len );
2154
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002155 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002156 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002157 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002158 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002159 {
2160 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2161 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2162 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002163 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002164 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002165 p += certificate_request_context_len;
2166 }
2167
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002168 /* ...
2169 * Extension extensions<2..2^16-1>;
2170 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002171 */
2172 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2173 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2174 p += 2;
2175
2176 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2177 extensions_end = p + extensions_len;
2178
2179 while( p < extensions_end )
2180 {
2181 unsigned int extension_type;
2182 size_t extension_data_len;
2183
2184 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2185 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2186 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2187 p += 4;
2188
2189 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2190
2191 switch( extension_type )
2192 {
2193 case MBEDTLS_TLS_EXT_SIG_ALG:
2194 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002195 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002196 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002197 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002198 if( ret != 0 )
2199 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002200 if( ! sig_alg_ext_found )
2201 sig_alg_ext_found = 1;
2202 else
2203 {
2204 MBEDTLS_SSL_DEBUG_MSG( 3,
2205 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002206 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002207 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002208 break;
2209
2210 default:
2211 MBEDTLS_SSL_DEBUG_MSG(
2212 3,
2213 ( "unknown extension found: %u ( ignoring )",
2214 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002215 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002216 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002217 p += extension_data_len;
2218 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002219 /* Check that we consumed all the message. */
2220 if( p != end )
2221 {
2222 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002223 ( "CertificateRequest misaligned" ) );
2224 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002225 }
2226 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002227 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002228 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002229 MBEDTLS_SSL_DEBUG_MSG( 3,
2230 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002231 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002232 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002233
Jerry Yu7840f812022-01-29 10:26:51 +08002234 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002235 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002236
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002237decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002238 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2239 MBEDTLS_ERR_SSL_DECODE_ERROR );
2240 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002241}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002242
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002243/*
2244 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2245 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002246MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002247static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002248{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002249 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002250
2251 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2252
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002253 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2254
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002255 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2256 {
2257 unsigned char *buf;
2258 size_t buf_len;
2259
2260 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2261 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2262 &buf, &buf_len ) );
2263
2264 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2265 buf, buf + buf_len ) );
2266
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002267 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2268 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002269 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002270 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002271 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002272 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002273 }
2274 else
2275 {
2276 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002277 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2278 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002279 }
2280
Jerry Yud2674312021-10-29 10:08:19 +08002281 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2282
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002283cleanup:
2284
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002285 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2286 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002287}
2288
2289/*
Jerry Yu687101b2021-09-14 16:03:56 +08002290 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2291 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002292MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002293static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002294{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002295 int ret;
2296
2297 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002298 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002299 return( ret );
2300
Jerry Yu687101b2021-09-14 16:03:56 +08002301 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2302 return( 0 );
2303}
2304
2305/*
2306 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2307 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002308MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002309static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002310{
Jerry Yu30b071c2021-09-12 20:16:03 +08002311 int ret;
2312
2313 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2314 if( ret != 0 )
2315 return( ret );
2316
Jerry Yu687101b2021-09-14 16:03:56 +08002317 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2318 return( 0 );
2319}
Jerry Yua93ac112021-10-27 16:31:48 +08002320#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002321
Jerry Yu687101b2021-09-14 16:03:56 +08002322/*
2323 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2324 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002325MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002326static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002327{
XiaokangQianac0385c2021-11-03 06:40:11 +00002328 int ret;
2329
XiaokangQianc5c39d52021-11-09 11:55:10 +00002330 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002331 if( ret != 0 )
2332 return( ret );
2333
Jerry Yue3d67cb2022-05-19 15:33:10 +08002334 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2335 if( ret != 0 )
2336 {
2337 MBEDTLS_SSL_PEND_FATAL_ALERT(
2338 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2339 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2340 return( ret );
2341 }
2342
Ronald Cron49ad6192021-11-24 16:25:31 +01002343#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2344 mbedtls_ssl_handshake_set_state(
2345 ssl,
2346 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2347#else
Jerry Yuca133a32022-02-15 14:22:05 +08002348 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002349#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002350
XiaokangQianac0385c2021-11-03 06:40:11 +00002351 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002352}
2353
2354/*
Jerry Yu566c7812022-01-26 15:41:22 +08002355 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2356 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002357MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002358static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2359{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002360 int non_empty_certificate_msg = 0;
2361
Jerry Yu5cc35062022-01-28 16:16:08 +08002362 MBEDTLS_SSL_DEBUG_MSG( 1,
2363 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002364 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002365
Ronald Cron9df7c802022-03-08 18:38:54 +01002366#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002367 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002368 {
2369 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2370 if( ret != 0 )
2371 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002372
Ronald Cron7a94aca2022-03-09 07:44:27 +01002373 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2374 non_empty_certificate_msg = 1;
2375 }
2376 else
2377 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002378 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002379 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002380#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002381
Ronald Cron7a94aca2022-03-09 07:44:27 +01002382 if( non_empty_certificate_msg )
2383 {
2384 mbedtls_ssl_handshake_set_state( ssl,
2385 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2386 }
2387 else
Ronald Cron19385882022-06-15 16:26:13 +02002388 {
2389 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002390 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002391 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002392
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002393 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002394}
2395
Ronald Cron9df7c802022-03-08 18:38:54 +01002396#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002397/*
2398 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2399 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002400MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002401static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2402{
Ronald Crona8b38872022-03-09 07:59:25 +01002403 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2404
2405 if( ret == 0 )
2406 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2407
2408 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002409}
Jerry Yu90f152d2022-01-29 22:12:42 +08002410#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002411
2412/*
Jerry Yu687101b2021-09-14 16:03:56 +08002413 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2414 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002415MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002416static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002417{
XiaokangQian0fa66432021-11-15 03:33:57 +00002418 int ret;
2419
2420 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2421 if( ret != 0 )
2422 return( ret );
2423
Jerry Yu466dda82022-09-13 11:20:20 +08002424 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002425 if( ret != 0 )
2426 {
2427 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002428 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002429 return ( ret );
2430 }
2431
XiaokangQian0fa66432021-11-15 03:33:57 +00002432 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2433 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002434}
2435
2436/*
2437 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2438 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002439MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002440static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002441{
Jerry Yu378254d2021-10-30 21:44:47 +08002442 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002443 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002444 return( 0 );
2445}
2446
2447/*
2448 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2449 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002450MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002451static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002452{
Jerry Yu378254d2021-10-30 21:44:47 +08002453
2454 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2455
2456 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2457 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002458}
2459
Jerry Yuf8a49942022-07-07 11:32:32 +00002460#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2461
Jerry Yua0446a02022-07-13 11:22:55 +08002462MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002463static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2464 const unsigned char *buf,
2465 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002466{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002467 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002468
2469 ((void) ssl);
2470
2471 while( p < end )
2472 {
2473 unsigned int extension_type;
2474 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002475
Jerry Yuf8a49942022-07-07 11:32:32 +00002476 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2477 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2478 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2479 p += 4;
2480
2481 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002482
2483 switch( extension_type )
2484 {
2485 case MBEDTLS_TLS_EXT_EARLY_DATA:
2486 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2487 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002488
Jerry Yuf8a49942022-07-07 11:32:32 +00002489 default:
2490 break;
2491 }
2492 p += extension_data_len;
2493 }
2494
2495 return( 0 );
2496}
2497
2498/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002499 * From RFC8446, page 74
2500 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002501 * struct {
2502 * uint32 ticket_lifetime;
2503 * uint32 ticket_age_add;
2504 * opaque ticket_nonce<0..255>;
2505 * opaque ticket<1..2^16-1>;
2506 * Extension extensions<0..2^16-2>;
2507 * } NewSessionTicket;
2508 *
2509 */
Jerry Yua0446a02022-07-13 11:22:55 +08002510MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002511static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2512 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002513 unsigned char *end,
2514 unsigned char **ticket_nonce,
2515 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002516{
2517 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2518 unsigned char *p = buf;
2519 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002520 size_t ticket_len;
2521 unsigned char *ticket;
2522 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002523
Jerry Yucb3b1392022-07-12 06:09:38 +00002524 *ticket_nonce = NULL;
2525 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002526 /*
2527 * ticket_lifetime 4 bytes
2528 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002529 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002530 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002531 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002532
2533 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002534 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002535 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002536 ( unsigned int )session->ticket_lifetime ) );
2537
Jerry Yucb3b1392022-07-12 06:09:38 +00002538 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002539 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002540 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002541 ( unsigned int )session->ticket_age_add ) );
2542
Jerry Yucb3b1392022-07-12 06:09:38 +00002543 *ticket_nonce_len = p[8];
2544 p += 9;
2545
2546 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2547 *ticket_nonce = p;
2548 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2549 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002550
2551 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002552 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002553 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2554 p += 2;
2555 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002556 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2557
2558 /* Check if we previously received a ticket already. */
2559 if( session->ticket != NULL || session->ticket_len > 0 )
2560 {
2561 mbedtls_free( session->ticket );
2562 session->ticket = NULL;
2563 session->ticket_len = 0;
2564 }
2565
2566 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2567 {
2568 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2569 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2570 }
2571 memcpy( ticket, p, ticket_len );
2572 p += ticket_len;
2573 session->ticket = ticket;
2574 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002575
Jerry Yucb3b1392022-07-12 06:09:38 +00002576 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002577 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2578 p += 2;
2579 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2580
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002581 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002582
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002583 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002584 if( ret != 0 )
2585 {
2586 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002587 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002588 ret );
2589 return( ret );
2590 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002591
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002592 /* session has been updated, allow export */
2593 session->exported = 0;
2594
Jerry Yucb3b1392022-07-12 06:09:38 +00002595 return( 0 );
2596}
2597
Jerry Yua0446a02022-07-13 11:22:55 +08002598MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002599static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2600 unsigned char *ticket_nonce,
2601 size_t ticket_nonce_len )
2602{
2603 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2604 mbedtls_ssl_session *session = ssl->session;
2605 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2606 psa_algorithm_t psa_hash_alg;
2607 int hash_length;
2608
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002609#if defined(MBEDTLS_HAVE_TIME)
2610 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002611 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002612#endif
2613
Jerry Yuf8a49942022-07-07 11:32:32 +00002614 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2615 if( ciphersuite_info == NULL )
2616 {
2617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2618 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2619 }
2620
2621 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2622 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002623 if( hash_length == -1 ||
2624 ( size_t )hash_length > sizeof( session->resumption_key ) )
2625 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002626 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002627 }
2628
Jerry Yuf8a49942022-07-07 11:32:32 +00002629
2630 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2631 session->app_secrets.resumption_master_secret,
2632 hash_length );
2633
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002634 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002635 *
2636 * HKDF-Expand-Label( resumption_master_secret,
2637 * "resumption", ticket_nonce, Hash.length )
2638 */
2639 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2640 psa_hash_alg,
2641 session->app_secrets.resumption_master_secret,
2642 hash_length,
2643 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2644 ticket_nonce,
2645 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002646 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002647 hash_length );
2648
2649 if( ret != 0 )
2650 {
2651 MBEDTLS_SSL_DEBUG_RET( 2,
2652 "Creating the ticket-resumed PSK failed",
2653 ret );
2654 return( ret );
2655 }
2656
Jerry Yu0a430c82022-07-20 11:02:48 +08002657 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002658
2659 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002660 session->resumption_key,
2661 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002662
Jerry Yuf8a49942022-07-07 11:32:32 +00002663 return( 0 );
2664}
2665
2666/*
Jerry Yua357cf42022-07-12 05:36:45 +00002667 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002668 */
Jerry Yua0446a02022-07-13 11:22:55 +08002669MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002670static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2671{
2672 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2673 unsigned char *buf;
2674 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002675 unsigned char *ticket_nonce;
2676 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002677
2678 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2679
2680 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2681 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2682 &buf, &buf_len ) );
2683
Jerry Yucb3b1392022-07-12 06:09:38 +00002684 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2685 ssl, buf, buf + buf_len,
2686 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002687
Jerry Yucb3b1392022-07-12 06:09:38 +00002688 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2689 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002690
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002691 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2692
Jerry Yuf8a49942022-07-07 11:32:32 +00002693cleanup:
2694
2695 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2696 return( ret );
2697}
2698#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2699
Jerry Yu92c6b402021-08-27 16:59:09 +08002700int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002701{
Jerry Yu92c6b402021-08-27 16:59:09 +08002702 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002703
Jerry Yu92c6b402021-08-27 16:59:09 +08002704 switch( ssl->state )
2705 {
2706 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002707 * ssl->state is initialized as HELLO_REQUEST. It is the same
2708 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002709 */
2710 case MBEDTLS_SSL_HELLO_REQUEST:
2711 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002712 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002713 break;
2714
2715 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002716 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002717 break;
2718
2719 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002720 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002721 break;
2722
Jerry Yua93ac112021-10-27 16:31:48 +08002723#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002724 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2725 ret = ssl_tls13_process_certificate_request( ssl );
2726 break;
2727
Jerry Yu687101b2021-09-14 16:03:56 +08002728 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002729 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002730 break;
2731
2732 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002733 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002734 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002735#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002736
2737 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002738 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002739 break;
2740
Jerry Yu566c7812022-01-26 15:41:22 +08002741 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2742 ret = ssl_tls13_write_client_certificate( ssl );
2743 break;
2744
Ronald Cron9df7c802022-03-08 18:38:54 +01002745#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002746 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2747 ret = ssl_tls13_write_client_certificate_verify( ssl );
2748 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002749#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002750
Jerry Yu687101b2021-09-14 16:03:56 +08002751 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002752 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002753 break;
2754
2755 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002756 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002757 break;
2758
2759 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002760 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002761 break;
2762
Ronald Cron49ad6192021-11-24 16:25:31 +01002763 /*
2764 * Injection of dummy-CCS's for middlebox compatibility
2765 */
2766#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002767 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002768 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2769 if( ret == 0 )
2770 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2771 break;
2772
2773 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2774 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2775 if( ret == 0 )
2776 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002777 break;
2778#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2779
Jerry Yuf8a49942022-07-07 11:32:32 +00002780#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002781 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002782 ret = ssl_tls13_process_new_session_ticket( ssl );
2783 if( ret != 0 )
2784 break;
2785 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2786 break;
2787#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2788
Jerry Yu92c6b402021-08-27 16:59:09 +08002789 default:
2790 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2791 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2792 }
2793
2794 return( ret );
2795}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002796
Jerry Yufb4b6472022-01-27 15:03:26 +08002797#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002798
Jerry Yufb4b6472022-01-27 15:03:26 +08002799