blob: a41ccea124a28727b289d28e4a2a30dfa1c28bc5 [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"
25
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080026#include "ssl_misc.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000027#include "ssl_tls13_keys.h"
Gilles Peskine923d5c92021-12-15 12:56:54 +010028#include "ssl_debug_helpers.h"
Jerry Yu3bf2c642022-03-30 22:02:12 +080029#include "ecdh_misc.h"
30
XiaokangQian7807f9f2022-02-15 10:04:37 +000031#if defined(MBEDTLS_ECP_C)
32#include "mbedtls/ecp.h"
XiaokangQian7807f9f2022-02-15 10:04:37 +000033#endif /* MBEDTLS_ECP_C */
Jerry Yu3cc4c2a2021-08-06 16:29:08 +080034
XiaokangQiana9c58412022-02-17 09:41:26 +000035#if defined(MBEDTLS_PLATFORM_C)
36#include "mbedtls/platform.h"
37#else
38#include <stdlib.h>
39#define mbedtls_calloc calloc
40#define mbedtls_free free
41#endif /* MBEDTLS_PLATFORM_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +000042
43/* From RFC 8446:
44 * struct {
XiaokangQiancfd925f2022-04-14 07:10:37 +000045 * ProtocolVersion versions<2..254>;
XiaokangQian7807f9f2022-02-15 10:04:37 +000046 * } SupportedVersions;
47 */
48static int ssl_tls13_parse_supported_versions_ext( mbedtls_ssl_context *ssl,
49 const unsigned char *buf,
50 const unsigned char *end )
51{
XiaokangQian7807f9f2022-02-15 10:04:37 +000052 const unsigned char *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +000053 size_t versions_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +000054 const unsigned char *versions_end;
XiaokangQian0a1b54e2022-04-21 03:01:38 +000055 uint16_t tls_version;
XiaokangQian8f9dfe42022-04-15 02:52:39 +000056 int tls13_supported = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +000057
58 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 1 );
XiaokangQian4080a7f2022-04-11 09:55:18 +000059 versions_len = p[0];
XiaokangQian7807f9f2022-02-15 10:04:37 +000060 p += 1;
61
XiaokangQian4080a7f2022-04-11 09:55:18 +000062 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, versions_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +000063 versions_end = p + versions_len;
64 while( p < versions_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +000065 {
XiaokangQiancfd925f2022-04-14 07:10:37 +000066 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, versions_end, 2 );
XiaokangQiande333912022-04-20 08:49:42 +000067 tls_version = mbedtls_ssl_read_version( p, ssl->conf->transport );
XiaokangQianb67384d2022-04-19 00:02:38 +000068 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +000069
70 /* In this implementation we only support TLS 1.3 and DTLS 1.3. */
XiaokangQiande333912022-04-20 08:49:42 +000071 if( tls_version == MBEDTLS_SSL_VERSION_TLS1_3 )
XiaokangQian7807f9f2022-02-15 10:04:37 +000072 {
73 tls13_supported = 1;
74 break;
75 }
XiaokangQian7807f9f2022-02-15 10:04:37 +000076 }
77
XiaokangQianb67384d2022-04-19 00:02:38 +000078 if( !tls13_supported )
XiaokangQian7807f9f2022-02-15 10:04:37 +000079 {
XiaokangQian7807f9f2022-02-15 10:04:37 +000080 MBEDTLS_SSL_DEBUG_MSG( 1, ( "TLS 1.3 is not supported by the client" ) );
81
82 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
83 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
84 return( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
85 }
86
XiaokangQiande333912022-04-20 08:49:42 +000087 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Negotiated version. Supported is [%04x]",
XiaokangQian0a1b54e2022-04-21 03:01:38 +000088 (unsigned int)tls_version ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +000089
XiaokangQian7807f9f2022-02-15 10:04:37 +000090 return( 0 );
91}
92
XiaokangQian8f9dfe42022-04-15 02:52:39 +000093#if defined(MBEDTLS_ECDH_C)
XiaokangQiane8ff3502022-04-22 02:34:40 +000094/*
XiaokangQian7807f9f2022-02-15 10:04:37 +000095 *
96 * From RFC 8446:
97 * enum {
98 * ... (0xFFFF)
99 * } NamedGroup;
100 * struct {
101 * NamedGroup named_group_list<2..2^16-1>;
102 * } NamedGroupList;
103 */
XiaokangQiancfd925f2022-04-14 07:10:37 +0000104static int ssl_tls13_parse_supported_groups_ext(
XiaokangQian7807f9f2022-02-15 10:04:37 +0000105 mbedtls_ssl_context *ssl,
106 const unsigned char *buf, const unsigned char *end )
107{
XiaokangQian7807f9f2022-02-15 10:04:37 +0000108 const unsigned char *p = buf;
XiaokangQian84823772022-04-19 07:57:30 +0000109 size_t named_group_list_len;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000110 const unsigned char *named_group_list_end;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000111
112 MBEDTLS_SSL_DEBUG_BUF( 3, "supported_groups extension", p, end - buf );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000113 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000114 named_group_list_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000115 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000116 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, named_group_list_len );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000117 named_group_list_end = p + named_group_list_len;
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000118 ssl->handshake->hrr_selected_group = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000119
XiaokangQian08037552022-04-20 07:16:41 +0000120 while( p < named_group_list_end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000121 {
XiaokangQian08037552022-04-20 07:16:41 +0000122 uint16_t named_group;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000123 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, named_group_list_end, 2 );
XiaokangQian08037552022-04-20 07:16:41 +0000124 named_group = MBEDTLS_GET_UINT16_BE( p, 0 );
125 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000126
XiaokangQian318dc762022-04-20 09:43:51 +0000127 MBEDTLS_SSL_DEBUG_MSG( 2, ( "got named group: %d", named_group ) );
XiaokangQian08037552022-04-20 07:16:41 +0000128
129 if( ! mbedtls_ssl_named_group_is_offered( ssl, named_group ) ||
130 ! mbedtls_ssl_named_group_is_supported( named_group ) ||
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000131 ssl->handshake->hrr_selected_group != 0 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000132 {
XiaokangQian08037552022-04-20 07:16:41 +0000133 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000134 }
135
XiaokangQian08037552022-04-20 07:16:41 +0000136 MBEDTLS_SSL_DEBUG_MSG(
137 2, ( "add named group (%04x) into received list.",
138 named_group ) );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000139 ssl->handshake->hrr_selected_group = named_group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000140 }
141
142 return( 0 );
143
144}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000145#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000146
XiaokangQian08037552022-04-20 07:16:41 +0000147#define SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH 1
148
XiaokangQian88408882022-04-02 10:15:03 +0000149#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000150/*
151 * ssl_tls13_parse_key_shares_ext() verifies whether the information in the
XiaokangQiane8ff3502022-04-22 02:34:40 +0000152 * extension is correct and stores the first acceptable key share and its associated group.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000153 *
154 * Possible return values are:
155 * - 0: Successful processing of the client provided key share extension.
XiaokangQian08037552022-04-20 07:16:41 +0000156 * - SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH: The key shares provided by the client
XiaokangQian7807f9f2022-02-15 10:04:37 +0000157 * does not match a group supported by the server. A HelloRetryRequest will
158 * be needed.
XiaokangQiane8ff3502022-04-22 02:34:40 +0000159 * - A negative value for fatal errors.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000160*/
161
162static int ssl_tls13_parse_key_shares_ext( mbedtls_ssl_context *ssl,
163 const unsigned char *buf,
164 const unsigned char *end )
165{
XiaokangQianb67384d2022-04-19 00:02:38 +0000166 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000167 unsigned char const *p = buf;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000168 unsigned char const *client_shares_end;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000169 size_t client_shares_len, key_exchange_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000170 int match_found = 0;
171
172 /* From RFC 8446:
173 *
174 * struct {
175 * KeyShareEntry client_shares<0..2^16-1>;
176 * } KeyShareClientHello;
177 *
178 */
179
XiaokangQian7807f9f2022-02-15 10:04:37 +0000180 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 2 );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000181 client_shares_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000182 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000183 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, client_shares_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000184
185 ssl->handshake->offered_group_id = 0;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000186 client_shares_end = p + client_shares_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000187
188 /* We try to find a suitable key share entry and copy it to the
189 * handshake context. Later, we have to find out whether we can do
190 * something with the provided key share or whether we have to
XiaokangQianc5763b52022-04-02 03:34:37 +0000191 * dismiss it and send a HelloRetryRequest message.
192 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000193
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000194 for( ; p < client_shares_end; p += key_exchange_len )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000195 {
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000196 uint16_t group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000197
198 /*
199 * struct {
200 * NamedGroup group;
201 * opaque key_exchange<1..2^16-1>;
202 * } KeyShareEntry;
203 */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000204 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, 4 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000205 group = MBEDTLS_GET_UINT16_BE( p, 0 );
206 p += 2;
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000207 key_exchange_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000208 p += 2;
XiaokangQianb67384d2022-04-19 00:02:38 +0000209 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, client_shares_end, key_exchange_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000210
211 /* Continue parsing even if we have already found a match,
XiaokangQianc5763b52022-04-02 03:34:37 +0000212 * for input validation purposes.
213 */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000214 if( match_found == 1 )
215 continue;
216
XiaokangQian060d8672022-04-21 09:24:56 +0000217 if( ! mbedtls_ssl_named_group_is_offered( ssl, group ) ||
218 ! mbedtls_ssl_named_group_is_supported( group ) )
219 {
220 continue;
221 }
XiaokangQian060d8672022-04-21 09:24:56 +0000222
XiaokangQian7807f9f2022-02-15 10:04:37 +0000223 /*
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000224 * For now, we only support ECDHE groups.
XiaokangQian7807f9f2022-02-15 10:04:37 +0000225 */
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000226 if( mbedtls_ssl_tls13_named_group_is_ecdhe( group ) )
227 {
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000228 const mbedtls_ecp_curve_info *curve_info =
229 mbedtls_ecp_curve_info_from_tls_id( group );
230 ((void) curve_info);
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000231 MBEDTLS_SSL_DEBUG_MSG( 2, ( "ECDH curve: %s", curve_info->name ) );
XiaokangQian318dc762022-04-20 09:43:51 +0000232 ret = mbedtls_ssl_tls13_read_public_ecdhe_share(
233 ssl, p - 2, key_exchange_len + 2 );
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000234 if( ret != 0 )
235 return( ret );
XiaokangQian4e8cd7b2022-04-21 09:48:09 +0000236
237 match_found = 1;
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000238 }
239 else
XiaokangQian7807f9f2022-02-15 10:04:37 +0000240 {
241 MBEDTLS_SSL_DEBUG_MSG( 4, ( "Unrecognized NamedGroup %u",
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000242 (unsigned) group ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000243 continue;
244 }
245
XiaokangQian9b5d04b2022-04-10 10:20:43 +0000246 ssl->handshake->offered_group_id = group;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000247 }
248
249 if( match_found == 0 )
250 {
251 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no matching key share" ) );
XiaokangQian08037552022-04-20 07:16:41 +0000252 return( SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000253 }
254 return( 0 );
255}
XiaokangQian88408882022-04-02 10:15:03 +0000256#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000257
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000258#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000259static void ssl_tls13_debug_print_client_hello_exts( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000260{
XiaokangQian3207a322022-02-23 03:15:27 +0000261 ((void) ssl);
262
XiaokangQian7807f9f2022-02-15 10:04:37 +0000263 MBEDTLS_SSL_DEBUG_MSG( 3, ( "Supported Extensions:" ) );
XiaokangQianb67384d2022-04-19 00:02:38 +0000264 MBEDTLS_SSL_DEBUG_MSG( 3,
265 ( "- KEY_SHARE_EXTENSION ( %s )",
266 ( ( ssl->handshake->extensions_present
267 & MBEDTLS_SSL_EXT_KEY_SHARE ) > 0 ) ? "TRUE" : "FALSE" ) );
268 MBEDTLS_SSL_DEBUG_MSG( 3,
269 ( "- PSK_KEY_EXCHANGE_MODES_EXTENSION ( %s )",
270 ( ( ssl->handshake->extensions_present
271 & MBEDTLS_SSL_EXT_PSK_KEY_EXCHANGE_MODES ) > 0 ) ?
272 "TRUE" : "FALSE" ) );
273 MBEDTLS_SSL_DEBUG_MSG( 3,
274 ( "- PRE_SHARED_KEY_EXTENSION ( %s )",
275 ( ( ssl->handshake->extensions_present
276 & MBEDTLS_SSL_EXT_PRE_SHARED_KEY ) > 0 ) ? "TRUE" : "FALSE" ) );
277 MBEDTLS_SSL_DEBUG_MSG( 3,
278 ( "- SIGNATURE_ALGORITHM_EXTENSION ( %s )",
279 ( ( ssl->handshake->extensions_present
280 & MBEDTLS_SSL_EXT_SIG_ALG ) > 0 ) ? "TRUE" : "FALSE" ) );
281 MBEDTLS_SSL_DEBUG_MSG( 3,
282 ( "- SUPPORTED_GROUPS_EXTENSION ( %s )",
283 ( ( ssl->handshake->extensions_present
284 & MBEDTLS_SSL_EXT_SUPPORTED_GROUPS ) >0 ) ?
285 "TRUE" : "FALSE" ) );
286 MBEDTLS_SSL_DEBUG_MSG( 3,
287 ( "- SUPPORTED_VERSION_EXTENSION ( %s )",
288 ( ( ssl->handshake->extensions_present
289 & MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS ) > 0 ) ?
290 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000291#if defined ( MBEDTLS_SSL_SERVER_NAME_INDICATION )
XiaokangQianb67384d2022-04-19 00:02:38 +0000292 MBEDTLS_SSL_DEBUG_MSG( 3,
293 ( "- SERVERNAME_EXTENSION ( %s )",
294 ( ( ssl->handshake->extensions_present
295 & MBEDTLS_SSL_EXT_SERVERNAME ) > 0 ) ?
296 "TRUE" : "FALSE" ) );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000297#endif /* MBEDTLS_SSL_SERVER_NAME_INDICATION */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000298}
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000299#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000300
XiaokangQian4080a7f2022-04-11 09:55:18 +0000301static int ssl_tls13_client_hello_has_exts( mbedtls_ssl_context *ssl,
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000302 int exts_mask )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000303{
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000304 int masked = ssl->handshake->extensions_present & exts_mask;
305 return( masked == exts_mask );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000306}
307
XiaokangQianb67384d2022-04-19 00:02:38 +0000308static int ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange(
309 mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000310{
XiaokangQian4080a7f2022-04-11 09:55:18 +0000311 return( ssl_tls13_client_hello_has_exts( ssl,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000312 MBEDTLS_SSL_EXT_SUPPORTED_GROUPS |
313 MBEDTLS_SSL_EXT_KEY_SHARE |
314 MBEDTLS_SSL_EXT_SIG_ALG ) );
315}
316
XiaokangQianb67384d2022-04-19 00:02:38 +0000317static int ssl_tls13_check_ephemeral_key_exchange( mbedtls_ssl_context *ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000318{
319 if( !mbedtls_ssl_conf_tls13_ephemeral_enabled( ssl ) )
320 return( 0 );
321
XiaokangQianb67384d2022-04-19 00:02:38 +0000322 if( !ssl_tls13_client_hello_has_exts_for_ephemeral_key_exchange( ssl ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000323 return( 0 );
324
XiaokangQianb67384d2022-04-19 00:02:38 +0000325 ssl->handshake->tls13_kex_modes =
326 MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000327 return( 1 );
328}
329
XiaokangQian4080a7f2022-04-11 09:55:18 +0000330/*
XiaokangQianed582dd2022-04-13 08:21:05 +0000331 *
332 * STATE HANDLING: ClientHello
333 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000334 * There are three possible classes of outcomes when parsing the ClientHello:
XiaokangQianed582dd2022-04-13 08:21:05 +0000335 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000336 * 1) The ClientHello was well-formed and matched the server's configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +0000337 *
338 * In this case, the server progresses to sending its ServerHello.
339 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000340 * 2) The ClientHello was well-formed but didn't match the server's
341 * configuration.
XiaokangQianed582dd2022-04-13 08:21:05 +0000342 *
343 * For example, the client might not have offered a key share which
344 * the server supports, or the server might require a cookie.
345 *
346 * In this case, the server sends a HelloRetryRequest.
347 *
XiaokangQianb67384d2022-04-19 00:02:38 +0000348 * 3) The ClientHello was ill-formed
XiaokangQianed582dd2022-04-13 08:21:05 +0000349 *
350 * In this case, we abort the handshake.
351 *
352 */
353
354/*
XiaokangQian4080a7f2022-04-11 09:55:18 +0000355 * Structure of this message:
356 *
XiaokangQiane8ff3502022-04-22 02:34:40 +0000357 * uint16 ProtocolVersion;
358 * opaque Random[32];
359 * uint8 CipherSuite[2]; // Cryptographic suite selector
XiaokangQian4080a7f2022-04-11 09:55:18 +0000360 *
XiaokangQiane8ff3502022-04-22 02:34:40 +0000361 * struct {
362 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
363 * Random random;
364 * opaque legacy_session_id<0..32>;
365 * CipherSuite cipher_suites<2..2^16-2>;
366 * opaque legacy_compression_methods<1..2^8-1>;
367 * Extension extensions<8..2^16-1>;
368 * } ClientHello;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000369 */
XiaokangQianed582dd2022-04-13 08:21:05 +0000370
371#define SSL_CLIENT_HELLO_OK 0
372#define SSL_CLIENT_HELLO_HRR_REQUIRED 1
373
XiaokangQian4080a7f2022-04-11 09:55:18 +0000374static int ssl_tls13_parse_client_hello( mbedtls_ssl_context *ssl,
375 const unsigned char *buf,
376 const unsigned char *end )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000377{
XiaokangQianb67384d2022-04-19 00:02:38 +0000378 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
379 const unsigned char *p = buf;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000380 size_t legacy_session_id_len;
XiaokangQian060d8672022-04-21 09:24:56 +0000381 const unsigned char *cipher_suites;
XiaokangQian318dc762022-04-20 09:43:51 +0000382 size_t cipher_suites_len;
XiaokangQian060d8672022-04-21 09:24:56 +0000383 const unsigned char *cipher_suites_end;
XiaokangQianb67384d2022-04-19 00:02:38 +0000384 size_t extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000385 const unsigned char *extensions_end;
386
XiaokangQian7807f9f2022-02-15 10:04:37 +0000387 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000388
389 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
390
391 /*
XiaokangQianb67384d2022-04-19 00:02:38 +0000392 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +0000393 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +0000394 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +0000395 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000396 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +0000397 * .. . .. ciphersuite list length ( 2 bytes )
398 * .. . .. ciphersuite list
399 * .. . .. compression alg. list length ( 1 byte )
400 * .. . .. compression alg. list
401 * .. . .. extensions length ( 2 bytes, optional )
402 * .. . .. extensions ( optional )
403 */
404
XiaokangQianb67384d2022-04-19 00:02:38 +0000405 /*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000406 * Minimal length ( with everything empty and extensions ommitted ) is
407 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
408 * read at least up to session id length without worrying.
409 */
410 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
411
412 /* ...
413 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
414 * ...
415 * with ProtocolVersion defined as:
416 * uint16 ProtocolVersion;
417 */
XiaokangQiande333912022-04-20 08:49:42 +0000418 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
419 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000420 {
421 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
422 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
423 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +0000424 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000425 }
426 p += 2;
427
428 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +0000429 * Only support TLS 1.3 currently, temporarily set the version.
430 */
XiaokangQiande333912022-04-20 08:49:42 +0000431 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +0000432
XiaokangQian08037552022-04-20 07:16:41 +0000433 /* ---
XiaokangQianb67384d2022-04-19 00:02:38 +0000434 * Random random;
435 * ---
436 * with Random defined as:
437 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000438 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000439 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +0000440 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000441
XiaokangQian08037552022-04-20 07:16:41 +0000442 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
443 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000444
XiaokangQianb67384d2022-04-19 00:02:38 +0000445 /* ---
446 * opaque legacy_session_id<0..32>;
447 * ---
XiaokangQian7807f9f2022-02-15 10:04:37 +0000448 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000449 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +0000450 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000451
XiaokangQianb67384d2022-04-19 00:02:38 +0000452 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000453 {
454 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
455 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
456 }
457
XiaokangQian4080a7f2022-04-11 09:55:18 +0000458 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +0000459 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +0000460 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +0000461 /*
462 * Check we have enough data for the legacy session identifier
463 * and the ciphersuite list length.
464 */
465 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000466
XiaokangQianed582dd2022-04-13 08:21:05 +0000467 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000468 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000469
XiaokangQian7807f9f2022-02-15 10:04:37 +0000470 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
471 p += 2;
472
XiaokangQianb67384d2022-04-19 00:02:38 +0000473 /* Check we have enough data for the ciphersuite list, the legacy
474 * compression methods and the length of the extensions.
475 */
476 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000477
XiaokangQian08037552022-04-20 07:16:41 +0000478 /* ---
479 * CipherSuite cipher_suites<2..2^16-2>;
480 * ---
481 * with CipherSuite defined as:
482 * uint8 CipherSuite[2];
483 */
XiaokangQian060d8672022-04-21 09:24:56 +0000484 cipher_suites = p;
485 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000486 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
487 p, cipher_suites_len );
XiaokangQian17f974c2022-04-19 09:57:41 +0000488 /*
489 * Search for a matching ciphersuite
490 */
XiaokangQian318dc762022-04-20 09:43:51 +0000491 int ciphersuite_match = 0;
XiaokangQian060d8672022-04-21 09:24:56 +0000492 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +0000493 {
XiaokangQiane8ff3502022-04-22 02:34:40 +0000494 uint16_t cipher_suite;
495 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
496 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
497 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
XiaokangQian08037552022-04-20 07:16:41 +0000498 /*
XiaokangQiane8ff3502022-04-22 02:34:40 +0000499 * Check whether this ciphersuite is valid and offered.
500 */
XiaokangQian08037552022-04-20 07:16:41 +0000501 if( ( mbedtls_ssl_validate_ciphersuite(
XiaokangQiande333912022-04-20 08:49:42 +0000502 ssl, ciphersuite_info, ssl->tls_version,
503 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +0000504 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
505 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000506
XiaokangQian08037552022-04-20 07:16:41 +0000507 ssl->session_negotiate->ciphersuite = cipher_suite;
508 ssl->handshake->ciphersuite_info = ciphersuite_info;
XiaokangQian318dc762022-04-20 09:43:51 +0000509 ciphersuite_match = 1;
XiaokangQian17f974c2022-04-19 09:57:41 +0000510
XiaokangQian08037552022-04-20 07:16:41 +0000511 break;
XiaokangQian17f974c2022-04-19 09:57:41 +0000512
XiaokangQian17f974c2022-04-19 09:57:41 +0000513 }
514
XiaokangQian318dc762022-04-20 09:43:51 +0000515 if( !ciphersuite_match )
516 {
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000517 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
518 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
519 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
XiaokangQian318dc762022-04-20 09:43:51 +0000520 }
XiaokangQian17f974c2022-04-19 09:57:41 +0000521
522 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %s",
523 ciphersuite_info->name ) );
524
XiaokangQian060d8672022-04-21 09:24:56 +0000525 p = cipher_suites + cipher_suites_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000526 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +0000527 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000528 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +0000529 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000530 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000531 {
XiaokangQian4080a7f2022-04-11 09:55:18 +0000532 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
533 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
534 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
535 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000536 }
XiaokangQianb67384d2022-04-19 00:02:38 +0000537 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000538
XiaokangQianb67384d2022-04-19 00:02:38 +0000539 /* ---
540 * Extension extensions<8..2^16-1>;
541 * ---
542 * with Extension defined as:
543 * struct {
544 * ExtensionType extension_type;
545 * opaque extension_data<0..2^16-1>;
546 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000547 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000548 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000549 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000550 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +0000551 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000552
XiaokangQian4080a7f2022-04-11 09:55:18 +0000553 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000554
555 while( p < extensions_end )
556 {
557 unsigned int extension_type;
558 size_t extension_data_len;
559 const unsigned char *extension_data_end;
560
XiaokangQian318dc762022-04-20 09:43:51 +0000561 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000562 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
563 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
564 p += 4;
565
566 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
567 extension_data_end = p + extension_data_len;
568
569 switch( extension_type )
570 {
XiaokangQianb67384d2022-04-19 00:02:38 +0000571#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000572 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
573 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
574
575 /* Supported Groups Extension
576 *
577 * When sent by the client, the "supported_groups" extension
578 * indicates the named groups which the client supports,
579 * ordered from most preferred to least preferred.
580 */
XiaokangQiancfd925f2022-04-14 07:10:37 +0000581 ret = ssl_tls13_parse_supported_groups_ext( ssl, p,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000582 extension_data_end );
583 if( ret != 0 )
584 {
585 MBEDTLS_SSL_DEBUG_RET( 1,
586 "mbedtls_ssl_parse_supported_groups_ext", ret );
587 return( ret );
588 }
589
590 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
591 break;
XiaokangQianb67384d2022-04-19 00:02:38 +0000592#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000593
XiaokangQian88408882022-04-02 10:15:03 +0000594#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000595 case MBEDTLS_TLS_EXT_KEY_SHARE:
596 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
597
598 /*
599 * Key Share Extension
600 *
601 * When sent by the client, the "key_share" extension
602 * contains the endpoint's cryptographic parameters for
603 * ECDHE/DHE key establishment methods.
604 */
605 ret = ssl_tls13_parse_key_shares_ext( ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +0000606 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000607 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000608 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
609 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000610 }
611
612 if( ret != 0 )
613 return( ret );
614
615 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
616 break;
XiaokangQian88408882022-04-02 10:15:03 +0000617#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000618
619 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
620 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
621
622 ret = ssl_tls13_parse_supported_versions_ext(
XiaokangQianb67384d2022-04-19 00:02:38 +0000623 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000624 if( ret != 0 )
625 {
626 MBEDTLS_SSL_DEBUG_RET( 1,
627 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
628 return( ret );
629 }
630 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
631 break;
632
633#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
634 case MBEDTLS_TLS_EXT_SIG_ALG:
635 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
636
637 ret = mbedtls_ssl_tls13_parse_sig_alg_ext( ssl, p,
638 extension_data_end );
639 if( ret != 0 )
640 {
641 MBEDTLS_SSL_DEBUG_MSG( 1,
642 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
643 ret ) );
644 return( ret );
645 }
646 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
647 break;
648#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
649
650 default:
651 MBEDTLS_SSL_DEBUG_MSG( 3,
652 ( "unknown extension found: %ud ( ignoring )",
653 extension_type ) );
654 }
655
656 p += extension_data_len;
657 }
658
659 /* Update checksum with either
660 * - The entire content of the CH message, if no PSK extension is present
661 * - The content up to but excluding the PSK extension, if present.
662 */
XiaokangQian3f84d5d2022-04-19 06:36:17 +0000663 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
XiaokangQianc4b8c992022-04-07 11:31:38 +0000664 buf, p - buf );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000665
666 /* List all the extensions we have received */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000667#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000668 ssl_tls13_debug_print_client_hello_exts( ssl );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000669#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000670
671 /*
XiaokangQianb67384d2022-04-19 00:02:38 +0000672 * Here we only support the ephemeral or (EC)DHE key echange mode
XiaokangQian7807f9f2022-02-15 10:04:37 +0000673 */
674
XiaokangQianb67384d2022-04-19 00:02:38 +0000675 if( !ssl_tls13_check_ephemeral_key_exchange( ssl ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000676 {
677 MBEDTLS_SSL_DEBUG_MSG(
678 1,
679 ( "ClientHello message misses mandatory extensions." ) );
680 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
681 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
682 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
683 }
684
XiaokangQian7807f9f2022-02-15 10:04:37 +0000685 return( 0 );
686}
687
XiaokangQiancfd925f2022-04-14 07:10:37 +0000688static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000689{
XiaokangQian08037552022-04-20 07:16:41 +0000690 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000691
XiaokangQian7807f9f2022-02-15 10:04:37 +0000692 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
693 if( ret != 0 )
694 {
695 MBEDTLS_SSL_DEBUG_RET( 1,
696 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
697 return( ret );
698 }
699
XiaokangQian7807f9f2022-02-15 10:04:37 +0000700 return( 0 );
701
702}
703
704/*
XiaokangQianed582dd2022-04-13 08:21:05 +0000705 * Main entry point from the state machine; orchestrates the otherfunctions.
706 */
707
708static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
709{
710
XiaokangQian08037552022-04-20 07:16:41 +0000711 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +0000712 unsigned char* buf = NULL;
713 size_t buflen = 0;
714 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
715
XiaokangQianed582dd2022-04-13 08:21:05 +0000716 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
717 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
718 &buf, &buflen ) );
719
720 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
721 buf + buflen ) );
XiaokangQiancfd925f2022-04-14 07:10:37 +0000722 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
XiaokangQiane8ff3502022-04-22 02:34:40 +0000723 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
XiaokangQianed582dd2022-04-13 08:21:05 +0000724
725cleanup:
726
727 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
728 return( ret );
729}
730
731/*
Jerry Yu1c3e6882022-04-20 21:23:40 +0800732 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +0800733 */
Jerry Yuf4b27e42022-03-30 17:32:21 +0800734static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
735{
Jerry Yu637a3f12022-04-20 21:37:58 +0800736 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
737 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +0800738 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +0800739 if( ssl->conf->f_rng == NULL )
740 {
741 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
742 return( MBEDTLS_ERR_SSL_NO_RNG );
743 }
744
Jerry Yu637a3f12022-04-20 21:37:58 +0800745 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +0800746 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
747 {
748 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
749 return( ret );
750 }
751
Jerry Yu637a3f12022-04-20 21:37:58 +0800752 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +0800753 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
754
755#if defined(MBEDTLS_HAVE_TIME)
756 ssl->session_negotiate->start = time( NULL );
757#endif /* MBEDTLS_HAVE_TIME */
758
759 return( ret );
760}
761
Jerry Yu3bf2c642022-03-30 22:02:12 +0800762/*
Jerry Yu349a6132022-04-14 20:52:56 +0800763 * ssl_tls13_write_selected_version_ext():
Jerry Yu3bf2c642022-03-30 22:02:12 +0800764 *
765 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +0800766 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800767 * } SupportedVersions;
768 */
Jerry Yu349a6132022-04-14 20:52:56 +0800769static int ssl_tls13_write_selected_version_ext( mbedtls_ssl_context *ssl,
770 unsigned char *buf,
771 unsigned char *end,
772 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800773{
Jerry Yu3bf2c642022-03-30 22:02:12 +0800774 *out_len = 0;
775
Jerry Yu349a6132022-04-14 20:52:56 +0800776 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected_version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800777
778 /* Check if we have space to write the extension:
779 * - extension_type (2 bytes)
780 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +0800781 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +0800782 */
Jerry Yu349a6132022-04-14 20:52:56 +0800783 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800784
Jerry Yu349a6132022-04-14 20:52:56 +0800785 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800786
Jerry Yu349a6132022-04-14 20:52:56 +0800787 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800788
Jerry Yu349a6132022-04-14 20:52:56 +0800789 mbedtls_ssl_write_version( buf + 4,
790 ssl->conf->transport,
791 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800792
793 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
794 ssl->tls_version ) );
795
Jerry Yu349a6132022-04-14 20:52:56 +0800796 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800797
798 return( 0 );
799}
800
Jerry Yud9436a12022-04-20 22:28:09 +0800801
Jerry Yu3bf2c642022-03-30 22:02:12 +0800802
803/* Generate and export a single key share. For hybrid KEMs, this can
804 * be called multiple times with the different components of the hybrid. */
805static int ssl_tls13_key_share_encapsulate( mbedtls_ssl_context *ssl,
806 uint16_t named_group,
807 unsigned char *buf,
808 unsigned char *end,
809 size_t *out_len )
810{
811 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu89e103c2022-03-30 22:43:29 +0800812 ((void) ssl);
813 ((void) named_group);
814 ((void) buf);
815 ((void) end);
816 ((void) out_len);
817#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +0800818 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
819 {
Jerry Yu89e103c2022-03-30 22:43:29 +0800820 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
821 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800822 if( ret != 0 )
823 {
Jerry Yu89e103c2022-03-30 22:43:29 +0800824 MBEDTLS_SSL_DEBUG_RET(
825 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
826 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800827 return( ret );
828 }
Jerry Yu3bf2c642022-03-30 22:02:12 +0800829 }
Jerry Yu89e103c2022-03-30 22:43:29 +0800830 else
831#endif /* MBEDTLS_ECDH_C */
832 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800833 {
834 }
835 else
836 {
837 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
838 }
839
840 return( ret );
841}
842
843/*
844 * ssl_tls13_write_key_share_ext
845 *
846 * Structure of key_share extension in ServerHello:
847 *
Jerry Yu1c3e6882022-04-20 21:23:40 +0800848 * struct {
849 * NamedGroup group;
850 * opaque key_exchange<1..2^16-1>;
851 * } KeyShareEntry;
852 * struct {
853 * KeyShareEntry server_share;
854 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800855 */
856static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
857 unsigned char *buf,
858 unsigned char *end,
859 size_t *out_len )
860{
861 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +0800862 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800863 unsigned char *server_share = buf + 4;
Jerry Yu57d48412022-04-20 21:50:42 +0800864 unsigned char *p_key_exchange_len = buf + 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800865 size_t key_exchange_length;
866 int ret;
867
868 *out_len = 0;
869
870 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
871
872 /* Check if we have space for header and length fields:
873 * - extension_type (2 bytes)
874 * - extension_data_length (2 bytes)
875 * - group (2 bytes)
876 * - key_exchange_length (2 bytes)
877 */
878 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +0800879 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
880 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800881 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +0800882
Jerry Yu3bf2c642022-03-30 22:02:12 +0800883 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
884 * function multiple times. */
Jerry Yu57d48412022-04-20 21:50:42 +0800885 ret = ssl_tls13_key_share_encapsulate( ssl, group, p_key_exchange_len + 2,
Jerry Yu3bf2c642022-03-30 22:02:12 +0800886 end, &key_exchange_length );
887 if( ret != 0 )
888 return( ret );
889 p += key_exchange_length;
Jerry Yu57d48412022-04-20 21:50:42 +0800890 MBEDTLS_PUT_UINT16_BE( key_exchange_length, p_key_exchange_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800891
Jerry Yu57d48412022-04-20 21:50:42 +0800892 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800893
Jerry Yu57d48412022-04-20 21:50:42 +0800894 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800895 return( 0 );
896}
Jerry Yud9436a12022-04-20 22:28:09 +0800897
Jerry Yu3bf2c642022-03-30 22:02:12 +0800898
899/*
900 * Structure of ServerHello message:
901 *
902 * struct {
903 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
904 * Random random;
905 * opaque legacy_session_id_echo<0..32>;
906 * CipherSuite cipher_suite;
907 * uint8 legacy_compression_method = 0;
908 * Extension extensions<6..2^16-1>;
909 * } ServerHello;
910 */
911static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +0800912 unsigned char *buf,
913 unsigned char *end,
914 size_t *out_len )
915{
Jerry Yu3bf2c642022-03-30 22:02:12 +0800916 int ret = 0;
917 size_t output_len; /* Length of buffer used by function */
Jerry Yu637a3f12022-04-20 21:37:58 +0800918 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +0800919 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
920
921 /* Buffer management */
922 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +0800923 unsigned char *p_extensions_len;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800924
925 *out_len = 0;
926
927 /*
928 * Write legacy_version
929 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
930 *
931 * For TLS 1.3 we use the legacy version number {0x03, 0x03}
932 * instead of the true version number.
933 */
934 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
935 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
936 p += 2;
937
Jerry Yu1c3e6882022-04-20 21:23:40 +0800938 /* ...
939 * Random random;
940 * ...
941 */
Jerry Yu3bf2c642022-03-30 22:02:12 +0800942 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu637a3f12022-04-20 21:37:58 +0800943 memcpy( p, server_randbytes, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800944 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
945 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
946 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
947
948#if defined(MBEDTLS_HAVE_TIME)
949 ssl->session_negotiate->start = time( NULL );
950#endif /* MBEDTLS_HAVE_TIME */
951
952 /*
953 * Write legacy_session_id_echo
954 */
955 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
956 *p++ = (unsigned char)ssl->session_negotiate->id_len;
957 if( ssl->session_negotiate->id_len > 0 )
958 {
959 memcpy( p, &ssl->session_negotiate->id[0],
960 ssl->session_negotiate->id_len );
961 p += ssl->session_negotiate->id_len;
962 MBEDTLS_SSL_DEBUG_MSG( 3, ( "session id length ( %"
963 MBEDTLS_PRINTF_SIZET " )",
964 ssl->session_negotiate->id_len ) );
965 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
966 ssl->session_negotiate->id_len );
967 }
968
969 /*
970 * Write ciphersuite
971 */
972 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
973 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
974 p += 2;
975 MBEDTLS_SSL_DEBUG_MSG( 3,
976 ( "server hello, chosen ciphersuite: %s ( id=%d )",
977 mbedtls_ssl_get_ciphersuite_name(
978 ssl->session_negotiate->ciphersuite ),
979 ssl->session_negotiate->ciphersuite ) );
980
981 /* write legacy_compression_method = ( 0 ) */
982 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
983 *p++ = 0x0;
984
985 /* Extensions */
986 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +0800987 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800988 p += 2;
989
990 /* Add supported_version extension */
Jerry Yu349a6132022-04-14 20:52:56 +0800991 if( ( ret = ssl_tls13_write_selected_version_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +0800992 ssl, p, end, &output_len ) ) != 0 )
993 {
Jerry Yu349a6132022-04-14 20:52:56 +0800994 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_selected_version_ext",
Jerry Yu3bf2c642022-03-30 22:02:12 +0800995 ret );
996 return( ret );
997 }
998 p += output_len;
999
Jerry Yu3bf2c642022-03-30 22:02:12 +08001000 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1001 {
1002 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
1003 if( ret != 0 )
1004 return( ret );
1005 p += output_len;
1006 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001007
1008 /* Write length information */
Jerry Yud9436a12022-04-20 22:28:09 +08001009 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001010
Jerry Yud9436a12022-04-20 22:28:09 +08001011 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
1012 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001013
Jerry Yud9436a12022-04-20 22:28:09 +08001014 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001015
Jerry Yud9436a12022-04-20 22:28:09 +08001016 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001017
1018 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08001019}
1020
Jerry Yu5b64ae92022-03-30 17:15:02 +08001021static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
1022{
Jerry Yu637a3f12022-04-20 21:37:58 +08001023 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001024 unsigned char *buf;
1025 size_t buf_len, msg_len;
1026
1027 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
1028
Jerry Yuf4b27e42022-03-30 17:32:21 +08001029 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
1030
Jerry Yu3bf2c642022-03-30 22:02:12 +08001031 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001032 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
1033
Jerry Yu3bf2c642022-03-30 22:02:12 +08001034 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
1035 buf + buf_len,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001036 &msg_len ) );
1037
Jerry Yu3bf2c642022-03-30 22:02:12 +08001038 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08001039 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
1040
Jerry Yu3bf2c642022-03-30 22:02:12 +08001041 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08001042 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08001043
1044 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Jerry Yuf4b27e42022-03-30 17:32:21 +08001045cleanup:
1046
1047 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
1048 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08001049}
1050
1051/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00001052 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00001053 */
Jerry Yu27561932021-08-27 17:07:38 +08001054int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08001055{
XiaokangQian08037552022-04-20 07:16:41 +00001056 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001057
1058 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
1059 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1060
Jerry Yue3b34122021-09-28 17:53:35 +08001061 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
1062 mbedtls_ssl_states_str( ssl->state ),
1063 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08001064
XiaokangQian7807f9f2022-02-15 10:04:37 +00001065 switch( ssl->state )
1066 {
1067 /* start state */
1068 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001069 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1070
XiaokangQian08037552022-04-20 07:16:41 +00001071 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001072 break;
1073
XiaokangQian7807f9f2022-02-15 10:04:37 +00001074 case MBEDTLS_SSL_CLIENT_HELLO:
1075
XiaokangQian4080a7f2022-04-11 09:55:18 +00001076 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001077 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00001078 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001079
1080 break;
1081
Jerry Yu5b64ae92022-03-30 17:15:02 +08001082 case MBEDTLS_SSL_SERVER_HELLO:
1083 ret = ssl_tls13_write_server_hello( ssl );
1084 break;
1085
XiaokangQian7807f9f2022-02-15 10:04:37 +00001086 default:
1087 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00001088 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001089 }
1090
1091 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08001092}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001093
Jerry Yufb4b6472022-01-27 15:03:26 +08001094#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */