blob: 4aba59f9ea88645be5c5cce8a014a18d574bf9be [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yubdc71882021-09-14 19:30:36 +080035
Jerry Yubc20bdd2021-08-24 15:59:48 +080036/* Write extensions */
37
Jerry Yu92c6b402021-08-27 16:59:09 +080038/*
39 * ssl_tls13_write_supported_versions_ext():
40 *
41 * struct {
42 * ProtocolVersion versions<2..254>;
43 * } SupportedVersions;
44 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020045MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4436812021-08-26 22:59:56 +080046static int ssl_tls13_write_supported_versions_ext( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +080047 unsigned char *buf,
48 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +000049 size_t *out_len )
Jerry Yu92c6b402021-08-27 16:59:09 +080050{
51 unsigned char *p = buf;
Glenn Strausscd78df62022-04-07 19:07:11 -040052 unsigned char versions_len = ( ssl->handshake->min_tls_version <=
53 MBEDTLS_SSL_VERSION_TLS1_2 ) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080054
Xiaofei Baid25fab62021-12-02 06:36:27 +000055 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080056
Jerry Yu159c5a02021-08-31 12:51:25 +080057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported versions extension" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080058
Jerry Yu388bd0d2021-09-15 18:41:02 +080059 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080060 * - extension_type (2 bytes)
61 * - extension_data_length (2 bytes)
62 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020063 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080064 */
Ronald Crona77fc272022-03-30 17:20:47 +020065 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 5 + versions_len );
Ronald Crondbe87f02022-02-10 14:35:27 +010066
Jerry Yueecfbf02021-08-30 18:32:07 +080067 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0 );
Ronald Crondbe87f02022-02-10 14:35:27 +010068 MBEDTLS_PUT_UINT16_BE( versions_len + 1, p, 2 );
Jerry Yueecfbf02021-08-30 18:32:07 +080069 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080071 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010072 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080073
Jerry Yu0c63af62021-09-02 12:59:12 +080074 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080075 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010076 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080077 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -040078 mbedtls_ssl_write_version( p, MBEDTLS_SSL_TRANSPORT_STREAM,
79 MBEDTLS_SSL_VERSION_TLS1_3 );
Ronald Crondbe87f02022-02-10 14:35:27 +010080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:4]" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080081
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Glenn Strausscd78df62022-04-07 19:07:11 -040083 if( ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
Ronald Crondbe87f02022-02-10 14:35:27 +010084 {
Glenn Strausse3af4cb2022-03-15 03:23:42 -040085 mbedtls_ssl_write_version( p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2 );
Ronald Crondbe87f02022-02-10 14:35:27 +010087 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:3]" ) );
88 }
89
90 *out_len = 5 + versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080091
92 return( 0 );
93}
Jerry Yubc20bdd2021-08-24 15:59:48 +080094
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020095MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +080096static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
97 const unsigned char *buf,
Jerry Yub85277e2021-10-13 13:36:05 +080098 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +080099{
Jerry Yue1b9c292021-09-10 10:08:31 +0800100 ((void) ssl);
101
Ronald Cron98473382022-03-30 20:04:10 +0200102 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Glenn Strausse3af4cb2022-03-15 03:23:42 -0400103 if( mbedtls_ssl_read_version( buf, ssl->conf->transport ) !=
104 MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yue1b9c292021-09-10 10:08:31 +0800105 {
106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unexpected version" ) );
Jerry Yu4a173382021-10-11 21:45:31 +0800107
108 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
109 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
110 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue1b9c292021-09-10 10:08:31 +0800111 }
112
Ronald Cron98473382022-03-30 20:04:10 +0200113 if( &buf[2] != end )
114 {
115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "supported_versions ext data length incorrect" ) );
116 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
117 MBEDTLS_ERR_SSL_DECODE_ERROR );
118 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
119 }
120
Jerry Yue1b9c292021-09-10 10:08:31 +0800121 return( 0 );
122}
123
lhuang0486cacac2022-01-21 07:34:27 -0800124#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200125MBEDTLS_CHECK_RETURN_CRITICAL
lhuang0486cacac2022-01-21 07:34:27 -0800126static int ssl_tls13_parse_alpn_ext( mbedtls_ssl_context *ssl,
Ronald Cron81a334f2022-05-31 16:04:11 +0200127 const unsigned char *buf, size_t len )
lhuang0486cacac2022-01-21 07:34:27 -0800128{
lhuang0486cacac2022-01-21 07:34:27 -0800129 const unsigned char *p = buf;
130 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200131 size_t protocol_name_list_len, protocol_name_len;
132 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800133
134 /* If we didn't send it, the server shouldn't send it */
135 if( ssl->conf->alpn_list == NULL )
136 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
137
138 /*
139 * opaque ProtocolName<1..2^8-1>;
140 *
141 * struct {
142 * ProtocolName protocol_name_list<2..2^16-1>
143 * } ProtocolNameList;
144 *
145 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
146 */
147
Ronald Cron81a334f2022-05-31 16:04:11 +0200148 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
149 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
lhuang0486cacac2022-01-21 07:34:27 -0800150 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800151
Ronald Cron81a334f2022-05-31 16:04:11 +0200152 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
153 protocol_name_list_end = p + protocol_name_list_len;
154
155 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, 1 );
156 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800157
158 /* Check that the server chosen protocol was in our list and save it */
Ronald Cron81a334f2022-05-31 16:04:11 +0200159 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, protocol_name_len );
160 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
lhuang0486cacac2022-01-21 07:34:27 -0800161 {
Ronald Cron81a334f2022-05-31 16:04:11 +0200162 if( protocol_name_len == strlen( *alpn ) &&
163 memcmp( p, *alpn, protocol_name_len ) == 0 )
lhuang0486cacac2022-01-21 07:34:27 -0800164 {
165 ssl->alpn_chosen = *alpn;
166 return( 0 );
167 }
168 }
169
170 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian16acd4b2022-01-14 07:35:47 +0000175static int ssl_tls13_reset_key_share( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
XiaokangQian647719a2021-12-07 09:16:29 +0000179 if( group_id == 0 )
180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
181
XiaokangQian355e09a2022-01-20 11:14:50 +0000182#if defined(MBEDTLS_ECDH_C)
XiaokangQian647719a2021-12-07 09:16:29 +0000183 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
XiaokangQian78b1fa72022-01-19 06:56:30 +0000184 {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
189 status = psa_destroy_key( ssl->handshake->ecdh_psa_privkey );
190 if( status != PSA_SUCCESS )
191 {
192 ret = psa_ssl_status_to_mbedtls( status );
193 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
194 return( ret );
195 }
196
197 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
XiaokangQian78b1fa72022-01-19 06:56:30 +0000198 return( 0 );
199 }
XiaokangQian355e09a2022-01-20 11:14:50 +0000200 else
201#endif /* MBEDTLS_ECDH_C */
202 if( 0 /* other KEMs? */ )
XiaokangQian647719a2021-12-07 09:16:29 +0000203 {
204 /* Do something */
205 }
206
207 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
208}
209
210/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800211 * Functions for writing key_share extension.
212 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub60e3cf2021-09-08 16:41:02 +0800214static int ssl_tls13_get_default_group_id( mbedtls_ssl_context *ssl,
215 uint16_t *group_id )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800216{
217 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
218
Jerry Yu56fc07f2021-09-01 17:48:49 +0800219
Jerry Yu56fc07f2021-09-01 17:48:49 +0800220#if defined(MBEDTLS_ECDH_C)
Brett Warren14efd332021-10-06 09:32:11 +0100221 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Jerry Yu388bd0d2021-09-15 18:41:02 +0800222 /* Pick first available ECDHE group compatible with TLS 1.3 */
Brett Warren14efd332021-10-06 09:32:11 +0100223 if( group_list == NULL )
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
225
Brett Warren14efd332021-10-06 09:32:11 +0100226 for ( ; *group_list != 0; group_list++ )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800227 {
Xiaofei Baieef15042021-11-18 07:29:56 +0000228 const mbedtls_ecp_curve_info *curve_info;
229 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
230 if( curve_info != NULL &&
Brett Warren14efd332021-10-06 09:32:11 +0100231 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800232 {
Brett Warren14efd332021-10-06 09:32:11 +0100233 *group_id = *group_list;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800234 return( 0 );
235 }
236 }
237#else
238 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800239 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800240#endif /* MBEDTLS_ECDH_C */
241
242 /*
243 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800244 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 */
246
247 return( ret );
248}
249
250/*
251 * ssl_tls13_write_key_share_ext
252 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800253 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800254 *
255 * struct {
256 * NamedGroup group;
257 * opaque key_exchange<1..2^16-1>;
258 * } KeyShareEntry;
259 * struct {
260 * KeyShareEntry client_shares<0..2^16-1>;
261 * } KeyShareClientHello;
262 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200263MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
265 unsigned char *buf,
266 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000267 size_t *out_len )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268{
269 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000270 unsigned char *client_shares; /* Start of client_shares */
271 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
274
Xiaofei Baid25fab62021-12-02 06:36:27 +0000275 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800276
Jerry Yub60e3cf2021-09-08 16:41:02 +0800277 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 * - extension_type (2 bytes)
279 * - extension_data_length (2 bytes)
280 * - client_shares_length (2 bytes)
281 */
282 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
283 p += 6;
284
285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello: adding key share extension" ) );
286
287 /* HRR could already have requested something else. */
288 group_id = ssl->handshake->offered_group_id;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800289 if( !mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) &&
290 !mbedtls_ssl_tls13_named_group_is_dhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800291 {
Jerry Yub60e3cf2021-09-08 16:41:02 +0800292 MBEDTLS_SSL_PROC_CHK( ssl_tls13_get_default_group_id( ssl,
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 &group_id ) );
294 }
295
296 /*
297 * Dispatch to type-specific key generation function.
298 *
299 * So far, we're only supporting ECDHE. With the introduction
300 * of PQC KEMs, we'll want to have multiple branches, one per
301 * type of KEM, and dispatch to the corresponding crypto. And
302 * only one key share entry is allowed.
303 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000304 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800305#if defined(MBEDTLS_ECDH_C)
Jerry Yub60e3cf2021-09-08 16:41:02 +0800306 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800307 {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800308 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000309 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800310 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100311 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800312
313 /* Check there is space for header of KeyShareEntry
314 * - group (2 bytes)
315 * - key_exchange_length (2 bytes)
316 */
317 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 );
318 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800319 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
320 ssl, group_id, p, end, &key_exchange_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800321 p += key_exchange_len;
322 if( ret != 0 )
323 return( ret );
324
325 /* Write group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000326 MBEDTLS_PUT_UINT16_BE( group_id, group, 0 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Write key_exchange_length */
Xiaofei Baieef15042021-11-18 07:29:56 +0000328 MBEDTLS_PUT_UINT16_BE( key_exchange_len, group, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329 }
330 else
331#endif /* MBEDTLS_ECDH_C */
332 if( 0 /* other KEMs? */ )
333 {
334 /* Do something */
335 }
336 else
337 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
338
Jerry Yub60e3cf2021-09-08 16:41:02 +0800339 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000340 client_shares_len = p - client_shares;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800341 if( client_shares_len == 0)
342 {
343 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No key share defined." ) );
344 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu7c522d42021-09-08 17:55:09 +0800345 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800346 /* Write extension_type */
347 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
348 /* Write extension_data_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800349 MBEDTLS_PUT_UINT16_BE( client_shares_len + 2, buf, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350 /* Write client_shares_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800351 MBEDTLS_PUT_UINT16_BE( client_shares_len, buf, 4 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352
353 /* Update offered_group_id field */
354 ssl->handshake->offered_group_id = group_id;
355
356 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000357 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
Xiaofei Baid25fab62021-12-02 06:36:27 +0000359 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, key_share extension", buf, *out_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
361 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
362
363cleanup:
364
365 return( ret );
366}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800367
Jerry Yue1b9c292021-09-10 10:08:31 +0800368
XiaokangQiand59be772022-01-24 10:12:51 +0000369/*
370 * ssl_tls13_parse_hrr_key_share_ext()
371 * Parse key_share extension in Hello Retry Request
372 *
373 * struct {
374 * NamedGroup selected_group;
375 * } KeyShareHelloRetryRequest;
376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200377MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiand9e068e2022-01-18 06:23:32 +0000378static int ssl_tls13_parse_hrr_key_share_ext( mbedtls_ssl_context *ssl,
XiaokangQianb851da82022-01-14 04:03:11 +0000379 const unsigned char *buf,
380 const unsigned char *end )
381{
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400382#if defined(MBEDTLS_ECDH_C)
XiaokangQianb851da82022-01-14 04:03:11 +0000383 const mbedtls_ecp_curve_info *curve_info = NULL;
384 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000385 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000386 int found = 0;
387
388 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
389 if( group_list == NULL )
390 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
391
392 MBEDTLS_SSL_DEBUG_BUF( 3, "key_share extension", p, end - buf );
393
394 /* Read selected_group */
XiaokangQianb48894e2022-01-17 02:05:52 +0000395 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQiand59be772022-01-24 10:12:51 +0000396 selected_group = MBEDTLS_GET_UINT16_BE( p, 0 );
397 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_group ( %d )", selected_group ) );
XiaokangQianb851da82022-01-14 04:03:11 +0000398
399 /* Upon receipt of this extension in a HelloRetryRequest, the client
400 * MUST first verify that the selected_group field corresponds to a
401 * group which was provided in the "supported_groups" extension in the
402 * original ClientHello.
403 * The supported_group was based on the info in ssl->conf->group_list.
404 *
405 * If the server provided a key share that was not sent in the ClientHello
406 * then the client MUST abort the handshake with an "illegal_parameter" alert.
407 */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000408 for( ; *group_list != 0; group_list++ )
XiaokangQianb851da82022-01-14 04:03:11 +0000409 {
410 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
XiaokangQiand59be772022-01-24 10:12:51 +0000411 if( curve_info == NULL || curve_info->tls_id != selected_group )
XiaokangQianb851da82022-01-14 04:03:11 +0000412 continue;
413
414 /* We found a match */
415 found = 1;
416 break;
417 }
418
419 /* Client MUST verify that the selected_group field does not
420 * correspond to a group which was provided in the "key_share"
421 * extension in the original ClientHello. If the server sent an
422 * HRR message with a key share already provided in the
423 * ClientHello then the client MUST abort the handshake with
424 * an "illegal_parameter" alert.
425 */
XiaokangQiand59be772022-01-24 10:12:51 +0000426 if( found == 0 || selected_group == ssl->handshake->offered_group_id )
XiaokangQianb851da82022-01-14 04:03:11 +0000427 {
428 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid key share in HRR" ) );
429 MBEDTLS_SSL_PEND_FATAL_ALERT(
430 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
431 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
432 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
433 }
434
435 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000436 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000437
438 return( 0 );
Andrzej Kurekc19fb082022-10-03 10:52:24 -0400439#else
440 (void) ssl;
441 (void) buf;
442 (void) end;
443 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
444#endif
XiaokangQianb851da82022-01-14 04:03:11 +0000445}
446
Jerry Yue1b9c292021-09-10 10:08:31 +0800447/*
Jerry Yub85277e2021-10-13 13:36:05 +0800448 * ssl_tls13_parse_key_share_ext()
449 * Parse key_share extension in Server Hello
450 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800451 * struct {
452 * KeyShareEntry server_share;
453 * } KeyShareServerHello;
454 * struct {
455 * NamedGroup group;
456 * opaque key_exchange<1..2^16-1>;
457 * } KeyShareEntry;
458 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200459MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +0800460static int ssl_tls13_parse_key_share_ext( mbedtls_ssl_context *ssl,
Jerry Yue1b9c292021-09-10 10:08:31 +0800461 const unsigned char *buf,
462 const unsigned char *end )
463{
Jerry Yub85277e2021-10-13 13:36:05 +0800464 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800465 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800466 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800467
Jerry Yu4a173382021-10-11 21:45:31 +0800468 /* ...
469 * NamedGroup group; (2 bytes)
470 * ...
471 */
472 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
473 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +0800474 p += 2;
475
Jerry Yu4a173382021-10-11 21:45:31 +0800476 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800477 offered_group = ssl->handshake->offered_group_id;
Jerry Yu4a173382021-10-11 21:45:31 +0800478 if( offered_group != group )
Jerry Yue1b9c292021-09-10 10:08:31 +0800479 {
480 MBEDTLS_SSL_DEBUG_MSG( 1,
481 ( "Invalid server key share, our group %u, their group %u",
Jerry Yu4a173382021-10-11 21:45:31 +0800482 (unsigned) offered_group, (unsigned) group ) );
483 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
484 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
485 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yue1b9c292021-09-10 10:08:31 +0800486 }
487
488#if defined(MBEDTLS_ECDH_C)
Jerry Yu4a173382021-10-11 21:45:31 +0800489 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
Jerry Yue1b9c292021-09-10 10:08:31 +0800490 {
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100491 const mbedtls_ecp_curve_info *curve_info =
492 mbedtls_ecp_curve_info_from_tls_id( group );
493 if( curve_info == NULL )
494 {
495 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid TLS curve group id" ) );
496 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
497 }
498
499 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
500
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000501 ret = mbedtls_ssl_tls13_read_public_ecdhe_share( ssl, p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +0800502 if( ret != 0 )
503 return( ret );
504 }
Jerry Yub85277e2021-10-13 13:36:05 +0800505 else
Jerry Yue1b9c292021-09-10 10:08:31 +0800506#endif /* MBEDTLS_ECDH_C */
Jerry Yub85277e2021-10-13 13:36:05 +0800507 if( 0 /* other KEMs? */ )
Jerry Yue1b9c292021-09-10 10:08:31 +0800508 {
509 /* Do something */
510 }
511 else
512 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
513
514 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
515 return( ret );
516}
517
XiaokangQiand59be772022-01-24 10:12:51 +0000518/*
519 * ssl_tls13_parse_cookie_ext()
520 * Parse cookie extension in Hello Retry Request
521 *
522 * struct {
523 * opaque cookie<1..2^16-1>;
524 * } Cookie;
525 *
526 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
527 * extension to the client (this is an exception to the usual rule that
528 * the only extensions that may be sent are those that appear in the
529 * ClientHello). When sending the new ClientHello, the client MUST copy
530 * the contents of the extension received in the HelloRetryRequest into
531 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
532 * cookies in their initial ClientHello in subsequent connections.
533 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200534MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian43550bd2022-01-21 04:32:58 +0000535static int ssl_tls13_parse_cookie_ext( mbedtls_ssl_context *ssl,
536 const unsigned char *buf,
537 const unsigned char *end )
538{
XiaokangQian25c9c902022-02-08 10:49:53 +0000539 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000540 const unsigned char *p = buf;
541 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
542
543 /* Retrieve length field of cookie */
544 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
545 cookie_len = MBEDTLS_GET_UINT16_BE( p, 0 );
546 p += 2;
547
548 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cookie_len );
549 MBEDTLS_SSL_DEBUG_BUF( 3, "cookie extension", p, cookie_len );
550
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000551 mbedtls_free( handshake->cookie );
XiaokangQian25c9c902022-02-08 10:49:53 +0000552 handshake->hrr_cookie_len = 0;
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000553 handshake->cookie = mbedtls_calloc( 1, cookie_len );
554 if( handshake->cookie == NULL )
XiaokangQian43550bd2022-01-21 04:32:58 +0000555 {
556 MBEDTLS_SSL_DEBUG_MSG( 1,
XiaokangQian25c9c902022-02-08 10:49:53 +0000557 ( "alloc failed ( %ud bytes )",
XiaokangQian43550bd2022-01-21 04:32:58 +0000558 cookie_len ) );
559 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
560 }
561
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000562 memcpy( handshake->cookie, p, cookie_len );
XiaokangQian25c9c902022-02-08 10:49:53 +0000563 handshake->hrr_cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000564
565 return( 0 );
566}
XiaokangQian43550bd2022-01-21 04:32:58 +0000567
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200568MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0b64eed2022-01-27 10:36:51 +0000569static int ssl_tls13_write_cookie_ext( mbedtls_ssl_context *ssl,
XiaokangQian233397e2022-02-07 08:32:16 +0000570 unsigned char *buf,
571 unsigned char *end,
XiaokangQian9deb90f2022-02-08 10:31:07 +0000572 size_t *out_len )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000573{
574 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000575 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000576 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000577
XiaokangQianc02768a2022-02-10 07:31:25 +0000578 if( handshake->cookie == NULL )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000579 {
580 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no cookie to send; skip extension" ) );
581 return( 0 );
582 }
583
584 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, cookie",
XiaokangQianc02768a2022-02-10 07:31:25 +0000585 handshake->cookie,
586 handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000587
XiaokangQianc02768a2022-02-10 07:31:25 +0000588 MBEDTLS_SSL_CHK_BUF_PTR( p, end, handshake->hrr_cookie_len + 6 );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000589
590 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding cookie extension" ) );
591
XiaokangQian0b64eed2022-01-27 10:36:51 +0000592 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_COOKIE, p, 0 );
XiaokangQianc02768a2022-02-10 07:31:25 +0000593 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len + 2, p, 2 );
594 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len, p, 4 );
XiaokangQian233397e2022-02-07 08:32:16 +0000595 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000596
597 /* Cookie */
XiaokangQianc02768a2022-02-10 07:31:25 +0000598 memcpy( p, handshake->cookie, handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000599
XiaokangQianc02768a2022-02-10 07:31:25 +0000600 *out_len = handshake->hrr_cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000601
602 return( 0 );
603}
604
XiaokangQianeb69aee2022-07-05 08:21:43 +0000605#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
606/*
607 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
608 *
609 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
610 *
611 * struct {
612 * PskKeyExchangeMode ke_modes<1..255>;
613 * } PskKeyExchangeModes;
614 */
XiaokangQian86981952022-07-19 09:51:50 +0000615MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616static int ssl_tls13_write_psk_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
617 unsigned char *buf,
618 unsigned char *end,
619 size_t *out_len )
620{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000621 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000622 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000623
XiaokangQian008d2bf2022-07-14 07:54:01 +0000624 ((void) ke_modes_len );
XiaokangQianeb69aee2022-07-05 08:21:43 +0000625 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000626
XiaokangQianeb69aee2022-07-05 08:21:43 +0000627 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000628 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000629 */
XiaokangQian86981952022-07-19 09:51:50 +0000630 if( !mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000631 {
632 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip psk_key_exchange_modes extension" ) );
633 return( 0 );
634 }
635
636 /* Require 7 bytes of data, otherwise fail,
637 * even if extension might be shorter.
638 */
639 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 );
640 MBEDTLS_SSL_DEBUG_MSG(
641 3, ( "client hello, adding psk_key_exchange_modes extension" ) );
642
XiaokangQianeb69aee2022-07-05 08:21:43 +0000643 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0 );
644
XiaokangQian008d2bf2022-07-14 07:54:01 +0000645 /* Skip extension length (2 bytes) and
646 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000647 */
648 p += 5;
649
650 if( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) )
651 {
652 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000653 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000654
655 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding pure PSK key exchange mode" ) );
656 }
657
658 if( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) )
659 {
660 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000661 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662
663 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding PSK-ECDHE key exchange mode" ) );
664 }
665
XiaokangQian008d2bf2022-07-14 07:54:01 +0000666 /* Now write the extension and ke_modes length */
667 MBEDTLS_PUT_UINT16_BE( ke_modes_len + 1, buf, 2 );
668 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000669
670 *out_len = p - buf;
671 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
672 return ( 0 );
673}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800674
Jerry Yua99cbfa2022-10-08 11:17:14 +0800675static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg( int ciphersuite )
Jerry Yuf7c12592022-09-28 22:09:38 +0800676{
Jerry Yu21f90952022-10-08 10:30:53 +0800677 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
678 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800679
Jerry Yua99cbfa2022-10-08 11:17:14 +0800680 if( ciphersuite_info != NULL )
681 return( mbedtls_psa_translate_md( ciphersuite_info->mac ) );
682
Jerry Yu21f90952022-10-08 10:30:53 +0800683 return( PSA_ALG_NONE );
Jerry Yuf7c12592022-09-28 22:09:38 +0800684}
685
Jerry Yuf75364b2022-09-30 10:30:31 +0800686#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf7c12592022-09-28 22:09:38 +0800687static int ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl )
688{
Jerry Yuf7c12592022-09-28 22:09:38 +0800689 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu4f77ecf2022-10-10 22:10:08 +0800690 return( ssl->handshake->resume &&
691 session != NULL && session->ticket != NULL );
Jerry Yuf7c12592022-09-28 22:09:38 +0800692}
693
Jerry Yuf7c12592022-09-28 22:09:38 +0800694MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800695static int ssl_tls13_ticket_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800696 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800697 const unsigned char **identity,
698 size_t *identity_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800699{
700 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800701
Jerry Yu8b41e892022-09-30 10:00:20 +0800702 if( !ssl_tls13_has_configured_ticket( ssl ) )
703 return( -1 );
704
Jerry Yua99cbfa2022-10-08 11:17:14 +0800705 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800706 *identity = session->ticket;
707 *identity_len = session->ticket_len;
708 return( 0 );
709}
710
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800711MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800712static int ssl_tls13_ticket_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800713 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800714 const unsigned char **psk,
715 size_t *psk_len )
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800716{
717
718 mbedtls_ssl_session *session = ssl->session_negotiate;
719
Jerry Yu8b41e892022-09-30 10:00:20 +0800720 if( !ssl_tls13_has_configured_ticket( ssl ) )
721 return( -1 );
722
Jerry Yua99cbfa2022-10-08 11:17:14 +0800723 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800724 *psk = session->resumption_key;
725 *psk_len = session->resumption_key_len;
726
727 return( 0 );
728}
Jerry Yuf7c12592022-09-28 22:09:38 +0800729#endif /* MBEDTLS_SSL_SESSION_TICKETS */
730
731MBEDTLS_CHECK_RETURN_CRITICAL
732static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800733 psa_algorithm_t *hash_alg,
Jerry Yuf7c12592022-09-28 22:09:38 +0800734 const unsigned char **identity,
735 size_t *identity_len )
736{
Jerry Yu8b41e892022-09-30 10:00:20 +0800737
Ronald Crond29e13e2022-10-19 10:33:48 +0200738 if( !mbedtls_ssl_conf_has_static_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800739 return( -1 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800740
Jerry Yua99cbfa2022-10-08 11:17:14 +0800741 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800742 *identity = ssl->conf->psk_identity;
743 *identity_len = ssl->conf->psk_identity_len;
744 return( 0 );
745}
746
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800747MBEDTLS_CHECK_RETURN_CRITICAL
748static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800749 psa_algorithm_t *hash_alg,
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800750 const unsigned char **psk,
751 size_t *psk_len )
752{
Jerry Yu8b41e892022-09-30 10:00:20 +0800753
Ronald Crond29e13e2022-10-19 10:33:48 +0200754 if( !mbedtls_ssl_conf_has_static_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800755 return( -1 );
756
Jerry Yua99cbfa2022-10-08 11:17:14 +0800757 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800758 *psk = ssl->conf->psk;
759 *psk_len = ssl->conf->psk_len;
760 return( 0 );
761}
762
Jerry Yuf75364b2022-09-30 10:30:31 +0800763static int ssl_tls13_get_configured_psk_count( mbedtls_ssl_context *ssl )
764{
765 int configured_psk_count = 0;
766#if defined(MBEDTLS_SSL_SESSION_TICKETS)
767 if( ssl_tls13_has_configured_ticket( ssl ) )
768 {
769 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Ticket is configured" ) );
770 configured_psk_count++;
771 }
772#endif
Ronald Crond29e13e2022-10-19 10:33:48 +0200773 if( mbedtls_ssl_conf_has_static_psk( ssl->conf ) )
Jerry Yuf75364b2022-09-30 10:30:31 +0800774 {
775 MBEDTLS_SSL_DEBUG_MSG( 3, ( "PSK is configured" ) );
776 configured_psk_count++;
777 }
778 return( configured_psk_count );
779}
780
Jerry Yuf7c12592022-09-28 22:09:38 +0800781MBEDTLS_CHECK_RETURN_CRITICAL
782static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
783 unsigned char *buf,
784 unsigned char *end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800785 const unsigned char *identity,
786 size_t identity_len,
787 uint32_t obfuscated_ticket_age,
788 size_t *out_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800789{
Jerry Yuf75364b2022-09-30 10:30:31 +0800790 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800791 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800792
793 /*
794 * - identity_len (2 bytes)
795 * - identity (psk_identity_len bytes)
796 * - obfuscated_ticket_age (4 bytes)
797 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800798 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800799
Jerry Yua99cbfa2022-10-08 11:17:14 +0800800 MBEDTLS_PUT_UINT16_BE( identity_len, buf, 0 );
801 memcpy( buf + 2, identity, identity_len );
802 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, buf, 2 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800803
Jerry Yua99cbfa2022-10-08 11:17:14 +0800804 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", buf, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800805
806 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800807
808 return( 0 );
809}
810
Jerry Yu8b41e892022-09-30 10:00:20 +0800811MBEDTLS_CHECK_RETURN_CRITICAL
812static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
813 unsigned char *buf,
814 unsigned char *end,
815 int psk_type,
Jerry Yu6183cc72022-09-30 11:08:57 +0800816 psa_algorithm_t hash_alg,
817 const unsigned char *psk,
818 size_t psk_len,
Jerry Yu8b41e892022-09-30 10:00:20 +0800819 size_t *out_len )
820{
821 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800822 unsigned char binder_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800823 unsigned char transcript[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Jerry Yu8b41e892022-09-30 10:00:20 +0800824 size_t transcript_len = 0;
825
826 *out_len = 0;
827
Jerry Yu6183cc72022-09-30 11:08:57 +0800828 binder_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yu8b41e892022-09-30 10:00:20 +0800829
830 /*
831 * - binder_len (1 bytes)
832 * - binder (binder_len bytes)
833 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800834 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800835
Jerry Yua99cbfa2022-10-08 11:17:14 +0800836 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800837
838 /* Get current state of handshake transcript. */
839 ret = mbedtls_ssl_get_handshake_transcript(
Jerry Yu6183cc72022-09-30 11:08:57 +0800840 ssl, mbedtls_hash_info_md_from_psa( hash_alg ),
Jerry Yu6916e702022-10-10 21:33:51 +0800841 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800842 if( ret != 0 )
843 return( ret );
844
Jerry Yu6183cc72022-09-30 11:08:57 +0800845 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800846 psk, psk_len, psk_type,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800847 transcript, buf + 1 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800848 if( ret != 0 )
849 {
850 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
851 return( ret );
852 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800853 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", buf, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800854
855 *out_len = 1 + binder_len;
856
Jerry Yu6916e702022-10-10 21:33:51 +0800857 return( 0 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800858}
859
860/*
861 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
862 *
863 * struct {
864 * opaque identity<1..2^16-1>;
865 * uint32 obfuscated_ticket_age;
866 * } PskIdentity;
867 *
868 * opaque PskBinderEntry<32..255>;
869 *
870 * struct {
871 * PskIdentity identities<7..2^16-1>;
872 * PskBinderEntry binders<33..2^16-1>;
873 * } OfferedPsks;
874 *
875 * struct {
876 * select (Handshake.msg_type) {
877 * case client_hello: OfferedPsks;
878 * ...
879 * };
880 * } PreSharedKeyExtension;
881 *
882 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000883int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Jerry Yuf75364b2022-09-30 10:30:31 +0800884 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
885 size_t *out_len, size_t *binders_len )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000886{
Jerry Yuf7c12592022-09-28 22:09:38 +0800887 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800888 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800889 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800890 psa_algorithm_t hash_alg;
891 const unsigned char *identity;
892 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800893 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800894 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800895
896 *out_len = 0;
897 *binders_len = 0;
898
899 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Jerry Yuf75364b2022-09-30 10:30:31 +0800900 configured_psk_count = ssl_tls13_get_configured_psk_count( ssl );
901 if( configured_psk_count == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800902 {
903 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
904 return( 0 );
905 }
906
907 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
Jerry Yuf75364b2022-09-30 10:30:31 +0800908 configured_psk_count ) );
909
Jerry Yuf7c12592022-09-28 22:09:38 +0800910 /* Check if we have space to write the extension, binders included.
911 * - extension_type (2 bytes)
912 * - extension_data_len (2 bytes)
913 * - identities_len (2 bytes)
914 */
915 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
916 p += 6;
917
Jerry Yuf75364b2022-09-30 10:30:31 +0800918#if defined(MBEDTLS_SSL_SESSION_TICKETS)
919 if( ssl_tls13_ticket_get_identity(
920 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800921 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800922#if defined(MBEDTLS_HAVE_TIME)
923 mbedtls_time_t now = mbedtls_time( NULL );
924 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800925 uint32_t obfuscated_ticket_age =
926 (uint32_t)( now - session->ticket_received );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800927
Jerry Yuf75364b2022-09-30 10:30:31 +0800928 obfuscated_ticket_age *= 1000;
929 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800930
Jerry Yuf7c12592022-09-28 22:09:38 +0800931 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800932 identity, identity_len,
933 obfuscated_ticket_age,
934 &output_len );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800935#else
936 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len,
937 0, &output_len );
938#endif /* MBEDTLS_HAVE_TIME */
Jerry Yuf7c12592022-09-28 22:09:38 +0800939 if( ret != 0 )
940 return( ret );
Jerry Yuf7c12592022-09-28 22:09:38 +0800941
Jerry Yuf75364b2022-09-30 10:30:31 +0800942 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800943 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf75364b2022-09-30 10:30:31 +0800944 }
945#endif /* MBEDTLS_SSL_SESSION_TICKETS */
946
947 if( ssl_tls13_psk_get_identity(
948 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800949 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800950
Jerry Yua99cbfa2022-10-08 11:17:14 +0800951 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len, 0,
Jerry Yuf75364b2022-09-30 10:30:31 +0800952 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800953 if( ret != 0 )
954 return( ret );
Jerry Yuf75364b2022-09-30 10:30:31 +0800955
Jerry Yuf7c12592022-09-28 22:09:38 +0800956 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800957 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf7c12592022-09-28 22:09:38 +0800958 }
959
960 MBEDTLS_SSL_DEBUG_MSG( 3,
961 ( "client hello, adding pre_shared_key extension, "
962 "omitting PSK binder list" ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800963
964 /* Take into account the two bytes for the length of the binders. */
965 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800966 /* Check if there is enough space for binders */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800967 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len );
968
Jerry Yuf7c12592022-09-28 22:09:38 +0800969 /*
970 * - extension_type (2 bytes)
971 * - extension_data_len (2 bytes)
972 * - identities_len (2 bytes)
973 */
974 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800975 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + l_binders_len , buf, 2 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800976 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
977
Jerry Yua99cbfa2022-10-08 11:17:14 +0800978 *out_len = ( p - buf ) + l_binders_len;
979 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800980
981 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
982
983 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
984
XiaokangQianeb69aee2022-07-05 08:21:43 +0000985 return( 0 );
986}
987
XiaokangQian86981952022-07-19 09:51:50 +0000988int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +0800989 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000990{
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800991 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
992 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +0800993 psa_algorithm_t hash_alg = PSA_ALG_NONE;
994 const unsigned char *psk;
995 size_t psk_len;
996 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800997
998 /* Check if we have space to write binders_len.
999 * - binders_len (2 bytes)
1000 */
1001 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1002 p += 2;
1003
Jerry Yu6183cc72022-09-30 11:08:57 +08001004#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1005 if( ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001006 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001007
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001008 ret = ssl_tls13_write_binder( ssl, p, end,
1009 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
Jerry Yu6183cc72022-09-30 11:08:57 +08001010 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001011 &output_len );
1012 if( ret != 0 )
1013 return( ret );
1014 p += output_len;
1015 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001016#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001017
Jerry Yu6183cc72022-09-30 11:08:57 +08001018 if( ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001019 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001020
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001021 ret = ssl_tls13_write_binder( ssl, p, end,
1022 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
Jerry Yu6183cc72022-09-30 11:08:57 +08001023 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001024 &output_len );
1025 if( ret != 0 )
1026 return( ret );
1027 p += output_len;
1028 }
1029
1030 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1031
1032 /*
1033 * - binders_len (2 bytes)
1034 */
1035 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1036
1037 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001038
1039 return( 0 );
1040}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001041
1042/*
1043 * struct {
1044 * opaque identity<1..2^16-1>;
1045 * uint32 obfuscated_ticket_age;
1046 * } PskIdentity;
1047 *
1048 * opaque PskBinderEntry<32..255>;
1049 *
1050 * struct {
1051 *
1052 * select (Handshake.msg_type) {
1053 * ...
1054 * case server_hello: uint16 selected_identity;
1055 * };
1056 *
1057 * } PreSharedKeyExtension;
1058 *
1059 */
1060MBEDTLS_CHECK_RETURN_CRITICAL
1061static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1062 const unsigned char *buf,
1063 const unsigned char *end )
1064{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001065 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001066 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001067 const unsigned char *psk;
1068 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001069 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001070
Jerry Yua99cbfa2022-10-08 11:17:14 +08001071 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Jerry Yub300e3c2022-09-28 22:12:07 +08001072 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001073
Jerry Yub300e3c2022-09-28 22:12:07 +08001074 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001075
Jerry Yu4a698342022-09-30 12:22:01 +08001076 if( selected_identity >= ssl_tls13_get_configured_psk_count( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001077 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001078 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid PSK identity." ) );
Jerry Yu4a698342022-09-30 12:22:01 +08001079
1080 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1081 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1082 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yub300e3c2022-09-28 22:12:07 +08001083 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001084
Jerry Yu4a698342022-09-30 12:22:01 +08001085#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1086 if( selected_identity == 0 && ssl_tls13_has_configured_ticket( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001087 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001088 ret = ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yu4a698342022-09-30 12:22:01 +08001089 }
1090 else
1091#endif
Ronald Crond29e13e2022-10-19 10:33:48 +02001092 if( mbedtls_ssl_conf_has_static_psk( ssl->conf ) )
Jerry Yu4a698342022-09-30 12:22:01 +08001093 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001094 ret = ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001095 }
1096 else
1097 {
1098 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1099 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1100 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001101 if( ret != 0 )
1102 return( ret );
1103
1104 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1105 if( ret != 0 )
1106 {
1107 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
Jerry Yu6916e702022-10-10 21:33:51 +08001108 return( ret );
Jerry Yub300e3c2022-09-28 22:12:07 +08001109 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001110
Jerry Yu6916e702022-10-10 21:33:51 +08001111 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1112
1113 return( 0 );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001114}
1115
XiaokangQianeb69aee2022-07-05 08:21:43 +00001116#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1117
Ronald Cron3d580bf2022-02-18 17:24:56 +01001118int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1119 unsigned char *buf,
1120 unsigned char *end,
1121 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001122{
1123 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1124 unsigned char *p = buf;
1125 size_t ext_len;
1126
1127 *out_len = 0;
1128
1129 /* Write supported_versions extension
1130 *
1131 * Supported Versions Extension is mandatory with TLS 1.3.
1132 */
1133 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1134 if( ret != 0 )
1135 return( ret );
1136 p += ext_len;
1137
1138 /* Echo the cookie if the server provided one in its preceding
1139 * HelloRetryRequest message.
1140 */
1141 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1142 if( ret != 0 )
1143 return( ret );
1144 p += ext_len;
1145
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001146 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1147 {
1148 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1149 if( ret != 0 )
1150 return( ret );
1151 p += ext_len;
1152 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001153
XiaokangQianeb69aee2022-07-05 08:21:43 +00001154#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1155 /* For PSK-based key exchange we need the pre_shared_key extension
1156 * and the psk_key_exchange_modes extension.
1157 *
1158 * The pre_shared_key extension MUST be the last extension in the
1159 * ClientHello. Servers MUST check that it is the last extension and
1160 * otherwise fail the handshake with an "illegal_parameter" alert.
1161 *
1162 * Add the psk_key_exchange_modes extension.
1163 */
1164 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1165 if( ret != 0 )
1166 return( ret );
1167 p += ext_len;
1168#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1169
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001170 *out_len = p - buf;
1171
1172 return( 0 );
1173}
1174
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001175/*
Jerry Yu4a173382021-10-11 21:45:31 +08001176 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001177 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001178
Ronald Cronda41b382022-03-30 09:57:11 +02001179/**
1180 * \brief Detect if the ServerHello contains a supported_versions extension
1181 * or not.
1182 *
1183 * \param[in] ssl SSL context
1184 * \param[in] buf Buffer containing the ServerHello message
1185 * \param[in] end End of the buffer containing the ServerHello message
1186 *
1187 * \return 0 if the ServerHello does not contain a supported_versions extension
1188 * \return 1 if the ServerHello contains a supported_versions extension
1189 * \return A negative value if an error occurred while parsing the ServerHello.
1190 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001191MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001192static int ssl_tls13_is_supported_versions_ext_present(
1193 mbedtls_ssl_context *ssl,
1194 const unsigned char *buf,
1195 const unsigned char *end )
1196{
1197 const unsigned char *p = buf;
1198 size_t legacy_session_id_echo_len;
1199 size_t extensions_len;
1200 const unsigned char *extensions_end;
1201
1202 /*
1203 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001204 * length:
1205 * - legacy_version 2 bytes
1206 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1207 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001208 */
1209 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1210 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1211 legacy_session_id_echo_len = *p;
1212
1213 /*
1214 * Jump to the extensions, jumping over:
1215 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1216 * - cipher_suite 2 bytes
1217 * - legacy_compression_method 1 byte
1218 */
Ronald Cron28271062022-06-10 14:43:55 +02001219 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001220 p += legacy_session_id_echo_len + 4;
1221
1222 /* Case of no extension */
1223 if( p == end )
1224 return( 0 );
1225
1226 /* ...
1227 * Extension extensions<6..2^16-1>;
1228 * ...
1229 * struct {
1230 * ExtensionType extension_type; (2 bytes)
1231 * opaque extension_data<0..2^16-1>;
1232 * } Extension;
1233 */
1234 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1235 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1236 p += 2;
1237
1238 /* Check extensions do not go beyond the buffer of data. */
1239 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1240 extensions_end = p + extensions_len;
1241
1242 while( p < extensions_end )
1243 {
1244 unsigned int extension_type;
1245 size_t extension_data_len;
1246
1247 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1248 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1249 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1250 p += 4;
1251
1252 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1253 return( 1 );
1254
1255 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1256 p += extension_data_len;
1257 }
1258
1259 return( 0 );
1260}
1261
Jerry Yu7a186a02021-10-15 18:46:14 +08001262/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001263 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1264 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1265 * - 0 otherwise
1266 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001267MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001268static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1269 const unsigned char *buf,
1270 const unsigned char *end )
1271{
1272 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1273 static const unsigned char magic_downgrade_string[] =
1274 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1275 const unsigned char *last_eight_bytes_of_random;
1276 unsigned char last_byte_of_random;
1277
1278 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1279 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1280
1281 if( memcmp( last_eight_bytes_of_random,
1282 magic_downgrade_string,
1283 sizeof( magic_downgrade_string ) ) == 0 )
1284 {
1285 last_byte_of_random = last_eight_bytes_of_random[7];
1286 return( last_byte_of_random == 0 ||
1287 last_byte_of_random == 1 );
1288 }
1289
1290 return( 0 );
1291}
1292
1293/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001294 * - SSL_SERVER_HELLO or
1295 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001296 * to indicate which message is expected and to be parsed next.
1297 */
Ronald Cron828aff62022-05-31 12:04:31 +02001298#define SSL_SERVER_HELLO 0
1299#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001300MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001301static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1302 const unsigned char *buf,
1303 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001304{
Jerry Yue1b9c292021-09-10 10:08:31 +08001305
1306 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1307 *
Jerry Yu4a173382021-10-11 21:45:31 +08001308 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001309 * special value of the SHA-256 of "HelloRetryRequest".
1310 *
1311 * struct {
1312 * ProtocolVersion legacy_version = 0x0303;
1313 * Random random;
1314 * opaque legacy_session_id_echo<0..32>;
1315 * CipherSuite cipher_suite;
1316 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001317 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001318 * } ServerHello;
1319 *
1320 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001321 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1322 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001323
Jerry Yu93a13f22022-04-11 23:00:01 +08001324 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1325 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001326 {
Ronald Cron828aff62022-05-31 12:04:31 +02001327 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001328 }
1329
Ronald Cron828aff62022-05-31 12:04:31 +02001330 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001331}
1332
Ronald Cron828aff62022-05-31 12:04:31 +02001333/*
Jerry Yu745bb612021-10-13 22:01:04 +08001334 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001335 * - SSL_SERVER_HELLO or
1336 * - SSL_SERVER_HELLO_HRR or
1337 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001338 */
Ronald Cron828aff62022-05-31 12:04:31 +02001339#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001340MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001341static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001342 const unsigned char *buf,
1343 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001344{
Jerry Yu4a173382021-10-11 21:45:31 +08001345 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001346 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001347
Ronald Cron9f0fba32022-02-10 16:45:15 +01001348 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001349 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001350
Ronald Cron9f0fba32022-02-10 16:45:15 +01001351 if( ret == 0 )
1352 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001353 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001354 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001355
1356 /* If the server is negotiating TLS 1.2 or below and:
1357 * . we did not propose TLS 1.2 or
1358 * . the server responded it is TLS 1.3 capable but negotiating a lower
1359 * version of the protocol and thus we are under downgrade attack
1360 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001361 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001362 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001363 {
1364 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1365 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1366 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1367 }
1368
1369 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001370 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001371 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001372 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001373
1374 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1375 {
1376 ret = ssl_tls13_reset_key_share( ssl );
1377 if( ret != 0 )
1378 return( ret );
1379 }
1380
Ronald Cron828aff62022-05-31 12:04:31 +02001381 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001382 }
1383
Jerry Yua66fece2022-07-13 14:30:29 +08001384#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1385 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1386 ssl->session_negotiate->tls_version = ssl->tls_version;
1387#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1388
Ronald Cron5afb9042022-05-31 12:11:39 +02001389 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1390
Ronald Crondb5dfa12022-05-31 11:44:38 +02001391 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001392 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001393 {
Ronald Cron828aff62022-05-31 12:04:31 +02001394 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001395 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1396 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001397 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001398 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001399 /* If a client receives a second
1400 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1401 * was itself in response to a HelloRetryRequest), it MUST abort the
1402 * handshake with an "unexpected_message" alert.
1403 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001404 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001405 {
1406 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1407 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1408 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1409 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1410 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001411 /*
1412 * Clients must abort the handshake with an "illegal_parameter"
1413 * alert if the HelloRetryRequest would not result in any change
1414 * in the ClientHello.
1415 * In a PSK only key exchange that what we expect.
1416 */
1417 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1418 {
1419 MBEDTLS_SSL_DEBUG_MSG( 1,
1420 ( "Unexpected HRR in pure PSK key exchange." ) );
1421 MBEDTLS_SSL_PEND_FATAL_ALERT(
1422 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1423 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1424 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1425 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001426
Ronald Cron5afb9042022-05-31 12:11:39 +02001427 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001428
Jerry Yu745bb612021-10-13 22:01:04 +08001429 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001430 }
1431
1432cleanup:
1433
1434 return( ret );
1435}
1436
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001437MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001438static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1439 const unsigned char **buf,
1440 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001441{
1442 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001443 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001444
Jerry Yude4fb2c2021-09-19 18:05:08 +08001445 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001446 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001447
Jerry Yu4a173382021-10-11 21:45:31 +08001448 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001449
1450 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001451 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1452 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001453 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001454 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1455 ssl->session_negotiate->id,
1456 ssl->session_negotiate->id_len );
1457 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001458 legacy_session_id_echo_len );
1459
1460 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1461 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1462
Jerry Yue1b9c292021-09-10 10:08:31 +08001463 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1464 }
1465
Jerry Yu4a173382021-10-11 21:45:31 +08001466 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001467 *buf = p;
1468
1469 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001470 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001471 return( 0 );
1472}
1473
Jerry Yue1b9c292021-09-10 10:08:31 +08001474/* Parse ServerHello message and configure context
1475 *
1476 * struct {
1477 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1478 * Random random;
1479 * opaque legacy_session_id_echo<0..32>;
1480 * CipherSuite cipher_suite;
1481 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001482 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001483 * } ServerHello;
1484 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001485MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001486static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1487 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001488 const unsigned char *end,
1489 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001490{
Jerry Yub85277e2021-10-13 13:36:05 +08001491 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001492 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001493 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001494 size_t extensions_len;
1495 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001496 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001497 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001498 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001499
1500 /*
1501 * Check there is space for minimal fields
1502 *
1503 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001504 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001505 * - legacy_session_id_echo ( 1 byte ), minimum size
1506 * - cipher_suite ( 2 bytes)
1507 * - legacy_compression_method ( 1 byte )
1508 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001509 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001510
1511 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001512 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1513
Jerry Yu4a173382021-10-11 21:45:31 +08001514 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001515 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001516 * ...
1517 * with ProtocolVersion defined as:
1518 * uint16 ProtocolVersion;
1519 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001520 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1521 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001522 {
1523 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1524 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1525 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001526 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1527 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001528 }
1529 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001530
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001531 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001532 * Random random;
1533 * ...
1534 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001535 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001536 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001537 if( !is_hrr )
1538 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001539 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001540 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1541 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1542 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1543 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001544 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001545
Jerry Yu4a173382021-10-11 21:45:31 +08001546 /* ...
1547 * opaque legacy_session_id_echo<0..32>;
1548 * ...
1549 */
1550 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001551 {
XiaokangQian52da5582022-01-26 09:49:29 +00001552 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001553 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001554 }
1555
Jerry Yu4a173382021-10-11 21:45:31 +08001556 /* ...
1557 * CipherSuite cipher_suite;
1558 * ...
1559 * with CipherSuite defined as:
1560 * uint8 CipherSuite[2];
1561 */
1562 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001563 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1564 p += 2;
1565
Jerry Yu4a173382021-10-11 21:45:31 +08001566
XiaokangQian355e09a2022-01-20 11:14:50 +00001567 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001568 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001569 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001570 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001571 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1572 ssl->tls_version,
1573 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001574 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001575 {
XiaokangQian52da5582022-01-26 09:49:29 +00001576 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001577 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001578 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001579 * If we received an HRR before and that the proposed selected
1580 * ciphersuite in this server hello is not the same as the one
1581 * proposed in the HRR, we abort the handshake and send an
1582 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001583 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001584 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1585 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001586 {
XiaokangQian52da5582022-01-26 09:49:29 +00001587 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001588 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001589
XiaokangQian52da5582022-01-26 09:49:29 +00001590 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001591 {
1592 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1593 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001594 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001595 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001596
Jerry Yu4a173382021-10-11 21:45:31 +08001597 /* Configure ciphersuites */
1598 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1599
XiaokangQian355e09a2022-01-20 11:14:50 +00001600 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001601 ssl->session_negotiate->ciphersuite = cipher_suite;
1602
Jerry Yue1b9c292021-09-10 10:08:31 +08001603 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1604 cipher_suite, ciphersuite_info->name ) );
1605
1606#if defined(MBEDTLS_HAVE_TIME)
1607 ssl->session_negotiate->start = time( NULL );
1608#endif /* MBEDTLS_HAVE_TIME */
1609
Jerry Yu4a173382021-10-11 21:45:31 +08001610 /* ...
1611 * uint8 legacy_compression_method = 0;
1612 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001613 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001614 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001615 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001616 {
Jerry Yub85277e2021-10-13 13:36:05 +08001617 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001618 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001619 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001620 }
1621 p++;
1622
Jerry Yub85277e2021-10-13 13:36:05 +08001623 /* ...
1624 * Extension extensions<6..2^16-1>;
1625 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001626 * struct {
1627 * ExtensionType extension_type; (2 bytes)
1628 * opaque extension_data<0..2^16-1>;
1629 * } Extension;
1630 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001631 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001632 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001633 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001634
Jerry Yu4a173382021-10-11 21:45:31 +08001635 /* Check extensions do not go beyond the buffer of data. */
1636 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1637 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001638
Jerry Yu4a173382021-10-11 21:45:31 +08001639 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001640
Jerry Yu4a173382021-10-11 21:45:31 +08001641 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001642 {
1643 unsigned int extension_type;
1644 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001645 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001646
Jerry Yu4a173382021-10-11 21:45:31 +08001647 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001648 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1649 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1650 p += 4;
1651
Jerry Yu4a173382021-10-11 21:45:31 +08001652 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001653 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001654
1655 switch( extension_type )
1656 {
XiaokangQianb851da82022-01-14 04:03:11 +00001657 case MBEDTLS_TLS_EXT_COOKIE:
1658
XiaokangQiand9e068e2022-01-18 06:23:32 +00001659 if( !is_hrr )
1660 {
XiaokangQian52da5582022-01-26 09:49:29 +00001661 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001662 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001663 }
1664
XiaokangQian43550bd2022-01-21 04:32:58 +00001665 ret = ssl_tls13_parse_cookie_ext( ssl,
1666 p, extension_data_end );
1667 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001668 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001669 MBEDTLS_SSL_DEBUG_RET( 1,
1670 "ssl_tls13_parse_cookie_ext",
1671 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001672 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001673 }
XiaokangQianb851da82022-01-14 04:03:11 +00001674 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001675
Jerry Yue1b9c292021-09-10 10:08:31 +08001676 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001677 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001678 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001679 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001680 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001681 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001682 break;
1683
XiaokangQianeb69aee2022-07-05 08:21:43 +00001684#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001685 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001686 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1687 if( is_hrr )
1688 {
1689 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1690 goto cleanup;
1691 }
Jerry Yu4a173382021-10-11 21:45:31 +08001692
XiaokangQian86981952022-07-19 09:51:50 +00001693 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001694 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001695 {
1696 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001697 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001698 return( ret );
1699 }
1700 break;
1701#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001702
Jerry Yue1b9c292021-09-10 10:08:31 +08001703 case MBEDTLS_TLS_EXT_KEY_SHARE:
1704 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001705 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1706 {
XiaokangQian52da5582022-01-26 09:49:29 +00001707 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001708 goto cleanup;
1709 }
1710
XiaokangQian53f20b72022-01-18 10:47:33 +00001711 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001712 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001713 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001714 else
XiaokangQianb851da82022-01-14 04:03:11 +00001715 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001716 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001717 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001718 {
1719 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001720 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001721 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001722 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001723 }
1724 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001725
1726 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001727 MBEDTLS_SSL_DEBUG_MSG(
1728 3,
1729 ( "unknown extension found: %u ( ignoring )",
1730 extension_type ) );
1731
XiaokangQian52da5582022-01-26 09:49:29 +00001732 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001733 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001734 }
1735
1736 p += extension_data_len;
1737 }
1738
XiaokangQiand59be772022-01-24 10:12:51 +00001739cleanup:
1740
XiaokangQian52da5582022-01-26 09:49:29 +00001741 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001742 {
1743 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1744 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1745 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1746 }
XiaokangQian52da5582022-01-26 09:49:29 +00001747 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001748 {
1749 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1750 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1751 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1752 }
1753 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001754}
1755
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001756#if defined(MBEDTLS_DEBUG_C)
1757static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001758{
1759 switch( mode )
1760 {
1761 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1762 return "psk";
1763 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1764 return "ephemeral";
1765 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1766 return "psk_ephemeral";
1767 default:
1768 return "unknown mode";
1769 }
1770}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001771#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001772
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001773MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001774static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001775{
Jerry Yub85277e2021-10-13 13:36:05 +08001776 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001777 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001778
Jerry Yub85277e2021-10-13 13:36:05 +08001779 /* Determine the key exchange mode:
1780 * 1) If both the pre_shared_key and key_share extensions were received
1781 * then the key exchange mode is PSK with EPHEMERAL.
1782 * 2) If only the pre_shared_key extension was received then the key
1783 * exchange mode is PSK-only.
1784 * 3) If only the key_share extension was received then the key
1785 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001786 */
Jerry Yub85277e2021-10-13 13:36:05 +08001787 switch( handshake->extensions_present &
1788 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001789 {
Jerry Yu745bb612021-10-13 22:01:04 +08001790 /* Only the pre_shared_key extension was received */
1791 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001792 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001793 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001794
Jerry Yu745bb612021-10-13 22:01:04 +08001795 /* Only the key_share extension was received */
1796 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001797 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001798 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001799
Jerry Yu745bb612021-10-13 22:01:04 +08001800 /* Both the pre_shared_key and key_share extensions were received */
1801 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001802 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001803 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001804
Jerry Yu745bb612021-10-13 22:01:04 +08001805 /* Neither pre_shared_key nor key_share extension was received */
1806 default:
1807 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1808 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1809 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001810 }
1811
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001812 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1813 {
1814 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1815 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001816 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001817 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001818 goto cleanup;
1819 }
1820
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001821 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001822 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001823 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001824
Jerry Yu0b177842021-09-05 19:41:30 +08001825 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1826 *
1827 * TODO: We don't have to do this in case we offered 0-RTT and the
1828 * server accepted it. In this case, we could skip generating
1829 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001830 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001831 if( ret != 0 )
1832 {
Jerry Yue110d252022-05-05 10:19:22 +08001833 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001834 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001835 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001836 }
1837
Jerry Yuf86eb752022-05-06 11:16:55 +08001838 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001839 if( ret != 0 )
1840 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001841 MBEDTLS_SSL_DEBUG_RET( 1,
1842 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001843 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001844 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001845 }
1846
Jerry Yue110d252022-05-05 10:19:22 +08001847 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001848 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1849 ssl->session_in = ssl->session_negotiate;
1850
Jerry Yu4a173382021-10-11 21:45:31 +08001851cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001852 if( ret != 0 )
1853 {
Jerry Yu4a173382021-10-11 21:45:31 +08001854 MBEDTLS_SSL_PEND_FATAL_ALERT(
1855 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1856 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1857 }
Jerry Yue110d252022-05-05 10:19:22 +08001858
Jerry Yu4a173382021-10-11 21:45:31 +08001859 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001860}
1861
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001862MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001863static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001864{
1865 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1866
XiaokangQian78b1fa72022-01-19 06:56:30 +00001867 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001868
XiaokangQian78b1fa72022-01-19 06:56:30 +00001869 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001870 * We are going to re-generate a shared secret corresponding to the group
1871 * selected by the server, which is different from the group for which we
1872 * generated a shared secret in the first client hello.
1873 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001874 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001875 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001876 if( ret != 0 )
1877 return( ret );
1878
1879 return( 0 );
1880}
1881
Jerry Yue1b9c292021-09-10 10:08:31 +08001882/*
Jerry Yu4a173382021-10-11 21:45:31 +08001883 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001884 * Handler for MBEDTLS_SSL_SERVER_HELLO
1885 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001886MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001887static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001888{
Jerry Yu4a173382021-10-11 21:45:31 +08001889 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001890 unsigned char *buf = NULL;
1891 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001892 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001893
1894 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1895
Ronald Crondb5dfa12022-05-31 11:44:38 +02001896 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1897 MBEDTLS_SSL_HS_SERVER_HELLO,
1898 &buf, &buf_len ) );
1899
Ronald Cron828aff62022-05-31 12:04:31 +02001900 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001901 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001902 goto cleanup;
1903 else
Ronald Cron828aff62022-05-31 12:04:31 +02001904 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001905
Ronald Cron828aff62022-05-31 12:04:31 +02001906 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001907 {
1908 ret = 0;
1909 goto cleanup;
1910 }
1911
XiaokangQianb851da82022-01-14 04:03:11 +00001912 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001913 buf + buf_len,
1914 is_hrr ) );
1915 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001916 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1917
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001918 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1919 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001920
XiaokangQiand9e068e2022-01-18 06:23:32 +00001921 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001922 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001923 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001924#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1925 /* If not offering early data, the client sends a dummy CCS record
1926 * immediately before its second flight. This may either be before
1927 * its second ClientHello or before its encrypted handshake flight.
1928 */
1929 mbedtls_ssl_handshake_set_state( ssl,
1930 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1931#else
1932 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1933#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1934 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001935 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001936 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001937 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001938 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1939 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001940
1941cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001942 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1943 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08001944 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08001945}
1946
1947/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001948 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001949 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001950 *
1951 * The EncryptedExtensions message contains any extensions which
1952 * should be protected, i.e., any which are not needed to establish
1953 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001954 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001955
XiaokangQian08da26c2021-10-09 10:12:11 +00001956/* Parse EncryptedExtensions message
1957 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001958 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001959 * } EncryptedExtensions;
1960 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001961MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00001962static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
1963 const unsigned char *buf,
1964 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001965{
1966 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001967 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00001968 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00001969 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001970
XiaokangQian08da26c2021-10-09 10:12:11 +00001971 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00001972 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001973 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001974
XiaokangQian97799ac2021-10-11 10:05:54 +00001975 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00001976 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02001977 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001978
XiaokangQian8db25ff2021-10-13 05:56:18 +00001979 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001980 {
XiaokangQian08da26c2021-10-09 10:12:11 +00001981 unsigned int extension_type;
1982 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001983
XiaokangQian08da26c2021-10-09 10:12:11 +00001984 /*
1985 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001986 * ExtensionType extension_type; (2 bytes)
1987 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001988 * } Extension;
1989 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00001990 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001991 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1992 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1993 p += 4;
1994
XiaokangQian8db25ff2021-10-13 05:56:18 +00001995 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001996
XiaokangQian97799ac2021-10-11 10:05:54 +00001997 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001998 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00001999 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002000 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002001 switch( extension_type )
2002 {
Jerry Yu661dd942022-08-03 14:50:01 +08002003 case MBEDTLS_TLS_EXT_SERVERNAME:
2004 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002005
Jerry Yu661dd942022-08-03 14:50:01 +08002006 /* The server_name extension should be an empty extension */
2007
2008 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002009 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2010 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2011 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002012
lhuang0486cacac2022-01-21 07:34:27 -08002013#if defined(MBEDTLS_SSL_ALPN)
2014 case MBEDTLS_TLS_EXT_ALPN:
2015 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2016
2017 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2018 {
2019 return( ret );
2020 }
2021
2022 break;
2023#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002024 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002025 MBEDTLS_SSL_DEBUG_MSG(
2026 3, ( "unsupported extension found: %u ", extension_type) );
2027 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002028 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002029 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2030 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002031 }
2032
XiaokangQian08da26c2021-10-09 10:12:11 +00002033 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002034 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002035
XiaokangQian97799ac2021-10-11 10:05:54 +00002036 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002037 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002038 {
2039 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002040 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002041 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002042 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002043 }
2044
2045 return( ret );
2046}
2047
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002048MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002049static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2050{
2051 int ret;
2052 unsigned char *buf;
2053 size_t buf_len;
2054
2055 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2056
2057 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2058 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2059 &buf, &buf_len ) );
2060
2061 /* Process the message contents */
2062 MBEDTLS_SSL_PROC_CHK(
2063 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2064
2065 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2066 buf, buf_len );
2067
Ronald Cronfb508b82022-05-31 14:49:55 +02002068#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002069 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002070 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2071 else
2072 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2073#else
2074 ((void) ssl);
2075 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2076#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002077
2078cleanup:
2079
2080 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2081 return( ret );
2082
2083}
2084
Jerry Yua93ac112021-10-27 16:31:48 +08002085#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002086/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002087 * STATE HANDLING: CertificateRequest
2088 *
Jerry Yud2674312021-10-29 10:08:19 +08002089 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002090#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2091#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002092/* Coordination:
2093 * Deals with the ambiguity of not knowing if a CertificateRequest
2094 * will be sent. Returns a negative code on failure, or
2095 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2096 * - SSL_CERTIFICATE_REQUEST_SKIP
2097 * indicating if a Certificate Request is expected or not.
2098 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002099MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002100static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002101{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002102 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002103
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002104 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002105 {
2106 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2107 return( ret );
2108 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002109 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002110
2111 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2112 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2113 {
Ronald Cron19385882022-06-15 16:26:13 +02002114 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002115 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002116 }
2117
Ronald Cron19385882022-06-15 16:26:13 +02002118 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2119
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002120 return( SSL_CERTIFICATE_REQUEST_SKIP );
2121}
2122
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002123/*
2124 * ssl_tls13_parse_certificate_request()
2125 * Parse certificate request
2126 * struct {
2127 * opaque certificate_request_context<0..2^8-1>;
2128 * Extension extensions<2..2^16-1>;
2129 * } CertificateRequest;
2130 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002131MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002132static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2133 const unsigned char *buf,
2134 const unsigned char *end )
2135{
2136 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2137 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002138 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002139 size_t extensions_len = 0;
2140 const unsigned char *extensions_end;
2141 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002142
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002143 /* ...
2144 * opaque certificate_request_context<0..2^8-1>
2145 * ...
2146 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002147 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2148 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002149 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002150
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002151 if( certificate_request_context_len > 0 )
2152 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002153 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002154 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2155 p, certificate_request_context_len );
2156
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002157 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002158 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002159 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002160 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002161 {
2162 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2163 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2164 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002165 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002166 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002167 p += certificate_request_context_len;
2168 }
2169
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002170 /* ...
2171 * Extension extensions<2..2^16-1>;
2172 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002173 */
2174 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2175 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2176 p += 2;
2177
2178 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2179 extensions_end = p + extensions_len;
2180
2181 while( p < extensions_end )
2182 {
2183 unsigned int extension_type;
2184 size_t extension_data_len;
2185
2186 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2187 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2188 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2189 p += 4;
2190
2191 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2192
2193 switch( extension_type )
2194 {
2195 case MBEDTLS_TLS_EXT_SIG_ALG:
2196 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002197 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002198 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002199 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002200 if( ret != 0 )
2201 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002202 if( ! sig_alg_ext_found )
2203 sig_alg_ext_found = 1;
2204 else
2205 {
2206 MBEDTLS_SSL_DEBUG_MSG( 3,
2207 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002208 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002209 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002210 break;
2211
2212 default:
2213 MBEDTLS_SSL_DEBUG_MSG(
2214 3,
2215 ( "unknown extension found: %u ( ignoring )",
2216 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002217 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002218 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002219 p += extension_data_len;
2220 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002221 /* Check that we consumed all the message. */
2222 if( p != end )
2223 {
2224 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002225 ( "CertificateRequest misaligned" ) );
2226 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002227 }
2228 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002229 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002230 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002231 MBEDTLS_SSL_DEBUG_MSG( 3,
2232 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002233 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002234 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002235
Jerry Yu7840f812022-01-29 10:26:51 +08002236 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002237 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002238
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002239decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002240 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2241 MBEDTLS_ERR_SSL_DECODE_ERROR );
2242 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002243}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002244
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002245/*
2246 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2247 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002248MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002249static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002250{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002251 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002252
2253 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2254
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002255 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2256
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002257 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2258 {
2259 unsigned char *buf;
2260 size_t buf_len;
2261
2262 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2263 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2264 &buf, &buf_len ) );
2265
2266 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2267 buf, buf + buf_len ) );
2268
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002269 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2270 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002271 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002272 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002273 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002274 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002275 }
2276 else
2277 {
2278 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002279 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2280 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002281 }
2282
Jerry Yud2674312021-10-29 10:08:19 +08002283 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2284
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002285cleanup:
2286
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002287 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2288 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002289}
2290
2291/*
Jerry Yu687101b2021-09-14 16:03:56 +08002292 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2293 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002294MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002295static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002296{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002297 int ret;
2298
2299 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002300 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002301 return( ret );
2302
Jerry Yu687101b2021-09-14 16:03:56 +08002303 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2304 return( 0 );
2305}
2306
2307/*
2308 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2309 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002310MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002311static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002312{
Jerry Yu30b071c2021-09-12 20:16:03 +08002313 int ret;
2314
2315 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2316 if( ret != 0 )
2317 return( ret );
2318
Jerry Yu687101b2021-09-14 16:03:56 +08002319 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2320 return( 0 );
2321}
Jerry Yua93ac112021-10-27 16:31:48 +08002322#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002323
Jerry Yu687101b2021-09-14 16:03:56 +08002324/*
2325 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2326 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002327MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002328static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002329{
XiaokangQianac0385c2021-11-03 06:40:11 +00002330 int ret;
2331
XiaokangQianc5c39d52021-11-09 11:55:10 +00002332 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002333 if( ret != 0 )
2334 return( ret );
2335
Jerry Yue3d67cb2022-05-19 15:33:10 +08002336 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2337 if( ret != 0 )
2338 {
2339 MBEDTLS_SSL_PEND_FATAL_ALERT(
2340 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2341 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2342 return( ret );
2343 }
2344
Ronald Cron49ad6192021-11-24 16:25:31 +01002345#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2346 mbedtls_ssl_handshake_set_state(
2347 ssl,
2348 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2349#else
Jerry Yuca133a32022-02-15 14:22:05 +08002350 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002351#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002352
XiaokangQianac0385c2021-11-03 06:40:11 +00002353 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002354}
2355
2356/*
Jerry Yu566c7812022-01-26 15:41:22 +08002357 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2358 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002359MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002360static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2361{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002362 int non_empty_certificate_msg = 0;
2363
Jerry Yu5cc35062022-01-28 16:16:08 +08002364 MBEDTLS_SSL_DEBUG_MSG( 1,
2365 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002366 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002367
Ronald Cron9df7c802022-03-08 18:38:54 +01002368#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002369 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002370 {
2371 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2372 if( ret != 0 )
2373 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002374
Ronald Cron7a94aca2022-03-09 07:44:27 +01002375 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2376 non_empty_certificate_msg = 1;
2377 }
2378 else
2379 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002380 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002381 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002382#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002383
Ronald Cron7a94aca2022-03-09 07:44:27 +01002384 if( non_empty_certificate_msg )
2385 {
2386 mbedtls_ssl_handshake_set_state( ssl,
2387 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2388 }
2389 else
Ronald Cron19385882022-06-15 16:26:13 +02002390 {
2391 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002392 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002393 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002394
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002395 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002396}
2397
Ronald Cron9df7c802022-03-08 18:38:54 +01002398#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002399/*
2400 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2401 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002402MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002403static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2404{
Ronald Crona8b38872022-03-09 07:59:25 +01002405 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2406
2407 if( ret == 0 )
2408 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2409
2410 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002411}
Jerry Yu90f152d2022-01-29 22:12:42 +08002412#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002413
2414/*
Jerry Yu687101b2021-09-14 16:03:56 +08002415 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2416 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002417MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002418static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002419{
XiaokangQian0fa66432021-11-15 03:33:57 +00002420 int ret;
2421
2422 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2423 if( ret != 0 )
2424 return( ret );
2425
Jerry Yu466dda82022-09-13 11:20:20 +08002426 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002427 if( ret != 0 )
2428 {
2429 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002430 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002431 return ( ret );
2432 }
2433
XiaokangQian0fa66432021-11-15 03:33:57 +00002434 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2435 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002436}
2437
2438/*
2439 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2440 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002441MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002442static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002443{
Jerry Yu378254d2021-10-30 21:44:47 +08002444 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002445 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002446 return( 0 );
2447}
2448
2449/*
2450 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002452MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002453static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002454{
Jerry Yu378254d2021-10-30 21:44:47 +08002455
2456 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2457
2458 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2459 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002460}
2461
Jerry Yuf8a49942022-07-07 11:32:32 +00002462#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2463
Jerry Yua0446a02022-07-13 11:22:55 +08002464MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002465static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2466 const unsigned char *buf,
2467 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002468{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002469 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002470
2471 ((void) ssl);
2472
2473 while( p < end )
2474 {
2475 unsigned int extension_type;
2476 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002477
Jerry Yuf8a49942022-07-07 11:32:32 +00002478 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2479 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2480 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2481 p += 4;
2482
2483 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002484
2485 switch( extension_type )
2486 {
2487 case MBEDTLS_TLS_EXT_EARLY_DATA:
2488 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2489 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002490
Jerry Yuf8a49942022-07-07 11:32:32 +00002491 default:
2492 break;
2493 }
2494 p += extension_data_len;
2495 }
2496
2497 return( 0 );
2498}
2499
2500/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002501 * From RFC8446, page 74
2502 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002503 * struct {
2504 * uint32 ticket_lifetime;
2505 * uint32 ticket_age_add;
2506 * opaque ticket_nonce<0..255>;
2507 * opaque ticket<1..2^16-1>;
2508 * Extension extensions<0..2^16-2>;
2509 * } NewSessionTicket;
2510 *
2511 */
Jerry Yua0446a02022-07-13 11:22:55 +08002512MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002513static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2514 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002515 unsigned char *end,
2516 unsigned char **ticket_nonce,
2517 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002518{
2519 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2520 unsigned char *p = buf;
2521 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002522 size_t ticket_len;
2523 unsigned char *ticket;
2524 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002525
Jerry Yucb3b1392022-07-12 06:09:38 +00002526 *ticket_nonce = NULL;
2527 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002528 /*
2529 * ticket_lifetime 4 bytes
2530 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002531 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002532 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002533 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002534
2535 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002536 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002537 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002538 ( unsigned int )session->ticket_lifetime ) );
2539
Jerry Yucb3b1392022-07-12 06:09:38 +00002540 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002541 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002542 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002543 ( unsigned int )session->ticket_age_add ) );
2544
Jerry Yucb3b1392022-07-12 06:09:38 +00002545 *ticket_nonce_len = p[8];
2546 p += 9;
2547
2548 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2549 *ticket_nonce = p;
2550 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2551 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002552
2553 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002554 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002555 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2556 p += 2;
2557 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002558 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2559
2560 /* Check if we previously received a ticket already. */
2561 if( session->ticket != NULL || session->ticket_len > 0 )
2562 {
2563 mbedtls_free( session->ticket );
2564 session->ticket = NULL;
2565 session->ticket_len = 0;
2566 }
2567
2568 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2569 {
2570 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2571 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2572 }
2573 memcpy( ticket, p, ticket_len );
2574 p += ticket_len;
2575 session->ticket = ticket;
2576 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002577
Jerry Yucb3b1392022-07-12 06:09:38 +00002578 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002579 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2580 p += 2;
2581 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2582
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002583 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002584
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002585 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002586 if( ret != 0 )
2587 {
2588 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002589 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002590 ret );
2591 return( ret );
2592 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002593
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002594 /* session has been updated, allow export */
2595 session->exported = 0;
2596
Jerry Yucb3b1392022-07-12 06:09:38 +00002597 return( 0 );
2598}
2599
Jerry Yua0446a02022-07-13 11:22:55 +08002600MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002601static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2602 unsigned char *ticket_nonce,
2603 size_t ticket_nonce_len )
2604{
2605 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2606 mbedtls_ssl_session *session = ssl->session;
2607 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2608 psa_algorithm_t psa_hash_alg;
2609 int hash_length;
2610
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002611#if defined(MBEDTLS_HAVE_TIME)
2612 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002613 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002614#endif
2615
Jerry Yuf8a49942022-07-07 11:32:32 +00002616 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2617 if( ciphersuite_info == NULL )
2618 {
2619 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2620 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2621 }
2622
2623 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2624 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002625 if( hash_length == -1 ||
2626 ( size_t )hash_length > sizeof( session->resumption_key ) )
2627 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002628 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002629 }
2630
Jerry Yuf8a49942022-07-07 11:32:32 +00002631
2632 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2633 session->app_secrets.resumption_master_secret,
2634 hash_length );
2635
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002636 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002637 *
2638 * HKDF-Expand-Label( resumption_master_secret,
2639 * "resumption", ticket_nonce, Hash.length )
2640 */
2641 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2642 psa_hash_alg,
2643 session->app_secrets.resumption_master_secret,
2644 hash_length,
2645 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2646 ticket_nonce,
2647 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002648 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002649 hash_length );
2650
2651 if( ret != 0 )
2652 {
2653 MBEDTLS_SSL_DEBUG_RET( 2,
2654 "Creating the ticket-resumed PSK failed",
2655 ret );
2656 return( ret );
2657 }
2658
Jerry Yu0a430c82022-07-20 11:02:48 +08002659 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002660
2661 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002662 session->resumption_key,
2663 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002664
Jerry Yuf8a49942022-07-07 11:32:32 +00002665 return( 0 );
2666}
2667
2668/*
Jerry Yua357cf42022-07-12 05:36:45 +00002669 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002670 */
Jerry Yua0446a02022-07-13 11:22:55 +08002671MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002672static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2673{
2674 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2675 unsigned char *buf;
2676 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002677 unsigned char *ticket_nonce;
2678 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002679
2680 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2681
2682 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2683 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2684 &buf, &buf_len ) );
2685
Jerry Yucb3b1392022-07-12 06:09:38 +00002686 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2687 ssl, buf, buf + buf_len,
2688 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002689
Jerry Yucb3b1392022-07-12 06:09:38 +00002690 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2691 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002692
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002693 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2694
Jerry Yuf8a49942022-07-07 11:32:32 +00002695cleanup:
2696
2697 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2698 return( ret );
2699}
2700#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2701
Jerry Yu92c6b402021-08-27 16:59:09 +08002702int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002703{
Jerry Yu92c6b402021-08-27 16:59:09 +08002704 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002705
Jerry Yu92c6b402021-08-27 16:59:09 +08002706 switch( ssl->state )
2707 {
2708 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002709 * ssl->state is initialized as HELLO_REQUEST. It is the same
2710 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002711 */
2712 case MBEDTLS_SSL_HELLO_REQUEST:
2713 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002714 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002715 break;
2716
2717 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002718 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002719 break;
2720
2721 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002722 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002723 break;
2724
Jerry Yua93ac112021-10-27 16:31:48 +08002725#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002726 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2727 ret = ssl_tls13_process_certificate_request( ssl );
2728 break;
2729
Jerry Yu687101b2021-09-14 16:03:56 +08002730 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002731 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002732 break;
2733
2734 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002735 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002736 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002737#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002738
2739 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002740 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002741 break;
2742
Jerry Yu566c7812022-01-26 15:41:22 +08002743 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2744 ret = ssl_tls13_write_client_certificate( ssl );
2745 break;
2746
Ronald Cron9df7c802022-03-08 18:38:54 +01002747#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002748 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2749 ret = ssl_tls13_write_client_certificate_verify( ssl );
2750 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002751#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002752
Jerry Yu687101b2021-09-14 16:03:56 +08002753 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002754 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002755 break;
2756
2757 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002758 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002759 break;
2760
2761 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002762 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002763 break;
2764
Ronald Cron49ad6192021-11-24 16:25:31 +01002765 /*
2766 * Injection of dummy-CCS's for middlebox compatibility
2767 */
2768#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002769 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002770 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2771 if( ret == 0 )
2772 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2773 break;
2774
2775 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2776 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2777 if( ret == 0 )
2778 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002779 break;
2780#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2781
Jerry Yuf8a49942022-07-07 11:32:32 +00002782#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002783 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002784 ret = ssl_tls13_process_new_session_ticket( ssl );
2785 if( ret != 0 )
2786 break;
2787 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2788 break;
2789#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2790
Jerry Yu92c6b402021-08-27 16:59:09 +08002791 default:
2792 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2793 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2794 }
2795
2796 return( ret );
2797}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002798
Jerry Yufb4b6472022-01-27 15:03:26 +08002799#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002800
Jerry Yufb4b6472022-01-27 15:03:26 +08002801