blob: 645479b830f708148cf5062b2022ae5f50ed45eb [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
XiaokangQianeb69aee2022-07-05 08:21:43 +0000668/*
Jerry Yudb8c5fa2022-08-03 12:10:13 +0800669 * mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext() structure:
XiaokangQianeb69aee2022-07-05 08:21:43 +0000670 *
671 * struct {
672 * opaque identity<1..2^16-1>;
673 * uint32 obfuscated_ticket_age;
674 * } PskIdentity;
675 *
676 * opaque PskBinderEntry<32..255>;
677 *
678 * struct {
XiaokangQian86981952022-07-19 09:51:50 +0000679 * PskIdentity identities<7..2^16-1>;
680 * PskBinderEntry binders<33..2^16-1>;
681 * } OfferedPsks;
XiaokangQianeb69aee2022-07-05 08:21:43 +0000682 *
XiaokangQian86981952022-07-19 09:51:50 +0000683 * struct {
684 * select (Handshake.msg_type) {
685 * case client_hello: OfferedPsks;
686 * ...
687 * };
XiaokangQianeb69aee2022-07-05 08:21:43 +0000688 * } PreSharedKeyExtension;
689 *
XiaokangQianeb69aee2022-07-05 08:21:43 +0000690 */
XiaokangQian3ad67bf2022-07-21 02:26:21 +0000691int mbedtls_ssl_tls13_write_identities_of_pre_shared_key_ext(
XiaokangQianeb69aee2022-07-05 08:21:43 +0000692 mbedtls_ssl_context *ssl,
693 unsigned char *buf, unsigned char *end,
694 size_t *out_len, size_t *binders_len )
695{
Jerry Yu0c6105b2022-08-12 17:26:40 +0800696 ((void) ssl);
697 ((void) buf);
698 ((void) end);
699 ((void) out_len);
700 ((void) binders_len);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000701 return( 0 );
702}
703
XiaokangQian86981952022-07-19 09:51:50 +0000704int mbedtls_ssl_tls13_write_binders_of_pre_shared_key_ext(
Jerry Yu0c6105b2022-08-12 17:26:40 +0800705 mbedtls_ssl_context *ssl, unsigned char *buf, unsigned char *end )
XiaokangQianeb69aee2022-07-05 08:21:43 +0000706{
Jerry Yu0c6105b2022-08-12 17:26:40 +0800707 ((void) ssl);
708 ((void) buf);
709 ((void) end);
XiaokangQianeb69aee2022-07-05 08:21:43 +0000710
711 return( 0 );
712}
Jerry Yu0c6105b2022-08-12 17:26:40 +0800713
714/*
715 * struct {
716 * opaque identity<1..2^16-1>;
717 * uint32 obfuscated_ticket_age;
718 * } PskIdentity;
719 *
720 * opaque PskBinderEntry<32..255>;
721 *
722 * struct {
723 *
724 * select (Handshake.msg_type) {
725 * ...
726 * case server_hello: uint16 selected_identity;
727 * };
728 *
729 * } PreSharedKeyExtension;
730 *
731 */
732MBEDTLS_CHECK_RETURN_CRITICAL
733static int ssl_tls13_parse_server_pre_shared_key_ext( mbedtls_ssl_context *ssl,
734 const unsigned char *buf,
735 const unsigned char *end )
736{
737 ((void) ssl);
738 ((void) buf);
739 ((void) end);
740 return( 0 );
741}
742
XiaokangQianeb69aee2022-07-05 08:21:43 +0000743#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
744
Ronald Cron3d580bf2022-02-18 17:24:56 +0100745int mbedtls_ssl_tls13_write_client_hello_exts( mbedtls_ssl_context *ssl,
746 unsigned char *buf,
747 unsigned char *end,
748 size_t *out_len )
Ronald Cron04fbd2b2022-02-18 12:06:07 +0100749{
750 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
751 unsigned char *p = buf;
752 size_t ext_len;
753
754 *out_len = 0;
755
756 /* Write supported_versions extension
757 *
758 * Supported Versions Extension is mandatory with TLS 1.3.
759 */
760 ret = ssl_tls13_write_supported_versions_ext( ssl, p, end, &ext_len );
761 if( ret != 0 )
762 return( ret );
763 p += ext_len;
764
765 /* Echo the cookie if the server provided one in its preceding
766 * HelloRetryRequest message.
767 */
768 ret = ssl_tls13_write_cookie_ext( ssl, p, end, &ext_len );
769 if( ret != 0 )
770 return( ret );
771 p += ext_len;
772
Ronald Cron04fbd2b2022-02-18 12:06:07 +0100773 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
774 {
775 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &ext_len );
776 if( ret != 0 )
777 return( ret );
778 p += ext_len;
779 }
Ronald Cron04fbd2b2022-02-18 12:06:07 +0100780
XiaokangQianeb69aee2022-07-05 08:21:43 +0000781#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
782 /* For PSK-based key exchange we need the pre_shared_key extension
783 * and the psk_key_exchange_modes extension.
784 *
785 * The pre_shared_key extension MUST be the last extension in the
786 * ClientHello. Servers MUST check that it is the last extension and
787 * otherwise fail the handshake with an "illegal_parameter" alert.
788 *
789 * Add the psk_key_exchange_modes extension.
790 */
791 ret = ssl_tls13_write_psk_key_exchange_modes_ext( ssl, p, end, &ext_len );
792 if( ret != 0 )
793 return( ret );
794 p += ext_len;
795#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
796
Ronald Cron04fbd2b2022-02-18 12:06:07 +0100797 *out_len = p - buf;
798
799 return( 0 );
800}
801
Jerry Yu1bc2c1f2021-09-01 12:57:29 +0800802/*
Jerry Yu4a173382021-10-11 21:45:31 +0800803 * Functions for parsing and processing Server Hello
Jerry Yue1b9c292021-09-10 10:08:31 +0800804 */
Ronald Cronfd6193c2022-04-05 11:04:20 +0200805
Ronald Cronda41b382022-03-30 09:57:11 +0200806/**
807 * \brief Detect if the ServerHello contains a supported_versions extension
808 * or not.
809 *
810 * \param[in] ssl SSL context
811 * \param[in] buf Buffer containing the ServerHello message
812 * \param[in] end End of the buffer containing the ServerHello message
813 *
814 * \return 0 if the ServerHello does not contain a supported_versions extension
815 * \return 1 if the ServerHello contains a supported_versions extension
816 * \return A negative value if an error occurred while parsing the ServerHello.
817 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200818MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9f0fba32022-02-10 16:45:15 +0100819static int ssl_tls13_is_supported_versions_ext_present(
820 mbedtls_ssl_context *ssl,
821 const unsigned char *buf,
822 const unsigned char *end )
823{
824 const unsigned char *p = buf;
825 size_t legacy_session_id_echo_len;
826 size_t extensions_len;
827 const unsigned char *extensions_end;
828
829 /*
830 * Check there is enough data to access the legacy_session_id_echo vector
Ronald Cronda41b382022-03-30 09:57:11 +0200831 * length:
832 * - legacy_version 2 bytes
833 * - random MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes
834 * - legacy_session_id_echo length 1 byte
Ronald Cron9f0fba32022-02-10 16:45:15 +0100835 */
836 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 3 );
837 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2;
838 legacy_session_id_echo_len = *p;
839
840 /*
841 * Jump to the extensions, jumping over:
842 * - legacy_session_id_echo (legacy_session_id_echo_len + 1) bytes
843 * - cipher_suite 2 bytes
844 * - legacy_compression_method 1 byte
845 */
Ronald Cron28271062022-06-10 14:43:55 +0200846 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len + 4 );
Ronald Cron9f0fba32022-02-10 16:45:15 +0100847 p += legacy_session_id_echo_len + 4;
848
849 /* Case of no extension */
850 if( p == end )
851 return( 0 );
852
853 /* ...
854 * Extension extensions<6..2^16-1>;
855 * ...
856 * struct {
857 * ExtensionType extension_type; (2 bytes)
858 * opaque extension_data<0..2^16-1>;
859 * } Extension;
860 */
861 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
862 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
863 p += 2;
864
865 /* Check extensions do not go beyond the buffer of data. */
866 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
867 extensions_end = p + extensions_len;
868
869 while( p < extensions_end )
870 {
871 unsigned int extension_type;
872 size_t extension_data_len;
873
874 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
875 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
876 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
877 p += 4;
878
879 if( extension_type == MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS )
880 return( 1 );
881
882 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
883 p += extension_data_len;
884 }
885
886 return( 0 );
887}
888
Jerry Yu7a186a02021-10-15 18:46:14 +0800889/* Returns a negative value on failure, and otherwise
Ronald Cronfd6193c2022-04-05 11:04:20 +0200890 * - 1 if the last eight bytes of the ServerHello random bytes indicate that
891 * the server is TLS 1.3 capable but negotiating TLS 1.2 or below.
892 * - 0 otherwise
893 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200894MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cronfd6193c2022-04-05 11:04:20 +0200895static int ssl_tls13_is_downgrade_negotiation( mbedtls_ssl_context *ssl,
896 const unsigned char *buf,
897 const unsigned char *end )
898{
899 /* First seven bytes of the magic downgrade strings, see RFC 8446 4.1.3 */
900 static const unsigned char magic_downgrade_string[] =
901 { 0x44, 0x4F, 0x57, 0x4E, 0x47, 0x52, 0x44 };
902 const unsigned char *last_eight_bytes_of_random;
903 unsigned char last_byte_of_random;
904
905 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 2 );
906 last_eight_bytes_of_random = buf + 2 + MBEDTLS_SERVER_HELLO_RANDOM_LEN - 8;
907
908 if( memcmp( last_eight_bytes_of_random,
909 magic_downgrade_string,
910 sizeof( magic_downgrade_string ) ) == 0 )
911 {
912 last_byte_of_random = last_eight_bytes_of_random[7];
913 return( last_byte_of_random == 0 ||
914 last_byte_of_random == 1 );
915 }
916
917 return( 0 );
918}
919
920/* Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +0200921 * - SSL_SERVER_HELLO or
922 * - SSL_SERVER_HELLO_HRR
XiaokangQian51eff222021-12-10 10:33:56 +0000923 * to indicate which message is expected and to be parsed next.
924 */
Ronald Cron828aff62022-05-31 12:04:31 +0200925#define SSL_SERVER_HELLO 0
926#define SSL_SERVER_HELLO_HRR 1
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200927MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yub85277e2021-10-13 13:36:05 +0800928static int ssl_server_hello_is_hrr( mbedtls_ssl_context *ssl,
929 const unsigned char *buf,
930 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +0800931{
Jerry Yue1b9c292021-09-10 10:08:31 +0800932
933 /* Check whether this message is a HelloRetryRequest ( HRR ) message.
934 *
Jerry Yu4a173382021-10-11 21:45:31 +0800935 * Server Hello and HRR are only distinguished by Random set to the
Jerry Yue1b9c292021-09-10 10:08:31 +0800936 * special value of the SHA-256 of "HelloRetryRequest".
937 *
938 * struct {
939 * ProtocolVersion legacy_version = 0x0303;
940 * Random random;
941 * opaque legacy_session_id_echo<0..32>;
942 * CipherSuite cipher_suite;
943 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +0800944 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +0800945 * } ServerHello;
946 *
947 */
Jerry Yu93a13f22022-04-11 23:00:01 +0800948 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end,
949 2 + sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) );
Jerry Yu4a173382021-10-11 21:45:31 +0800950
Jerry Yu93a13f22022-04-11 23:00:01 +0800951 if( memcmp( buf + 2, mbedtls_ssl_tls13_hello_retry_request_magic,
952 sizeof( mbedtls_ssl_tls13_hello_retry_request_magic ) ) == 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +0800953 {
Ronald Cron828aff62022-05-31 12:04:31 +0200954 return( SSL_SERVER_HELLO_HRR );
Jerry Yue1b9c292021-09-10 10:08:31 +0800955 }
956
Ronald Cron828aff62022-05-31 12:04:31 +0200957 return( SSL_SERVER_HELLO );
Jerry Yue1b9c292021-09-10 10:08:31 +0800958}
959
Ronald Cron828aff62022-05-31 12:04:31 +0200960/*
Jerry Yu745bb612021-10-13 22:01:04 +0800961 * Returns a negative value on failure, and otherwise
Ronald Cron828aff62022-05-31 12:04:31 +0200962 * - SSL_SERVER_HELLO or
963 * - SSL_SERVER_HELLO_HRR or
964 * - SSL_SERVER_HELLO_TLS1_2
Jerry Yu745bb612021-10-13 22:01:04 +0800965 */
Ronald Cron828aff62022-05-31 12:04:31 +0200966#define SSL_SERVER_HELLO_TLS1_2 2
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +0200967MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron828aff62022-05-31 12:04:31 +0200968static int ssl_tls13_preprocess_server_hello( mbedtls_ssl_context *ssl,
Ronald Crondb5dfa12022-05-31 11:44:38 +0200969 const unsigned char *buf,
970 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +0800971{
Jerry Yu4a173382021-10-11 21:45:31 +0800972 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Ronald Cron5afb9042022-05-31 12:11:39 +0200973 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yue1b9c292021-09-10 10:08:31 +0800974
Ronald Cron9f0fba32022-02-10 16:45:15 +0100975 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_is_supported_versions_ext_present(
Ronald Crondb5dfa12022-05-31 11:44:38 +0200976 ssl, buf, end ) );
Jerry Yua66fece2022-07-13 14:30:29 +0800977
Ronald Cron9f0fba32022-02-10 16:45:15 +0100978 if( ret == 0 )
979 {
Ronald Cronfd6193c2022-04-05 11:04:20 +0200980 MBEDTLS_SSL_PROC_CHK_NEG(
Ronald Crondb5dfa12022-05-31 11:44:38 +0200981 ssl_tls13_is_downgrade_negotiation( ssl, buf, end ) );
Ronald Cronfd6193c2022-04-05 11:04:20 +0200982
983 /* If the server is negotiating TLS 1.2 or below and:
984 * . we did not propose TLS 1.2 or
985 * . the server responded it is TLS 1.3 capable but negotiating a lower
986 * version of the protocol and thus we are under downgrade attack
987 * abort the handshake with an "illegal parameter" alert.
Ronald Cron9f0fba32022-02-10 16:45:15 +0100988 */
Ronald Cron5afb9042022-05-31 12:11:39 +0200989 if( handshake->min_tls_version > MBEDTLS_SSL_VERSION_TLS1_2 || ret )
Ronald Cron9f0fba32022-02-10 16:45:15 +0100990 {
991 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
992 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
993 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
994 }
995
996 ssl->keep_current_message = 1;
Glenn Strauss60bfe602022-03-14 19:04:24 -0400997 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_2;
Ronald Cron9f0fba32022-02-10 16:45:15 +0100998 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
Ronald Crondb5dfa12022-05-31 11:44:38 +0200999 buf, (size_t)(end - buf) );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001000
1001 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1002 {
1003 ret = ssl_tls13_reset_key_share( ssl );
1004 if( ret != 0 )
1005 return( ret );
1006 }
1007
Ronald Cron828aff62022-05-31 12:04:31 +02001008 return( SSL_SERVER_HELLO_TLS1_2 );
Ronald Cron9f0fba32022-02-10 16:45:15 +01001009 }
1010
Jerry Yua66fece2022-07-13 14:30:29 +08001011#if defined(MBEDTLS_SSL_SESSION_TICKETS)
1012 ssl->session_negotiate->endpoint = ssl->conf->endpoint;
1013 ssl->session_negotiate->tls_version = ssl->tls_version;
1014#endif /* MBEDTLS_SSL_SESSION_TICKETS */
1015
Ronald Cron5afb9042022-05-31 12:11:39 +02001016 handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
1017
Ronald Crondb5dfa12022-05-31 11:44:38 +02001018 ret = ssl_server_hello_is_hrr( ssl, buf, end );
Jerry Yub85277e2021-10-13 13:36:05 +08001019 switch( ret )
Jerry Yue1b9c292021-09-10 10:08:31 +08001020 {
Ronald Cron828aff62022-05-31 12:04:31 +02001021 case SSL_SERVER_HELLO:
Jerry Yu745bb612021-10-13 22:01:04 +08001022 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received ServerHello message" ) );
1023 break;
Ronald Cron828aff62022-05-31 12:04:31 +02001024 case SSL_SERVER_HELLO_HRR:
Jerry Yu745bb612021-10-13 22:01:04 +08001025 MBEDTLS_SSL_DEBUG_MSG( 2, ( "received HelloRetryRequest message" ) );
XiaokangQian16acd4b2022-01-14 07:35:47 +00001026 /* If a client receives a second
1027 * HelloRetryRequest in the same connection (i.e., where the ClientHello
1028 * was itself in response to a HelloRetryRequest), it MUST abort the
1029 * handshake with an "unexpected_message" alert.
1030 */
Ronald Cron5afb9042022-05-31 12:11:39 +02001031 if( handshake->hello_retry_request_count > 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001032 {
1033 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Multiple HRRs received" ) );
1034 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNEXPECTED_MESSAGE,
1035 MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1036 return( MBEDTLS_ERR_SSL_UNEXPECTED_MESSAGE );
1037 }
XiaokangQian2b01dc32022-01-21 02:53:13 +00001038 /*
1039 * Clients must abort the handshake with an "illegal_parameter"
1040 * alert if the HelloRetryRequest would not result in any change
1041 * in the ClientHello.
1042 * In a PSK only key exchange that what we expect.
1043 */
1044 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1045 {
1046 MBEDTLS_SSL_DEBUG_MSG( 1,
1047 ( "Unexpected HRR in pure PSK key exchange." ) );
1048 MBEDTLS_SSL_PEND_FATAL_ALERT(
1049 MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1050 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1051 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1052 }
XiaokangQian16acd4b2022-01-14 07:35:47 +00001053
Ronald Cron5afb9042022-05-31 12:11:39 +02001054 handshake->hello_retry_request_count++;
XiaokangQian16acd4b2022-01-14 07:35:47 +00001055
Jerry Yu745bb612021-10-13 22:01:04 +08001056 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001057 }
1058
1059cleanup:
1060
1061 return( ret );
1062}
1063
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001064MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu4a173382021-10-11 21:45:31 +08001065static int ssl_tls13_check_server_hello_session_id_echo( mbedtls_ssl_context *ssl,
1066 const unsigned char **buf,
1067 const unsigned char *end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001068{
1069 const unsigned char *p = *buf;
Jerry Yu4a173382021-10-11 21:45:31 +08001070 size_t legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001071
Jerry Yude4fb2c2021-09-19 18:05:08 +08001072 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Jerry Yu4a173382021-10-11 21:45:31 +08001073 legacy_session_id_echo_len = *p++ ;
Jerry Yue1b9c292021-09-10 10:08:31 +08001074
Jerry Yu4a173382021-10-11 21:45:31 +08001075 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_echo_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001076
1077 /* legacy_session_id_echo */
Jerry Yu4a173382021-10-11 21:45:31 +08001078 if( ssl->session_negotiate->id_len != legacy_session_id_echo_len ||
1079 memcmp( ssl->session_negotiate->id, p , legacy_session_id_echo_len ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001080 {
Jerry Yue1b9c292021-09-10 10:08:31 +08001081 MBEDTLS_SSL_DEBUG_BUF( 3, "Expected Session ID",
1082 ssl->session_negotiate->id,
1083 ssl->session_negotiate->id_len );
1084 MBEDTLS_SSL_DEBUG_BUF( 3, "Received Session ID", p,
Jerry Yu4a173382021-10-11 21:45:31 +08001085 legacy_session_id_echo_len );
1086
1087 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1088 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER);
1089
Jerry Yue1b9c292021-09-10 10:08:31 +08001090 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1091 }
1092
Jerry Yu4a173382021-10-11 21:45:31 +08001093 p += legacy_session_id_echo_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001094 *buf = p;
1095
1096 MBEDTLS_SSL_DEBUG_BUF( 3, "Session ID", ssl->session_negotiate->id,
Jerry Yu4a173382021-10-11 21:45:31 +08001097 ssl->session_negotiate->id_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001098 return( 0 );
1099}
1100
Jerry Yue1b9c292021-09-10 10:08:31 +08001101/* Parse ServerHello message and configure context
1102 *
1103 * struct {
1104 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1105 * Random random;
1106 * opaque legacy_session_id_echo<0..32>;
1107 * CipherSuite cipher_suite;
1108 * uint8 legacy_compression_method = 0;
Jerry Yub85277e2021-10-13 13:36:05 +08001109 * Extension extensions<6..2^16-1>;
Jerry Yue1b9c292021-09-10 10:08:31 +08001110 * } ServerHello;
1111 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001112MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuc068b662021-10-11 22:30:19 +08001113static int ssl_tls13_parse_server_hello( mbedtls_ssl_context *ssl,
1114 const unsigned char *buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001115 const unsigned char *end,
1116 int is_hrr )
Jerry Yue1b9c292021-09-10 10:08:31 +08001117{
Jerry Yub85277e2021-10-13 13:36:05 +08001118 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yue1b9c292021-09-10 10:08:31 +08001119 const unsigned char *p = buf;
XiaokangQian355e09a2022-01-20 11:14:50 +00001120 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yub85277e2021-10-13 13:36:05 +08001121 size_t extensions_len;
1122 const unsigned char *extensions_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001123 uint16_t cipher_suite;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001124 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
XiaokangQianb119a352022-01-26 03:29:10 +00001125 int fatal_alert = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001126
1127 /*
1128 * Check there is space for minimal fields
1129 *
1130 * - legacy_version ( 2 bytes)
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001131 * - random (MBEDTLS_SERVER_HELLO_RANDOM_LEN bytes)
Jerry Yue1b9c292021-09-10 10:08:31 +08001132 * - legacy_session_id_echo ( 1 byte ), minimum size
1133 * - cipher_suite ( 2 bytes)
1134 * - legacy_compression_method ( 1 byte )
1135 */
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001136 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN + 6 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001137
1138 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello", p, end - p );
Jerry Yue1b9c292021-09-10 10:08:31 +08001139 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, version", p, 2 );
1140
Jerry Yu4a173382021-10-11 21:45:31 +08001141 /* ...
Jerry Yub85277e2021-10-13 13:36:05 +08001142 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
Jerry Yu4a173382021-10-11 21:45:31 +08001143 * ...
1144 * with ProtocolVersion defined as:
1145 * uint16 ProtocolVersion;
1146 */
Glenn Strausse3af4cb2022-03-15 03:23:42 -04001147 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
1148 MBEDTLS_SSL_VERSION_TLS1_2 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001149 {
1150 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
1151 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
1152 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQiand59be772022-01-24 10:12:51 +00001153 ret = MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION;
1154 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001155 }
1156 p += 2;
Jerry Yue1b9c292021-09-10 10:08:31 +08001157
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001158 /* ...
Jerry Yu4a173382021-10-11 21:45:31 +08001159 * Random random;
1160 * ...
1161 * with Random defined as:
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001162 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu4a173382021-10-11 21:45:31 +08001163 */
XiaokangQian53f20b72022-01-18 10:47:33 +00001164 if( !is_hrr )
1165 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001166 memcpy( &handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN], p,
XiaokangQian53f20b72022-01-18 10:47:33 +00001167 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1168 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
1169 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1170 }
Jerry Yue6d7e5c2021-10-26 10:44:32 +08001171 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
Jerry Yue1b9c292021-09-10 10:08:31 +08001172
Jerry Yu4a173382021-10-11 21:45:31 +08001173 /* ...
1174 * opaque legacy_session_id_echo<0..32>;
1175 * ...
1176 */
1177 if( ssl_tls13_check_server_hello_session_id_echo( ssl, &p, end ) != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001178 {
XiaokangQian52da5582022-01-26 09:49:29 +00001179 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001180 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001181 }
1182
Jerry Yu4a173382021-10-11 21:45:31 +08001183 /* ...
1184 * CipherSuite cipher_suite;
1185 * ...
1186 * with CipherSuite defined as:
1187 * uint8 CipherSuite[2];
1188 */
1189 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001190 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
1191 p += 2;
1192
Jerry Yu4a173382021-10-11 21:45:31 +08001193
XiaokangQian355e09a2022-01-20 11:14:50 +00001194 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
Jerry Yu4a173382021-10-11 21:45:31 +08001195 /*
Ronald Cronba120bb2022-03-30 22:09:48 +02001196 * Check whether this ciphersuite is valid and offered.
Jerry Yu4a173382021-10-11 21:45:31 +08001197 */
Glenn Strauss60bfe602022-03-14 19:04:24 -04001198 if( ( mbedtls_ssl_validate_ciphersuite( ssl, ciphersuite_info,
1199 ssl->tls_version,
1200 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +00001201 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
Jerry Yue1b9c292021-09-10 10:08:31 +08001202 {
XiaokangQian52da5582022-01-26 09:49:29 +00001203 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
Jerry Yue1b9c292021-09-10 10:08:31 +08001204 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001205 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001206 * If we received an HRR before and that the proposed selected
1207 * ciphersuite in this server hello is not the same as the one
1208 * proposed in the HRR, we abort the handshake and send an
1209 * "illegal_parameter" alert.
XiaokangQian53f20b72022-01-18 10:47:33 +00001210 */
XiaokangQian355e09a2022-01-20 11:14:50 +00001211 else if( ( !is_hrr ) && ( handshake->hello_retry_request_count > 0 ) &&
1212 ( cipher_suite != ssl->session_negotiate->ciphersuite ) )
XiaokangQian53f20b72022-01-18 10:47:33 +00001213 {
XiaokangQian52da5582022-01-26 09:49:29 +00001214 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQian355e09a2022-01-20 11:14:50 +00001215 }
XiaokangQian53f20b72022-01-18 10:47:33 +00001216
XiaokangQian52da5582022-01-26 09:49:29 +00001217 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQian355e09a2022-01-20 11:14:50 +00001218 {
1219 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid ciphersuite(%04x) parameter",
1220 cipher_suite ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001221 goto cleanup;
XiaokangQian53f20b72022-01-18 10:47:33 +00001222 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001223
Jerry Yu4a173382021-10-11 21:45:31 +08001224 /* Configure ciphersuites */
1225 mbedtls_ssl_optimize_checksum( ssl, ciphersuite_info );
1226
XiaokangQian355e09a2022-01-20 11:14:50 +00001227 handshake->ciphersuite_info = ciphersuite_info;
Jerry Yue1b9c292021-09-10 10:08:31 +08001228 ssl->session_negotiate->ciphersuite = cipher_suite;
1229
Jerry Yue1b9c292021-09-10 10:08:31 +08001230 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, chosen ciphersuite: ( %04x ) - %s",
1231 cipher_suite, ciphersuite_info->name ) );
1232
1233#if defined(MBEDTLS_HAVE_TIME)
1234 ssl->session_negotiate->start = time( NULL );
1235#endif /* MBEDTLS_HAVE_TIME */
1236
Jerry Yu4a173382021-10-11 21:45:31 +08001237 /* ...
1238 * uint8 legacy_compression_method = 0;
1239 * ...
Jerry Yue1b9c292021-09-10 10:08:31 +08001240 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001241 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
Thomas Daubney31e03a82022-07-25 15:59:25 +01001242 if( p[0] != MBEDTLS_SSL_COMPRESS_NULL )
Jerry Yue1b9c292021-09-10 10:08:31 +08001243 {
Jerry Yub85277e2021-10-13 13:36:05 +08001244 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
XiaokangQian52da5582022-01-26 09:49:29 +00001245 fatal_alert = MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER;
XiaokangQiand59be772022-01-24 10:12:51 +00001246 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001247 }
1248 p++;
1249
Jerry Yub85277e2021-10-13 13:36:05 +08001250 /* ...
1251 * Extension extensions<6..2^16-1>;
1252 * ...
Jerry Yu4a173382021-10-11 21:45:31 +08001253 * struct {
1254 * ExtensionType extension_type; (2 bytes)
1255 * opaque extension_data<0..2^16-1>;
1256 * } Extension;
1257 */
Jerry Yude4fb2c2021-09-19 18:05:08 +08001258 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yu4a173382021-10-11 21:45:31 +08001259 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001260 p += 2;
Jerry Yude4fb2c2021-09-19 18:05:08 +08001261
Jerry Yu4a173382021-10-11 21:45:31 +08001262 /* Check extensions do not go beyond the buffer of data. */
1263 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1264 extensions_end = p + extensions_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001265
Jerry Yu4a173382021-10-11 21:45:31 +08001266 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello extensions", p, extensions_len );
Jerry Yue1b9c292021-09-10 10:08:31 +08001267
Jerry Yu4a173382021-10-11 21:45:31 +08001268 while( p < extensions_end )
Jerry Yue1b9c292021-09-10 10:08:31 +08001269 {
1270 unsigned int extension_type;
1271 size_t extension_data_len;
XiaokangQian43550bd2022-01-21 04:32:58 +00001272 const unsigned char *extension_data_end;
Jerry Yue1b9c292021-09-10 10:08:31 +08001273
Jerry Yu4a173382021-10-11 21:45:31 +08001274 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
Jerry Yue1b9c292021-09-10 10:08:31 +08001275 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1276 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1277 p += 4;
1278
Jerry Yu4a173382021-10-11 21:45:31 +08001279 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian43550bd2022-01-21 04:32:58 +00001280 extension_data_end = p + extension_data_len;
Jerry Yue1b9c292021-09-10 10:08:31 +08001281
1282 switch( extension_type )
1283 {
XiaokangQianb851da82022-01-14 04:03:11 +00001284 case MBEDTLS_TLS_EXT_COOKIE:
1285
XiaokangQiand9e068e2022-01-18 06:23:32 +00001286 if( !is_hrr )
1287 {
XiaokangQian52da5582022-01-26 09:49:29 +00001288 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001289 goto cleanup;
XiaokangQiand9e068e2022-01-18 06:23:32 +00001290 }
1291
XiaokangQian43550bd2022-01-21 04:32:58 +00001292 ret = ssl_tls13_parse_cookie_ext( ssl,
1293 p, extension_data_end );
1294 if( ret != 0 )
XiaokangQianb851da82022-01-14 04:03:11 +00001295 {
XiaokangQian43550bd2022-01-21 04:32:58 +00001296 MBEDTLS_SSL_DEBUG_RET( 1,
1297 "ssl_tls13_parse_cookie_ext",
1298 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001299 goto cleanup;
XiaokangQianb851da82022-01-14 04:03:11 +00001300 }
XiaokangQianb851da82022-01-14 04:03:11 +00001301 break;
XiaokangQianb851da82022-01-14 04:03:11 +00001302
Jerry Yue1b9c292021-09-10 10:08:31 +08001303 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
Jerry Yuc068b662021-10-11 22:30:19 +08001304 ret = ssl_tls13_parse_supported_versions_ext( ssl,
Jerry Yub85277e2021-10-13 13:36:05 +08001305 p,
XiaokangQian43550bd2022-01-21 04:32:58 +00001306 extension_data_end );
Jerry Yue1b9c292021-09-10 10:08:31 +08001307 if( ret != 0 )
XiaokangQiand59be772022-01-24 10:12:51 +00001308 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001309 break;
1310
XiaokangQianeb69aee2022-07-05 08:21:43 +00001311#if defined(MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED)
Jerry Yue1b9c292021-09-10 10:08:31 +08001312 case MBEDTLS_TLS_EXT_PRE_SHARED_KEY:
XiaokangQianeb69aee2022-07-05 08:21:43 +00001313 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found pre_shared_key extension" ) );
1314 if( is_hrr )
1315 {
1316 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
1317 goto cleanup;
1318 }
Jerry Yu4a173382021-10-11 21:45:31 +08001319
XiaokangQian86981952022-07-19 09:51:50 +00001320 if( ( ret = ssl_tls13_parse_server_pre_shared_key_ext(
XiaokangQian008d2bf2022-07-14 07:54:01 +00001321 ssl, p, extension_data_end ) ) != 0 )
XiaokangQianeb69aee2022-07-05 08:21:43 +00001322 {
1323 MBEDTLS_SSL_DEBUG_RET(
XiaokangQian86981952022-07-19 09:51:50 +00001324 1, ( "ssl_tls13_parse_server_pre_shared_key_ext" ), ret );
XiaokangQianeb69aee2022-07-05 08:21:43 +00001325 return( ret );
1326 }
1327 break;
1328#endif /* MBEDTLS_KEY_EXCHANGE_SOME_PSK_ENABLED */
Jerry Yue1b9c292021-09-10 10:08:31 +08001329
Jerry Yue1b9c292021-09-10 10:08:31 +08001330 case MBEDTLS_TLS_EXT_KEY_SHARE:
1331 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key_shares extension" ) );
XiaokangQiand59be772022-01-24 10:12:51 +00001332 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1333 {
XiaokangQian52da5582022-01-26 09:49:29 +00001334 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001335 goto cleanup;
1336 }
1337
XiaokangQian53f20b72022-01-18 10:47:33 +00001338 if( is_hrr )
XiaokangQiand9e068e2022-01-18 06:23:32 +00001339 ret = ssl_tls13_parse_hrr_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001340 p, extension_data_end );
XiaokangQian53f20b72022-01-18 10:47:33 +00001341 else
XiaokangQianb851da82022-01-14 04:03:11 +00001342 ret = ssl_tls13_parse_key_share_ext( ssl,
XiaokangQian43550bd2022-01-21 04:32:58 +00001343 p, extension_data_end );
XiaokangQianb851da82022-01-14 04:03:11 +00001344 if( ret != 0 )
Jerry Yue1b9c292021-09-10 10:08:31 +08001345 {
1346 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu4a173382021-10-11 21:45:31 +08001347 "ssl_tls13_parse_key_share_ext",
Jerry Yue1b9c292021-09-10 10:08:31 +08001348 ret );
XiaokangQiand59be772022-01-24 10:12:51 +00001349 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001350 }
1351 break;
Jerry Yue1b9c292021-09-10 10:08:31 +08001352
1353 default:
Jerry Yu4a173382021-10-11 21:45:31 +08001354 MBEDTLS_SSL_DEBUG_MSG(
1355 3,
1356 ( "unknown extension found: %u ( ignoring )",
1357 extension_type ) );
1358
XiaokangQian52da5582022-01-26 09:49:29 +00001359 fatal_alert = MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT;
XiaokangQiand59be772022-01-24 10:12:51 +00001360 goto cleanup;
Jerry Yue1b9c292021-09-10 10:08:31 +08001361 }
1362
1363 p += extension_data_len;
1364 }
1365
XiaokangQiand59be772022-01-24 10:12:51 +00001366cleanup:
1367
XiaokangQian52da5582022-01-26 09:49:29 +00001368 if( fatal_alert == MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT )
XiaokangQiand59be772022-01-24 10:12:51 +00001369 {
1370 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
1371 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1372 ret = MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION;
1373 }
XiaokangQian52da5582022-01-26 09:49:29 +00001374 else if ( fatal_alert == MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER )
XiaokangQiand59be772022-01-24 10:12:51 +00001375 {
1376 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
1377 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
1378 ret = MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER;
1379 }
1380 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001381}
1382
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001383#if defined(MBEDTLS_DEBUG_C)
1384static const char *ssl_tls13_get_kex_mode_str(int mode)
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001385{
1386 switch( mode )
1387 {
1388 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK:
1389 return "psk";
1390 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL:
1391 return "ephemeral";
1392 case MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL:
1393 return "psk_ephemeral";
1394 default:
1395 return "unknown mode";
1396 }
1397}
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001398#endif /* MBEDTLS_DEBUG_C */
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001399
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001400MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001401static int ssl_tls13_postprocess_server_hello( mbedtls_ssl_context *ssl )
Jerry Yue1b9c292021-09-10 10:08:31 +08001402{
Jerry Yub85277e2021-10-13 13:36:05 +08001403 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yub85277e2021-10-13 13:36:05 +08001404 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Jerry Yu0b177842021-09-05 19:41:30 +08001405
Jerry Yub85277e2021-10-13 13:36:05 +08001406 /* Determine the key exchange mode:
1407 * 1) If both the pre_shared_key and key_share extensions were received
1408 * then the key exchange mode is PSK with EPHEMERAL.
1409 * 2) If only the pre_shared_key extension was received then the key
1410 * exchange mode is PSK-only.
1411 * 3) If only the key_share extension was received then the key
1412 * exchange mode is EPHEMERAL-only.
Jerry Yu0b177842021-09-05 19:41:30 +08001413 */
Jerry Yub85277e2021-10-13 13:36:05 +08001414 switch( handshake->extensions_present &
1415 ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ) )
Jerry Yu0b177842021-09-05 19:41:30 +08001416 {
Jerry Yu745bb612021-10-13 22:01:04 +08001417 /* Only the pre_shared_key extension was received */
1418 case MBEDTLS_SSL_EXT_PRE_SHARED_KEY:
Ronald Cron79907712022-07-20 17:05:29 +02001419 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK;
Jerry Yu745bb612021-10-13 22:01:04 +08001420 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001421
Jerry Yu745bb612021-10-13 22:01:04 +08001422 /* Only the key_share extension was received */
1423 case MBEDTLS_SSL_EXT_KEY_SHARE:
Ronald Cron79907712022-07-20 17:05:29 +02001424 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001425 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001426
Jerry Yu745bb612021-10-13 22:01:04 +08001427 /* Both the pre_shared_key and key_share extensions were received */
1428 case ( MBEDTLS_SSL_EXT_PRE_SHARED_KEY | MBEDTLS_SSL_EXT_KEY_SHARE ):
Ronald Cron79907712022-07-20 17:05:29 +02001429 handshake->key_exchange_mode = MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL;
Jerry Yu745bb612021-10-13 22:01:04 +08001430 break;
Jerry Yub85277e2021-10-13 13:36:05 +08001431
Jerry Yu745bb612021-10-13 22:01:04 +08001432 /* Neither pre_shared_key nor key_share extension was received */
1433 default:
1434 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unknown key exchange." ) );
1435 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1436 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001437 }
1438
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001439 if( !mbedtls_ssl_conf_tls13_check_kex_modes( ssl, handshake->key_exchange_mode ) )
1440 {
1441 ret = MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE;
1442 MBEDTLS_SSL_DEBUG_MSG( 2,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001443 ( "Key exchange mode(%s) is not supported.",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001444 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qianac8195f2022-09-26 04:01:06 +00001445 goto cleanup;
1446 }
1447
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001448 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaokang Qianca343ae2022-09-28 02:07:54 +00001449 ( "Selected key exchange mode: %s",
Xiaokang Qiancb6e9632022-09-26 11:59:32 +00001450 ssl_tls13_get_kex_mode_str( handshake->key_exchange_mode ) ) );
Xiaokang Qian5beec4b2022-09-26 08:23:45 +00001451
Jerry Yu0b177842021-09-05 19:41:30 +08001452 /* Start the TLS 1.3 key schedule: Set the PSK and derive early secret.
1453 *
1454 * TODO: We don't have to do this in case we offered 0-RTT and the
1455 * server accepted it. In this case, we could skip generating
1456 * the early secret. */
Xiaofei Bai746f9482021-11-12 08:53:56 +00001457 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001458 if( ret != 0 )
1459 {
Jerry Yue110d252022-05-05 10:19:22 +08001460 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_tls13_key_schedule_stage_early",
Jerry Yu0b177842021-09-05 19:41:30 +08001461 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001462 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001463 }
1464
Jerry Yuf86eb752022-05-06 11:16:55 +08001465 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yu0b177842021-09-05 19:41:30 +08001466 if( ret != 0 )
1467 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001468 MBEDTLS_SSL_DEBUG_RET( 1,
1469 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yuc068b662021-10-11 22:30:19 +08001470 ret );
Jerry Yu4a173382021-10-11 21:45:31 +08001471 goto cleanup;
Jerry Yu0b177842021-09-05 19:41:30 +08001472 }
1473
Jerry Yue110d252022-05-05 10:19:22 +08001474 mbedtls_ssl_set_inbound_transform( ssl, handshake->transform_handshake );
Jerry Yu0b177842021-09-05 19:41:30 +08001475 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Switch to handshake keys for inbound traffic" ) );
1476 ssl->session_in = ssl->session_negotiate;
1477
Jerry Yu4a173382021-10-11 21:45:31 +08001478cleanup:
Jerry Yu4a173382021-10-11 21:45:31 +08001479 if( ret != 0 )
1480 {
Jerry Yu4a173382021-10-11 21:45:31 +08001481 MBEDTLS_SSL_PEND_FATAL_ALERT(
1482 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1483 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1484 }
Jerry Yue110d252022-05-05 10:19:22 +08001485
Jerry Yu4a173382021-10-11 21:45:31 +08001486 return( ret );
Jerry Yue1b9c292021-09-10 10:08:31 +08001487}
1488
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001489MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian355e09a2022-01-20 11:14:50 +00001490static int ssl_tls13_postprocess_hrr( mbedtls_ssl_context *ssl )
XiaokangQian647719a2021-12-07 09:16:29 +00001491{
1492 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1493
XiaokangQian78b1fa72022-01-19 06:56:30 +00001494 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
XiaokangQian647719a2021-12-07 09:16:29 +00001495
XiaokangQian78b1fa72022-01-19 06:56:30 +00001496 /*
XiaokangQian355e09a2022-01-20 11:14:50 +00001497 * We are going to re-generate a shared secret corresponding to the group
1498 * selected by the server, which is different from the group for which we
1499 * generated a shared secret in the first client hello.
1500 * Thus, reset the shared secret.
XiaokangQian51eff222021-12-10 10:33:56 +00001501 */
XiaokangQian16acd4b2022-01-14 07:35:47 +00001502 ret = ssl_tls13_reset_key_share( ssl );
XiaokangQian647719a2021-12-07 09:16:29 +00001503 if( ret != 0 )
1504 return( ret );
1505
1506 return( 0 );
1507}
1508
Jerry Yue1b9c292021-09-10 10:08:31 +08001509/*
Jerry Yu4a173382021-10-11 21:45:31 +08001510 * Wait and parse ServerHello handshake message.
Jerry Yu687101b2021-09-14 16:03:56 +08001511 * Handler for MBEDTLS_SSL_SERVER_HELLO
1512 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001513MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001514static int ssl_tls13_process_server_hello( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001515{
Jerry Yu4a173382021-10-11 21:45:31 +08001516 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian647719a2021-12-07 09:16:29 +00001517 unsigned char *buf = NULL;
1518 size_t buf_len = 0;
XiaokangQian78b1fa72022-01-19 06:56:30 +00001519 int is_hrr = 0;
Jerry Yue1b9c292021-09-10 10:08:31 +08001520
1521 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> %s", __func__ ) );
1522
Ronald Crondb5dfa12022-05-31 11:44:38 +02001523 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1524 MBEDTLS_SSL_HS_SERVER_HELLO,
1525 &buf, &buf_len ) );
1526
Ronald Cron828aff62022-05-31 12:04:31 +02001527 ret = ssl_tls13_preprocess_server_hello( ssl, buf, buf + buf_len );
XiaokangQiand9e068e2022-01-18 06:23:32 +00001528 if( ret < 0 )
XiaokangQian16acd4b2022-01-14 07:35:47 +00001529 goto cleanup;
1530 else
Ronald Cron828aff62022-05-31 12:04:31 +02001531 is_hrr = ( ret == SSL_SERVER_HELLO_HRR );
XiaokangQiand59be772022-01-24 10:12:51 +00001532
Ronald Cron828aff62022-05-31 12:04:31 +02001533 if( ret == SSL_SERVER_HELLO_TLS1_2 )
Ronald Cron9f0fba32022-02-10 16:45:15 +01001534 {
1535 ret = 0;
1536 goto cleanup;
1537 }
1538
XiaokangQianb851da82022-01-14 04:03:11 +00001539 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_server_hello( ssl, buf,
XiaokangQiand9e068e2022-01-18 06:23:32 +00001540 buf + buf_len,
1541 is_hrr ) );
1542 if( is_hrr )
XiaokangQian647719a2021-12-07 09:16:29 +00001543 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_reset_transcript_for_hrr( ssl ) );
1544
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001545 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_SERVER_HELLO,
1546 buf, buf_len );
XiaokangQian647719a2021-12-07 09:16:29 +00001547
XiaokangQiand9e068e2022-01-18 06:23:32 +00001548 if( is_hrr )
Ronald Cronfb508b82022-05-31 14:49:55 +02001549 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001550 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_hrr( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001551#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1552 /* If not offering early data, the client sends a dummy CCS record
1553 * immediately before its second flight. This may either be before
1554 * its second ClientHello or before its encrypted handshake flight.
1555 */
1556 mbedtls_ssl_handshake_set_state( ssl,
1557 MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO );
1558#else
1559 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1560#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
1561 }
XiaokangQiand9e068e2022-01-18 06:23:32 +00001562 else
Ronald Cronfb508b82022-05-31 14:49:55 +02001563 {
XiaokangQian355e09a2022-01-20 11:14:50 +00001564 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_server_hello( ssl ) );
Ronald Cronfb508b82022-05-31 14:49:55 +02001565 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
1566 }
Jerry Yue1b9c292021-09-10 10:08:31 +08001567
1568cleanup:
XiaokangQiana9090612022-01-27 03:48:27 +00001569 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= %s ( %s )", __func__,
1570 is_hrr?"HelloRetryRequest":"ServerHello" ) );
Jerry Yue1b9c292021-09-10 10:08:31 +08001571 return( ret );
Jerry Yu687101b2021-09-14 16:03:56 +08001572}
1573
1574/*
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001575 *
Ronald Cron9d6a5452022-05-30 16:05:38 +02001576 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001577 *
1578 * The EncryptedExtensions message contains any extensions which
1579 * should be protected, i.e., any which are not needed to establish
1580 * the cryptographic context.
Jerry Yu687101b2021-09-14 16:03:56 +08001581 */
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001582
XiaokangQian08da26c2021-10-09 10:12:11 +00001583/* Parse EncryptedExtensions message
1584 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001585 * Extension extensions<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001586 * } EncryptedExtensions;
1587 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001588MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian97799ac2021-10-11 10:05:54 +00001589static int ssl_tls13_parse_encrypted_extensions( mbedtls_ssl_context *ssl,
1590 const unsigned char *buf,
1591 const unsigned char *end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001592{
1593 int ret = 0;
XiaokangQian08da26c2021-10-09 10:12:11 +00001594 size_t extensions_len;
XiaokangQian140f0452021-10-08 08:05:53 +00001595 const unsigned char *p = buf;
XiaokangQian8db25ff2021-10-13 05:56:18 +00001596 const unsigned char *extensions_end;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001597
XiaokangQian08da26c2021-10-09 10:12:11 +00001598 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian97799ac2021-10-11 10:05:54 +00001599 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001600 p += 2;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001601
XiaokangQian97799ac2021-10-11 10:05:54 +00001602 MBEDTLS_SSL_DEBUG_BUF( 3, "encrypted extensions", p, extensions_len );
XiaokangQian8db25ff2021-10-13 05:56:18 +00001603 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
Ronald Cronc8083592022-05-31 16:24:05 +02001604 extensions_end = p + extensions_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001605
XiaokangQian8db25ff2021-10-13 05:56:18 +00001606 while( p < extensions_end )
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001607 {
XiaokangQian08da26c2021-10-09 10:12:11 +00001608 unsigned int extension_type;
1609 size_t extension_data_len;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001610
XiaokangQian08da26c2021-10-09 10:12:11 +00001611 /*
1612 * struct {
XiaokangQian97799ac2021-10-11 10:05:54 +00001613 * ExtensionType extension_type; (2 bytes)
1614 * opaque extension_data<0..2^16-1>;
XiaokangQian08da26c2021-10-09 10:12:11 +00001615 * } Extension;
1616 */
XiaokangQian8db25ff2021-10-13 05:56:18 +00001617 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian08da26c2021-10-09 10:12:11 +00001618 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1619 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1620 p += 4;
1621
XiaokangQian8db25ff2021-10-13 05:56:18 +00001622 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001623
XiaokangQian97799ac2021-10-11 10:05:54 +00001624 /* The client MUST check EncryptedExtensions for the
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001625 * presence of any forbidden extensions and if any are found MUST abort
XiaokangQian08da26c2021-10-09 10:12:11 +00001626 * the handshake with an "unsupported_extension" alert.
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001627 */
XiaokangQian08da26c2021-10-09 10:12:11 +00001628 switch( extension_type )
1629 {
Jerry Yu661dd942022-08-03 14:50:01 +08001630 case MBEDTLS_TLS_EXT_SERVERNAME:
1631 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found server_name extension" ) );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001632
Jerry Yu661dd942022-08-03 14:50:01 +08001633 /* The server_name extension should be an empty extension */
1634
1635 break;
XiaokangQian08da26c2021-10-09 10:12:11 +00001636 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
1637 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found extensions supported groups" ) );
1638 break;
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001639
lhuang0486cacac2022-01-21 07:34:27 -08001640#if defined(MBEDTLS_SSL_ALPN)
1641 case MBEDTLS_TLS_EXT_ALPN:
1642 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found alpn extension" ) );
1643
1644 if( ( ret = ssl_tls13_parse_alpn_ext( ssl, p, (size_t)extension_data_len ) ) != 0 )
1645 {
1646 return( ret );
1647 }
1648
1649 break;
1650#endif /* MBEDTLS_SSL_ALPN */
XiaokangQian08da26c2021-10-09 10:12:11 +00001651 default:
XiaokangQian97799ac2021-10-11 10:05:54 +00001652 MBEDTLS_SSL_DEBUG_MSG(
1653 3, ( "unsupported extension found: %u ", extension_type) );
1654 MBEDTLS_SSL_PEND_FATAL_ALERT(
Jerry Yu7aa71862021-10-28 21:41:30 +08001655 MBEDTLS_SSL_ALERT_MSG_UNSUPPORTED_EXT,
XiaokangQian97799ac2021-10-11 10:05:54 +00001656 MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
1657 return ( MBEDTLS_ERR_SSL_UNSUPPORTED_EXTENSION );
XiaokangQian08da26c2021-10-09 10:12:11 +00001658 }
1659
XiaokangQian08da26c2021-10-09 10:12:11 +00001660 p += extension_data_len;
XiaokangQian97799ac2021-10-11 10:05:54 +00001661 }
XiaokangQian08da26c2021-10-09 10:12:11 +00001662
XiaokangQian97799ac2021-10-11 10:05:54 +00001663 /* Check that we consumed all the message. */
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00001664 if( p != end )
XiaokangQian97799ac2021-10-11 10:05:54 +00001665 {
1666 MBEDTLS_SSL_DEBUG_MSG( 1, ( "EncryptedExtension lengths misaligned" ) );
Jerry Yu7aa71862021-10-28 21:41:30 +08001667 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
XiaokangQian7b2d4ef2021-10-13 10:19:02 +00001668 MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian97799ac2021-10-11 10:05:54 +00001669 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
XiaokangQian2d5c72b2021-09-13 07:30:09 +00001670 }
1671
1672 return( ret );
1673}
1674
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001675MBEDTLS_CHECK_RETURN_CRITICAL
Ronald Cron9d6a5452022-05-30 16:05:38 +02001676static int ssl_tls13_process_encrypted_extensions( mbedtls_ssl_context *ssl )
1677{
1678 int ret;
1679 unsigned char *buf;
1680 size_t buf_len;
1681
1682 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse encrypted extensions" ) );
1683
1684 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1685 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
1686 &buf, &buf_len ) );
1687
1688 /* Process the message contents */
1689 MBEDTLS_SSL_PROC_CHK(
1690 ssl_tls13_parse_encrypted_extensions( ssl, buf, buf + buf_len ) );
1691
1692 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS,
1693 buf, buf_len );
1694
Ronald Cronfb508b82022-05-31 14:49:55 +02001695#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron79907712022-07-20 17:05:29 +02001696 if( mbedtls_ssl_tls13_key_exchange_mode_with_psk( ssl ) )
Ronald Cronfb508b82022-05-31 14:49:55 +02001697 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1698 else
1699 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
1700#else
1701 ((void) ssl);
1702 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1703#endif
Ronald Cron9d6a5452022-05-30 16:05:38 +02001704
1705cleanup:
1706
1707 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse encrypted extensions" ) );
1708 return( ret );
1709
1710}
1711
Jerry Yua93ac112021-10-27 16:31:48 +08001712#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu687101b2021-09-14 16:03:56 +08001713/*
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001714 * STATE HANDLING: CertificateRequest
1715 *
Jerry Yud2674312021-10-29 10:08:19 +08001716 */
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001717#define SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST 0
1718#define SSL_CERTIFICATE_REQUEST_SKIP 1
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001719/* Coordination:
1720 * Deals with the ambiguity of not knowing if a CertificateRequest
1721 * will be sent. Returns a negative code on failure, or
1722 * - SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST
1723 * - SSL_CERTIFICATE_REQUEST_SKIP
1724 * indicating if a Certificate Request is expected or not.
1725 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001726MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001727static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
Jerry Yud2674312021-10-29 10:08:19 +08001728{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00001729 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yud2674312021-10-29 10:08:19 +08001730
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001731 if( ( ret = mbedtls_ssl_read_record( ssl, 0 ) ) != 0 )
Jerry Yud2674312021-10-29 10:08:19 +08001732 {
1733 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_read_record", ret );
1734 return( ret );
1735 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001736 ssl->keep_current_message = 1;
Jerry Yud2674312021-10-29 10:08:19 +08001737
1738 if( ( ssl->in_msgtype == MBEDTLS_SSL_MSG_HANDSHAKE ) &&
1739 ( ssl->in_msg[0] == MBEDTLS_SSL_HS_CERTIFICATE_REQUEST ) )
1740 {
Ronald Cron19385882022-06-15 16:26:13 +02001741 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got a certificate request" ) );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001742 return( SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST );
Jerry Yud2674312021-10-29 10:08:19 +08001743 }
1744
Ronald Cron19385882022-06-15 16:26:13 +02001745 MBEDTLS_SSL_DEBUG_MSG( 3, ( "got no certificate request" ) );
1746
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001747 return( SSL_CERTIFICATE_REQUEST_SKIP );
1748}
1749
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001750/*
1751 * ssl_tls13_parse_certificate_request()
1752 * Parse certificate request
1753 * struct {
1754 * opaque certificate_request_context<0..2^8-1>;
1755 * Extension extensions<2..2^16-1>;
1756 * } CertificateRequest;
1757 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001758MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001759static int ssl_tls13_parse_certificate_request( mbedtls_ssl_context *ssl,
1760 const unsigned char *buf,
1761 const unsigned char *end )
1762{
1763 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1764 const unsigned char *p = buf;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001765 size_t certificate_request_context_len = 0;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001766 size_t extensions_len = 0;
1767 const unsigned char *extensions_end;
1768 unsigned char sig_alg_ext_found = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001769
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001770 /* ...
1771 * opaque certificate_request_context<0..2^8-1>
1772 * ...
1773 */
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001774 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
1775 certificate_request_context_len = (size_t) p[0];
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001776 p += 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001777
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001778 if( certificate_request_context_len > 0 )
1779 {
Xiaofei Baic234ecf2022-02-08 09:59:23 +00001780 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001781 MBEDTLS_SSL_DEBUG_BUF( 3, "Certificate Request Context",
1782 p, certificate_request_context_len );
1783
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001784 mbedtls_ssl_handshake_params *handshake = ssl->handshake;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001785 handshake->certificate_request_context =
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00001786 mbedtls_calloc( 1, certificate_request_context_len );
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001787 if( handshake->certificate_request_context == NULL )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001788 {
1789 MBEDTLS_SSL_DEBUG_MSG( 1, ( "buffer too small" ) );
1790 return ( MBEDTLS_ERR_SSL_ALLOC_FAILED );
1791 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001792 memcpy( handshake->certificate_request_context, p,
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001793 certificate_request_context_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001794 p += certificate_request_context_len;
1795 }
1796
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001797 /* ...
1798 * Extension extensions<2..2^16-1>;
1799 * ...
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001800 */
1801 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
1802 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
1803 p += 2;
1804
1805 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
1806 extensions_end = p + extensions_len;
1807
1808 while( p < extensions_end )
1809 {
1810 unsigned int extension_type;
1811 size_t extension_data_len;
1812
1813 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
1814 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
1815 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
1816 p += 4;
1817
1818 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
1819
1820 switch( extension_type )
1821 {
1822 case MBEDTLS_TLS_EXT_SIG_ALG:
1823 MBEDTLS_SSL_DEBUG_MSG( 3,
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001824 ( "found signature algorithms extension" ) );
Gabor Mezei078e8032022-04-27 21:17:56 +02001825 ret = mbedtls_ssl_parse_sig_alg_ext( ssl, p,
Gabor Mezei696956d2022-05-13 16:27:29 +02001826 p + extension_data_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001827 if( ret != 0 )
1828 return( ret );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001829 if( ! sig_alg_ext_found )
1830 sig_alg_ext_found = 1;
1831 else
1832 {
1833 MBEDTLS_SSL_DEBUG_MSG( 3,
1834 ( "Duplicate signature algorithms extensions found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00001835 goto decode_error;
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001836 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001837 break;
1838
1839 default:
1840 MBEDTLS_SSL_DEBUG_MSG(
1841 3,
1842 ( "unknown extension found: %u ( ignoring )",
1843 extension_type ) );
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001844 break;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001845 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001846 p += extension_data_len;
1847 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001848 /* Check that we consumed all the message. */
1849 if( p != end )
1850 {
1851 MBEDTLS_SSL_DEBUG_MSG( 1,
Xiaofei Baic234ecf2022-02-08 09:59:23 +00001852 ( "CertificateRequest misaligned" ) );
1853 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001854 }
1855 /* Check that we found signature algorithms extension */
Xiaofei Bai82f0a9a2022-01-26 09:21:54 +00001856 if( ! sig_alg_ext_found )
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001857 {
Xiaofei Bai6d42bb42022-01-28 08:52:13 +00001858 MBEDTLS_SSL_DEBUG_MSG( 3,
1859 ( "no signature algorithms extension found" ) );
Xiaofei Baic234ecf2022-02-08 09:59:23 +00001860 goto decode_error;
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001861 }
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001862
Jerry Yu7840f812022-01-29 10:26:51 +08001863 ssl->handshake->client_auth = 1;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001864 return( 0 );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00001865
Xiaofei Baic234ecf2022-02-08 09:59:23 +00001866decode_error:
Xiaofei Bai51f515a2022-02-08 07:28:04 +00001867 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_DECODE_ERROR,
1868 MBEDTLS_ERR_SSL_DECODE_ERROR );
1869 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001870}
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001871
Xiaofei Baide3f13e2022-01-18 05:47:05 +00001872/*
1873 * Handler for MBEDTLS_SSL_CERTIFICATE_REQUEST
1874 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001875MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Baide3f13e2022-01-18 05:47:05 +00001876static int ssl_tls13_process_certificate_request( mbedtls_ssl_context *ssl )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001877{
Xiaofei Baide3f13e2022-01-18 05:47:05 +00001878 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001879
1880 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse certificate request" ) );
1881
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001882 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
1883
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001884 if( ret == SSL_CERTIFICATE_REQUEST_EXPECT_REQUEST )
1885 {
1886 unsigned char *buf;
1887 size_t buf_len;
1888
1889 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg( ssl,
1890 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
1891 &buf, &buf_len ) );
1892
1893 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_certificate_request( ssl,
1894 buf, buf + buf_len ) );
1895
Ronald Cron8f6d39a2022-03-10 18:56:50 +01001896 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST,
1897 buf, buf_len );
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001898 }
Xiaofei Bai69fcd392022-01-20 08:25:00 +00001899 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001900 {
Xiaofei Baif6d36962022-01-16 14:54:35 +00001901 ret = 0;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001902 }
1903 else
1904 {
1905 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
Xiaofei Bai51f515a2022-02-08 07:28:04 +00001906 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1907 goto cleanup;
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001908 }
1909
Jerry Yud2674312021-10-29 10:08:19 +08001910 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
1911
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001912cleanup:
1913
Xiaofei Baia0ab7772022-01-16 12:14:45 +00001914 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse certificate request" ) );
1915 return( ret );
Jerry Yud2674312021-10-29 10:08:19 +08001916}
1917
1918/*
Jerry Yu687101b2021-09-14 16:03:56 +08001919 * Handler for MBEDTLS_SSL_SERVER_CERTIFICATE
1920 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001921MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001922static int ssl_tls13_process_server_certificate( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001923{
Xiaofei Bai947571e2021-09-29 09:12:03 +00001924 int ret;
1925
1926 ret = mbedtls_ssl_tls13_process_certificate( ssl );
Xiaofei Baif93cbd22021-10-29 02:39:30 +00001927 if( ret != 0 )
Xiaofei Bai947571e2021-09-29 09:12:03 +00001928 return( ret );
1929
Jerry Yu687101b2021-09-14 16:03:56 +08001930 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_VERIFY );
1931 return( 0 );
1932}
1933
1934/*
1935 * Handler for MBEDTLS_SSL_CERTIFICATE_VERIFY
1936 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001937MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001938static int ssl_tls13_process_certificate_verify( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001939{
Jerry Yu30b071c2021-09-12 20:16:03 +08001940 int ret;
1941
1942 ret = mbedtls_ssl_tls13_process_certificate_verify( ssl );
1943 if( ret != 0 )
1944 return( ret );
1945
Jerry Yu687101b2021-09-14 16:03:56 +08001946 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1947 return( 0 );
1948}
Jerry Yua93ac112021-10-27 16:31:48 +08001949#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Ronald Crond4c64022021-12-06 09:06:46 +01001950
Jerry Yu687101b2021-09-14 16:03:56 +08001951/*
1952 * Handler for MBEDTLS_SSL_SERVER_FINISHED
1953 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001954MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00001955static int ssl_tls13_process_server_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08001956{
XiaokangQianac0385c2021-11-03 06:40:11 +00001957 int ret;
1958
XiaokangQianc5c39d52021-11-09 11:55:10 +00001959 ret = mbedtls_ssl_tls13_process_finished_message( ssl );
XiaokangQianac0385c2021-11-03 06:40:11 +00001960 if( ret != 0 )
1961 return( ret );
1962
Jerry Yue3d67cb2022-05-19 15:33:10 +08001963 ret = mbedtls_ssl_tls13_compute_application_transform( ssl );
1964 if( ret != 0 )
1965 {
1966 MBEDTLS_SSL_PEND_FATAL_ALERT(
1967 MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
1968 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1969 return( ret );
1970 }
1971
Ronald Cron49ad6192021-11-24 16:25:31 +01001972#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
1973 mbedtls_ssl_handshake_set_state(
1974 ssl,
1975 MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED );
1976#else
Jerry Yuca133a32022-02-15 14:22:05 +08001977 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Jerry Yu566c7812022-01-26 15:41:22 +08001978#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
Ronald Cron49ad6192021-11-24 16:25:31 +01001979
XiaokangQianac0385c2021-11-03 06:40:11 +00001980 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08001981}
1982
1983/*
Jerry Yu566c7812022-01-26 15:41:22 +08001984 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE
1985 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02001986MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08001987static int ssl_tls13_write_client_certificate( mbedtls_ssl_context *ssl )
1988{
Ronald Cron7a94aca2022-03-09 07:44:27 +01001989 int non_empty_certificate_msg = 0;
1990
Jerry Yu5cc35062022-01-28 16:16:08 +08001991 MBEDTLS_SSL_DEBUG_MSG( 1,
1992 ( "Switch to handshake traffic keys for outbound traffic" ) );
Jerry Yu566c7812022-01-26 15:41:22 +08001993 mbedtls_ssl_set_outbound_transform( ssl, ssl->handshake->transform_handshake );
Jerry Yu5cc35062022-01-28 16:16:08 +08001994
Ronald Cron9df7c802022-03-08 18:38:54 +01001995#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Ronald Cron5bb8fc82022-03-09 07:00:13 +01001996 if( ssl->handshake->client_auth )
Ronald Cron7a94aca2022-03-09 07:44:27 +01001997 {
1998 int ret = mbedtls_ssl_tls13_write_certificate( ssl );
1999 if( ret != 0 )
2000 return( ret );
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002001
Ronald Cron7a94aca2022-03-09 07:44:27 +01002002 if( mbedtls_ssl_own_cert( ssl ) != NULL )
2003 non_empty_certificate_msg = 1;
2004 }
2005 else
2006 {
XiaokangQian23c5be62022-06-07 02:04:34 +00002007 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002008 }
Ronald Cron9df7c802022-03-08 18:38:54 +01002009#endif
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002010
Ronald Cron7a94aca2022-03-09 07:44:27 +01002011 if( non_empty_certificate_msg )
2012 {
2013 mbedtls_ssl_handshake_set_state( ssl,
2014 MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY );
2015 }
2016 else
Ronald Cron19385882022-06-15 16:26:13 +02002017 {
2018 MBEDTLS_SSL_DEBUG_MSG( 2, ( "skip write certificate verify" ) );
Ronald Cron7a94aca2022-03-09 07:44:27 +01002019 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
Ronald Cron19385882022-06-15 16:26:13 +02002020 }
Ronald Cron7a94aca2022-03-09 07:44:27 +01002021
Ronald Cron5bb8fc82022-03-09 07:00:13 +01002022 return( 0 );
Jerry Yu566c7812022-01-26 15:41:22 +08002023}
2024
Ronald Cron9df7c802022-03-08 18:38:54 +01002025#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002026/*
2027 * Handler for MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY
2028 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002029MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yu566c7812022-01-26 15:41:22 +08002030static int ssl_tls13_write_client_certificate_verify( mbedtls_ssl_context *ssl )
2031{
Ronald Crona8b38872022-03-09 07:59:25 +01002032 int ret = mbedtls_ssl_tls13_write_certificate_verify( ssl );
2033
2034 if( ret == 0 )
2035 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_FINISHED );
2036
2037 return( ret );
Jerry Yu566c7812022-01-26 15:41:22 +08002038}
Jerry Yu90f152d2022-01-29 22:12:42 +08002039#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002040
2041/*
Jerry Yu687101b2021-09-14 16:03:56 +08002042 * Handler for MBEDTLS_SSL_CLIENT_FINISHED
2043 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002044MBEDTLS_CHECK_RETURN_CRITICAL
XiaokangQian74af2a82021-09-22 07:40:30 +00002045static int ssl_tls13_write_client_finished( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002046{
XiaokangQian0fa66432021-11-15 03:33:57 +00002047 int ret;
2048
2049 ret = mbedtls_ssl_tls13_write_finished_message( ssl );
2050 if( ret != 0 )
2051 return( ret );
2052
Jerry Yu466dda82022-09-13 11:20:20 +08002053 ret = mbedtls_ssl_tls13_compute_resumption_master_secret( ssl );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002054 if( ret != 0 )
2055 {
2056 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yu466dda82022-09-13 11:20:20 +08002057 "mbedtls_ssl_tls13_compute_resumption_master_secret ", ret );
Jerry Yue3d67cb2022-05-19 15:33:10 +08002058 return ( ret );
2059 }
2060
XiaokangQian0fa66432021-11-15 03:33:57 +00002061 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_FLUSH_BUFFERS );
2062 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002063}
2064
2065/*
2066 * Handler for MBEDTLS_SSL_FLUSH_BUFFERS
2067 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002068MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002069static int ssl_tls13_flush_buffers( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002070{
Jerry Yu378254d2021-10-30 21:44:47 +08002071 MBEDTLS_SSL_DEBUG_MSG( 2, ( "handshake: done" ) );
Jerry Yuad8d0ba2021-09-28 17:58:26 +08002072 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_WRAPUP );
Jerry Yu687101b2021-09-14 16:03:56 +08002073 return( 0 );
2074}
2075
2076/*
2077 * Handler for MBEDTLS_SSL_HANDSHAKE_WRAPUP
2078 */
Manuel Pégourié-Gonnarda3115dc2022-06-17 10:52:54 +02002079MBEDTLS_CHECK_RETURN_CRITICAL
Xiaofei Bai746f9482021-11-12 08:53:56 +00002080static int ssl_tls13_handshake_wrapup( mbedtls_ssl_context *ssl )
Jerry Yu687101b2021-09-14 16:03:56 +08002081{
Jerry Yu378254d2021-10-30 21:44:47 +08002082
2083 mbedtls_ssl_tls13_handshake_wrapup( ssl );
2084
2085 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2086 return( 0 );
Jerry Yu687101b2021-09-14 16:03:56 +08002087}
2088
Jerry Yuf8a49942022-07-07 11:32:32 +00002089#if defined(MBEDTLS_SSL_SESSION_TICKETS)
2090
Jerry Yua0446a02022-07-13 11:22:55 +08002091MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002092static int ssl_tls13_parse_new_session_ticket_exts( mbedtls_ssl_context *ssl,
2093 const unsigned char *buf,
2094 const unsigned char *end )
Jerry Yuf8a49942022-07-07 11:32:32 +00002095{
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002096 const unsigned char *p = buf;
Jerry Yuf8a49942022-07-07 11:32:32 +00002097
2098 ((void) ssl);
2099
2100 while( p < end )
2101 {
2102 unsigned int extension_type;
2103 size_t extension_data_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002104
Jerry Yuf8a49942022-07-07 11:32:32 +00002105 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 4 );
2106 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
2107 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
2108 p += 4;
2109
2110 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extension_data_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002111
2112 switch( extension_type )
2113 {
2114 case MBEDTLS_TLS_EXT_EARLY_DATA:
2115 MBEDTLS_SSL_DEBUG_MSG( 4, ( "early_data extension received" ) );
2116 break;
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002117
Jerry Yuf8a49942022-07-07 11:32:32 +00002118 default:
2119 break;
2120 }
2121 p += extension_data_len;
2122 }
2123
2124 return( 0 );
2125}
2126
2127/*
Jerry Yu08aed4d2022-07-20 10:36:12 +08002128 * From RFC8446, page 74
2129 *
Jerry Yuf8a49942022-07-07 11:32:32 +00002130 * struct {
2131 * uint32 ticket_lifetime;
2132 * uint32 ticket_age_add;
2133 * opaque ticket_nonce<0..255>;
2134 * opaque ticket<1..2^16-1>;
2135 * Extension extensions<0..2^16-2>;
2136 * } NewSessionTicket;
2137 *
2138 */
Jerry Yua0446a02022-07-13 11:22:55 +08002139MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002140static int ssl_tls13_parse_new_session_ticket( mbedtls_ssl_context *ssl,
2141 unsigned char *buf,
Jerry Yucb3b1392022-07-12 06:09:38 +00002142 unsigned char *end,
2143 unsigned char **ticket_nonce,
2144 size_t *ticket_nonce_len )
Jerry Yuf8a49942022-07-07 11:32:32 +00002145{
2146 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2147 unsigned char *p = buf;
2148 mbedtls_ssl_session *session = ssl->session;
Jerry Yuf8a49942022-07-07 11:32:32 +00002149 size_t ticket_len;
2150 unsigned char *ticket;
2151 size_t extensions_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002152
Jerry Yucb3b1392022-07-12 06:09:38 +00002153 *ticket_nonce = NULL;
2154 *ticket_nonce_len = 0;
Jerry Yuf8a49942022-07-07 11:32:32 +00002155 /*
2156 * ticket_lifetime 4 bytes
2157 * ticket_age_add 4 bytes
Jerry Yu08aed4d2022-07-20 10:36:12 +08002158 * ticket_nonce_len 1 byte
Jerry Yuf8a49942022-07-07 11:32:32 +00002159 */
Jerry Yucb3b1392022-07-12 06:09:38 +00002160 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 9 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002161
2162 session->ticket_lifetime = MBEDTLS_GET_UINT32_BE( p, 0 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002163 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002164 ( "ticket_lifetime: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002165 ( unsigned int )session->ticket_lifetime ) );
2166
Jerry Yucb3b1392022-07-12 06:09:38 +00002167 session->ticket_age_add = MBEDTLS_GET_UINT32_BE( p, 4 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002168 MBEDTLS_SSL_DEBUG_MSG( 3,
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002169 ( "ticket_age_add: %u",
Jerry Yuf8a49942022-07-07 11:32:32 +00002170 ( unsigned int )session->ticket_age_add ) );
2171
Jerry Yucb3b1392022-07-12 06:09:38 +00002172 *ticket_nonce_len = p[8];
2173 p += 9;
2174
2175 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, *ticket_nonce_len );
2176 *ticket_nonce = p;
2177 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket_nonce:", *ticket_nonce, *ticket_nonce_len );
2178 p += *ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002179
2180 /* Ticket */
Jerry Yucb3b1392022-07-12 06:09:38 +00002181 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002182 ticket_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2183 p += 2;
2184 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, ticket_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002185 MBEDTLS_SSL_DEBUG_BUF( 3, "received ticket", p, ticket_len ) ;
2186
2187 /* Check if we previously received a ticket already. */
2188 if( session->ticket != NULL || session->ticket_len > 0 )
2189 {
2190 mbedtls_free( session->ticket );
2191 session->ticket = NULL;
2192 session->ticket_len = 0;
2193 }
2194
2195 if( ( ticket = mbedtls_calloc( 1, ticket_len ) ) == NULL )
2196 {
2197 MBEDTLS_SSL_DEBUG_MSG( 1, ( "ticket alloc failed" ) );
2198 return( MBEDTLS_ERR_SSL_ALLOC_FAILED );
2199 }
2200 memcpy( ticket, p, ticket_len );
2201 p += ticket_len;
2202 session->ticket = ticket;
2203 session->ticket_len = ticket_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002204
Jerry Yucb3b1392022-07-12 06:09:38 +00002205 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
Jerry Yuf8a49942022-07-07 11:32:32 +00002206 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
2207 p += 2;
2208 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
2209
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002210 MBEDTLS_SSL_DEBUG_BUF( 3, "ticket extension", p, extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002211
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002212 ret = ssl_tls13_parse_new_session_ticket_exts( ssl, p, p + extensions_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002213 if( ret != 0 )
2214 {
2215 MBEDTLS_SSL_DEBUG_RET( 1,
Jerry Yuaf2c0c82022-07-12 05:47:21 +00002216 "ssl_tls13_parse_new_session_ticket_exts",
Jerry Yuf8a49942022-07-07 11:32:32 +00002217 ret );
2218 return( ret );
2219 }
Jerry Yucb3b1392022-07-12 06:09:38 +00002220
Jerry Yudb8c5fa2022-08-03 12:10:13 +08002221 /* session has been updated, allow export */
2222 session->exported = 0;
2223
Jerry Yucb3b1392022-07-12 06:09:38 +00002224 return( 0 );
2225}
2226
Jerry Yua0446a02022-07-13 11:22:55 +08002227MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yucb3b1392022-07-12 06:09:38 +00002228static int ssl_tls13_postprocess_new_session_ticket( mbedtls_ssl_context *ssl,
2229 unsigned char *ticket_nonce,
2230 size_t ticket_nonce_len )
2231{
2232 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2233 mbedtls_ssl_session *session = ssl->session;
2234 const mbedtls_ssl_ciphersuite_t *ciphersuite_info;
2235 psa_algorithm_t psa_hash_alg;
2236 int hash_length;
2237
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002238#if defined(MBEDTLS_HAVE_TIME)
2239 /* Store ticket creation time */
Jerry Yu08aed4d2022-07-20 10:36:12 +08002240 session->ticket_received = mbedtls_time( NULL );
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002241#endif
2242
Jerry Yuf8a49942022-07-07 11:32:32 +00002243 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( session->ciphersuite );
2244 if( ciphersuite_info == NULL )
2245 {
2246 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
2247 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
2248 }
2249
2250 psa_hash_alg = mbedtls_psa_translate_md( ciphersuite_info->mac );
2251 hash_length = PSA_HASH_LENGTH( psa_hash_alg );
Jerry Yu3afdf362022-07-20 17:34:14 +08002252 if( hash_length == -1 ||
2253 ( size_t )hash_length > sizeof( session->resumption_key ) )
2254 {
Jerry Yuf8a49942022-07-07 11:32:32 +00002255 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
Jerry Yu3afdf362022-07-20 17:34:14 +08002256 }
2257
Jerry Yuf8a49942022-07-07 11:32:32 +00002258
2259 MBEDTLS_SSL_DEBUG_BUF( 3, "resumption_master_secret",
2260 session->app_secrets.resumption_master_secret,
2261 hash_length );
2262
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002263 /* Compute resumption key
Jerry Yuf8a49942022-07-07 11:32:32 +00002264 *
2265 * HKDF-Expand-Label( resumption_master_secret,
2266 * "resumption", ticket_nonce, Hash.length )
2267 */
2268 ret = mbedtls_ssl_tls13_hkdf_expand_label(
2269 psa_hash_alg,
2270 session->app_secrets.resumption_master_secret,
2271 hash_length,
2272 MBEDTLS_SSL_TLS1_3_LBL_WITH_LEN( resumption ),
2273 ticket_nonce,
2274 ticket_nonce_len,
Jerry Yu0a430c82022-07-20 11:02:48 +08002275 session->resumption_key,
Jerry Yuf8a49942022-07-07 11:32:32 +00002276 hash_length );
2277
2278 if( ret != 0 )
2279 {
2280 MBEDTLS_SSL_DEBUG_RET( 2,
2281 "Creating the ticket-resumed PSK failed",
2282 ret );
2283 return( ret );
2284 }
2285
Jerry Yu0a430c82022-07-20 11:02:48 +08002286 session->resumption_key_len = hash_length;
Jerry Yuf8a49942022-07-07 11:32:32 +00002287
2288 MBEDTLS_SSL_DEBUG_BUF( 3, "Ticket-resumed PSK",
Jerry Yu0a430c82022-07-20 11:02:48 +08002289 session->resumption_key,
2290 session->resumption_key_len );
Jerry Yuf8a49942022-07-07 11:32:32 +00002291
Jerry Yuf8a49942022-07-07 11:32:32 +00002292 return( 0 );
2293}
2294
2295/*
Jerry Yua357cf42022-07-12 05:36:45 +00002296 * Handler for MBEDTLS_SSL_NEW_SESSION_TICKET
Jerry Yuf8a49942022-07-07 11:32:32 +00002297 */
Jerry Yua0446a02022-07-13 11:22:55 +08002298MBEDTLS_CHECK_RETURN_CRITICAL
Jerry Yuf8a49942022-07-07 11:32:32 +00002299static int ssl_tls13_process_new_session_ticket( mbedtls_ssl_context *ssl )
2300{
2301 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
2302 unsigned char *buf;
2303 size_t buf_len;
Jerry Yucb3b1392022-07-12 06:09:38 +00002304 unsigned char *ticket_nonce;
2305 size_t ticket_nonce_len;
Jerry Yuf8a49942022-07-07 11:32:32 +00002306
2307 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse new session ticket" ) );
2308
2309 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
2310 ssl, MBEDTLS_SSL_HS_NEW_SESSION_TICKET,
2311 &buf, &buf_len ) );
2312
Jerry Yucb3b1392022-07-12 06:09:38 +00002313 MBEDTLS_SSL_PROC_CHK( ssl_tls13_parse_new_session_ticket(
2314 ssl, buf, buf + buf_len,
2315 &ticket_nonce, &ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002316
Jerry Yucb3b1392022-07-12 06:09:38 +00002317 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_new_session_ticket(
2318 ssl, ticket_nonce, ticket_nonce_len ) );
Jerry Yuf8a49942022-07-07 11:32:32 +00002319
Jerry Yu4e6c42a2022-07-13 11:16:51 +08002320 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HANDSHAKE_OVER );
2321
Jerry Yuf8a49942022-07-07 11:32:32 +00002322cleanup:
2323
2324 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse new session ticket" ) );
2325 return( ret );
2326}
2327#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2328
Jerry Yu92c6b402021-08-27 16:59:09 +08002329int mbedtls_ssl_tls13_handshake_client_step( mbedtls_ssl_context *ssl )
Jerry Yubc20bdd2021-08-24 15:59:48 +08002330{
Jerry Yu92c6b402021-08-27 16:59:09 +08002331 int ret = 0;
Jerry Yuc8a392c2021-08-18 16:46:28 +08002332
Jerry Yu92c6b402021-08-27 16:59:09 +08002333 switch( ssl->state )
2334 {
2335 /*
Jerry Yu0c63af62021-09-02 12:59:12 +08002336 * ssl->state is initialized as HELLO_REQUEST. It is the same
2337 * as CLIENT_HELLO state.
Jerry Yu92c6b402021-08-27 16:59:09 +08002338 */
2339 case MBEDTLS_SSL_HELLO_REQUEST:
2340 case MBEDTLS_SSL_CLIENT_HELLO:
Ronald Cron3d580bf2022-02-18 17:24:56 +01002341 ret = mbedtls_ssl_write_client_hello( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002342 break;
2343
2344 case MBEDTLS_SSL_SERVER_HELLO:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002345 ret = ssl_tls13_process_server_hello( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002346 break;
2347
2348 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
XiaokangQian97799ac2021-10-11 10:05:54 +00002349 ret = ssl_tls13_process_encrypted_extensions( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002350 break;
2351
Jerry Yua93ac112021-10-27 16:31:48 +08002352#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yud2674312021-10-29 10:08:19 +08002353 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
2354 ret = ssl_tls13_process_certificate_request( ssl );
2355 break;
2356
Jerry Yu687101b2021-09-14 16:03:56 +08002357 case MBEDTLS_SSL_SERVER_CERTIFICATE:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002358 ret = ssl_tls13_process_server_certificate( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002359 break;
2360
2361 case MBEDTLS_SSL_CERTIFICATE_VERIFY:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002362 ret = ssl_tls13_process_certificate_verify( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002363 break;
Jerry Yua93ac112021-10-27 16:31:48 +08002364#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu687101b2021-09-14 16:03:56 +08002365
2366 case MBEDTLS_SSL_SERVER_FINISHED:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002367 ret = ssl_tls13_process_server_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002368 break;
2369
Jerry Yu566c7812022-01-26 15:41:22 +08002370 case MBEDTLS_SSL_CLIENT_CERTIFICATE:
2371 ret = ssl_tls13_write_client_certificate( ssl );
2372 break;
2373
Ronald Cron9df7c802022-03-08 18:38:54 +01002374#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
Jerry Yu566c7812022-01-26 15:41:22 +08002375 case MBEDTLS_SSL_CLIENT_CERTIFICATE_VERIFY:
2376 ret = ssl_tls13_write_client_certificate_verify( ssl );
2377 break;
Jerry Yu90f152d2022-01-29 22:12:42 +08002378#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
Jerry Yu566c7812022-01-26 15:41:22 +08002379
Jerry Yu687101b2021-09-14 16:03:56 +08002380 case MBEDTLS_SSL_CLIENT_FINISHED:
XiaokangQian74af2a82021-09-22 07:40:30 +00002381 ret = ssl_tls13_write_client_finished( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002382 break;
2383
2384 case MBEDTLS_SSL_FLUSH_BUFFERS:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002385 ret = ssl_tls13_flush_buffers( ssl );
Jerry Yu687101b2021-09-14 16:03:56 +08002386 break;
2387
2388 case MBEDTLS_SSL_HANDSHAKE_WRAPUP:
Xiaofei Bai746f9482021-11-12 08:53:56 +00002389 ret = ssl_tls13_handshake_wrapup( ssl );
Jerry Yu92c6b402021-08-27 16:59:09 +08002390 break;
2391
Ronald Cron49ad6192021-11-24 16:25:31 +01002392 /*
2393 * Injection of dummy-CCS's for middlebox compatibility
2394 */
2395#if defined(MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE)
XiaokangQian0b56a8f2021-12-22 02:39:32 +00002396 case MBEDTLS_SSL_CLIENT_CCS_BEFORE_2ND_CLIENT_HELLO:
Ronald Cron9f55f632022-02-02 16:02:47 +01002397 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2398 if( ret == 0 )
2399 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
2400 break;
2401
2402 case MBEDTLS_SSL_CLIENT_CCS_AFTER_SERVER_FINISHED:
2403 ret = mbedtls_ssl_tls13_write_change_cipher_spec( ssl );
2404 if( ret == 0 )
2405 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_CERTIFICATE );
Ronald Cron49ad6192021-11-24 16:25:31 +01002406 break;
2407#endif /* MBEDTLS_SSL_TLS1_3_COMPATIBILITY_MODE */
2408
Jerry Yuf8a49942022-07-07 11:32:32 +00002409#if defined(MBEDTLS_SSL_SESSION_TICKETS)
Jerry Yua357cf42022-07-12 05:36:45 +00002410 case MBEDTLS_SSL_NEW_SESSION_TICKET:
Jerry Yuf8a49942022-07-07 11:32:32 +00002411 ret = ssl_tls13_process_new_session_ticket( ssl );
2412 if( ret != 0 )
2413 break;
2414 ret = MBEDTLS_ERR_SSL_RECEIVED_NEW_SESSION_TICKET;
2415 break;
2416#endif /* MBEDTLS_SSL_SESSION_TICKETS */
2417
Jerry Yu92c6b402021-08-27 16:59:09 +08002418 default:
2419 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
2420 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
2421 }
2422
2423 return( ret );
2424}
Jerry Yu65dd2cc2021-08-18 16:38:40 +08002425
Jerry Yufb4b6472022-01-27 15:03:26 +08002426#endif /* MBEDTLS_SSL_CLI_C && MBEDTLS_SSL_PROTO_TLS1_3 */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08002427
Jerry Yufb4b6472022-01-27 15:03:26 +08002428