blob: 528409b57f699ee3fbaa04c424f6b086127776cf [file] [log] [blame]
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001/*
Jerry Yub9930e72021-08-06 17:11:51 +08002 * TLS 1.3 server-side functions
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08003 *
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
20#include "common.h"
21
Jerry Yufb4b6472022-01-27 15:03:26 +080022#if defined(MBEDTLS_SSL_SRV_C) && defined(MBEDTLS_SSL_PROTO_TLS1_3)
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080023
Jerry Yu687101b2021-09-14 16:03:56 +080024#include "mbedtls/debug.h"
Xiaofei Baicba64af2022-02-15 10:00:56 +000025#include "mbedtls/error.h"
26#include "mbedtls/platform.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080027
Xiaofei Bai9ca09d42022-02-14 12:57:18 +000028#include "ssl_misc.h"
29#include "ssl_tls13_keys.h"
30#include "ssl_debug_helpers.h"
31
XiaokangQian7807f9f2022-02-15 10:04:37 +000032#if defined(MBEDTLS_ECP_C)
33#include "mbedtls/ecp.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000034#endif /* MBEDTLS_ECP_C */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080035
XiaokangQiana9c58412022-02-17 09:41:26 +000036#if defined(MBEDTLS_PLATFORM_C)
37#include "mbedtls/platform.h"
38#else
39#include <stdlib.h>
40#define mbedtls_calloc calloc
41#define mbedtls_free free
42#endif /* MBEDTLS_PLATFORM_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +000043
Jerry Yu4d3841a2022-04-16 12:37:19 +080044#include "ssl_misc.h"
45#include "ssl_tls13_keys.h"
46#include "ssl_debug_helpers.h"
47
XiaokangQian7807f9f2022-02-15 10:04:37 +000048/* From RFC 8446:
49 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +000050 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +000051 * } SupportedVersions;
52 */
53static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
54 const unsigned char *buf,
55 const unsigned char *end )
56{
XiaokangQian7807f9f2022-02-15 10:04:37 +000057 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +000058 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +000059 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +000060 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +000061 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +000062
63 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +000064 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +000065 p += 1;
66
XiaokangQian4080a7f2022-04-11 09:55:18 +000067 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +000068 versions_end = p + versions_len;
69 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +000070 {
XiaokangQiancfd925f2022-04-14 07:10:37 +000071 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +000072 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +000073 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +000074
75 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +000076 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +000077 {
78 tls13_supported = 1;
79 break;
80 }
XiaokangQian7807f9f2022-02-15 10:04:37 +000081 }
82
XiaokangQianb67384d2022-04-19 00:02:38 +000083 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +000084 {
XiaokangQian7807f9f2022-02-15 10:04:37 +000085 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
86
87 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
88 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
89 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
90 }
91
XiaokangQiande333912022-04-20 08:49:42 +000092 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +000093 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +000094
XiaokangQian7807f9f2022-02-15 10:04:37 +000095 return( 0 );
96}
97
XiaokangQian8f9dfe42022-04-15 02:52:39 +000098#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +000099/*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000100 *
101 * From RFC 8446:
102 * enum {
103 * ... (0xFFFF)
104 * } NamedGroup;
105 * struct {
106 * NamedGroup named_group_list<2..2^16-1>;
107 * } NamedGroupList;
108 */
XiaokangQiancfd925f2022-04-14 07:10:37 +0000109static int ssl_tls13_parse_supported_groups_ext(
XiaokangQian7807f9f2022-02-15 10:04:37 +0000110 mbedtls_ssl_context *ssl,
111 const unsigned char *buf, const unsigned char *end )
112{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000113 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000114 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000115 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000116
117 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000118 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000119 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000120 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000121 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000122 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000123 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000124
XiaokangQian08037552022-04-20 07:16:41 +0000125 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000126 {
XiaokangQian08037552022-04-20 07:16:41 +0000127 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000128 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000129 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
130 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000131
XiaokangQian318dc762022-04-20 09:43:51 +0000132 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got named group: %d", named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000133
134 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
135 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000136 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000137 {
XiaokangQian08037552022-04-20 07:16:41 +0000138 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000139 }
140
XiaokangQian08037552022-04-20 07:16:41 +0000141 MBEDTLS_SSL_DEBUG_MSG(
142 2, ( "add named group (%04x) into received list.",
143 named_group ) );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000144 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000145 }
146
147 return( 0 );
148
149}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000150#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000151
XiaokangQian08037552022-04-20 07:16:41 +0000152#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
153
XiaokangQian88408882022-04-02 10:15:03 +0000154#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000155/*
156 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000157 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000158 *
159 * Possible return values are:
160 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000161 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000162 * does not match a group supported by the server. A HelloRetryRequest will
163 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000164 * - A negative value for fatal errors.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000165*/
166
167static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
168 const unsigned char *buf,
169 const unsigned char *end )
170{
XiaokangQianb67384d2022-04-19 00:02:38 +0000171 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000172 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000173 unsigned char const *client_shares_end;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000174 size_t client_shares_len, key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000175 int match_found = 0;
176
177 /* From RFC 8446:
178 *
179 * struct {
180 * KeyShareEntry client_shares<0..2^16-1>;
181 * } KeyShareClientHello;
182 *
183 */
184
XiaokangQian7807f9f2022-02-15 10:04:37 +0000185 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000186 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000187 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000188 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000189
190 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000191 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000192
193 /* We try to find a suitable key share entry and copy it to the
194 * handshake context. Later, we have to find out whether we can do
195 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000196 * dismiss it and send a HelloRetryRequest message.
197 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000198
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000199 for( ; p < client_shares_end; p += key_exchange_len )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000200 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000201 uint16_t group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000202
203 /*
204 * struct {
205 * NamedGroup group;
206 * opaque key_exchange<1..2^16-1>;
207 * } KeyShareEntry;
208 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000209 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000210 group = MBEDTLS_GET_UINT16_BE( p, 0 );
211 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000212 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000213 p += 2;
XiaokangQianb67384d2022-04-19 00:02:38 +0000214 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000215
216 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000217 * for input validation purposes.
218 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000219 if( match_found == 1 )
220 continue;
221
XiaokangQian060d8672022-04-21 09:24:56 +0000222 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
223 ! mbedtls_ssl_named_group_is_supported( group ) )
224 {
225 continue;
226 }
XiaokangQian060d8672022-04-21 09:24:56 +0000227
XiaokangQian7807f9f2022-02-15 10:04:37 +0000228 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000229 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000230 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000231 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
232 {
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000233 const mbedtls_ecp_curve_info *curve_info =
234 mbedtls_ecp_curve_info_from_tls_id( group );
235 ((void) curve_info);
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000236 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000237 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
238 ssl, p - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000239 if( ret != 0 )
240 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000241
242 match_found = 1;
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000243 }
244 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000245 {
246 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000247 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000248 continue;
249 }
250
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000251 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000252 }
253
254 if( match_found == 0 )
255 {
256 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000257 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000258 }
259 return( 0 );
260}
XiaokangQian88408882022-04-02 10:15:03 +0000261#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000262
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000263#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000264static void ssl_tls13_debug_print_client_hello_exts( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000265{
XiaokangQian3207a322022-02-23 03:15:27 +0000266 ((void) ssl);
267
XiaokangQian7807f9f2022-02-15 10:04:37 +0000268 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Supported Extensions:" ) );
XiaokangQianb67384d2022-04-19 00:02:38 +0000269 MBEDTLS_SSL_DEBUG_MSG( 3,
270 ( "- KEY_SHARE_EXTENSION ( %s )",
271 ( ( ssl->handshake->extensions_present
272 & MBEDTLS_SSL_EXT_KEY_SHARE ) > 0 ) ? "TRUE" : "FALSE" ) );
273 MBEDTLS_SSL_DEBUG_MSG( 3,
274 ( "- PSK_KEY_EXCHANGE_MODES_EXTENSION ( %s )",
275 ( ( ssl->handshake->extensions_present
276 & MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) > 0 ) ?
277 "TRUE" : "FALSE" ) );
278 MBEDTLS_SSL_DEBUG_MSG( 3,
279 ( "- PRE_SHARED_KEY_EXTENSION ( %s )",
280 ( ( ssl->handshake->extensions_present
281 & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) > 0 ) ? "TRUE" : "FALSE" ) );
282 MBEDTLS_SSL_DEBUG_MSG( 3,
283 ( "- SIGNATURE_ALGORITHM_EXTENSION ( %s )",
284 ( ( ssl->handshake->extensions_present
285 & MBEDTLS_SSL_EXT_SIG_ALG ) > 0 ) ? "TRUE" : "FALSE" ) );
286 MBEDTLS_SSL_DEBUG_MSG( 3,
287 ( "- SUPPORTED_GROUPS_EXTENSION ( %s )",
288 ( ( ssl->handshake->extensions_present
289 & MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ) >0 ) ?
290 "TRUE" : "FALSE" ) );
291 MBEDTLS_SSL_DEBUG_MSG( 3,
292 ( "- SUPPORTED_VERSION_EXTENSION ( %s )",
293 ( ( ssl->handshake->extensions_present
294 & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) > 0 ) ?
295 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000296#if defined ( MBEDTLS_SSL_SERVER_NAME_INDICATION )
XiaokangQianb67384d2022-04-19 00:02:38 +0000297 MBEDTLS_SSL_DEBUG_MSG( 3,
298 ( "- SERVERNAME_EXTENSION ( %s )",
299 ( ( ssl->handshake->extensions_present
300 & MBEDTLS_SSL_EXT_SERVERNAME ) > 0 ) ?
301 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000302#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000303}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000304#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000305
XiaokangQian4080a7f2022-04-11 09:55:18 +0000306static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000307 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000308{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000309 int masked = ssl->handshake->extensions_present & exts_mask;
310 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000311}
312
XiaokangQianb67384d2022-04-19 00:02:38 +0000313static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
314 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000315{
XiaokangQian4080a7f2022-04-11 09:55:18 +0000316 return( ssl_tls13_client_hello_has_exts( ssl,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000317 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
318 MBEDTLS_SSL_EXT_KEY_SHARE |
319 MBEDTLS_SSL_EXT_SIG_ALG ) );
320}
321
XiaokangQianb67384d2022-04-19 00:02:38 +0000322static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000323{
324 if( !mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) )
325 return( 0 );
326
XiaokangQianb67384d2022-04-19 00:02:38 +0000327 if( !ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000328 return( 0 );
329
XiaokangQianb67384d2022-04-19 00:02:38 +0000330 ssl->handshake->tls13_kex_modes =
331 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000332 return( 1 );
333}
334
XiaokangQian4080a7f2022-04-11 09:55:18 +0000335/*
XiaokangQianed582dd2022-04-13 08:21:05 +0000336 *
337 * STATE HANDLING: ClientHello
338 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000339 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +0000340 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000341 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +0000342 *
343 * In this case, the server progresses to sending its ServerHello.
344 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000345 * 2) The ClientHello was well-formed but didn't match the server's
346 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +0000347 *
348 * For example, the client might not have offered a key share which
349 * the server supports, or the server might require a cookie.
350 *
351 * In this case, the server sends a HelloRetryRequest.
352 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000353 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +0000354 *
355 * In this case, we abort the handshake.
356 *
357 */
358
359/*
XiaokangQian4080a7f2022-04-11 09:55:18 +0000360 * Structure of this message:
361 *
XiaokangQiane8ff3502022-04-22 02:34:40 +0000362 * uint16 ProtocolVersion;
363 * opaque Random[32];
364 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +0000365 *
XiaokangQiane8ff3502022-04-22 02:34:40 +0000366 * struct {
367 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
368 * Random random;
369 * opaque legacy_session_id<0..32>;
370 * CipherSuite cipher_suites<2..2^16-2>;
371 * opaque legacy_compression_methods<1..2^8-1>;
372 * Extension extensions<8..2^16-1>;
373 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000374 */
XiaokangQianed582dd2022-04-13 08:21:05 +0000375
376#define SSL_CLIENT_HELLO_OK 0
377#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
378
XiaokangQian4080a7f2022-04-11 09:55:18 +0000379static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
380 const unsigned char *buf,
381 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000382{
XiaokangQianb67384d2022-04-19 00:02:38 +0000383 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
384 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000385 size_t legacy_session_id_len;
XiaokangQian060d8672022-04-21 09:24:56 +0000386 const unsigned char *cipher_suites;
XiaokangQian318dc762022-04-20 09:43:51 +0000387 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +0000388 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +0000389 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000390 const unsigned char *extensions_end;
Jerry Yu582dd062022-04-22 21:59:01 +0800391 int hrr_required = SSL_CLIENT_HELLO_OK;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000392
XiaokangQian7807f9f2022-02-15 10:04:37 +0000393 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000394
395 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
396
397 /*
XiaokangQianb67384d2022-04-19 00:02:38 +0000398 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +0000399 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +0000400 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +0000401 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000402 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +0000403 * .. . .. ciphersuite list length ( 2 bytes )
404 * .. . .. ciphersuite list
405 * .. . .. compression alg. list length ( 1 byte )
406 * .. . .. compression alg. list
407 * .. . .. extensions length ( 2 bytes, optional )
408 * .. . .. extensions ( optional )
409 */
410
XiaokangQianb67384d2022-04-19 00:02:38 +0000411 /*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000412 * Minimal length ( with everything empty and extensions ommitted ) is
413 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
414 * read at least up to session id length without worrying.
415 */
416 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
417
418 /* ...
419 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
420 * ...
421 * with ProtocolVersion defined as:
422 * uint16 ProtocolVersion;
423 */
XiaokangQiande333912022-04-20 08:49:42 +0000424 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
425 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000426 {
427 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
428 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
429 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +0000430 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000431 }
432 p += 2;
433
434 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +0000435 * Only support TLS 1.3 currently, temporarily set the version.
436 */
XiaokangQiande333912022-04-20 08:49:42 +0000437 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +0000438
XiaokangQian08037552022-04-20 07:16:41 +0000439 /* ---
XiaokangQianb67384d2022-04-19 00:02:38 +0000440 * Random random;
441 * ---
442 * with Random defined as:
443 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000444 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000445 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +0000446 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000447
XiaokangQian08037552022-04-20 07:16:41 +0000448 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
449 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000450
XiaokangQianb67384d2022-04-19 00:02:38 +0000451 /* ---
452 * opaque legacy_session_id<0..32>;
453 * ---
XiaokangQian7807f9f2022-02-15 10:04:37 +0000454 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000455 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +0000456 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000457
XiaokangQianb67384d2022-04-19 00:02:38 +0000458 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000459 {
460 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
461 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
462 }
463
XiaokangQian4080a7f2022-04-11 09:55:18 +0000464 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +0000465 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +0000466 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +0000467 /*
468 * Check we have enough data for the legacy session identifier
469 * and the ciphersuite list length.
470 */
471 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000472
XiaokangQianed582dd2022-04-13 08:21:05 +0000473 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000474 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000475
XiaokangQian7807f9f2022-02-15 10:04:37 +0000476 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
477 p += 2;
478
XiaokangQianb67384d2022-04-19 00:02:38 +0000479 /* Check we have enough data for the ciphersuite list, the legacy
480 * compression methods and the length of the extensions.
481 */
482 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000483
XiaokangQian08037552022-04-20 07:16:41 +0000484 /* ---
485 * CipherSuite cipher_suites<2..2^16-2>;
486 * ---
487 * with CipherSuite defined as:
488 * uint8 CipherSuite[2];
489 */
XiaokangQian060d8672022-04-21 09:24:56 +0000490 cipher_suites = p;
491 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000492 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
493 p, cipher_suites_len );
XiaokangQian17f974c2022-04-19 09:57:41 +0000494 /*
495 * Search for a matching ciphersuite
496 */
XiaokangQian318dc762022-04-20 09:43:51 +0000497 int ciphersuite_match = 0;
XiaokangQian060d8672022-04-21 09:24:56 +0000498 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +0000499 {
XiaokangQiane8ff3502022-04-22 02:34:40 +0000500 uint16_t cipher_suite;
501 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
502 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
503 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
XiaokangQian08037552022-04-20 07:16:41 +0000504 /*
XiaokangQiane8ff3502022-04-22 02:34:40 +0000505 * Check whether this ciphersuite is valid and offered.
506 */
XiaokangQian08037552022-04-20 07:16:41 +0000507 if( ( mbedtls_ssl_validate_ciphersuite(
XiaokangQiande333912022-04-20 08:49:42 +0000508 ssl, ciphersuite_info, ssl->tls_version,
509 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +0000510 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
511 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000512
XiaokangQian08037552022-04-20 07:16:41 +0000513 ssl->session_negotiate->ciphersuite = cipher_suite;
514 ssl->handshake->ciphersuite_info = ciphersuite_info;
XiaokangQian318dc762022-04-20 09:43:51 +0000515 ciphersuite_match = 1;
XiaokangQian17f974c2022-04-19 09:57:41 +0000516
XiaokangQian08037552022-04-20 07:16:41 +0000517 break;
XiaokangQian17f974c2022-04-19 09:57:41 +0000518
XiaokangQian17f974c2022-04-19 09:57:41 +0000519 }
520
XiaokangQian318dc762022-04-20 09:43:51 +0000521 if( !ciphersuite_match )
522 {
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000523 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
524 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
525 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
XiaokangQian318dc762022-04-20 09:43:51 +0000526 }
XiaokangQian17f974c2022-04-19 09:57:41 +0000527
528 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %s",
529 ciphersuite_info->name ) );
530
XiaokangQian060d8672022-04-21 09:24:56 +0000531 p = cipher_suites + cipher_suites_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000532 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +0000533 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000534 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +0000535 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000536 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000537 {
XiaokangQian4080a7f2022-04-11 09:55:18 +0000538 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
539 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
540 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
541 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000542 }
XiaokangQianb67384d2022-04-19 00:02:38 +0000543 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000544
XiaokangQianb67384d2022-04-19 00:02:38 +0000545 /* ---
546 * Extension extensions<8..2^16-1>;
547 * ---
548 * with Extension defined as:
549 * struct {
550 * ExtensionType extension_type;
551 * opaque extension_data<0..2^16-1>;
552 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000553 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000554 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000555 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000556 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +0000557 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000558
XiaokangQian4080a7f2022-04-11 09:55:18 +0000559 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000560
561 while( p < extensions_end )
562 {
563 unsigned int extension_type;
564 size_t extension_data_len;
565 const unsigned char *extension_data_end;
566
XiaokangQian318dc762022-04-20 09:43:51 +0000567 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000568 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
569 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
570 p += 4;
571
572 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
573 extension_data_end = p + extension_data_len;
574
575 switch( extension_type )
576 {
XiaokangQianb67384d2022-04-19 00:02:38 +0000577#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000578 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
579 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
580
581 /* Supported Groups Extension
582 *
583 * When sent by the client, the "supported_groups" extension
584 * indicates the named groups which the client supports,
585 * ordered from most preferred to least preferred.
586 */
XiaokangQiancfd925f2022-04-14 07:10:37 +0000587 ret = ssl_tls13_parse_supported_groups_ext( ssl, p,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000588 extension_data_end );
589 if( ret != 0 )
590 {
591 MBEDTLS_SSL_DEBUG_RET( 1,
592 "mbedtls_ssl_parse_supported_groups_ext", ret );
593 return( ret );
594 }
595
596 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
597 break;
XiaokangQianb67384d2022-04-19 00:02:38 +0000598#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000599
XiaokangQian88408882022-04-02 10:15:03 +0000600#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000601 case MBEDTLS_TLS_EXT_KEY_SHARE:
602 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
603
604 /*
605 * Key Share Extension
606 *
607 * When sent by the client, the "key_share" extension
608 * contains the endpoint's cryptographic parameters for
609 * ECDHE/DHE key establishment methods.
610 */
611 ret = ssl_tls13_parse_key_shares_ext( ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +0000612 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000613 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000614 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
Jerry Yu582dd062022-04-22 21:59:01 +0800615 hrr_required |= SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000616 }
617
Jerry Yu582dd062022-04-22 21:59:01 +0800618 if( ret < 0 )
619 {
620 MBEDTLS_SSL_DEBUG_RET(
621 1, "ssl_tls13_parse_key_shares_ext", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000622 return( ret );
Jerry Yu582dd062022-04-22 21:59:01 +0800623 }
XiaokangQian7807f9f2022-02-15 10:04:37 +0000624
625 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
626 break;
XiaokangQian88408882022-04-02 10:15:03 +0000627#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000628
629 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
630 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
631
632 ret = ssl_tls13_parse_supported_versions_ext(
XiaokangQianb67384d2022-04-19 00:02:38 +0000633 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000634 if( ret != 0 )
635 {
636 MBEDTLS_SSL_DEBUG_RET( 1,
637 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
638 return( ret );
639 }
640 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
641 break;
642
643#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
644 case MBEDTLS_TLS_EXT_SIG_ALG:
645 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
646
647 ret = mbedtls_ssl_tls13_parse_sig_alg_ext( ssl, p,
648 extension_data_end );
649 if( ret != 0 )
650 {
651 MBEDTLS_SSL_DEBUG_MSG( 1,
652 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
653 ret ) );
654 return( ret );
655 }
656 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
657 break;
658#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
659
660 default:
661 MBEDTLS_SSL_DEBUG_MSG( 3,
662 ( "unknown extension found: %ud ( ignoring )",
663 extension_type ) );
664 }
665
666 p += extension_data_len;
667 }
668
669 /* Update checksum with either
670 * - The entire content of the CH message, if no PSK extension is present
671 * - The content up to but excluding the PSK extension, if present.
672 */
XiaokangQian3f84d5d2022-04-19 06:36:17 +0000673 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
XiaokangQianc4b8c992022-04-07 11:31:38 +0000674 buf, p - buf );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000675
676 /* List all the extensions we have received */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000677#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000678 ssl_tls13_debug_print_client_hello_exts( ssl );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000679#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000680
681 /*
XiaokangQianb67384d2022-04-19 00:02:38 +0000682 * Here we only support the ephemeral or (EC)DHE key echange mode
XiaokangQian7807f9f2022-02-15 10:04:37 +0000683 */
684
XiaokangQianb67384d2022-04-19 00:02:38 +0000685 if( !ssl_tls13_check_ephemeral_key_exchange( ssl ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000686 {
687 MBEDTLS_SSL_DEBUG_MSG(
688 1,
689 ( "ClientHello message misses mandatory extensions." ) );
690 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
691 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
692 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
693 }
694
Jerry Yu582dd062022-04-22 21:59:01 +0800695 return( hrr_required );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000696}
697
Jerry Yu582dd062022-04-22 21:59:01 +0800698/* Update the handshake state machine */
699
XiaokangQiancfd925f2022-04-14 07:10:37 +0000700static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000701{
XiaokangQian08037552022-04-20 07:16:41 +0000702 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000703
XiaokangQian7807f9f2022-02-15 10:04:37 +0000704 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
705 if( ret != 0 )
706 {
707 MBEDTLS_SSL_DEBUG_RET( 1,
708 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
709 return( ret );
710 }
711
XiaokangQian7807f9f2022-02-15 10:04:37 +0000712 return( 0 );
713
714}
715
716/*
XiaokangQianed582dd2022-04-13 08:21:05 +0000717 * Main entry point from the state machine; orchestrates the otherfunctions.
718 */
719
720static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
721{
722
XiaokangQian08037552022-04-20 07:16:41 +0000723 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +0000724 unsigned char* buf = NULL;
725 size_t buflen = 0;
Jerry Yu582dd062022-04-22 21:59:01 +0800726 int hrr_required ;
XiaokangQianed582dd2022-04-13 08:21:05 +0000727 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
728
XiaokangQianed582dd2022-04-13 08:21:05 +0000729 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
730 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
731 &buf, &buflen ) );
732
733 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
734 buf + buflen ) );
Jerry Yu582dd062022-04-22 21:59:01 +0800735
736 hrr_required = ret;
XiaokangQiancfd925f2022-04-14 07:10:37 +0000737 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
Jerry Yu582dd062022-04-22 21:59:01 +0800738
739 if( hrr_required == SSL_CLIENT_HELLO_OK )
740 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
741 else
742 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_HELLO_RETRY_REQUEST );
XiaokangQianed582dd2022-04-13 08:21:05 +0000743
744cleanup:
745
746 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
747 return( ret );
748}
749
750/*
Jerry Yu1c3e6882022-04-20 21:23:40 +0800751 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +0800752 */
Jerry Yuf4b27e42022-03-30 17:32:21 +0800753static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
754{
Jerry Yu637a3f12022-04-20 21:37:58 +0800755 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
756 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +0800757 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +0800758 if( ssl->conf->f_rng == NULL )
759 {
760 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
761 return( MBEDTLS_ERR_SSL_NO_RNG );
762 }
763
Jerry Yu637a3f12022-04-20 21:37:58 +0800764 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +0800765 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
766 {
767 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
768 return( ret );
769 }
770
Jerry Yu637a3f12022-04-20 21:37:58 +0800771 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +0800772 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
773
774#if defined(MBEDTLS_HAVE_TIME)
775 ssl->session_negotiate->start = time( NULL );
776#endif /* MBEDTLS_HAVE_TIME */
777
778 return( ret );
779}
780
Jerry Yu3bf2c642022-03-30 22:02:12 +0800781/*
Jerry Yue74e04a2022-04-21 09:23:16 +0800782 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +0800783 *
784 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +0800785 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800786 * } SupportedVersions;
787 */
Jerry Yue74e04a2022-04-21 09:23:16 +0800788static int ssl_tls13_write_server_hello_supported_versions_ext(
789 mbedtls_ssl_context *ssl,
790 unsigned char *buf,
791 unsigned char *end,
792 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800793{
Jerry Yu3bf2c642022-03-30 22:02:12 +0800794 *out_len = 0;
795
Jerry Yu955ddd72022-04-22 22:27:33 +0800796 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800797
798 /* Check if we have space to write the extension:
799 * - extension_type (2 bytes)
800 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +0800801 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +0800802 */
Jerry Yu349a6132022-04-14 20:52:56 +0800803 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800804
Jerry Yu349a6132022-04-14 20:52:56 +0800805 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800806
Jerry Yu349a6132022-04-14 20:52:56 +0800807 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800808
Jerry Yu349a6132022-04-14 20:52:56 +0800809 mbedtls_ssl_write_version( buf + 4,
810 ssl->conf->transport,
811 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800812
813 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
814 ssl->tls_version ) );
815
Jerry Yu349a6132022-04-14 20:52:56 +0800816 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800817
818 return( 0 );
819}
820
Jerry Yud9436a12022-04-20 22:28:09 +0800821
Jerry Yu3bf2c642022-03-30 22:02:12 +0800822
823/* Generate and export a single key share. For hybrid KEMs, this can
824 * be called multiple times with the different components of the hybrid. */
Jerry Yu955ddd72022-04-22 22:27:33 +0800825static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
826 uint16_t named_group,
827 unsigned char *buf,
828 unsigned char *end,
829 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800830{
831 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +0800832
833 *out_len = 0;
834
Jerry Yu89e103c2022-03-30 22:43:29 +0800835#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +0800836 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
837 {
Jerry Yu89e103c2022-03-30 22:43:29 +0800838 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
839 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800840 if( ret != 0 )
841 {
Jerry Yu89e103c2022-03-30 22:43:29 +0800842 MBEDTLS_SSL_DEBUG_RET(
843 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
844 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800845 return( ret );
846 }
Jerry Yu3bf2c642022-03-30 22:02:12 +0800847 }
Jerry Yu89e103c2022-03-30 22:43:29 +0800848 else
849#endif /* MBEDTLS_ECDH_C */
850 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800851 {
852 }
853 else
854 {
Jerry Yu955ddd72022-04-22 22:27:33 +0800855 ((void) ssl);
856 ((void) named_group);
857 ((void) buf);
858 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +0800859 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
860 }
861
862 return( ret );
863}
864
865/*
866 * ssl_tls13_write_key_share_ext
867 *
868 * Structure of key_share extension in ServerHello:
869 *
Jerry Yu1c3e6882022-04-20 21:23:40 +0800870 * struct {
871 * NamedGroup group;
872 * opaque key_exchange<1..2^16-1>;
873 * } KeyShareEntry;
874 * struct {
875 * KeyShareEntry server_share;
876 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800877 */
878static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
879 unsigned char *buf,
880 unsigned char *end,
881 size_t *out_len )
882{
Jerry Yu955ddd72022-04-22 22:27:33 +0800883 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800884 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +0800885 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800886 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800887 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800888
889 *out_len = 0;
890
891 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
892
893 /* Check if we have space for header and length fields:
894 * - extension_type (2 bytes)
895 * - extension_data_length (2 bytes)
896 * - group (2 bytes)
897 * - key_exchange_length (2 bytes)
898 */
899 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +0800900 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
901 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800902 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +0800903
Jerry Yu3bf2c642022-03-30 22:02:12 +0800904 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
905 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +0800906 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +0800907 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800908 if( ret != 0 )
909 return( ret );
910 p += key_exchange_length;
Jerry Yu955ddd72022-04-22 22:27:33 +0800911 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800912
Jerry Yu57d48412022-04-20 21:50:42 +0800913 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800914
Jerry Yu57d48412022-04-20 21:50:42 +0800915 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +0800916
Jerry Yu3bf2c642022-03-30 22:02:12 +0800917 return( 0 );
918}
Jerry Yud9436a12022-04-20 22:28:09 +0800919
Jerry Yu23f7a6f2022-04-23 15:16:45 +0800920static int ssl_tls13_write_hrr_key_share_ext( mbedtls_ssl_context *ssl,
921 unsigned char *buf,
922 unsigned char *end,
923 size_t *out_len )
924{
925 uint16_t selected_group = ssl->handshake->hrr_selected_group;
926 /* key_share Extension
927 *
928 * struct {
929 * select (Handshake.msg_type) {
930 * ...
931 * case hello_retry_request:
932 * NamedGroup selected_group;
933 * ...
934 * };
935 * } KeyShare;
936 */
937
938 *out_len = 0;
939
940 /* For a pure PSK-based ciphersuite there is no key share to declare. */
941 if( ! mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
942 return( 0 );
943
944 /* We should only send the key_share extension if the client's initial
945 * key share was not acceptable. */
946 if( ssl->handshake->offered_group_id != 0 )
947 {
948 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Skip key_share extension in HRR" ) );
949 return( 0 );
950 }
951
952 if( selected_group == 0 )
953 {
954 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching named group found" ) );
955 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
956 }
957
958 if( ! mbedtls_ssl_named_group_is_offered( ssl, selected_group ) ||
959 ! mbedtls_ssl_named_group_is_supported( selected_group ) )
960 {
961 MBEDTLS_SSL_DEBUG_MSG( 4, ( "should never happen" ) );
962 return( MBEDTLS_ERR_SSL_INTERNAL_ERROR );
963 }
964
965 /* extension header, extension length, NamedGroup value */
966 MBEDTLS_SSL_CHK_BUF_READ_PTR( buf, end, 6 );
967
968 /* Write extension header */
969 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, buf, 0 );
970
971 /* Write extension length */
972 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
973
974 /* Write selected group */
975 MBEDTLS_PUT_UINT16_BE( selected_group, buf, 4 );
976
977 MBEDTLS_SSL_DEBUG_MSG( 3,
978 ( "HRR selected_group: %s (%x)",
979 mbedtls_ssl_named_group_to_str( selected_group ),
980 selected_group ) );
981
982 *out_len = 6;
983 return( 0 );
984
985}
Jerry Yu3bf2c642022-03-30 22:02:12 +0800986
987/*
988 * Structure of ServerHello message:
989 *
990 * struct {
991 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
992 * Random random;
993 * opaque legacy_session_id_echo<0..32>;
994 * CipherSuite cipher_suite;
995 * uint8 legacy_compression_method = 0;
996 * Extension extensions<6..2^16-1>;
997 * } ServerHello;
998 */
999static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +08001000 unsigned char *buf,
1001 unsigned char *end,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001002 size_t *out_len,
1003 int is_hrr )
Jerry Yu56404d72022-03-30 17:36:13 +08001004{
Jerry Yu955ddd72022-04-22 22:27:33 +08001005 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001006 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +08001007 unsigned char *p_extensions_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08001008 size_t output_len; /* Length of buffer used by function */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001009
1010 *out_len = 0;
1011
Jerry Yucfc04b32022-04-21 09:31:58 +08001012 /* ...
1013 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
1014 * ...
1015 * with ProtocolVersion defined as:
1016 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001017 */
1018 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1019 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
1020 p += 2;
1021
Jerry Yu1c3e6882022-04-20 21:23:40 +08001022 /* ...
1023 * Random random;
1024 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +08001025 * with Random defined as:
1026 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +08001027 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001028 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001029 if( is_hrr )
1030 {
1031 memcpy( p, mbedtls_ssl_tls13_hello_retry_request_magic,
1032 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1033 }
1034 else
1035 {
1036 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
1037 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1038 }
Jerry Yu955ddd72022-04-22 22:27:33 +08001039 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +08001040 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
1041 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
1042
Jerry Yucfc04b32022-04-21 09:31:58 +08001043 /* ...
1044 * opaque legacy_session_id_echo<0..32>;
1045 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +08001046 */
1047 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
1048 *p++ = (unsigned char)ssl->session_negotiate->id_len;
1049 if( ssl->session_negotiate->id_len > 0 )
1050 {
1051 memcpy( p, &ssl->session_negotiate->id[0],
1052 ssl->session_negotiate->id_len );
1053 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +08001054
Jerry Yu3bf2c642022-03-30 22:02:12 +08001055 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
1056 ssl->session_negotiate->id_len );
1057 }
1058
Jerry Yucfc04b32022-04-21 09:31:58 +08001059 /* ...
1060 * CipherSuite cipher_suite;
1061 * ...
1062 * with CipherSuite defined as:
1063 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +08001064 */
1065 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
1066 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
1067 p += 2;
1068 MBEDTLS_SSL_DEBUG_MSG( 3,
1069 ( "server hello, chosen ciphersuite: %s ( id=%d )",
1070 mbedtls_ssl_get_ciphersuite_name(
1071 ssl->session_negotiate->ciphersuite ),
1072 ssl->session_negotiate->ciphersuite ) );
1073
Jerry Yucfc04b32022-04-21 09:31:58 +08001074 /* ...
1075 * uint8 legacy_compression_method = 0;
1076 * ...
1077 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001078 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
1079 *p++ = 0x0;
1080
Jerry Yucfc04b32022-04-21 09:31:58 +08001081 /* ...
1082 * Extension extensions<6..2^16-1>;
1083 * ...
1084 * struct {
1085 * ExtensionType extension_type; (2 bytes)
1086 * opaque extension_data<0..2^16-1>;
1087 * } Extension;
1088 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001089 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08001090 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001091 p += 2;
1092
Jerry Yue74e04a2022-04-21 09:23:16 +08001093 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08001094 ssl, p, end, &output_len ) ) != 0 )
1095 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001096 MBEDTLS_SSL_DEBUG_RET(
1097 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001098 return( ret );
1099 }
1100 p += output_len;
1101
Jerry Yu3bf2c642022-03-30 22:02:12 +08001102 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1103 {
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001104 if( is_hrr )
1105 ret = ssl_tls13_write_hrr_key_share_ext( ssl, p, end, &output_len );
1106 else
1107 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001108 if( ret != 0 )
1109 return( ret );
1110 p += output_len;
1111 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001112
Jerry Yud9436a12022-04-20 22:28:09 +08001113 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001114
Jerry Yud9436a12022-04-20 22:28:09 +08001115 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
1116 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001117
Jerry Yud9436a12022-04-20 22:28:09 +08001118 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001119
Jerry Yud9436a12022-04-20 22:28:09 +08001120 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001121
1122 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08001123}
1124
Jerry Yue110d252022-05-05 10:19:22 +08001125static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
1126{
1127 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08001128 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08001129 if( ret != 0 )
1130 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001131 MBEDTLS_SSL_DEBUG_RET( 1,
1132 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08001133 ret );
1134 return( ret );
1135 }
1136
1137 mbedtls_ssl_set_outbound_transform( ssl,
1138 ssl->handshake->transform_handshake );
1139 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuf86eb752022-05-06 11:16:55 +08001140 3, ( "switching to handshake transform for outbound data" ) );
Jerry Yue110d252022-05-05 10:19:22 +08001141
1142 return( ret );
1143}
1144
Jerry Yu5b64ae92022-03-30 17:15:02 +08001145static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
1146{
Jerry Yu637a3f12022-04-20 21:37:58 +08001147 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001148 unsigned char *buf;
1149 size_t buf_len, msg_len;
1150
1151 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
1152
Jerry Yuf4b27e42022-03-30 17:32:21 +08001153 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
1154
Jerry Yu3bf2c642022-03-30 22:02:12 +08001155 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001156 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
1157
Jerry Yu3bf2c642022-03-30 22:02:12 +08001158 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
1159 buf + buf_len,
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001160 &msg_len,
1161 0 ) );
Jerry Yuf4b27e42022-03-30 17:32:21 +08001162
Jerry Yu3bf2c642022-03-30 22:02:12 +08001163 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08001164 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
1165
Jerry Yu3bf2c642022-03-30 22:02:12 +08001166 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08001167 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08001168
Jerry Yue110d252022-05-05 10:19:22 +08001169 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
1170
Jerry Yu637a3f12022-04-20 21:37:58 +08001171 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Jerry Yue110d252022-05-05 10:19:22 +08001172
Jerry Yuf4b27e42022-03-30 17:32:21 +08001173cleanup:
1174
1175 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
1176 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08001177}
1178
1179/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08001180 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
1181 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08001182
1183/*
1184 * struct {
1185 * Extension extensions<0..2 ^ 16 - 1>;
1186 * } EncryptedExtensions;
1187 *
1188 */
1189static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
1190 unsigned char *buf,
1191 unsigned char *end,
1192 size_t *out_len )
1193{
Jerry Yu4d3841a2022-04-16 12:37:19 +08001194 unsigned char *p = buf;
1195 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08001196 unsigned char *p_extensions_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08001197
Jerry Yu4d3841a2022-04-16 12:37:19 +08001198 *out_len = 0;
1199
1200 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08001201 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08001202 p += 2;
1203
Jerry Yu8937eb42022-05-03 12:12:14 +08001204 ((void) ssl);
Jerry Yu4d3841a2022-04-16 12:37:19 +08001205
Jerry Yu8937eb42022-05-03 12:12:14 +08001206 extensions_len = ( p - p_extensions_len ) - 2;
1207 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
1208
1209 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08001210
1211 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
1212
1213 return( 0 );
1214}
1215
1216static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
1217{
1218 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1219 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08001220 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08001221
Jerry Yuab452cc2022-04-28 15:27:08 +08001222 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08001223
Jerry Yu4d3841a2022-04-16 12:37:19 +08001224 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
1225 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
1226
1227 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
1228 ssl, buf, buf + buf_len, &msg_len ) );
1229
1230 mbedtls_ssl_add_hs_msg_to_checksum(
1231 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
1232
Jerry Yu4d3841a2022-04-16 12:37:19 +08001233 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
1234 ssl, buf_len, msg_len ) );
1235
Jerry Yu8937eb42022-05-03 12:12:14 +08001236#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1237 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) )
1238 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1239 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00001240 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08001241#else
1242 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1243#endif
1244
Jerry Yu4d3841a2022-04-16 12:37:19 +08001245cleanup:
1246
Jerry Yuab452cc2022-04-28 15:27:08 +08001247 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08001248 return( ret );
1249}
1250
XiaokangQiancec9ae62022-05-06 07:28:50 +00001251#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00001252#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
1253#define SSL_CERTIFICATE_REQUEST_SKIP 1
1254/* Coordination:
1255 * Check whether a CertificateRequest message should be written.
1256 * Returns a negative code on failure, or
1257 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
1258 * - SSL_CERTIFICATE_REQUEST_SKIP
1259 * indicating if the writing of the CertificateRequest
1260 * should be skipped or not.
1261 */
1262static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
1263{
1264 int authmode;
1265
1266 authmode = ssl->conf->authmode;
1267
1268 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
1269 return( SSL_CERTIFICATE_REQUEST_SKIP );
1270
1271 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
1272}
1273
XiaokangQiancec9ae62022-05-06 07:28:50 +00001274/*
1275 * struct {
1276 * opaque certificate_request_context<0..2^8-1>;
1277 * Extension extensions<2..2^16-1>;
1278 * } CertificateRequest;
1279 *
1280 */
1281static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
1282 unsigned char *buf,
1283 const unsigned char *end,
1284 size_t *out_len )
1285{
1286 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1287 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00001288 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00001289 unsigned char *p_extensions_len;
1290
1291 *out_len = 0;
1292
1293 /* Check if we have enough space:
1294 * - certificate_request_context (1 byte)
1295 * - extensions length (2 bytes)
1296 */
1297 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
1298
1299 /*
1300 * Write certificate_request_context
1301 */
1302 /*
1303 * We use a zero length context for the normal handshake
1304 * messages. For post-authentication handshake messages
1305 * this request context would be set to a non-zero value.
1306 */
1307 *p++ = 0x0;
1308
1309 /*
1310 * Write extensions
1311 */
1312 /* The extensions must contain the signature_algorithms. */
1313 p_extensions_len = p;
1314 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00001315 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00001316 if( ret != 0 )
1317 return( ret );
1318
XiaokangQianec6efb92022-05-06 09:53:10 +00001319 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00001320 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00001321
1322 *out_len = p - buf;
1323
1324 return( 0 );
1325}
1326
1327static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
1328{
1329 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1330
1331 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
1332
1333 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
1334
1335 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
1336 {
1337 unsigned char *buf;
1338 size_t buf_len, msg_len;
1339
1340 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
1341 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
1342
1343 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
1344 ssl, buf, buf + buf_len, &msg_len ) );
1345
1346 mbedtls_ssl_add_hs_msg_to_checksum(
1347 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
1348
1349 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
1350 ssl, buf_len, msg_len ) );
1351 }
1352 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
1353 {
1354 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
1355 ret = 0;
1356 }
1357 else
1358 {
1359 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1360 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1361 goto cleanup;
1362 }
1363
1364 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
1365cleanup:
1366
1367 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
1368 return( ret );
1369}
1370#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1371
Jerry Yu4d3841a2022-04-16 12:37:19 +08001372/*
Jerry Yu67a2c372022-04-14 18:52:29 +08001373 * Handler for MBEDTLS_SSL_HELLO_RETRY_REQUEST
1374 */
1375
Jerry Yu582dd062022-04-22 21:59:01 +08001376static int ssl_tls13_write_hello_retry_request_coordinate(
1377 mbedtls_ssl_context *ssl )
1378{
1379 int ret;
1380 if( ssl->handshake->hello_retry_request_count > 1 )
1381 {
1382 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Too many HRRs" ) );
1383 return( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
1384 }
1385
1386 /*
1387 * Create stateless transcript hash for HRR
1388 */
1389 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Reset transcript for HRR" ) );
1390 ret = mbedtls_ssl_reset_transcript_for_hrr( ssl );
1391 if( ret != 0 )
1392 {
1393 MBEDTLS_SSL_DEBUG_RET( 1, "mbedtls_ssl_reset_transcript_for_hrr", ret );
1394 return( ret );
1395 }
1396 mbedtls_ssl_session_reset_msg_layer( ssl, 0 );
1397
1398 return( 0 );
1399}
1400
Jerry Yu67a2c372022-04-14 18:52:29 +08001401static int ssl_tls13_write_hello_retry_request( mbedtls_ssl_context *ssl )
1402{
Jerry Yu582dd062022-04-22 21:59:01 +08001403 int ret;
1404 unsigned char *buf;
1405 size_t buf_len, msg_len;
1406
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001407 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write hello retry request" ) );
1408
Jerry Yu582dd062022-04-22 21:59:01 +08001409 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_hello_retry_request_coordinate( ssl ) );
1410
1411 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
1412 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
1413
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001414 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
1415 buf + buf_len,
1416 &msg_len,
1417 1 ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001418 mbedtls_ssl_add_hs_msg_to_checksum(
1419 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
1420
1421
1422 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg( ssl, buf_len,
1423 msg_len ) );
1424
1425 ssl->handshake->hello_retry_request_count++;
1426
1427 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1428
1429cleanup:
Jerry Yu23f7a6f2022-04-23 15:16:45 +08001430 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write hello retry request" ) );
Jerry Yu582dd062022-04-22 21:59:01 +08001431 return( ret );
Jerry Yu67a2c372022-04-14 18:52:29 +08001432}
1433
1434/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00001435 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00001436 */
Jerry Yu27561932021-08-27 17:07:38 +08001437int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08001438{
XiaokangQian08037552022-04-20 07:16:41 +00001439 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001440
1441 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
1442 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1443
Jerry Yue3b34122021-09-28 17:53:35 +08001444 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
1445 mbedtls_ssl_states_str( ssl->state ),
1446 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08001447
XiaokangQian7807f9f2022-02-15 10:04:37 +00001448 switch( ssl->state )
1449 {
1450 /* start state */
1451 case MBEDTLS_SSL_HELLO_REQUEST:
Jerry Yu582dd062022-04-22 21:59:01 +08001452 ssl->handshake->hello_retry_request_count = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001453 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1454
XiaokangQian08037552022-04-20 07:16:41 +00001455 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001456 break;
1457
XiaokangQian7807f9f2022-02-15 10:04:37 +00001458 case MBEDTLS_SSL_CLIENT_HELLO:
1459
XiaokangQian4080a7f2022-04-11 09:55:18 +00001460 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001461 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00001462 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001463
1464 break;
1465
Jerry Yu5b64ae92022-03-30 17:15:02 +08001466 case MBEDTLS_SSL_SERVER_HELLO:
1467 ret = ssl_tls13_write_server_hello( ssl );
1468 break;
1469
Jerry Yu67a2c372022-04-14 18:52:29 +08001470<<<<<<< HEAD
Xiaofei Baicba64af2022-02-15 10:00:56 +00001471 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08001472 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00001473 if( ret != 0 )
1474 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08001475 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
1476 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00001477 }
Jerry Yu67a2c372022-04-14 18:52:29 +08001478=======
1479 case MBEDTLS_SSL_HELLO_RETRY_REQUEST:
1480 ret = ssl_tls13_write_hello_retry_request( ssl );
1481>>>>>>> tls13:hrr:add empty frame work
Xiaofei Baicba64af2022-02-15 10:00:56 +00001482 break;
1483
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00001484#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1485 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00001486 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00001487 break;
1488#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1489
XiaokangQian7807f9f2022-02-15 10:04:37 +00001490 default:
1491 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00001492 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001493 }
1494
1495 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08001496}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001497
Jerry Yufb4b6472022-01-27 15:03:26 +08001498#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */