blob: ee4c24d21360bb54f1955c5907e9b3e7830acc7f [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
2 * TLS 1.3 client-side functions
3 *
4 * Copyright The Mbed TLS Contributors
5 * SPDX-License-Identifier: Apache-2.0
6 *
7 * Licensed under the Apache License, Version 2.0 (the "License"); you may
8 * not use this file except in compliance with the License.
9 * You may obtain a copy of the License at
10 *
11 * http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing, software
14 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
15 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16 * See the License for the specific language governing permissions and
17 * limitations under the License.
18 *
19 * This file is part of mbed TLS ( https://tls.mbed.org )
20 */
21
22#include "common.h"
23
Jerry Yucc43c6b2022-01-28 10:24:45 +080024#if defined(MBEDTLS_SSL_CLI_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080025
Jerry Yubc20bdd2021-08-24 15:59:48 +080026#include <string.h>
27
Jerry Yu56fc07f2021-09-01 17:48:49 +080028#include "mbedtls/debug.h"
29#include "mbedtls/error.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080030#include "mbedtls/platform.h"
Jerry Yua13c7e72021-08-17 10:44:40 +080031
Jerry Yubdc71882021-09-14 19:30:36 +080032#include "ssl_misc.h"
Ronald Cron3d580bf2022-02-18 17:24:56 +010033#include "ssl_client.h"
Jerry Yue1b9c292021-09-10 10:08:31 +080034#include "ssl_tls13_keys.h"
Jerry Yubdc71882021-09-14 19:30:36 +080035
Jerry Yubc20bdd2021-08-24 15:59:48 +080036/* Write extensions */
37
Jerry Yu92c6b402021-08-27 16:59:09 +080038/*
39 * ssl_tls13_write_supported_versions_ext():
40 *
41 * struct {
42 * ProtocolVersion versions<2..254>;
43 * } SupportedVersions;
44 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020045MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf4436812021-08-26 22:59:56 +080046static int ssl_tls13_write_supported_versions_ext( mbedtls_ssl_context *ssl,
Jerry Yueecfbf02021-08-30 18:32:07 +080047 unsigned char *buf,
48 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +000049 size_t *out_len )
Jerry Yu92c6b402021-08-27 16:59:09 +080050{
51 unsigned char *p = buf;
Glenn Strausscd78df62022-04-07 19:07:11 -040052 unsigned char versions_len = ( ssl->handshake->min_tls_version <=
53 MBEDTLS_SSL_VERSION_TLS1_2 ) ? 4 : 2;
Jerry Yu92c6b402021-08-27 16:59:09 +080054
Xiaofei Baid25fab62021-12-02 06:36:27 +000055 *out_len = 0;
Jerry Yu92c6b402021-08-27 16:59:09 +080056
Jerry Yu159c5a02021-08-31 12:51:25 +080057 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding supported versions extension" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080058
Jerry Yu388bd0d2021-09-15 18:41:02 +080059 /* Check if we have space to write the extension:
Jerry Yub60e3cf2021-09-08 16:41:02 +080060 * - extension_type (2 bytes)
61 * - extension_data_length (2 bytes)
62 * - versions_length (1 byte )
Ronald Crona77fc272022-03-30 17:20:47 +020063 * - versions (2 or 4 bytes)
Jerry Yu159c5a02021-08-31 12:51:25 +080064 */
Ronald Crona77fc272022-03-30 17:20:47 +020065 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 5 + versions_len );
Ronald Crondbe87f02022-02-10 14:35:27 +010066
Jerry Yueecfbf02021-08-30 18:32:07 +080067 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, p, 0 );
Ronald Crondbe87f02022-02-10 14:35:27 +010068 MBEDTLS_PUT_UINT16_BE( versions_len + 1, p, 2 );
Jerry Yueecfbf02021-08-30 18:32:07 +080069 p += 4;
Jerry Yu92c6b402021-08-27 16:59:09 +080070
Jerry Yu1bc2c1f2021-09-01 12:57:29 +080071 /* Length of versions */
Ronald Crondbe87f02022-02-10 14:35:27 +010072 *p++ = versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080073
Jerry Yu0c63af62021-09-02 12:59:12 +080074 /* Write values of supported versions.
Jerry Yu0c63af62021-09-02 12:59:12 +080075 * They are defined by the configuration.
Ronald Crondbe87f02022-02-10 14:35:27 +010076 * Currently, we advertise only TLS 1.3 or both TLS 1.3 and TLS 1.2.
Jerry Yu92c6b402021-08-27 16:59:09 +080077 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -040078 mbedtls_ssl_write_version( p, MBEDTLS_SSL_TRANSPORT_STREAM,
79 MBEDTLS_SSL_VERSION_TLS1_3 );
Ronald Crondbe87f02022-02-10 14:35:27 +010080 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:4]" ) );
Jerry Yu92c6b402021-08-27 16:59:09 +080081
Jerry Yu92c6b402021-08-27 16:59:09 +080082
Glenn Strausscd78df62022-04-07 19:07:11 -040083 if( ssl->handshake->min_tls_version <= MBEDTLS_SSL_VERSION_TLS1_2 )
Ronald Crondbe87f02022-02-10 14:35:27 +010084 {
Glenn Strausse3af4cb2022-03-15 03:23:42 -040085 mbedtls_ssl_write_version( p + 2, MBEDTLS_SSL_TRANSPORT_STREAM,
86 MBEDTLS_SSL_VERSION_TLS1_2 );
Ronald Crondbe87f02022-02-10 14:35:27 +010087 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [3:3]" ) );
88 }
89
90 *out_len = 5 + versions_len;
Jerry Yu92c6b402021-08-27 16:59:09 +080091
92 return( 0 );
93}
Jerry Yubc20bdd2021-08-24 15:59:48 +080094
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +020095MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +080096static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
97 const unsigned char *buf,
Jerry Yub85277e2021-10-13 13:36:05 +080098 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +080099{
Jerry Yue1b9c292021-09-10 10:08:31 +0800100 ((void) ssl);
101
Ronald Cron98473382022-03-30 20:04:10 +0200102 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Glenn Strausse3af4cb2022-03-15 03:23:42 -0400103 if( mbedtls_ssl_read_version( buf, ssl->conf->transport ) !=
104 MBEDTLS_SSL_VERSION_TLS1_3 )
Jerry Yue1b9c292021-09-10 10:08:31 +0800105 {
106 MBEDTLS_SSL_DEBUG_MSG( 1, ( "unexpected version" ) );
Jerry Yu4a173382021-10-11 21:45:31 +0800107
108 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
109 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
110 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yue1b9c292021-09-10 10:08:31 +0800111 }
112
Ronald Cron98473382022-03-30 20:04:10 +0200113 if( &buf[2] != end )
114 {
115 MBEDTLS_SSL_DEBUG_MSG( 1, ( "supported_versions ext data length incorrect" ) );
116 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
117 MBEDTLS_ERR_SSL_DECODE_ERROR );
118 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
119 }
120
Jerry Yue1b9c292021-09-10 10:08:31 +0800121 return( 0 );
122}
123
lhuang0486cacac2022-01-21 07:34:27 -0800124#if defined(MBEDTLS_SSL_ALPN)
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200125MBEDTLS_CHECK_RETURN_CRITICAL
lhuang0486cacac2022-01-21 07:34:27 -0800126static int ssl_tls13_parse_alpn_ext( mbedtls_ssl_context *ssl,
Ronald Cron81a334f2022-05-31 16:04:11 +0200127 const unsigned char *buf, size_t len )
lhuang0486cacac2022-01-21 07:34:27 -0800128{
lhuang0486cacac2022-01-21 07:34:27 -0800129 const unsigned char *p = buf;
130 const unsigned char *end = buf + len;
Ronald Cron81a334f2022-05-31 16:04:11 +0200131 size_t protocol_name_list_len, protocol_name_len;
132 const unsigned char *protocol_name_list_end;
lhuang0486cacac2022-01-21 07:34:27 -0800133
134 /* If we didn't send it, the server shouldn't send it */
135 if( ssl->conf->alpn_list == NULL )
136 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
137
138 /*
139 * opaque ProtocolName<1..2^8-1>;
140 *
141 * struct {
142 * ProtocolName protocol_name_list<2..2^16-1>
143 * } ProtocolNameList;
144 *
145 * the "ProtocolNameList" MUST contain exactly one "ProtocolName"
146 */
147
Ronald Cron81a334f2022-05-31 16:04:11 +0200148 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
149 protocol_name_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
lhuang0486cacac2022-01-21 07:34:27 -0800150 p += 2;
lhuang0486cacac2022-01-21 07:34:27 -0800151
Ronald Cron81a334f2022-05-31 16:04:11 +0200152 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, protocol_name_list_len );
153 protocol_name_list_end = p + protocol_name_list_len;
154
155 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, 1 );
156 protocol_name_len = *p++;
lhuang0486cacac2022-01-21 07:34:27 -0800157
158 /* Check that the server chosen protocol was in our list and save it */
Ronald Cron81a334f2022-05-31 16:04:11 +0200159 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, protocol_name_list_end, protocol_name_len );
160 for( const char **alpn = ssl->conf->alpn_list; *alpn != NULL; alpn++ )
lhuang0486cacac2022-01-21 07:34:27 -0800161 {
Ronald Cron81a334f2022-05-31 16:04:11 +0200162 if( protocol_name_len == strlen( *alpn ) &&
163 memcmp( p, *alpn, protocol_name_len ) == 0 )
lhuang0486cacac2022-01-21 07:34:27 -0800164 {
165 ssl->alpn_chosen = *alpn;
166 return( 0 );
167 }
168 }
169
170 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
171}
172#endif /* MBEDTLS_SSL_ALPN */
173
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200174MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian16acd4b2022-01-14 07:35:47 +0000175static int ssl_tls13_reset_key_share( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +0000176{
177 uint16_t group_id = ssl->handshake->offered_group_id;
Ronald Cron5b98ac92022-03-15 10:19:18 +0100178
XiaokangQian647719a2021-12-07 09:16:29 +0000179 if( group_id == 0 )
180 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
181
XiaokangQian355e09a2022-01-20 11:14:50 +0000182#if defined(MBEDTLS_ECDH_C)
XiaokangQian647719a2021-12-07 09:16:29 +0000183 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
XiaokangQian78b1fa72022-01-19 06:56:30 +0000184 {
Ronald Cron5b98ac92022-03-15 10:19:18 +0100185 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
186 psa_status_t status = PSA_ERROR_CORRUPTION_DETECTED;
187
188 /* Destroy generated private key. */
189 status = psa_destroy_key( ssl->handshake->ecdh_psa_privkey );
190 if( status != PSA_SUCCESS )
191 {
192 ret = psa_ssl_status_to_mbedtls( status );
193 MBEDTLS_SSL_DEBUG_RET( 1, "psa_destroy_key", ret );
194 return( ret );
195 }
196
197 ssl->handshake->ecdh_psa_privkey = MBEDTLS_SVC_KEY_ID_INIT;
XiaokangQian78b1fa72022-01-19 06:56:30 +0000198 return( 0 );
199 }
XiaokangQian355e09a2022-01-20 11:14:50 +0000200 else
201#endif /* MBEDTLS_ECDH_C */
202 if( 0 /* other KEMs? */ )
XiaokangQian647719a2021-12-07 09:16:29 +0000203 {
204 /* Do something */
205 }
206
207 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
208}
209
210/*
Jerry Yu56fc07f2021-09-01 17:48:49 +0800211 * Functions for writing key_share extension.
212 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200213MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub60e3cf2021-09-08 16:41:02 +0800214static int ssl_tls13_get_default_group_id( mbedtls_ssl_context *ssl,
215 uint16_t *group_id )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800216{
217 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
218
Jerry Yu56fc07f2021-09-01 17:48:49 +0800219
Jerry Yu56fc07f2021-09-01 17:48:49 +0800220#if defined(MBEDTLS_ECDH_C)
Brett Warren14efd332021-10-06 09:32:11 +0100221 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
Jerry Yu388bd0d2021-09-15 18:41:02 +0800222 /* Pick first available ECDHE group compatible with TLS 1.3 */
Brett Warren14efd332021-10-06 09:32:11 +0100223 if( group_list == NULL )
Jerry Yu388bd0d2021-09-15 18:41:02 +0800224 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
225
Brett Warren14efd332021-10-06 09:32:11 +0100226 for ( ; *group_list != 0; group_list++ )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800227 {
Xiaofei Baieef15042021-11-18 07:29:56 +0000228 const mbedtls_ecp_curve_info *curve_info;
229 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
230 if( curve_info != NULL &&
Brett Warren14efd332021-10-06 09:32:11 +0100231 mbedtls_ssl_tls13_named_group_is_ecdhe( *group_list ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800232 {
Brett Warren14efd332021-10-06 09:32:11 +0100233 *group_id = *group_list;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800234 return( 0 );
235 }
236 }
237#else
238 ((void) ssl);
Jerry Yub60e3cf2021-09-08 16:41:02 +0800239 ((void) group_id);
Jerry Yu56fc07f2021-09-01 17:48:49 +0800240#endif /* MBEDTLS_ECDH_C */
241
242 /*
243 * Add DHE named groups here.
Jerry Yu388bd0d2021-09-15 18:41:02 +0800244 * Pick first available DHE group compatible with TLS 1.3
Jerry Yu56fc07f2021-09-01 17:48:49 +0800245 */
246
247 return( ret );
248}
249
250/*
251 * ssl_tls13_write_key_share_ext
252 *
Jerry Yu388bd0d2021-09-15 18:41:02 +0800253 * Structure of key_share extension in ClientHello:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800254 *
255 * struct {
256 * NamedGroup group;
257 * opaque key_exchange<1..2^16-1>;
258 * } KeyShareEntry;
259 * struct {
260 * KeyShareEntry client_shares<0..2^16-1>;
261 * } KeyShareClientHello;
262 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200263MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu56fc07f2021-09-01 17:48:49 +0800264static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
265 unsigned char *buf,
266 unsigned char *end,
Xiaofei Baid25fab62021-12-02 06:36:27 +0000267 size_t *out_len )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800268{
269 unsigned char *p = buf;
Xiaofei Baieef15042021-11-18 07:29:56 +0000270 unsigned char *client_shares; /* Start of client_shares */
271 size_t client_shares_len; /* Length of client_shares */
Jerry Yu56fc07f2021-09-01 17:48:49 +0800272 uint16_t group_id;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800273 int ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
274
Xiaofei Baid25fab62021-12-02 06:36:27 +0000275 *out_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800276
Jerry Yub60e3cf2021-09-08 16:41:02 +0800277 /* Check if we have space for header and length fields:
Jerry Yu56fc07f2021-09-01 17:48:49 +0800278 * - extension_type (2 bytes)
279 * - extension_data_length (2 bytes)
280 * - client_shares_length (2 bytes)
281 */
282 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
283 p += 6;
284
285 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello: adding key share extension" ) );
286
287 /* HRR could already have requested something else. */
288 group_id = ssl->handshake->offered_group_id;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800289 if( !mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) &&
290 !mbedtls_ssl_tls13_named_group_is_dhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800291 {
Jerry Yub60e3cf2021-09-08 16:41:02 +0800292 MBEDTLS_SSL_PROC_CHK( ssl_tls13_get_default_group_id( ssl,
Jerry Yu56fc07f2021-09-01 17:48:49 +0800293 &group_id ) );
294 }
295
296 /*
297 * Dispatch to type-specific key generation function.
298 *
299 * So far, we're only supporting ECDHE. With the introduction
300 * of PQC KEMs, we'll want to have multiple branches, one per
301 * type of KEM, and dispatch to the corresponding crypto. And
302 * only one key share entry is allowed.
303 */
Xiaofei Baieef15042021-11-18 07:29:56 +0000304 client_shares = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800305#if defined(MBEDTLS_ECDH_C)
Jerry Yub60e3cf2021-09-08 16:41:02 +0800306 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group_id ) )
Jerry Yu56fc07f2021-09-01 17:48:49 +0800307 {
Jerry Yu388bd0d2021-09-15 18:41:02 +0800308 /* Pointer to group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000309 unsigned char *group = p;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800310 /* Length of key_exchange */
Przemyslaw Stekiel4f419e52022-02-10 15:56:26 +0100311 size_t key_exchange_len = 0;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800312
313 /* Check there is space for header of KeyShareEntry
314 * - group (2 bytes)
315 * - key_exchange_length (2 bytes)
316 */
317 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 4 );
318 p += 4;
Jerry Yu89e103c2022-03-30 22:43:29 +0800319 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
320 ssl, group_id, p, end, &key_exchange_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800321 p += key_exchange_len;
322 if( ret != 0 )
323 return( ret );
324
325 /* Write group */
Xiaofei Baieef15042021-11-18 07:29:56 +0000326 MBEDTLS_PUT_UINT16_BE( group_id, group, 0 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800327 /* Write key_exchange_length */
Xiaofei Baieef15042021-11-18 07:29:56 +0000328 MBEDTLS_PUT_UINT16_BE( key_exchange_len, group, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800329 }
330 else
331#endif /* MBEDTLS_ECDH_C */
332 if( 0 /* other KEMs? */ )
333 {
334 /* Do something */
335 }
336 else
337 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
338
Jerry Yub60e3cf2021-09-08 16:41:02 +0800339 /* Length of client_shares */
Xiaofei Baieef15042021-11-18 07:29:56 +0000340 client_shares_len = p - client_shares;
Jerry Yub60e3cf2021-09-08 16:41:02 +0800341 if( client_shares_len == 0)
342 {
343 MBEDTLS_SSL_DEBUG_MSG( 1, ( "No key share defined." ) );
344 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu7c522d42021-09-08 17:55:09 +0800345 }
Jerry Yu56fc07f2021-09-01 17:48:49 +0800346 /* Write extension_type */
347 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
348 /* Write extension_data_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800349 MBEDTLS_PUT_UINT16_BE( client_shares_len + 2, buf, 2 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800350 /* Write client_shares_length */
Jerry Yub60e3cf2021-09-08 16:41:02 +0800351 MBEDTLS_PUT_UINT16_BE( client_shares_len, buf, 4 );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800352
353 /* Update offered_group_id field */
354 ssl->handshake->offered_group_id = group_id;
355
356 /* Output the total length of key_share extension. */
Xiaofei Baid25fab62021-12-02 06:36:27 +0000357 *out_len = p - buf;
Jerry Yu56fc07f2021-09-01 17:48:49 +0800358
Xiaofei Baid25fab62021-12-02 06:36:27 +0000359 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, key_share extension", buf, *out_len );
Jerry Yu56fc07f2021-09-01 17:48:49 +0800360
361 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
362
363cleanup:
364
365 return( ret );
366}
Jerry Yubc20bdd2021-08-24 15:59:48 +0800367
Jerry Yue1b9c292021-09-10 10:08:31 +0800368
XiaokangQiand59be772022-01-24 10:12:51 +0000369/*
370 * ssl_tls13_parse_hrr_key_share_ext()
371 * Parse key_share extension in Hello Retry Request
372 *
373 * struct {
374 * NamedGroup selected_group;
375 * } KeyShareHelloRetryRequest;
376 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200377MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQiand9e068e2022-01-18 06:23:32 +0000378static int ssl_tls13_parse_hrr_key_share_ext( mbedtls_ssl_context *ssl,
XiaokangQianb851da82022-01-14 04:03:11 +0000379 const unsigned char *buf,
380 const unsigned char *end )
381{
XiaokangQianb851da82022-01-14 04:03:11 +0000382 const mbedtls_ecp_curve_info *curve_info = NULL;
383 const unsigned char *p = buf;
XiaokangQiand59be772022-01-24 10:12:51 +0000384 int selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000385 int found = 0;
386
387 const uint16_t *group_list = mbedtls_ssl_get_groups( ssl );
388 if( group_list == NULL )
389 return( MBEDTLS_ERR_SSL_BAD_CONFIG );
390
391 MBEDTLS_SSL_DEBUG_BUF( 3, "key_share extension", p, end - buf );
392
393 /* Read selected_group */
XiaokangQianb48894e2022-01-17 02:05:52 +0000394 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQiand59be772022-01-24 10:12:51 +0000395 selected_group = MBEDTLS_GET_UINT16_BE( p, 0 );
396 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_group ( %d )", selected_group ) );
XiaokangQianb851da82022-01-14 04:03:11 +0000397
398 /* Upon receipt of this extension in a HelloRetryRequest, the client
399 * MUST first verify that the selected_group field corresponds to a
400 * group which was provided in the "supported_groups" extension in the
401 * original ClientHello.
402 * The supported_group was based on the info in ssl->conf->group_list.
403 *
404 * If the server provided a key share that was not sent in the ClientHello
405 * then the client MUST abort the handshake with an "illegal_parameter" alert.
406 */
XiaokangQiand9e068e2022-01-18 06:23:32 +0000407 for( ; *group_list != 0; group_list++ )
XiaokangQianb851da82022-01-14 04:03:11 +0000408 {
409 curve_info = mbedtls_ecp_curve_info_from_tls_id( *group_list );
XiaokangQiand59be772022-01-24 10:12:51 +0000410 if( curve_info == NULL || curve_info->tls_id != selected_group )
XiaokangQianb851da82022-01-14 04:03:11 +0000411 continue;
412
413 /* We found a match */
414 found = 1;
415 break;
416 }
417
418 /* Client MUST verify that the selected_group field does not
419 * correspond to a group which was provided in the "key_share"
420 * extension in the original ClientHello. If the server sent an
421 * HRR message with a key share already provided in the
422 * ClientHello then the client MUST abort the handshake with
423 * an "illegal_parameter" alert.
424 */
XiaokangQiand59be772022-01-24 10:12:51 +0000425 if( found == 0 || selected_group == ssl->handshake->offered_group_id )
XiaokangQianb851da82022-01-14 04:03:11 +0000426 {
427 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid key share in HRR" ) );
428 MBEDTLS_SSL_PEND_FATAL_ALERT(
429 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
430 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
431 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
432 }
433
434 /* Remember server's preference for next ClientHello */
XiaokangQiand59be772022-01-24 10:12:51 +0000435 ssl->handshake->offered_group_id = selected_group;
XiaokangQianb851da82022-01-14 04:03:11 +0000436
437 return( 0 );
438}
439
Jerry Yue1b9c292021-09-10 10:08:31 +0800440/*
Jerry Yub85277e2021-10-13 13:36:05 +0800441 * ssl_tls13_parse_key_share_ext()
442 * Parse key_share extension in Server Hello
443 *
Jerry Yue1b9c292021-09-10 10:08:31 +0800444 * struct {
445 * KeyShareEntry server_share;
446 * } KeyShareServerHello;
447 * struct {
448 * NamedGroup group;
449 * opaque key_exchange<1..2^16-1>;
450 * } KeyShareEntry;
451 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200452MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +0800453static int ssl_tls13_parse_key_share_ext( mbedtls_ssl_context *ssl,
Jerry Yue1b9c292021-09-10 10:08:31 +0800454 const unsigned char *buf,
455 const unsigned char *end )
456{
Jerry Yub85277e2021-10-13 13:36:05 +0800457 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +0800458 const unsigned char *p = buf;
Jerry Yu4a173382021-10-11 21:45:31 +0800459 uint16_t group, offered_group;
Jerry Yue1b9c292021-09-10 10:08:31 +0800460
Jerry Yu4a173382021-10-11 21:45:31 +0800461 /* ...
462 * NamedGroup group; (2 bytes)
463 * ...
464 */
465 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
466 group = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +0800467 p += 2;
468
Jerry Yu4a173382021-10-11 21:45:31 +0800469 /* Check that the chosen group matches the one we offered. */
Jerry Yue1b9c292021-09-10 10:08:31 +0800470 offered_group = ssl->handshake->offered_group_id;
Jerry Yu4a173382021-10-11 21:45:31 +0800471 if( offered_group != group )
Jerry Yue1b9c292021-09-10 10:08:31 +0800472 {
473 MBEDTLS_SSL_DEBUG_MSG( 1,
474 ( "Invalid server key share, our group %u, their group %u",
Jerry Yu4a173382021-10-11 21:45:31 +0800475 (unsigned) offered_group, (unsigned) group ) );
476 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
477 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
478 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
Jerry Yue1b9c292021-09-10 10:08:31 +0800479 }
480
481#if defined(MBEDTLS_ECDH_C)
Jerry Yu4a173382021-10-11 21:45:31 +0800482 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
Jerry Yue1b9c292021-09-10 10:08:31 +0800483 {
Przemyslaw Stekiel9e23ddb2022-02-10 10:32:02 +0100484 const mbedtls_ecp_curve_info *curve_info =
485 mbedtls_ecp_curve_info_from_tls_id( group );
486 if( curve_info == NULL )
487 {
488 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid TLS curve group id" ) );
489 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
490 }
491
492 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
493
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000494 ret = mbedtls_ssl_tls13_read_public_ecdhe_share( ssl, p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +0800495 if( ret != 0 )
496 return( ret );
497 }
Jerry Yub85277e2021-10-13 13:36:05 +0800498 else
Jerry Yue1b9c292021-09-10 10:08:31 +0800499#endif /* MBEDTLS_ECDH_C */
Jerry Yub85277e2021-10-13 13:36:05 +0800500 if( 0 /* other KEMs? */ )
Jerry Yue1b9c292021-09-10 10:08:31 +0800501 {
502 /* Do something */
503 }
504 else
505 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
506
507 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
508 return( ret );
509}
510
XiaokangQiand59be772022-01-24 10:12:51 +0000511/*
512 * ssl_tls13_parse_cookie_ext()
513 * Parse cookie extension in Hello Retry Request
514 *
515 * struct {
516 * opaque cookie<1..2^16-1>;
517 * } Cookie;
518 *
519 * When sending a HelloRetryRequest, the server MAY provide a "cookie"
520 * extension to the client (this is an exception to the usual rule that
521 * the only extensions that may be sent are those that appear in the
522 * ClientHello). When sending the new ClientHello, the client MUST copy
523 * the contents of the extension received in the HelloRetryRequest into
524 * a "cookie" extension in the new ClientHello. Clients MUST NOT use
525 * cookies in their initial ClientHello in subsequent connections.
526 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200527MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian43550bd2022-01-21 04:32:58 +0000528static int ssl_tls13_parse_cookie_ext( mbedtls_ssl_context *ssl,
529 const unsigned char *buf,
530 const unsigned char *end )
531{
XiaokangQian25c9c902022-02-08 10:49:53 +0000532 uint16_t cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000533 const unsigned char *p = buf;
534 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
535
536 /* Retrieve length field of cookie */
537 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
538 cookie_len = MBEDTLS_GET_UINT16_BE( p, 0 );
539 p += 2;
540
541 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cookie_len );
542 MBEDTLS_SSL_DEBUG_BUF( 3, "cookie extension", p, cookie_len );
543
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000544 mbedtls_free( handshake->cookie );
XiaokangQian25c9c902022-02-08 10:49:53 +0000545 handshake->hrr_cookie_len = 0;
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000546 handshake->cookie = mbedtls_calloc( 1, cookie_len );
547 if( handshake->cookie == NULL )
XiaokangQian43550bd2022-01-21 04:32:58 +0000548 {
549 MBEDTLS_SSL_DEBUG_MSG( 1,
XiaokangQian25c9c902022-02-08 10:49:53 +0000550 ( "alloc failed ( %ud bytes )",
XiaokangQian43550bd2022-01-21 04:32:58 +0000551 cookie_len ) );
552 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
553 }
554
XiaokangQian9b93c0d2022-02-09 06:02:25 +0000555 memcpy( handshake->cookie, p, cookie_len );
XiaokangQian25c9c902022-02-08 10:49:53 +0000556 handshake->hrr_cookie_len = cookie_len;
XiaokangQian43550bd2022-01-21 04:32:58 +0000557
558 return( 0 );
559}
XiaokangQian43550bd2022-01-21 04:32:58 +0000560
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200561MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian0b64eed2022-01-27 10:36:51 +0000562static int ssl_tls13_write_cookie_ext( mbedtls_ssl_context *ssl,
XiaokangQian233397e2022-02-07 08:32:16 +0000563 unsigned char *buf,
564 unsigned char *end,
XiaokangQian9deb90f2022-02-08 10:31:07 +0000565 size_t *out_len )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000566{
567 unsigned char *p = buf;
XiaokangQian9deb90f2022-02-08 10:31:07 +0000568 *out_len = 0;
XiaokangQianc02768a2022-02-10 07:31:25 +0000569 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000570
XiaokangQianc02768a2022-02-10 07:31:25 +0000571 if( handshake->cookie == NULL )
XiaokangQian0b64eed2022-01-27 10:36:51 +0000572 {
573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "no cookie to send; skip extension" ) );
574 return( 0 );
575 }
576
577 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, cookie",
XiaokangQianc02768a2022-02-10 07:31:25 +0000578 handshake->cookie,
579 handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000580
XiaokangQianc02768a2022-02-10 07:31:25 +0000581 MBEDTLS_SSL_CHK_BUF_PTR( p, end, handshake->hrr_cookie_len + 6 );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000582
583 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding cookie extension" ) );
584
XiaokangQian0b64eed2022-01-27 10:36:51 +0000585 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_COOKIE, p, 0 );
XiaokangQianc02768a2022-02-10 07:31:25 +0000586 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len + 2, p, 2 );
587 MBEDTLS_PUT_UINT16_BE( handshake->hrr_cookie_len, p, 4 );
XiaokangQian233397e2022-02-07 08:32:16 +0000588 p += 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000589
590 /* Cookie */
XiaokangQianc02768a2022-02-10 07:31:25 +0000591 memcpy( p, handshake->cookie, handshake->hrr_cookie_len );
XiaokangQian0b64eed2022-01-27 10:36:51 +0000592
XiaokangQianc02768a2022-02-10 07:31:25 +0000593 *out_len = handshake->hrr_cookie_len + 6;
XiaokangQian0b64eed2022-01-27 10:36:51 +0000594
595 return( 0 );
596}
597
XiaokangQianeb69aee2022-07-05 08:21:43 +0000598#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
599/*
600 * ssl_tls13_write_psk_key_exchange_modes_ext() structure:
601 *
602 * enum { psk_ke( 0 ), psk_dhe_ke( 1 ), ( 255 ) } PskKeyExchangeMode;
603 *
604 * struct {
605 * PskKeyExchangeMode ke_modes<1..255>;
606 * } PskKeyExchangeModes;
607 */
XiaokangQian86981952022-07-19 09:51:50 +0000608MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQianeb69aee2022-07-05 08:21:43 +0000609static int ssl_tls13_write_psk_key_exchange_modes_ext( mbedtls_ssl_context *ssl,
610 unsigned char *buf,
611 unsigned char *end,
612 size_t *out_len )
613{
XiaokangQianeb69aee2022-07-05 08:21:43 +0000614 unsigned char *p = buf;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000615 int ke_modes_len = 0;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000616
XiaokangQian008d2bf2022-07-14 07:54:01 +0000617 ((void) ke_modes_len );
XiaokangQianeb69aee2022-07-05 08:21:43 +0000618 *out_len = 0;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000619
XiaokangQianeb69aee2022-07-05 08:21:43 +0000620 /* Skip writing extension if no PSK key exchange mode
XiaokangQian7c12d312022-07-20 07:25:43 +0000621 * is enabled in the config.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000622 */
XiaokangQian86981952022-07-19 09:51:50 +0000623 if( !mbedtls_ssl_conf_tls13_some_psk_enabled( ssl ) )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000624 {
625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip psk_key_exchange_modes extension" ) );
626 return( 0 );
627 }
628
629 /* Require 7 bytes of data, otherwise fail,
630 * even if extension might be shorter.
631 */
632 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 7 );
633 MBEDTLS_SSL_DEBUG_MSG(
634 3, ( "client hello, adding psk_key_exchange_modes extension" ) );
635
XiaokangQianeb69aee2022-07-05 08:21:43 +0000636 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PSK_KEY_EXCHANGE_MODES, p, 0 );
637
XiaokangQian008d2bf2022-07-14 07:54:01 +0000638 /* Skip extension length (2 bytes) and
639 * ke_modes length (1 byte) for now.
XiaokangQianeb69aee2022-07-05 08:21:43 +0000640 */
641 p += 5;
642
643 if( mbedtls_ssl_conf_tls13_psk_enabled( ssl ) )
644 {
645 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_PURE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000646 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000647
648 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding pure PSK key exchange mode" ) );
649 }
650
651 if( mbedtls_ssl_conf_tls13_psk_ephemeral_enabled( ssl ) )
652 {
653 *p++ = MBEDTLS_SSL_TLS1_3_PSK_MODE_ECDHE;
XiaokangQian008d2bf2022-07-14 07:54:01 +0000654 ke_modes_len++;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000655
656 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Adding PSK-ECDHE key exchange mode" ) );
657 }
658
XiaokangQian008d2bf2022-07-14 07:54:01 +0000659 /* Now write the extension and ke_modes length */
660 MBEDTLS_PUT_UINT16_BE( ke_modes_len + 1, buf, 2 );
661 buf[4] = ke_modes_len;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000662
663 *out_len = p - buf;
664 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES;
665 return ( 0 );
666}
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800667
Jerry Yua99cbfa2022-10-08 11:17:14 +0800668static psa_algorithm_t ssl_tls13_get_ciphersuite_hash_alg( int ciphersuite )
Jerry Yuf7c12592022-09-28 22:09:38 +0800669{
Jerry Yu21f90952022-10-08 10:30:53 +0800670 const mbedtls_ssl_ciphersuite_t *ciphersuite_info = NULL;
671 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800672
Jerry Yua99cbfa2022-10-08 11:17:14 +0800673 if( ciphersuite_info != NULL )
674 return( mbedtls_psa_translate_md( ciphersuite_info->mac ) );
675
Jerry Yu21f90952022-10-08 10:30:53 +0800676 return( PSA_ALG_NONE );
Jerry Yuf7c12592022-09-28 22:09:38 +0800677}
678
Jerry Yuf75364b2022-09-30 10:30:31 +0800679#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yuf7c12592022-09-28 22:09:38 +0800680
681static int ssl_tls13_has_configured_ticket( mbedtls_ssl_context *ssl )
682{
Jerry Yuf7c12592022-09-28 22:09:38 +0800683 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yuf75364b2022-09-30 10:30:31 +0800684 return( session != NULL && session->ticket != NULL );
Jerry Yuf7c12592022-09-28 22:09:38 +0800685}
686
Jerry Yuf7c12592022-09-28 22:09:38 +0800687MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800688static int ssl_tls13_ticket_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800689 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800690 const unsigned char **identity,
691 size_t *identity_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800692{
693 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu8b41e892022-09-30 10:00:20 +0800694
Jerry Yu8b41e892022-09-30 10:00:20 +0800695 if( !ssl_tls13_has_configured_ticket( ssl ) )
696 return( -1 );
697
Jerry Yua99cbfa2022-10-08 11:17:14 +0800698 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yuf7c12592022-09-28 22:09:38 +0800699 *identity = session->ticket;
700 *identity_len = session->ticket_len;
701 return( 0 );
702}
703
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800704MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu8b41e892022-09-30 10:00:20 +0800705static int ssl_tls13_ticket_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800706 psa_algorithm_t *hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800707 const unsigned char **psk,
708 size_t *psk_len )
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800709{
710
711 mbedtls_ssl_session *session = ssl->session_negotiate;
712
Jerry Yu8b41e892022-09-30 10:00:20 +0800713 if( !ssl_tls13_has_configured_ticket( ssl ) )
714 return( -1 );
715
Jerry Yua99cbfa2022-10-08 11:17:14 +0800716 *hash_alg = ssl_tls13_get_ciphersuite_hash_alg( session->ciphersuite );
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800717 *psk = session->resumption_key;
718 *psk_len = session->resumption_key_len;
719
720 return( 0 );
721}
722
Jerry Yuf7c12592022-09-28 22:09:38 +0800723#endif /* MBEDTLS_SSL_SESSION_TICKETS */
724
Jerry Yua99cbfa2022-10-08 11:17:14 +0800725static int ssl_tls13_has_configured_psk( const mbedtls_ssl_config *conf )
Jerry Yuf75364b2022-09-30 10:30:31 +0800726{
Jerry Yua99cbfa2022-10-08 11:17:14 +0800727 return( conf->psk != NULL && conf->psk_identity != NULL );
Jerry Yuf75364b2022-09-30 10:30:31 +0800728}
729
Jerry Yuf7c12592022-09-28 22:09:38 +0800730MBEDTLS_CHECK_RETURN_CRITICAL
731static int ssl_tls13_psk_get_identity( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800732 psa_algorithm_t *hash_alg,
Jerry Yuf7c12592022-09-28 22:09:38 +0800733 const unsigned char **identity,
734 size_t *identity_len )
735{
Jerry Yu8b41e892022-09-30 10:00:20 +0800736
Jerry Yua99cbfa2022-10-08 11:17:14 +0800737 if( !ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800738 return( -1 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800739
Jerry Yua99cbfa2022-10-08 11:17:14 +0800740 *hash_alg = PSA_ALG_SHA_256;
Jerry Yuf7c12592022-09-28 22:09:38 +0800741 *identity = ssl->conf->psk_identity;
742 *identity_len = ssl->conf->psk_identity_len;
743 return( 0 );
744}
745
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800746MBEDTLS_CHECK_RETURN_CRITICAL
747static int ssl_tls13_psk_get_psk( mbedtls_ssl_context *ssl,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800748 psa_algorithm_t *hash_alg,
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800749 const unsigned char **psk,
750 size_t *psk_len )
751{
Jerry Yu8b41e892022-09-30 10:00:20 +0800752
Jerry Yua99cbfa2022-10-08 11:17:14 +0800753 if( !ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu8b41e892022-09-30 10:00:20 +0800754 return( -1 );
755
Jerry Yua99cbfa2022-10-08 11:17:14 +0800756 *hash_alg = PSA_ALG_SHA_256;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800757 *psk = ssl->conf->psk;
758 *psk_len = ssl->conf->psk_len;
759 return( 0 );
760}
761
Jerry Yuf75364b2022-09-30 10:30:31 +0800762static int ssl_tls13_get_configured_psk_count( mbedtls_ssl_context *ssl )
763{
764 int configured_psk_count = 0;
765#if defined(MBEDTLS_SSL_SESSION_TICKETS)
766 if( ssl_tls13_has_configured_ticket( ssl ) )
767 {
768 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Ticket is configured" ) );
769 configured_psk_count++;
770 }
771#endif
Jerry Yua99cbfa2022-10-08 11:17:14 +0800772 if( ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yuf75364b2022-09-30 10:30:31 +0800773 {
774 MBEDTLS_SSL_DEBUG_MSG( 3, ( "PSK is configured" ) );
775 configured_psk_count++;
776 }
777 return( configured_psk_count );
778}
779
Jerry Yuf7c12592022-09-28 22:09:38 +0800780MBEDTLS_CHECK_RETURN_CRITICAL
781static int ssl_tls13_write_identity( mbedtls_ssl_context *ssl,
782 unsigned char *buf,
783 unsigned char *end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800784 const unsigned char *identity,
785 size_t identity_len,
786 uint32_t obfuscated_ticket_age,
787 size_t *out_len )
Jerry Yuf7c12592022-09-28 22:09:38 +0800788{
Jerry Yuf75364b2022-09-30 10:30:31 +0800789 ((void) ssl);
Jerry Yuf7c12592022-09-28 22:09:38 +0800790 *out_len = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800791
792 /*
793 * - identity_len (2 bytes)
794 * - identity (psk_identity_len bytes)
795 * - obfuscated_ticket_age (4 bytes)
796 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800797 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800798
Jerry Yua99cbfa2022-10-08 11:17:14 +0800799 MBEDTLS_PUT_UINT16_BE( identity_len, buf, 0 );
800 memcpy( buf + 2, identity, identity_len );
801 MBEDTLS_PUT_UINT32_BE( obfuscated_ticket_age, buf, 2 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800802
Jerry Yua99cbfa2022-10-08 11:17:14 +0800803 MBEDTLS_SSL_DEBUG_BUF( 4, "write identity", buf, 6 + identity_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800804
805 *out_len = 6 + identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800806
807 return( 0 );
808}
809
Jerry Yu8b41e892022-09-30 10:00:20 +0800810MBEDTLS_CHECK_RETURN_CRITICAL
811static int ssl_tls13_write_binder( mbedtls_ssl_context *ssl,
812 unsigned char *buf,
813 unsigned char *end,
814 int psk_type,
Jerry Yu6183cc72022-09-30 11:08:57 +0800815 psa_algorithm_t hash_alg,
816 const unsigned char *psk,
817 size_t psk_len,
Jerry Yu8b41e892022-09-30 10:00:20 +0800818 size_t *out_len )
819{
820 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu8b41e892022-09-30 10:00:20 +0800821 unsigned char binder_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800822 unsigned char transcript[ MBEDTLS_TLS1_3_MD_MAX_SIZE ];
Jerry Yu8b41e892022-09-30 10:00:20 +0800823 size_t transcript_len = 0;
824
825 *out_len = 0;
826
Jerry Yu6183cc72022-09-30 11:08:57 +0800827 binder_len = PSA_HASH_LENGTH( hash_alg );
Jerry Yu8b41e892022-09-30 10:00:20 +0800828
829 /*
830 * - binder_len (1 bytes)
831 * - binder (binder_len bytes)
832 */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800833 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800834
Jerry Yua99cbfa2022-10-08 11:17:14 +0800835 buf[0] = binder_len;
Jerry Yu8b41e892022-09-30 10:00:20 +0800836
837 /* Get current state of handshake transcript. */
838 ret = mbedtls_ssl_get_handshake_transcript(
Jerry Yu6183cc72022-09-30 11:08:57 +0800839 ssl, mbedtls_hash_info_md_from_psa( hash_alg ),
Jerry Yu6916e702022-10-10 21:33:51 +0800840 transcript, sizeof( transcript ), &transcript_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800841 if( ret != 0 )
842 return( ret );
843
Jerry Yu6183cc72022-09-30 11:08:57 +0800844 ret = mbedtls_ssl_tls13_create_psk_binder( ssl, hash_alg,
Jerry Yu8b41e892022-09-30 10:00:20 +0800845 psk, psk_len, psk_type,
Jerry Yua99cbfa2022-10-08 11:17:14 +0800846 transcript, buf + 1 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800847 if( ret != 0 )
848 {
849 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_create_psk_binder", ret );
850 return( ret );
851 }
Jerry Yua99cbfa2022-10-08 11:17:14 +0800852 MBEDTLS_SSL_DEBUG_BUF( 4, "write binder", buf, 1 + binder_len );
Jerry Yu8b41e892022-09-30 10:00:20 +0800853
854 *out_len = 1 + binder_len;
855
Jerry Yu6916e702022-10-10 21:33:51 +0800856 return( 0 );
Jerry Yu8b41e892022-09-30 10:00:20 +0800857}
858
859/*
860 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
861 *
862 * struct {
863 * opaque identity<1..2^16-1>;
864 * uint32 obfuscated_ticket_age;
865 * } PskIdentity;
866 *
867 * opaque PskBinderEntry<32..255>;
868 *
869 * struct {
870 * PskIdentity identities<7..2^16-1>;
871 * PskBinderEntry binders<33..2^16-1>;
872 * } OfferedPsks;
873 *
874 * struct {
875 * select (Handshake.msg_type) {
876 * case client_hello: OfferedPsks;
877 * ...
878 * };
879 * } PreSharedKeyExtension;
880 *
881 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000882int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
Jerry Yuf75364b2022-09-30 10:30:31 +0800883 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end,
884 size_t *out_len, size_t *binders_len )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000885{
Jerry Yuf7c12592022-09-28 22:09:38 +0800886 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf75364b2022-09-30 10:30:31 +0800887 int configured_psk_count = 0;
Jerry Yuf7c12592022-09-28 22:09:38 +0800888 unsigned char *p = buf;
Jerry Yuf75364b2022-09-30 10:30:31 +0800889 psa_algorithm_t hash_alg;
890 const unsigned char *identity;
891 size_t identity_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800892 size_t l_binders_len = 0;
Jerry Yuf75364b2022-09-30 10:30:31 +0800893 size_t output_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800894
895 *out_len = 0;
896 *binders_len = 0;
897
898 /* Check if we have any PSKs to offer. If no, skip pre_shared_key */
Jerry Yuf75364b2022-09-30 10:30:31 +0800899 configured_psk_count = ssl_tls13_get_configured_psk_count( ssl );
900 if( configured_psk_count == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800901 {
902 MBEDTLS_SSL_DEBUG_MSG( 3, ( "skip pre_shared_key extensions" ) );
903 return( 0 );
904 }
905
906 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Pre-configured PSK number = %d",
Jerry Yuf75364b2022-09-30 10:30:31 +0800907 configured_psk_count ) );
908
Jerry Yuf7c12592022-09-28 22:09:38 +0800909 /* Check if we have space to write the extension, binders included.
910 * - extension_type (2 bytes)
911 * - extension_data_len (2 bytes)
912 * - identities_len (2 bytes)
913 */
914 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 6 );
915 p += 6;
916
Jerry Yuf75364b2022-09-30 10:30:31 +0800917#if defined(MBEDTLS_SSL_SESSION_TICKETS)
918 if( ssl_tls13_ticket_get_identity(
919 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800920 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800921#if defined(MBEDTLS_HAVE_TIME)
922 mbedtls_time_t now = mbedtls_time( NULL );
923 mbedtls_ssl_session *session = ssl->session_negotiate;
Jerry Yu6916e702022-10-10 21:33:51 +0800924 uint32_t obfuscated_ticket_age =
925 (uint32_t)( now - session->ticket_received );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800926
Jerry Yuf75364b2022-09-30 10:30:31 +0800927 obfuscated_ticket_age *= 1000;
928 obfuscated_ticket_age += session->ticket_age_add;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800929
Jerry Yuf7c12592022-09-28 22:09:38 +0800930 ret = ssl_tls13_write_identity( ssl, p, end,
Jerry Yuf75364b2022-09-30 10:30:31 +0800931 identity, identity_len,
932 obfuscated_ticket_age,
933 &output_len );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800934#else
935 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len,
936 0, &output_len );
937#endif /* MBEDTLS_HAVE_TIME */
Jerry Yuf7c12592022-09-28 22:09:38 +0800938 if( ret != 0 )
939 return( ret );
Jerry Yuf7c12592022-09-28 22:09:38 +0800940
Jerry Yuf75364b2022-09-30 10:30:31 +0800941 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800942 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf75364b2022-09-30 10:30:31 +0800943 }
944#endif /* MBEDTLS_SSL_SESSION_TICKETS */
945
946 if( ssl_tls13_psk_get_identity(
947 ssl, &hash_alg, &identity, &identity_len ) == 0 )
Jerry Yuf7c12592022-09-28 22:09:38 +0800948 {
Jerry Yuf75364b2022-09-30 10:30:31 +0800949
Jerry Yua99cbfa2022-10-08 11:17:14 +0800950 ret = ssl_tls13_write_identity( ssl, p, end, identity, identity_len, 0,
Jerry Yuf75364b2022-09-30 10:30:31 +0800951 &output_len );
Jerry Yuf7c12592022-09-28 22:09:38 +0800952 if( ret != 0 )
953 return( ret );
Jerry Yuf75364b2022-09-30 10:30:31 +0800954
Jerry Yuf7c12592022-09-28 22:09:38 +0800955 p += output_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +0800956 l_binders_len += 1 + PSA_HASH_LENGTH( hash_alg );
Jerry Yuf7c12592022-09-28 22:09:38 +0800957 }
958
959 MBEDTLS_SSL_DEBUG_MSG( 3,
960 ( "client hello, adding pre_shared_key extension, "
961 "omitting PSK binder list" ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800962
963 /* Take into account the two bytes for the length of the binders. */
964 l_binders_len += 2;
Jerry Yu6916e702022-10-10 21:33:51 +0800965 /* Check if there is enough space for binders */
Jerry Yua99cbfa2022-10-08 11:17:14 +0800966 MBEDTLS_SSL_CHK_BUF_PTR( p, end, l_binders_len );
967
Jerry Yuf7c12592022-09-28 22:09:38 +0800968 /*
969 * - extension_type (2 bytes)
970 * - extension_data_len (2 bytes)
971 * - identities_len (2 bytes)
972 */
973 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_PRE_SHARED_KEY, buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +0800974 MBEDTLS_PUT_UINT16_BE( p - buf - 4 + l_binders_len , buf, 2 );
Jerry Yuf7c12592022-09-28 22:09:38 +0800975 MBEDTLS_PUT_UINT16_BE( p - buf - 6 , buf, 4 );
976
Jerry Yua99cbfa2022-10-08 11:17:14 +0800977 *out_len = ( p - buf ) + l_binders_len;
978 *binders_len = l_binders_len;
Jerry Yuf7c12592022-09-28 22:09:38 +0800979
980 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key identities", buf, p - buf );
981
982 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
983
XiaokangQianeb69aee2022-07-05 08:21:43 +0000984 return( 0 );
985}
986
XiaokangQian86981952022-07-19 09:51:50 +0000987int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +0800988 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000989{
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800990 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
991 unsigned char *p = buf;
Jerry Yu6183cc72022-09-30 11:08:57 +0800992 psa_algorithm_t hash_alg = PSA_ALG_NONE;
993 const unsigned char *psk;
994 size_t psk_len;
995 size_t output_len;
Jerry Yu1a0a0f42022-09-28 22:11:02 +0800996
997 /* Check if we have space to write binders_len.
998 * - binders_len (2 bytes)
999 */
1000 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1001 p += 2;
1002
Jerry Yu6183cc72022-09-30 11:08:57 +08001003#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1004 if( ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001005 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001006
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001007 ret = ssl_tls13_write_binder( ssl, p, end,
1008 MBEDTLS_SSL_TLS1_3_PSK_RESUMPTION,
Jerry Yu6183cc72022-09-30 11:08:57 +08001009 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001010 &output_len );
1011 if( ret != 0 )
1012 return( ret );
1013 p += output_len;
1014 }
Jerry Yu6183cc72022-09-30 11:08:57 +08001015#endif /* MBEDTLS_SSL_SESSION_TICKETS */
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001016
Jerry Yu6183cc72022-09-30 11:08:57 +08001017 if( ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len ) == 0 )
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001018 {
Jerry Yu6183cc72022-09-30 11:08:57 +08001019
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001020 ret = ssl_tls13_write_binder( ssl, p, end,
1021 MBEDTLS_SSL_TLS1_3_PSK_EXTERNAL,
Jerry Yu6183cc72022-09-30 11:08:57 +08001022 hash_alg, psk, psk_len,
Jerry Yu1a0a0f42022-09-28 22:11:02 +08001023 &output_len );
1024 if( ret != 0 )
1025 return( ret );
1026 p += output_len;
1027 }
1028
1029 MBEDTLS_SSL_DEBUG_MSG( 3, ( "client hello, adding PSK binder list." ) );
1030
1031 /*
1032 * - binders_len (2 bytes)
1033 */
1034 MBEDTLS_PUT_UINT16_BE( p - buf - 2, buf, 0 );
1035
1036 MBEDTLS_SSL_DEBUG_BUF( 3, "pre_shared_key binders", buf, p - buf );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001037
1038 return( 0 );
1039}
Jerry Yu0c6105b2022-08-12 17:26:40 +08001040
1041/*
1042 * struct {
1043 * opaque identity<1..2^16-1>;
1044 * uint32 obfuscated_ticket_age;
1045 * } PskIdentity;
1046 *
1047 * opaque PskBinderEntry<32..255>;
1048 *
1049 * struct {
1050 *
1051 * select (Handshake.msg_type) {
1052 * ...
1053 * case server_hello: uint16 selected_identity;
1054 * };
1055 *
1056 * } PreSharedKeyExtension;
1057 *
1058 */
1059MBEDTLS_CHECK_RETURN_CRITICAL
1060static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
1061 const unsigned char *buf,
1062 const unsigned char *end )
1063{
Jerry Yua99cbfa2022-10-08 11:17:14 +08001064 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub300e3c2022-09-28 22:12:07 +08001065 int selected_identity;
Jerry Yub300e3c2022-09-28 22:12:07 +08001066 const unsigned char *psk;
1067 size_t psk_len;
Jerry Yua99cbfa2022-10-08 11:17:14 +08001068 psa_algorithm_t hash_alg;
Jerry Yub300e3c2022-09-28 22:12:07 +08001069
Jerry Yua99cbfa2022-10-08 11:17:14 +08001070 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 2 );
Jerry Yub300e3c2022-09-28 22:12:07 +08001071 selected_identity = MBEDTLS_GET_UINT16_BE( buf, 0 );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001072
Jerry Yub300e3c2022-09-28 22:12:07 +08001073 MBEDTLS_SSL_DEBUG_MSG( 3, ( "selected_identity = %d", selected_identity ) );
Jerry Yua99cbfa2022-10-08 11:17:14 +08001074
Jerry Yu4a698342022-09-30 12:22:01 +08001075 if( selected_identity >= ssl_tls13_get_configured_psk_count( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001076 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001077 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Invalid PSK identity." ) );
Jerry Yu4a698342022-09-30 12:22:01 +08001078
1079 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1080 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1081 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
Jerry Yub300e3c2022-09-28 22:12:07 +08001082 }
Jerry Yua99cbfa2022-10-08 11:17:14 +08001083
Jerry Yu4a698342022-09-30 12:22:01 +08001084#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1085 if( selected_identity == 0 && ssl_tls13_has_configured_ticket( ssl ) )
Jerry Yub300e3c2022-09-28 22:12:07 +08001086 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001087 ret = ssl_tls13_ticket_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yu4a698342022-09-30 12:22:01 +08001088 }
1089 else
1090#endif
Jerry Yua99cbfa2022-10-08 11:17:14 +08001091 if( ssl_tls13_has_configured_psk( ssl->conf ) )
Jerry Yu4a698342022-09-30 12:22:01 +08001092 {
Jerry Yua99cbfa2022-10-08 11:17:14 +08001093 ret = ssl_tls13_psk_get_psk( ssl, &hash_alg, &psk, &psk_len );
Jerry Yub300e3c2022-09-28 22:12:07 +08001094 }
1095 else
1096 {
1097 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1098 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
1099 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001100 if( ret != 0 )
1101 return( ret );
1102
1103 ret = mbedtls_ssl_set_hs_psk( ssl, psk, psk_len );
1104 if( ret != 0 )
1105 {
1106 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_set_hs_psk", ret );
Jerry Yu6916e702022-10-10 21:33:51 +08001107 return( ret );
Jerry Yub300e3c2022-09-28 22:12:07 +08001108 }
Jerry Yub300e3c2022-09-28 22:12:07 +08001109
Jerry Yu6916e702022-10-10 21:33:51 +08001110 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_PRE_SHARED_KEY;
1111
1112 return( 0 );
Jerry Yu0c6105b2022-08-12 17:26:40 +08001113}
1114
XiaokangQianeb69aee2022-07-05 08:21:43 +00001115#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1116
Ronald Cron3d580bf2022-02-18 17:24:56 +01001117int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
1118 unsigned char *buf,
1119 unsigned char *end,
1120 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001121{
1122 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1123 unsigned char *p = buf;
1124 size_t ext_len;
1125
1126 *out_len = 0;
1127
1128 /* Write supported_versions extension
1129 *
1130 * Supported Versions Extension is mandatory with TLS 1.3.
1131 */
1132 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
1133 if( ret != 0 )
1134 return( ret );
1135 p += ext_len;
1136
1137 /* Echo the cookie if the server provided one in its preceding
1138 * HelloRetryRequest message.
1139 */
1140 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
1141 if( ret != 0 )
1142 return( ret );
1143 p += ext_len;
1144
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001145 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1146 {
1147 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
1148 if( ret != 0 )
1149 return( ret );
1150 p += ext_len;
1151 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001152
XiaokangQianeb69aee2022-07-05 08:21:43 +00001153#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
1154 /* For PSK-based key exchange we need the pre_shared_key extension
1155 * and the psk_key_exchange_modes extension.
1156 *
1157 * The pre_shared_key extension MUST be the last extension in the
1158 * ClientHello. Servers MUST check that it is the last extension and
1159 * otherwise fail the handshake with an "illegal_parameter" alert.
1160 *
1161 * Add the psk_key_exchange_modes extension.
1162 */
1163 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
1164 if( ret != 0 )
1165 return( ret );
1166 p += ext_len;
1167#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
1168
Ronald Cron04fbd2b2022-02-18 12:06:07 +01001169 *out_len = p - buf;
1170
1171 return( 0 );
1172}
1173
Jerry Yu1bc2c1f2021-09-01 12:57:29 +08001174/*
Jerry Yu4a173382021-10-11 21:45:31 +08001175 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +08001176 */
Ronald Cronfd6193c2022-04-05 11:04:20 +02001177
Ronald Cronda41b382022-03-30 09:57:11 +02001178/**
1179 * \brief Detect if the ServerHello contains a supported_versions extension
1180 * or not.
1181 *
1182 * \param[in] ssl SSL context
1183 * \param[in] buf Buffer containing the ServerHello message
1184 * \param[in] end End of the buffer containing the ServerHello message
1185 *
1186 * \return 0 if the ServerHello does not contain a supported_versions extension
1187 * \return 1 if the ServerHello contains a supported_versions extension
1188 * \return A negative value if an error occurred while parsing the ServerHello.
1189 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001190MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +01001191static int ssl_tls13_is_supported_versions_ext_present(
1192 mbedtls_ssl_context *ssl,
1193 const unsigned char *buf,
1194 const unsigned char *end )
1195{
1196 const unsigned char *p = buf;
1197 size_t legacy_session_id_echo_len;
1198 size_t extensions_len;
1199 const unsigned char *extensions_end;
1200
1201 /*
1202 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +02001203 * length:
1204 * - legacy_version 2 bytes
1205 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
1206 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +01001207 */
1208 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
1209 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
1210 legacy_session_id_echo_len = *p;
1211
1212 /*
1213 * Jump to the extensions, jumping over:
1214 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
1215 * - cipher_suite 2 bytes
1216 * - legacy_compression_method 1 byte
1217 */
Ronald Cron28271062022-06-10 14:43:55 +02001218 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001219 p += legacy_session_id_echo_len + 4;
1220
1221 /* Case of no extension */
1222 if( p == end )
1223 return( 0 );
1224
1225 /* ...
1226 * Extension extensions<6..2^16-1>;
1227 * ...
1228 * struct {
1229 * ExtensionType extension_type; (2 bytes)
1230 * opaque extension_data<0..2^16-1>;
1231 * } Extension;
1232 */
1233 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1234 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1235 p += 2;
1236
1237 /* Check extensions do not go beyond the buffer of data. */
1238 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1239 extensions_end = p + extensions_len;
1240
1241 while( p < extensions_end )
1242 {
1243 unsigned int extension_type;
1244 size_t extension_data_len;
1245
1246 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1247 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1248 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1249 p += 4;
1250
1251 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
1252 return( 1 );
1253
1254 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1255 p += extension_data_len;
1256 }
1257
1258 return( 0 );
1259}
1260
Jerry Yu7a186a02021-10-15 18:46:14 +08001261/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +02001262 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
1263 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
1264 * - 0 otherwise
1265 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001266MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +02001267static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
1268 const unsigned char *buf,
1269 const unsigned char *end )
1270{
1271 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
1272 static const unsigned char magic_downgrade_string[] =
1273 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
1274 const unsigned char *last_eight_bytes_of_random;
1275 unsigned char last_byte_of_random;
1276
1277 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
1278 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
1279
1280 if( memcmp( last_eight_bytes_of_random,
1281 magic_downgrade_string,
1282 sizeof( magic_downgrade_string ) ) == 0 )
1283 {
1284 last_byte_of_random = last_eight_bytes_of_random[7];
1285 return( last_byte_of_random == 0 ||
1286 last_byte_of_random == 1 );
1287 }
1288
1289 return( 0 );
1290}
1291
1292/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001293 * - SSL_SERVER_HELLO or
1294 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +00001295 * to indicate which message is expected and to be parsed next.
1296 */
Ronald Cron828aff62022-05-31 12:04:31 +02001297#define SSL_SERVER_HELLO 0
1298#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001299MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +08001300static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
1301 const unsigned char *buf,
1302 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001303{
Jerry Yue1b9c292021-09-10 10:08:31 +08001304
1305 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
1306 *
Jerry Yu4a173382021-10-11 21:45:31 +08001307 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +08001308 * special value of the SHA-256 of "HelloRetryRequest".
1309 *
1310 * struct {
1311 * ProtocolVersion legacy_version = 0x0303;
1312 * Random random;
1313 * opaque legacy_session_id_echo<0..32>;
1314 * CipherSuite cipher_suite;
1315 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001316 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001317 * } ServerHello;
1318 *
1319 */
Jerry Yu93a13f22022-04-11 23:00:01 +08001320 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
1321 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +08001322
Jerry Yu93a13f22022-04-11 23:00:01 +08001323 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
1324 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001325 {
Ronald Cron828aff62022-05-31 12:04:31 +02001326 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +08001327 }
1328
Ronald Cron828aff62022-05-31 12:04:31 +02001329 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +08001330}
1331
Ronald Cron828aff62022-05-31 12:04:31 +02001332/*
Jerry Yu745bb612021-10-13 22:01:04 +08001333 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +02001334 * - SSL_SERVER_HELLO or
1335 * - SSL_SERVER_HELLO_HRR or
1336 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +08001337 */
Ronald Cron828aff62022-05-31 12:04:31 +02001338#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001339MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +02001340static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001341 const unsigned char *buf,
1342 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001343{
Jerry Yu4a173382021-10-11 21:45:31 +08001344 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +02001345 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +08001346
Ronald Cron9f0fba32022-02-10 16:45:15 +01001347 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001348 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +08001349
Ronald Cron9f0fba32022-02-10 16:45:15 +01001350 if( ret == 0 )
1351 {
Ronald Cronfd6193c2022-04-05 11:04:20 +02001352 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +02001353 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +02001354
1355 /* If the server is negotiating TLS 1.2 or below and:
1356 * . we did not propose TLS 1.2 or
1357 * . the server responded it is TLS 1.3 capable but negotiating a lower
1358 * version of the protocol and thus we are under downgrade attack
1359 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +01001360 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001361 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001362 {
1363 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1364 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1365 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1366 }
1367
1368 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -04001369 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +01001370 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +02001371 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001372
1373 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1374 {
1375 ret = ssl_tls13_reset_key_share( ssl );
1376 if( ret != 0 )
1377 return( ret );
1378 }
1379
Ronald Cron828aff62022-05-31 12:04:31 +02001380 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001381 }
1382
Jerry Yua66fece2022-07-13 14:30:29 +08001383#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1384 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1385 ssl->session_negotiate->tls_version = ssl->tls_version;
1386#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1387
Ronald Cron5afb9042022-05-31 12:11:39 +02001388 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1389
Ronald Crondb5dfa12022-05-31 11:44:38 +02001390 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001391 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001392 {
Ronald Cron828aff62022-05-31 12:04:31 +02001393 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001394 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1395 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001396 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001397 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001398 /* If a client receives a second
1399 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1400 * was itself in response to a HelloRetryRequest), it MUST abort the
1401 * handshake with an "unexpected_message" alert.
1402 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001403 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001404 {
1405 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1406 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1407 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1408 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1409 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001410 /*
1411 * Clients must abort the handshake with an "illegal_parameter"
1412 * alert if the HelloRetryRequest would not result in any change
1413 * in the ClientHello.
1414 * In a PSK only key exchange that what we expect.
1415 */
1416 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1417 {
1418 MBEDTLS_SSL_DEBUG_MSG( 1,
1419 ( "Unexpected HRR in pure PSK key exchange." ) );
1420 MBEDTLS_SSL_PEND_FATAL_ALERT(
1421 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1422 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1423 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1424 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001425
Ronald Cron5afb9042022-05-31 12:11:39 +02001426 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001427
Jerry Yu745bb612021-10-13 22:01:04 +08001428 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001429 }
1430
1431cleanup:
1432
1433 return( ret );
1434}
1435
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001436MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001437static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1438 const unsigned char **buf,
1439 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001440{
1441 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001442 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001443
Jerry Yude4fb2c2021-09-19 18:05:08 +08001444 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001445 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001446
Jerry Yu4a173382021-10-11 21:45:31 +08001447 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001448
1449 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001450 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1451 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001452 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001453 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1454 ssl->session_negotiate->id,
1455 ssl->session_negotiate->id_len );
1456 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001457 legacy_session_id_echo_len );
1458
1459 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1460 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1461
Jerry Yue1b9c292021-09-10 10:08:31 +08001462 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1463 }
1464
Jerry Yu4a173382021-10-11 21:45:31 +08001465 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001466 *buf = p;
1467
1468 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001469 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001470 return( 0 );
1471}
1472
Jerry Yue1b9c292021-09-10 10:08:31 +08001473/* Parse ServerHello message and configure context
1474 *
1475 * struct {
1476 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1477 * Random random;
1478 * opaque legacy_session_id_echo<0..32>;
1479 * CipherSuite cipher_suite;
1480 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001481 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001482 * } ServerHello;
1483 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001484MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001485static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1486 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001487 const unsigned char *end,
1488 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001489{
Jerry Yub85277e2021-10-13 13:36:05 +08001490 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001491 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001492 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001493 size_t extensions_len;
1494 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001495 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001496 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001497 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001498
1499 /*
1500 * Check there is space for minimal fields
1501 *
1502 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001503 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001504 * - legacy_session_id_echo ( 1 byte ), minimum size
1505 * - cipher_suite ( 2 bytes)
1506 * - legacy_compression_method ( 1 byte )
1507 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001508 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001509
1510 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001511 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1512
Jerry Yu4a173382021-10-11 21:45:31 +08001513 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001514 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001515 * ...
1516 * with ProtocolVersion defined as:
1517 * uint16 ProtocolVersion;
1518 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001519 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1520 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001521 {
1522 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1523 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1524 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001525 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1526 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001527 }
1528 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001529
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001530 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001531 * Random random;
1532 * ...
1533 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001534 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001535 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001536 if( !is_hrr )
1537 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001538 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001539 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1540 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1541 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1542 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001543 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001544
Jerry Yu4a173382021-10-11 21:45:31 +08001545 /* ...
1546 * opaque legacy_session_id_echo<0..32>;
1547 * ...
1548 */
1549 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001550 {
XiaokangQian52da5582022-01-26 09:49:29 +00001551 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001552 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001553 }
1554
Jerry Yu4a173382021-10-11 21:45:31 +08001555 /* ...
1556 * CipherSuite cipher_suite;
1557 * ...
1558 * with CipherSuite defined as:
1559 * uint8 CipherSuite[2];
1560 */
1561 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001562 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1563 p += 2;
1564
Jerry Yu4a173382021-10-11 21:45:31 +08001565
XiaokangQian355e09a2022-01-20 11:14:50 +00001566 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001567 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001568 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001569 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001570 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1571 ssl->tls_version,
1572 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001573 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001574 {
XiaokangQian52da5582022-01-26 09:49:29 +00001575 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001576 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001577 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001578 * If we received an HRR before and that the proposed selected
1579 * ciphersuite in this server hello is not the same as the one
1580 * proposed in the HRR, we abort the handshake and send an
1581 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001582 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001583 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1584 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001585 {
XiaokangQian52da5582022-01-26 09:49:29 +00001586 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001587 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001588
XiaokangQian52da5582022-01-26 09:49:29 +00001589 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001590 {
1591 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1592 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001593 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001594 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001595
Jerry Yu4a173382021-10-11 21:45:31 +08001596 /* Configure ciphersuites */
1597 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1598
XiaokangQian355e09a2022-01-20 11:14:50 +00001599 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001600 ssl->session_negotiate->ciphersuite = cipher_suite;
1601
Jerry Yue1b9c292021-09-10 10:08:31 +08001602 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1603 cipher_suite, ciphersuite_info->name ) );
1604
1605#if defined(MBEDTLS_HAVE_TIME)
1606 ssl->session_negotiate->start = time( NULL );
1607#endif /* MBEDTLS_HAVE_TIME */
1608
Jerry Yu4a173382021-10-11 21:45:31 +08001609 /* ...
1610 * uint8 legacy_compression_method = 0;
1611 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001612 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001613 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001614 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001615 {
Jerry Yub85277e2021-10-13 13:36:05 +08001616 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001617 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001618 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001619 }
1620 p++;
1621
Jerry Yub85277e2021-10-13 13:36:05 +08001622 /* ...
1623 * Extension extensions<6..2^16-1>;
1624 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001625 * struct {
1626 * ExtensionType extension_type; (2 bytes)
1627 * opaque extension_data<0..2^16-1>;
1628 * } Extension;
1629 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001630 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001631 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001632 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001633
Jerry Yu4a173382021-10-11 21:45:31 +08001634 /* Check extensions do not go beyond the buffer of data. */
1635 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1636 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001637
Jerry Yu4a173382021-10-11 21:45:31 +08001638 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001639
Jerry Yu4a173382021-10-11 21:45:31 +08001640 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001641 {
1642 unsigned int extension_type;
1643 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001644 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001645
Jerry Yu4a173382021-10-11 21:45:31 +08001646 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001647 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1648 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1649 p += 4;
1650
Jerry Yu4a173382021-10-11 21:45:31 +08001651 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001652 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001653
1654 switch( extension_type )
1655 {
XiaokangQianb851da82022-01-14 04:03:11 +00001656 case MBEDTLS_TLS_EXT_COOKIE:
1657
XiaokangQiand9e068e2022-01-18 06:23:32 +00001658 if( !is_hrr )
1659 {
XiaokangQian52da5582022-01-26 09:49:29 +00001660 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001661 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001662 }
1663
XiaokangQian43550bd2022-01-21 04:32:58 +00001664 ret = ssl_tls13_parse_cookie_ext( ssl,
1665 p, extension_data_end );
1666 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001667 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001668 MBEDTLS_SSL_DEBUG_RET( 1,
1669 "ssl_tls13_parse_cookie_ext",
1670 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001671 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001672 }
XiaokangQianb851da82022-01-14 04:03:11 +00001673 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001674
Jerry Yue1b9c292021-09-10 10:08:31 +08001675 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001676 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001677 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001678 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001679 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001680 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001681 break;
1682
XiaokangQianeb69aee2022-07-05 08:21:43 +00001683#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001684 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001685 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1686 if( is_hrr )
1687 {
1688 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1689 goto cleanup;
1690 }
Jerry Yu4a173382021-10-11 21:45:31 +08001691
XiaokangQian86981952022-07-19 09:51:50 +00001692 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001693 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001694 {
1695 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001696 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001697 return( ret );
1698 }
1699 break;
1700#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001701
Jerry Yue1b9c292021-09-10 10:08:31 +08001702 case MBEDTLS_TLS_EXT_KEY_SHARE:
1703 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001704 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1705 {
XiaokangQian52da5582022-01-26 09:49:29 +00001706 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001707 goto cleanup;
1708 }
1709
XiaokangQian53f20b72022-01-18 10:47:33 +00001710 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001711 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001712 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001713 else
XiaokangQianb851da82022-01-14 04:03:11 +00001714 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001715 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001716 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001717 {
1718 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001719 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001720 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001721 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001722 }
1723 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001724
1725 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001726 MBEDTLS_SSL_DEBUG_MSG(
1727 3,
1728 ( "unknown extension found: %u ( ignoring )",
1729 extension_type ) );
1730
XiaokangQian52da5582022-01-26 09:49:29 +00001731 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001732 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001733 }
1734
1735 p += extension_data_len;
1736 }
1737
XiaokangQiand59be772022-01-24 10:12:51 +00001738cleanup:
1739
XiaokangQian52da5582022-01-26 09:49:29 +00001740 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001741 {
1742 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1743 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1744 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1745 }
XiaokangQian52da5582022-01-26 09:49:29 +00001746 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001747 {
1748 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1749 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1750 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1751 }
1752 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001753}
1754
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001755#if defined(MBEDTLS_DEBUG_C)
1756static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001757{
1758 switch( mode )
1759 {
1760 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1761 return "psk";
1762 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1763 return "ephemeral";
1764 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1765 return "psk_ephemeral";
1766 default:
1767 return "unknown mode";
1768 }
1769}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001770#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001771
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001772MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001773static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001774{
Jerry Yub85277e2021-10-13 13:36:05 +08001775 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001776 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001777
Jerry Yub85277e2021-10-13 13:36:05 +08001778 /* Determine the key exchange mode:
1779 * 1) If both the pre_shared_key and key_share extensions were received
1780 * then the key exchange mode is PSK with EPHEMERAL.
1781 * 2) If only the pre_shared_key extension was received then the key
1782 * exchange mode is PSK-only.
1783 * 3) If only the key_share extension was received then the key
1784 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001785 */
Jerry Yub85277e2021-10-13 13:36:05 +08001786 switch( handshake->extensions_present &
1787 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001788 {
Jerry Yu745bb612021-10-13 22:01:04 +08001789 /* Only the pre_shared_key extension was received */
1790 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001791 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001792 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001793
Jerry Yu745bb612021-10-13 22:01:04 +08001794 /* Only the key_share extension was received */
1795 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001796 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001797 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001798
Jerry Yu745bb612021-10-13 22:01:04 +08001799 /* Both the pre_shared_key and key_share extensions were received */
1800 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001801 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001802 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001803
Jerry Yu745bb612021-10-13 22:01:04 +08001804 /* Neither pre_shared_key nor key_share extension was received */
1805 default:
1806 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1807 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1808 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001809 }
1810
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001811 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1812 {
1813 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1814 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001815 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001816 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001817 goto cleanup;
1818 }
1819
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001820 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001821 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001822 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001823
Jerry Yu0b177842021-09-05 19:41:30 +08001824 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1825 *
1826 * TODO: We don't have to do this in case we offered 0-RTT and the
1827 * server accepted it. In this case, we could skip generating
1828 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001829 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001830 if( ret != 0 )
1831 {
Jerry Yue110d252022-05-05 10:19:22 +08001832 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001833 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001834 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001835 }
1836
Jerry Yuf86eb752022-05-06 11:16:55 +08001837 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001838 if( ret != 0 )
1839 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001840 MBEDTLS_SSL_DEBUG_RET( 1,
1841 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001842 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001843 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001844 }
1845
Jerry Yue110d252022-05-05 10:19:22 +08001846 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001847 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1848 ssl->session_in = ssl->session_negotiate;
1849
Jerry Yu4a173382021-10-11 21:45:31 +08001850cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001851 if( ret != 0 )
1852 {
Jerry Yu4a173382021-10-11 21:45:31 +08001853 MBEDTLS_SSL_PEND_FATAL_ALERT(
1854 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1855 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1856 }
Jerry Yue110d252022-05-05 10:19:22 +08001857
Jerry Yu4a173382021-10-11 21:45:31 +08001858 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001859}
1860
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001861MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001862static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001863{
1864 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1865
XiaokangQian78b1fa72022-01-19 06:56:30 +00001866 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001867
XiaokangQian78b1fa72022-01-19 06:56:30 +00001868 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001869 * We are going to re-generate a shared secret corresponding to the group
1870 * selected by the server, which is different from the group for which we
1871 * generated a shared secret in the first client hello.
1872 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001873 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001874 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001875 if( ret != 0 )
1876 return( ret );
1877
1878 return( 0 );
1879}
1880
Jerry Yue1b9c292021-09-10 10:08:31 +08001881/*
Jerry Yu4a173382021-10-11 21:45:31 +08001882 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001883 * Handler for MBEDTLS_SSL_SERVER_HELLO
1884 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001885MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001886static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001887{
Jerry Yu4a173382021-10-11 21:45:31 +08001888 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001889 unsigned char *buf = NULL;
1890 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001891 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001892
1893 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1894
Ronald Crondb5dfa12022-05-31 11:44:38 +02001895 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1896 MBEDTLS_SSL_HS_SERVER_HELLO,
1897 &buf, &buf_len ) );
1898
Ronald Cron828aff62022-05-31 12:04:31 +02001899 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001900 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001901 goto cleanup;
1902 else
Ronald Cron828aff62022-05-31 12:04:31 +02001903 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001904
Ronald Cron828aff62022-05-31 12:04:31 +02001905 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001906 {
1907 ret = 0;
1908 goto cleanup;
1909 }
1910
XiaokangQianb851da82022-01-14 04:03:11 +00001911 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001912 buf + buf_len,
1913 is_hrr ) );
1914 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001915 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1916
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001917 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1918 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001919
XiaokangQiand9e068e2022-01-18 06:23:32 +00001920 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001921 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001922 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001923#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1924 /* If not offering early data, the client sends a dummy CCS record
1925 * immediately before its second flight. This may either be before
1926 * its second ClientHello or before its encrypted handshake flight.
1927 */
1928 mbedtls_ssl_handshake_set_state( ssl,
1929 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1930#else
1931 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1932#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1933 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001934 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001935 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001936 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001937 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1938 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001939
1940cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001941 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1942 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08001943 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08001944}
1945
1946/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001947 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001948 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001949 *
1950 * The EncryptedExtensions message contains any extensions which
1951 * should be protected, i.e., any which are not needed to establish
1952 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001953 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001954
XiaokangQian08da26c2021-10-09 10:12:11 +00001955/* Parse EncryptedExtensions message
1956 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001957 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001958 * } EncryptedExtensions;
1959 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001960MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00001961static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
1962 const unsigned char *buf,
1963 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001964{
1965 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001966 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00001967 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00001968 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001969
XiaokangQian08da26c2021-10-09 10:12:11 +00001970 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00001971 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001972 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001973
XiaokangQian97799ac2021-10-11 10:05:54 +00001974 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00001975 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02001976 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001977
XiaokangQian8db25ff2021-10-13 05:56:18 +00001978 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001979 {
XiaokangQian08da26c2021-10-09 10:12:11 +00001980 unsigned int extension_type;
1981 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001982
XiaokangQian08da26c2021-10-09 10:12:11 +00001983 /*
1984 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001985 * ExtensionType extension_type; (2 bytes)
1986 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001987 * } Extension;
1988 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00001989 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001990 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1991 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1992 p += 4;
1993
XiaokangQian8db25ff2021-10-13 05:56:18 +00001994 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001995
XiaokangQian97799ac2021-10-11 10:05:54 +00001996 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001997 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00001998 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001999 */
XiaokangQian08da26c2021-10-09 10:12:11 +00002000 switch( extension_type )
2001 {
Jerry Yu661dd942022-08-03 14:50:01 +08002002 case MBEDTLS_TLS_EXT_SERVERNAME:
2003 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002004
Jerry Yu661dd942022-08-03 14:50:01 +08002005 /* The server_name extension should be an empty extension */
2006
2007 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00002008 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
2009 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
2010 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002011
lhuang0486cacac2022-01-21 07:34:27 -08002012#if defined(MBEDTLS_SSL_ALPN)
2013 case MBEDTLS_TLS_EXT_ALPN:
2014 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
2015
2016 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
2017 {
2018 return( ret );
2019 }
2020
2021 break;
2022#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00002023 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00002024 MBEDTLS_SSL_DEBUG_MSG(
2025 3, ( "unsupported extension found: %u ", extension_type) );
2026 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08002027 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00002028 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
2029 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00002030 }
2031
XiaokangQian08da26c2021-10-09 10:12:11 +00002032 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00002033 }
XiaokangQian08da26c2021-10-09 10:12:11 +00002034
XiaokangQian97799ac2021-10-11 10:05:54 +00002035 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002036 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00002037 {
2038 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08002039 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00002040 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00002041 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00002042 }
2043
2044 return( ret );
2045}
2046
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002047MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02002048static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
2049{
2050 int ret;
2051 unsigned char *buf;
2052 size_t buf_len;
2053
2054 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
2055
2056 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2057 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2058 &buf, &buf_len ) );
2059
2060 /* Process the message contents */
2061 MBEDTLS_SSL_PROC_CHK(
2062 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
2063
2064 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
2065 buf, buf_len );
2066
Ronald Cronfb508b82022-05-31 14:49:55 +02002067#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02002068 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02002069 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2070 else
2071 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
2072#else
2073 ((void) ssl);
2074 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2075#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02002076
2077cleanup:
2078
2079 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
2080 return( ret );
2081
2082}
2083
Jerry Yua93ac112021-10-27 16:31:48 +08002084#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08002085/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002086 * STATE HANDLING: CertificateRequest
2087 *
Jerry Yud2674312021-10-29 10:08:19 +08002088 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002089#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
2090#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002091/* Coordination:
2092 * Deals with the ambiguity of not knowing if a CertificateRequest
2093 * will be sent. Returns a negative code on failure, or
2094 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
2095 * - SSL_CERTIFICATE_REQUEST_SKIP
2096 * indicating if a Certificate Request is expected or not.
2097 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002098MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002099static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08002100{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002101 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08002102
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002103 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08002104 {
2105 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
2106 return( ret );
2107 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002108 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08002109
2110 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
2111 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
2112 {
Ronald Cron19385882022-06-15 16:26:13 +02002113 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002114 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08002115 }
2116
Ronald Cron19385882022-06-15 16:26:13 +02002117 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
2118
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002119 return( SSL_CERTIFICATE_REQUEST_SKIP );
2120}
2121
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002122/*
2123 * ssl_tls13_parse_certificate_request()
2124 * Parse certificate request
2125 * struct {
2126 * opaque certificate_request_context<0..2^8-1>;
2127 * Extension extensions<2..2^16-1>;
2128 * } CertificateRequest;
2129 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002130MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002131static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
2132 const unsigned char *buf,
2133 const unsigned char *end )
2134{
2135 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2136 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002137 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002138 size_t extensions_len = 0;
2139 const unsigned char *extensions_end;
2140 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002141
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002142 /* ...
2143 * opaque certificate_request_context<0..2^8-1>
2144 * ...
2145 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002146 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
2147 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002148 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002149
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002150 if( certificate_request_context_len > 0 )
2151 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002152 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002153 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
2154 p, certificate_request_context_len );
2155
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002156 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002157 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002158 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002159 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002160 {
2161 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
2162 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2163 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002164 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002165 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002166 p += certificate_request_context_len;
2167 }
2168
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002169 /* ...
2170 * Extension extensions<2..2^16-1>;
2171 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002172 */
2173 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
2174 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2175 p += 2;
2176
2177 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2178 extensions_end = p + extensions_len;
2179
2180 while( p < extensions_end )
2181 {
2182 unsigned int extension_type;
2183 size_t extension_data_len;
2184
2185 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
2186 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2187 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2188 p += 4;
2189
2190 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
2191
2192 switch( extension_type )
2193 {
2194 case MBEDTLS_TLS_EXT_SIG_ALG:
2195 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002196 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02002197 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02002198 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002199 if( ret != 0 )
2200 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002201 if( ! sig_alg_ext_found )
2202 sig_alg_ext_found = 1;
2203 else
2204 {
2205 MBEDTLS_SSL_DEBUG_MSG( 3,
2206 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002207 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002208 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002209 break;
2210
2211 default:
2212 MBEDTLS_SSL_DEBUG_MSG(
2213 3,
2214 ( "unknown extension found: %u ( ignoring )",
2215 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002216 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002217 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002218 p += extension_data_len;
2219 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002220 /* Check that we consumed all the message. */
2221 if( p != end )
2222 {
2223 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002224 ( "CertificateRequest misaligned" ) );
2225 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002226 }
2227 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00002228 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002229 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00002230 MBEDTLS_SSL_DEBUG_MSG( 3,
2231 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002232 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002233 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002234
Jerry Yu7840f812022-01-29 10:26:51 +08002235 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002236 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002237
Xiaofei Baic234ecf2022-02-08 09:59:23 +00002238decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002239 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
2240 MBEDTLS_ERR_SSL_DECODE_ERROR );
2241 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002242}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002243
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002244/*
2245 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
2246 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002247MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002248static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002249{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00002250 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002251
2252 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
2253
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002254 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
2255
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002256 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
2257 {
2258 unsigned char *buf;
2259 size_t buf_len;
2260
2261 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
2262 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2263 &buf, &buf_len ) );
2264
2265 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
2266 buf, buf + buf_len ) );
2267
Ronald Cron8f6d39a2022-03-10 18:56:50 +01002268 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
2269 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002270 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00002271 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002272 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00002273 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002274 }
2275 else
2276 {
2277 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00002278 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
2279 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002280 }
2281
Jerry Yud2674312021-10-29 10:08:19 +08002282 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
2283
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002284cleanup:
2285
Xiaofei Baia0ab7772022-01-16 12:14:45 +00002286 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
2287 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08002288}
2289
2290/*
Jerry Yu687101b2021-09-14 16:03:56 +08002291 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
2292 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002293MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002294static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002295{
Xiaofei Bai947571e2021-09-29 09:12:03 +00002296 int ret;
2297
2298 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00002299 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00002300 return( ret );
2301
Jerry Yu687101b2021-09-14 16:03:56 +08002302 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
2303 return( 0 );
2304}
2305
2306/*
2307 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
2308 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002309MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002310static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002311{
Jerry Yu30b071c2021-09-12 20:16:03 +08002312 int ret;
2313
2314 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
2315 if( ret != 0 )
2316 return( ret );
2317
Jerry Yu687101b2021-09-14 16:03:56 +08002318 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
2319 return( 0 );
2320}
Jerry Yua93ac112021-10-27 16:31:48 +08002321#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01002322
Jerry Yu687101b2021-09-14 16:03:56 +08002323/*
2324 * Handler for MBEDTLS_SSL_SERVER_FINISHED
2325 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002326MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002327static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002328{
XiaokangQianac0385c2021-11-03 06:40:11 +00002329 int ret;
2330
XiaokangQianc5c39d52021-11-09 11:55:10 +00002331 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00002332 if( ret != 0 )
2333 return( ret );
2334
Jerry Yue3d67cb2022-05-19 15:33:10 +08002335 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
2336 if( ret != 0 )
2337 {
2338 MBEDTLS_SSL_PEND_FATAL_ALERT(
2339 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
2340 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
2341 return( ret );
2342 }
2343
Ronald Cron49ad6192021-11-24 16:25:31 +01002344#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
2345 mbedtls_ssl_handshake_set_state(
2346 ssl,
2347 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
2348#else
Jerry Yuca133a32022-02-15 14:22:05 +08002349 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08002350#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01002351
XiaokangQianac0385c2021-11-03 06:40:11 +00002352 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002353}
2354
2355/*
Jerry Yu566c7812022-01-26 15:41:22 +08002356 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
2357 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002358MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002359static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
2360{
Ronald Cron7a94aca2022-03-09 07:44:27 +01002361 int non_empty_certificate_msg = 0;
2362
Jerry Yu5cc35062022-01-28 16:16:08 +08002363 MBEDTLS_SSL_DEBUG_MSG( 1,
2364 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08002365 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08002366
Ronald Cron9df7c802022-03-08 18:38:54 +01002367#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002368 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01002369 {
2370 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
2371 if( ret != 0 )
2372 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002373
Ronald Cron7a94aca2022-03-09 07:44:27 +01002374 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2375 non_empty_certificate_msg = 1;
2376 }
2377 else
2378 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002379 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002380 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002381#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002382
Ronald Cron7a94aca2022-03-09 07:44:27 +01002383 if( non_empty_certificate_msg )
2384 {
2385 mbedtls_ssl_handshake_set_state( ssl,
2386 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2387 }
2388 else
Ronald Cron19385882022-06-15 16:26:13 +02002389 {
2390 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002391 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002392 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002393
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002394 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002395}
2396
Ronald Cron9df7c802022-03-08 18:38:54 +01002397#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002398/*
2399 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2400 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002401MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002402static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2403{
Ronald Crona8b38872022-03-09 07:59:25 +01002404 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2405
2406 if( ret == 0 )
2407 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2408
2409 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002410}
Jerry Yu90f152d2022-01-29 22:12:42 +08002411#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002412
2413/*
Jerry Yu687101b2021-09-14 16:03:56 +08002414 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2415 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002416MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002417static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002418{
XiaokangQian0fa66432021-11-15 03:33:57 +00002419 int ret;
2420
2421 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2422 if( ret != 0 )
2423 return( ret );
2424
Jerry Yu466dda82022-09-13 11:20:20 +08002425 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002426 if( ret != 0 )
2427 {
2428 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002429 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002430 return ( ret );
2431 }
2432
XiaokangQian0fa66432021-11-15 03:33:57 +00002433 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2434 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002435}
2436
2437/*
2438 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2439 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002440MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002441static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002442{
Jerry Yu378254d2021-10-30 21:44:47 +08002443 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002444 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002445 return( 0 );
2446}
2447
2448/*
2449 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2450 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002451MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002452static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002453{
Jerry Yu378254d2021-10-30 21:44:47 +08002454
2455 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2456
2457 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2458 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002459}
2460
Jerry Yuf8a49942022-07-07 11:32:32 +00002461#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2462
Jerry Yua0446a02022-07-13 11:22:55 +08002463MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002464static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2465 const unsigned char *buf,
2466 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002467{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002468 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002469
2470 ((void) ssl);
2471
2472 while( p < end )
2473 {
2474 unsigned int extension_type;
2475 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002476
Jerry Yuf8a49942022-07-07 11:32:32 +00002477 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2478 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2479 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2480 p += 4;
2481
2482 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002483
2484 switch( extension_type )
2485 {
2486 case MBEDTLS_TLS_EXT_EARLY_DATA:
2487 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2488 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002489
Jerry Yuf8a49942022-07-07 11:32:32 +00002490 default:
2491 break;
2492 }
2493 p += extension_data_len;
2494 }
2495
2496 return( 0 );
2497}
2498
2499/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002500 * From RFC8446, page 74
2501 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002502 * struct {
2503 * uint32 ticket_lifetime;
2504 * uint32 ticket_age_add;
2505 * opaque ticket_nonce<0..255>;
2506 * opaque ticket<1..2^16-1>;
2507 * Extension extensions<0..2^16-2>;
2508 * } NewSessionTicket;
2509 *
2510 */
Jerry Yua0446a02022-07-13 11:22:55 +08002511MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002512static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2513 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002514 unsigned char *end,
2515 unsigned char **ticket_nonce,
2516 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002517{
2518 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2519 unsigned char *p = buf;
2520 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002521 size_t ticket_len;
2522 unsigned char *ticket;
2523 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002524
Jerry Yucb3b1392022-07-12 06:09:38 +00002525 *ticket_nonce = NULL;
2526 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002527 /*
2528 * ticket_lifetime 4 bytes
2529 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002530 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002531 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002532 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002533
2534 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002535 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002536 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002537 ( unsigned int )session->ticket_lifetime ) );
2538
Jerry Yucb3b1392022-07-12 06:09:38 +00002539 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002540 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002541 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002542 ( unsigned int )session->ticket_age_add ) );
2543
Jerry Yucb3b1392022-07-12 06:09:38 +00002544 *ticket_nonce_len = p[8];
2545 p += 9;
2546
2547 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2548 *ticket_nonce = p;
2549 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2550 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002551
2552 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002553 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002554 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2555 p += 2;
2556 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002557 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2558
2559 /* Check if we previously received a ticket already. */
2560 if( session->ticket != NULL || session->ticket_len > 0 )
2561 {
2562 mbedtls_free( session->ticket );
2563 session->ticket = NULL;
2564 session->ticket_len = 0;
2565 }
2566
2567 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2568 {
2569 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2570 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2571 }
2572 memcpy( ticket, p, ticket_len );
2573 p += ticket_len;
2574 session->ticket = ticket;
2575 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002576
Jerry Yucb3b1392022-07-12 06:09:38 +00002577 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002578 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2579 p += 2;
2580 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2581
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002582 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002583
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002584 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002585 if( ret != 0 )
2586 {
2587 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002588 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002589 ret );
2590 return( ret );
2591 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002592
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002593 /* session has been updated, allow export */
2594 session->exported = 0;
2595
Jerry Yucb3b1392022-07-12 06:09:38 +00002596 return( 0 );
2597}
2598
Jerry Yua0446a02022-07-13 11:22:55 +08002599MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002600static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2601 unsigned char *ticket_nonce,
2602 size_t ticket_nonce_len )
2603{
2604 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2605 mbedtls_ssl_session *session = ssl->session;
2606 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2607 psa_algorithm_t psa_hash_alg;
2608 int hash_length;
2609
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002610#if defined(MBEDTLS_HAVE_TIME)
2611 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002612 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002613#endif
2614
Jerry Yuf8a49942022-07-07 11:32:32 +00002615 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2616 if( ciphersuite_info == NULL )
2617 {
2618 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2619 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2620 }
2621
2622 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2623 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002624 if( hash_length == -1 ||
2625 ( size_t )hash_length > sizeof( session->resumption_key ) )
2626 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002627 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002628 }
2629
Jerry Yuf8a49942022-07-07 11:32:32 +00002630
2631 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2632 session->app_secrets.resumption_master_secret,
2633 hash_length );
2634
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002635 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002636 *
2637 * HKDF-Expand-Label( resumption_master_secret,
2638 * "resumption", ticket_nonce, Hash.length )
2639 */
2640 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2641 psa_hash_alg,
2642 session->app_secrets.resumption_master_secret,
2643 hash_length,
2644 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2645 ticket_nonce,
2646 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002647 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002648 hash_length );
2649
2650 if( ret != 0 )
2651 {
2652 MBEDTLS_SSL_DEBUG_RET( 2,
2653 "Creating the ticket-resumed PSK failed",
2654 ret );
2655 return( ret );
2656 }
2657
Jerry Yu0a430c82022-07-20 11:02:48 +08002658 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002659
2660 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002661 session->resumption_key,
2662 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002663
Jerry Yuf8a49942022-07-07 11:32:32 +00002664 return( 0 );
2665}
2666
2667/*
Jerry Yua357cf42022-07-12 05:36:45 +00002668 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002669 */
Jerry Yua0446a02022-07-13 11:22:55 +08002670MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002671static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2672{
2673 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2674 unsigned char *buf;
2675 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002676 unsigned char *ticket_nonce;
2677 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002678
2679 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2680
2681 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2682 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2683 &buf, &buf_len ) );
2684
Jerry Yucb3b1392022-07-12 06:09:38 +00002685 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2686 ssl, buf, buf + buf_len,
2687 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002688
Jerry Yucb3b1392022-07-12 06:09:38 +00002689 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2690 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002691
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002692 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2693
Jerry Yuf8a49942022-07-07 11:32:32 +00002694cleanup:
2695
2696 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2697 return( ret );
2698}
2699#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2700
Jerry Yu92c6b402021-08-27 16:59:09 +08002701int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002702{
Jerry Yu92c6b402021-08-27 16:59:09 +08002703 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002704
Jerry Yu92c6b402021-08-27 16:59:09 +08002705 switch( ssl->state )
2706 {
2707 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002708 * ssl->state is initialized as HELLO_REQUEST. It is the same
2709 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002710 */
2711 case MBEDTLS_SSL_HELLO_REQUEST:
2712 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002713 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002714 break;
2715
2716 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002717 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002718 break;
2719
2720 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002721 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002722 break;
2723
Jerry Yua93ac112021-10-27 16:31:48 +08002724#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002725 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2726 ret = ssl_tls13_process_certificate_request( ssl );
2727 break;
2728
Jerry Yu687101b2021-09-14 16:03:56 +08002729 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002730 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002731 break;
2732
2733 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002734 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002735 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002736#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002737
2738 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002739 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002740 break;
2741
Jerry Yu566c7812022-01-26 15:41:22 +08002742 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2743 ret = ssl_tls13_write_client_certificate( ssl );
2744 break;
2745
Ronald Cron9df7c802022-03-08 18:38:54 +01002746#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002747 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2748 ret = ssl_tls13_write_client_certificate_verify( ssl );
2749 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002750#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002751
Jerry Yu687101b2021-09-14 16:03:56 +08002752 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002753 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002754 break;
2755
2756 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002757 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002758 break;
2759
2760 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002761 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002762 break;
2763
Ronald Cron49ad6192021-11-24 16:25:31 +01002764 /*
2765 * Injection of dummy-CCS's for middlebox compatibility
2766 */
2767#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002768 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002769 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2770 if( ret == 0 )
2771 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2772 break;
2773
2774 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2775 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2776 if( ret == 0 )
2777 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002778 break;
2779#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2780
Jerry Yuf8a49942022-07-07 11:32:32 +00002781#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002782 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002783 ret = ssl_tls13_process_new_session_ticket( ssl );
2784 if( ret != 0 )
2785 break;
2786 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2787 break;
2788#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2789
Jerry Yu92c6b402021-08-27 16:59:09 +08002790 default:
2791 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2792 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2793 }
2794
2795 return( ret );
2796}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002797
Jerry Yufb4b6472022-01-27 15:03:26 +08002798#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002799
Jerry Yufb4b6472022-01-27 15:03:26 +08002800