blob: 775443cd61808ab8ddad3a8ea81114faf1b8cfb9 [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;
391
XiaokangQian7807f9f2022-02-15 10:04:37 +0000392 const mbedtls_ssl_ciphersuite_t* ciphersuite_info;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000393
394 ssl->handshake->extensions_present = MBEDTLS_SSL_EXT_NONE;
395
396 /*
XiaokangQianb67384d2022-04-19 00:02:38 +0000397 * ClientHello layout:
XiaokangQian7807f9f2022-02-15 10:04:37 +0000398 * 0 . 1 protocol version
XiaokangQiane8ff3502022-04-22 02:34:40 +0000399 * 2 . 33 random bytes
XiaokangQianc5763b52022-04-02 03:34:37 +0000400 * 34 . 34 session id length ( 1 byte )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000401 * 35 . 34+x session id
XiaokangQian7807f9f2022-02-15 10:04:37 +0000402 * .. . .. ciphersuite list length ( 2 bytes )
403 * .. . .. ciphersuite list
404 * .. . .. compression alg. list length ( 1 byte )
405 * .. . .. compression alg. list
406 * .. . .. extensions length ( 2 bytes, optional )
407 * .. . .. extensions ( optional )
408 */
409
XiaokangQianb67384d2022-04-19 00:02:38 +0000410 /*
XiaokangQian7807f9f2022-02-15 10:04:37 +0000411 * Minimal length ( with everything empty and extensions ommitted ) is
412 * 2 + 32 + 1 + 2 + 1 = 38 bytes. Check that first, so that we can
413 * read at least up to session id length without worrying.
414 */
415 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, 38 );
416
417 /* ...
418 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
419 * ...
420 * with ProtocolVersion defined as:
421 * uint16 ProtocolVersion;
422 */
XiaokangQiande333912022-04-20 08:49:42 +0000423 if( mbedtls_ssl_read_version( p, ssl->conf->transport ) !=
424 MBEDTLS_SSL_VERSION_TLS1_2 )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000425 {
426 MBEDTLS_SSL_DEBUG_MSG( 1, ( "Unsupported version of TLS." ) );
427 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_PROTOCOL_VERSION,
428 MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQianb67384d2022-04-19 00:02:38 +0000429 return ( MBEDTLS_ERR_SSL_BAD_PROTOCOL_VERSION );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000430 }
431 p += 2;
432
433 /*
XiaokangQianf8ceb942022-04-15 11:43:27 +0000434 * Only support TLS 1.3 currently, temporarily set the version.
435 */
XiaokangQiande333912022-04-20 08:49:42 +0000436 ssl->tls_version = MBEDTLS_SSL_VERSION_TLS1_3;
XiaokangQianf8ceb942022-04-15 11:43:27 +0000437
XiaokangQian08037552022-04-20 07:16:41 +0000438 /* ---
XiaokangQianb67384d2022-04-19 00:02:38 +0000439 * Random random;
440 * ---
441 * with Random defined as:
442 * opaque Random[32];
XiaokangQian7807f9f2022-02-15 10:04:37 +0000443 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000444 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, random bytes",
XiaokangQian08037552022-04-20 07:16:41 +0000445 p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000446
XiaokangQian08037552022-04-20 07:16:41 +0000447 memcpy( &ssl->handshake->randbytes[0], p, MBEDTLS_CLIENT_HELLO_RANDOM_LEN );
448 p += MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000449
XiaokangQianb67384d2022-04-19 00:02:38 +0000450 /* ---
451 * opaque legacy_session_id<0..32>;
452 * ---
XiaokangQian7807f9f2022-02-15 10:04:37 +0000453 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000454 legacy_session_id_len = p[0];
XiaokangQianc5763b52022-04-02 03:34:37 +0000455 p++;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000456
XiaokangQianb67384d2022-04-19 00:02:38 +0000457 if( legacy_session_id_len > sizeof( ssl->session_negotiate->id ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000458 {
459 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad client hello message" ) );
460 return( MBEDTLS_ERR_SSL_DECODE_ERROR );
461 }
462
XiaokangQian4080a7f2022-04-11 09:55:18 +0000463 ssl->session_negotiate->id_len = legacy_session_id_len;
XiaokangQianed582dd2022-04-13 08:21:05 +0000464 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, session id",
XiaokangQiane8ff3502022-04-22 02:34:40 +0000465 p, legacy_session_id_len );
XiaokangQianb67384d2022-04-19 00:02:38 +0000466 /*
467 * Check we have enough data for the legacy session identifier
468 * and the ciphersuite list length.
469 */
470 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, legacy_session_id_len + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000471
XiaokangQianed582dd2022-04-13 08:21:05 +0000472 memcpy( &ssl->session_negotiate->id[0], p, legacy_session_id_len );
XiaokangQian4080a7f2022-04-11 09:55:18 +0000473 p += legacy_session_id_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000474
XiaokangQian7807f9f2022-02-15 10:04:37 +0000475 cipher_suites_len = MBEDTLS_GET_UINT16_BE( p, 0 );
476 p += 2;
477
XiaokangQianb67384d2022-04-19 00:02:38 +0000478 /* Check we have enough data for the ciphersuite list, the legacy
479 * compression methods and the length of the extensions.
480 */
481 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, cipher_suites_len + 2 + 2 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000482
XiaokangQian08037552022-04-20 07:16:41 +0000483 /* ---
484 * CipherSuite cipher_suites<2..2^16-2>;
485 * ---
486 * with CipherSuite defined as:
487 * uint8 CipherSuite[2];
488 */
XiaokangQian060d8672022-04-21 09:24:56 +0000489 cipher_suites = p;
490 cipher_suites_end = p + cipher_suites_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000491 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello, ciphersuitelist",
492 p, cipher_suites_len );
XiaokangQian17f974c2022-04-19 09:57:41 +0000493 /*
494 * Search for a matching ciphersuite
495 */
XiaokangQian318dc762022-04-20 09:43:51 +0000496 int ciphersuite_match = 0;
XiaokangQian060d8672022-04-21 09:24:56 +0000497 for ( ; p < cipher_suites_end; p += 2 )
XiaokangQian17f974c2022-04-19 09:57:41 +0000498 {
XiaokangQiane8ff3502022-04-22 02:34:40 +0000499 uint16_t cipher_suite;
500 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, cipher_suites_end, 2 );
501 cipher_suite = MBEDTLS_GET_UINT16_BE( p, 0 );
502 ciphersuite_info = mbedtls_ssl_ciphersuite_from_id( cipher_suite );
XiaokangQian08037552022-04-20 07:16:41 +0000503 /*
XiaokangQiane8ff3502022-04-22 02:34:40 +0000504 * Check whether this ciphersuite is valid and offered.
505 */
XiaokangQian08037552022-04-20 07:16:41 +0000506 if( ( mbedtls_ssl_validate_ciphersuite(
XiaokangQiande333912022-04-20 08:49:42 +0000507 ssl, ciphersuite_info, ssl->tls_version,
508 ssl->tls_version ) != 0 ) ||
XiaokangQian08037552022-04-20 07:16:41 +0000509 !mbedtls_ssl_tls13_cipher_suite_is_offered( ssl, cipher_suite ) )
510 continue;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000511
XiaokangQian08037552022-04-20 07:16:41 +0000512 ssl->session_negotiate->ciphersuite = cipher_suite;
513 ssl->handshake->ciphersuite_info = ciphersuite_info;
XiaokangQian318dc762022-04-20 09:43:51 +0000514 ciphersuite_match = 1;
XiaokangQian17f974c2022-04-19 09:57:41 +0000515
XiaokangQian08037552022-04-20 07:16:41 +0000516 break;
XiaokangQian17f974c2022-04-19 09:57:41 +0000517
XiaokangQian17f974c2022-04-19 09:57:41 +0000518 }
519
XiaokangQian318dc762022-04-20 09:43:51 +0000520 if( !ciphersuite_match )
521 {
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000522 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_HANDSHAKE_FAILURE,
523 MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
524 return ( MBEDTLS_ERR_SSL_HANDSHAKE_FAILURE );
XiaokangQian318dc762022-04-20 09:43:51 +0000525 }
XiaokangQian17f974c2022-04-19 09:57:41 +0000526
527 MBEDTLS_SSL_DEBUG_MSG( 2, ( "selected ciphersuite: %s",
528 ciphersuite_info->name ) );
529
XiaokangQian060d8672022-04-21 09:24:56 +0000530 p = cipher_suites + cipher_suites_len;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000531 /* ...
XiaokangQianb67384d2022-04-19 00:02:38 +0000532 * opaque legacy_compression_methods<1..2^8-1>;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000533 * ...
XiaokangQian7807f9f2022-02-15 10:04:37 +0000534 */
XiaokangQian0a1b54e2022-04-21 03:01:38 +0000535 if( p[0] != 1 || p[1] != MBEDTLS_SSL_COMPRESS_NULL )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000536 {
XiaokangQian4080a7f2022-04-11 09:55:18 +0000537 MBEDTLS_SSL_DEBUG_MSG( 1, ( "bad legacy compression method" ) );
538 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_ILLEGAL_PARAMETER,
539 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
540 return ( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000541 }
XiaokangQianb67384d2022-04-19 00:02:38 +0000542 p += 2;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000543
XiaokangQianb67384d2022-04-19 00:02:38 +0000544 /* ---
545 * Extension extensions<8..2^16-1>;
546 * ---
547 * with Extension defined as:
548 * struct {
549 * ExtensionType extension_type;
550 * opaque extension_data<0..2^16-1>;
551 * } Extension;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000552 */
XiaokangQian4080a7f2022-04-11 09:55:18 +0000553 extensions_len = MBEDTLS_GET_UINT16_BE( p, 0 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000554 p += 2;
XiaokangQian4080a7f2022-04-11 09:55:18 +0000555 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, end, extensions_len );
XiaokangQiane8ff3502022-04-22 02:34:40 +0000556 extensions_end = p + extensions_len;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000557
XiaokangQian4080a7f2022-04-11 09:55:18 +0000558 MBEDTLS_SSL_DEBUG_BUF( 3, "client hello extensions", p, extensions_len );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000559
560 while( p < extensions_end )
561 {
562 unsigned int extension_type;
563 size_t extension_data_len;
564 const unsigned char *extension_data_end;
565
XiaokangQian318dc762022-04-20 09:43:51 +0000566 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, 4 );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000567 extension_type = MBEDTLS_GET_UINT16_BE( p, 0 );
568 extension_data_len = MBEDTLS_GET_UINT16_BE( p, 2 );
569 p += 4;
570
571 MBEDTLS_SSL_CHK_BUF_READ_PTR( p, extensions_end, extension_data_len );
572 extension_data_end = p + extension_data_len;
573
574 switch( extension_type )
575 {
XiaokangQianb67384d2022-04-19 00:02:38 +0000576#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000577 case MBEDTLS_TLS_EXT_SUPPORTED_GROUPS:
578 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported group extension" ) );
579
580 /* Supported Groups Extension
581 *
582 * When sent by the client, the "supported_groups" extension
583 * indicates the named groups which the client supports,
584 * ordered from most preferred to least preferred.
585 */
XiaokangQiancfd925f2022-04-14 07:10:37 +0000586 ret = ssl_tls13_parse_supported_groups_ext( ssl, p,
XiaokangQian7807f9f2022-02-15 10:04:37 +0000587 extension_data_end );
588 if( ret != 0 )
589 {
590 MBEDTLS_SSL_DEBUG_RET( 1,
591 "mbedtls_ssl_parse_supported_groups_ext", ret );
592 return( ret );
593 }
594
595 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_GROUPS;
596 break;
XiaokangQianb67384d2022-04-19 00:02:38 +0000597#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000598
XiaokangQian88408882022-04-02 10:15:03 +0000599#if defined(MBEDTLS_ECDH_C)
XiaokangQian7807f9f2022-02-15 10:04:37 +0000600 case MBEDTLS_TLS_EXT_KEY_SHARE:
601 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found key share extension" ) );
602
603 /*
604 * Key Share Extension
605 *
606 * When sent by the client, the "key_share" extension
607 * contains the endpoint's cryptographic parameters for
608 * ECDHE/DHE key establishment methods.
609 */
610 ret = ssl_tls13_parse_key_shares_ext( ssl, p, extension_data_end );
XiaokangQian08037552022-04-20 07:16:41 +0000611 if( ret == SSL_TLS1_3_PARSE_KEY_SHARES_EXT_NO_MATCH )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000612 {
XiaokangQianed582dd2022-04-13 08:21:05 +0000613 MBEDTLS_SSL_DEBUG_MSG( 2, ( "HRR needed " ) );
614 ret = MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000615 }
616
617 if( ret != 0 )
618 return( ret );
619
620 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_KEY_SHARE;
621 break;
XiaokangQian88408882022-04-02 10:15:03 +0000622#endif /* MBEDTLS_ECDH_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000623
624 case MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS:
625 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found supported versions extension" ) );
626
627 ret = ssl_tls13_parse_supported_versions_ext(
XiaokangQianb67384d2022-04-19 00:02:38 +0000628 ssl, p, extension_data_end );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000629 if( ret != 0 )
630 {
631 MBEDTLS_SSL_DEBUG_RET( 1,
632 ( "ssl_tls13_parse_supported_versions_ext" ), ret );
633 return( ret );
634 }
635 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SUPPORTED_VERSIONS;
636 break;
637
638#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
639 case MBEDTLS_TLS_EXT_SIG_ALG:
640 MBEDTLS_SSL_DEBUG_MSG( 3, ( "found signature_algorithms extension" ) );
641
642 ret = mbedtls_ssl_tls13_parse_sig_alg_ext( ssl, p,
643 extension_data_end );
644 if( ret != 0 )
645 {
646 MBEDTLS_SSL_DEBUG_MSG( 1,
647 ( "ssl_parse_supported_signature_algorithms_server_ext ( %d )",
648 ret ) );
649 return( ret );
650 }
651 ssl->handshake->extensions_present |= MBEDTLS_SSL_EXT_SIG_ALG;
652 break;
653#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
654
655 default:
656 MBEDTLS_SSL_DEBUG_MSG( 3,
657 ( "unknown extension found: %ud ( ignoring )",
658 extension_type ) );
659 }
660
661 p += extension_data_len;
662 }
663
664 /* Update checksum with either
665 * - The entire content of the CH message, if no PSK extension is present
666 * - The content up to but excluding the PSK extension, if present.
667 */
XiaokangQian3f84d5d2022-04-19 06:36:17 +0000668 mbedtls_ssl_add_hs_msg_to_checksum( ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
XiaokangQianc4b8c992022-04-07 11:31:38 +0000669 buf, p - buf );
XiaokangQian7807f9f2022-02-15 10:04:37 +0000670
671 /* List all the extensions we have received */
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000672#if defined(MBEDTLS_DEBUG_C)
XiaokangQian4080a7f2022-04-11 09:55:18 +0000673 ssl_tls13_debug_print_client_hello_exts( ssl );
XiaokangQian8f9dfe42022-04-15 02:52:39 +0000674#endif /* MBEDTLS_DEBUG_C */
XiaokangQian7807f9f2022-02-15 10:04:37 +0000675
676 /*
XiaokangQianb67384d2022-04-19 00:02:38 +0000677 * Here we only support the ephemeral or (EC)DHE key echange mode
XiaokangQian7807f9f2022-02-15 10:04:37 +0000678 */
679
XiaokangQianb67384d2022-04-19 00:02:38 +0000680 if( !ssl_tls13_check_ephemeral_key_exchange( ssl ) )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000681 {
682 MBEDTLS_SSL_DEBUG_MSG(
683 1,
684 ( "ClientHello message misses mandatory extensions." ) );
685 MBEDTLS_SSL_PEND_FATAL_ALERT( MBEDTLS_SSL_ALERT_MSG_MISSING_EXTENSION ,
686 MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
687 return( MBEDTLS_ERR_SSL_ILLEGAL_PARAMETER );
688 }
689
XiaokangQian7807f9f2022-02-15 10:04:37 +0000690 return( 0 );
691}
692
XiaokangQiancfd925f2022-04-14 07:10:37 +0000693static int ssl_tls13_postprocess_client_hello( mbedtls_ssl_context* ssl )
XiaokangQian7807f9f2022-02-15 10:04:37 +0000694{
XiaokangQian08037552022-04-20 07:16:41 +0000695 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +0000696
XiaokangQian7807f9f2022-02-15 10:04:37 +0000697 ret = mbedtls_ssl_tls13_key_schedule_stage_early( ssl );
698 if( ret != 0 )
699 {
700 MBEDTLS_SSL_DEBUG_RET( 1,
701 "mbedtls_ssl_tls1_3_key_schedule_stage_early", ret );
702 return( ret );
703 }
704
XiaokangQian7807f9f2022-02-15 10:04:37 +0000705 return( 0 );
706
707}
708
709/*
XiaokangQianed582dd2022-04-13 08:21:05 +0000710 * Main entry point from the state machine; orchestrates the otherfunctions.
711 */
712
713static int ssl_tls13_process_client_hello( mbedtls_ssl_context *ssl )
714{
715
XiaokangQian08037552022-04-20 07:16:41 +0000716 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQianed582dd2022-04-13 08:21:05 +0000717 unsigned char* buf = NULL;
718 size_t buflen = 0;
719 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> parse client hello" ) );
720
XiaokangQianed582dd2022-04-13 08:21:05 +0000721 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_tls13_fetch_handshake_msg(
722 ssl, MBEDTLS_SSL_HS_CLIENT_HELLO,
723 &buf, &buflen ) );
724
725 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_parse_client_hello( ssl, buf,
726 buf + buflen ) );
XiaokangQiancfd925f2022-04-14 07:10:37 +0000727 MBEDTLS_SSL_PROC_CHK( ssl_tls13_postprocess_client_hello( ssl ) );
XiaokangQiane8ff3502022-04-22 02:34:40 +0000728 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_HELLO );
XiaokangQianed582dd2022-04-13 08:21:05 +0000729
730cleanup:
731
732 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= parse client hello" ) );
733 return( ret );
734}
735
736/*
Jerry Yu1c3e6882022-04-20 21:23:40 +0800737 * Handler for MBEDTLS_SSL_SERVER_HELLO
Jerry Yu5b64ae92022-03-30 17:15:02 +0800738 */
Jerry Yuf4b27e42022-03-30 17:32:21 +0800739static int ssl_tls13_prepare_server_hello( mbedtls_ssl_context *ssl )
740{
Jerry Yu637a3f12022-04-20 21:37:58 +0800741 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
742 unsigned char *server_randbytes =
Jerry Yu3bf2c642022-03-30 22:02:12 +0800743 ssl->handshake->randbytes + MBEDTLS_CLIENT_HELLO_RANDOM_LEN;
Jerry Yuf4b27e42022-03-30 17:32:21 +0800744 if( ssl->conf->f_rng == NULL )
745 {
746 MBEDTLS_SSL_DEBUG_MSG( 1, ( "no RNG provided" ) );
747 return( MBEDTLS_ERR_SSL_NO_RNG );
748 }
749
Jerry Yu637a3f12022-04-20 21:37:58 +0800750 if( ( ret = ssl->conf->f_rng( ssl->conf->p_rng, server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +0800751 MBEDTLS_SERVER_HELLO_RANDOM_LEN ) ) != 0 )
752 {
753 MBEDTLS_SSL_DEBUG_RET( 1, "f_rng", ret );
754 return( ret );
755 }
756
Jerry Yu637a3f12022-04-20 21:37:58 +0800757 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes", server_randbytes,
Jerry Yuf4b27e42022-03-30 17:32:21 +0800758 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
759
760#if defined(MBEDTLS_HAVE_TIME)
761 ssl->session_negotiate->start = time( NULL );
762#endif /* MBEDTLS_HAVE_TIME */
763
764 return( ret );
765}
766
Jerry Yu3bf2c642022-03-30 22:02:12 +0800767/*
Jerry Yue74e04a2022-04-21 09:23:16 +0800768 * ssl_tls13_write_server_hello_supported_versions_ext ():
Jerry Yu3bf2c642022-03-30 22:02:12 +0800769 *
770 * struct {
Jerry Yufb9f54d2022-04-06 10:08:34 +0800771 * ProtocolVersion selected_version;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800772 * } SupportedVersions;
773 */
Jerry Yue74e04a2022-04-21 09:23:16 +0800774static int ssl_tls13_write_server_hello_supported_versions_ext(
775 mbedtls_ssl_context *ssl,
776 unsigned char *buf,
777 unsigned char *end,
778 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800779{
Jerry Yu3bf2c642022-03-30 22:02:12 +0800780 *out_len = 0;
781
Jerry Yu955ddd72022-04-22 22:27:33 +0800782 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, write selected version" ) );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800783
784 /* Check if we have space to write the extension:
785 * - extension_type (2 bytes)
786 * - extension_data_length (2 bytes)
Jerry Yu349a6132022-04-14 20:52:56 +0800787 * - selected_version (2 bytes)
Jerry Yu3bf2c642022-03-30 22:02:12 +0800788 */
Jerry Yu349a6132022-04-14 20:52:56 +0800789 MBEDTLS_SSL_CHK_BUF_PTR( buf, end, 6 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800790
Jerry Yu349a6132022-04-14 20:52:56 +0800791 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_SUPPORTED_VERSIONS, buf, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800792
Jerry Yu349a6132022-04-14 20:52:56 +0800793 MBEDTLS_PUT_UINT16_BE( 2, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800794
Jerry Yu349a6132022-04-14 20:52:56 +0800795 mbedtls_ssl_write_version( buf + 4,
796 ssl->conf->transport,
797 ssl->tls_version );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800798
799 MBEDTLS_SSL_DEBUG_MSG( 3, ( "supported version: [%04x]",
800 ssl->tls_version ) );
801
Jerry Yu349a6132022-04-14 20:52:56 +0800802 *out_len = 6;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800803
804 return( 0 );
805}
806
Jerry Yud9436a12022-04-20 22:28:09 +0800807
Jerry Yu3bf2c642022-03-30 22:02:12 +0800808
809/* Generate and export a single key share. For hybrid KEMs, this can
810 * be called multiple times with the different components of the hybrid. */
Jerry Yu955ddd72022-04-22 22:27:33 +0800811static int ssl_tls13_generate_and_write_key_share( mbedtls_ssl_context *ssl,
812 uint16_t named_group,
813 unsigned char *buf,
814 unsigned char *end,
815 size_t *out_len )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800816{
817 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu955ddd72022-04-22 22:27:33 +0800818
819 *out_len = 0;
820
Jerry Yu89e103c2022-03-30 22:43:29 +0800821#if defined(MBEDTLS_ECDH_C)
Jerry Yu3bf2c642022-03-30 22:02:12 +0800822 if( mbedtls_ssl_tls13_named_group_is_ecdhe( named_group ) )
823 {
Jerry Yu89e103c2022-03-30 22:43:29 +0800824 ret = mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange(
825 ssl, named_group, buf, end, out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800826 if( ret != 0 )
827 {
Jerry Yu89e103c2022-03-30 22:43:29 +0800828 MBEDTLS_SSL_DEBUG_RET(
829 1, "mbedtls_ssl_tls13_generate_and_write_ecdh_key_exchange",
830 ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800831 return( ret );
832 }
Jerry Yu3bf2c642022-03-30 22:02:12 +0800833 }
Jerry Yu89e103c2022-03-30 22:43:29 +0800834 else
835#endif /* MBEDTLS_ECDH_C */
836 if( 0 /* Other kinds of KEMs */ )
Jerry Yu3bf2c642022-03-30 22:02:12 +0800837 {
838 }
839 else
840 {
Jerry Yu955ddd72022-04-22 22:27:33 +0800841 ((void) ssl);
842 ((void) named_group);
843 ((void) buf);
844 ((void) end);
Jerry Yu3bf2c642022-03-30 22:02:12 +0800845 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
846 }
847
848 return( ret );
849}
850
851/*
852 * ssl_tls13_write_key_share_ext
853 *
854 * Structure of key_share extension in ServerHello:
855 *
Jerry Yu1c3e6882022-04-20 21:23:40 +0800856 * struct {
857 * NamedGroup group;
858 * opaque key_exchange<1..2^16-1>;
859 * } KeyShareEntry;
860 * struct {
861 * KeyShareEntry server_share;
862 * } KeyShareServerHello;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800863 */
864static int ssl_tls13_write_key_share_ext( mbedtls_ssl_context *ssl,
865 unsigned char *buf,
866 unsigned char *end,
867 size_t *out_len )
868{
Jerry Yu955ddd72022-04-22 22:27:33 +0800869 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800870 unsigned char *p = buf;
Jerry Yu57d48412022-04-20 21:50:42 +0800871 uint16_t group = ssl->handshake->offered_group_id;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800872 unsigned char *server_share = buf + 4;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800873 size_t key_exchange_length;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800874
875 *out_len = 0;
876
877 MBEDTLS_SSL_DEBUG_MSG( 3, ( "server hello, adding key share extension" ) );
878
879 /* Check if we have space for header and length fields:
880 * - extension_type (2 bytes)
881 * - extension_data_length (2 bytes)
882 * - group (2 bytes)
883 * - key_exchange_length (2 bytes)
884 */
885 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 8 );
Jerry Yu57d48412022-04-20 21:50:42 +0800886 MBEDTLS_PUT_UINT16_BE( MBEDTLS_TLS_EXT_KEY_SHARE, p, 0 );
887 MBEDTLS_PUT_UINT16_BE( group, server_share, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800888 p += 8;
Jerry Yu57d48412022-04-20 21:50:42 +0800889
Jerry Yu3bf2c642022-03-30 22:02:12 +0800890 /* When we introduce PQC-ECDHE hybrids, we'll want to call this
891 * function multiple times. */
Jerry Yu955ddd72022-04-22 22:27:33 +0800892 ret = ssl_tls13_generate_and_write_key_share(
Jerry Yue65d8012022-04-23 10:34:35 +0800893 ssl, group, server_share + 4, end, &key_exchange_length );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800894 if( ret != 0 )
895 return( ret );
896 p += key_exchange_length;
Jerry Yu955ddd72022-04-22 22:27:33 +0800897 MBEDTLS_PUT_UINT16_BE( key_exchange_length, server_share + 2, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800898
Jerry Yu57d48412022-04-20 21:50:42 +0800899 MBEDTLS_PUT_UINT16_BE( p - server_share, buf, 2 );
Jerry Yu3bf2c642022-03-30 22:02:12 +0800900
Jerry Yu57d48412022-04-20 21:50:42 +0800901 *out_len = p - buf;
Jerry Yu955ddd72022-04-22 22:27:33 +0800902
Jerry Yu3bf2c642022-03-30 22:02:12 +0800903 return( 0 );
904}
Jerry Yud9436a12022-04-20 22:28:09 +0800905
Jerry Yu3bf2c642022-03-30 22:02:12 +0800906
907/*
908 * Structure of ServerHello message:
909 *
910 * struct {
911 * ProtocolVersion legacy_version = 0x0303; // TLS v1.2
912 * Random random;
913 * opaque legacy_session_id_echo<0..32>;
914 * CipherSuite cipher_suite;
915 * uint8 legacy_compression_method = 0;
916 * Extension extensions<6..2^16-1>;
917 * } ServerHello;
918 */
919static int ssl_tls13_write_server_hello_body( mbedtls_ssl_context *ssl,
Jerry Yu56404d72022-03-30 17:36:13 +0800920 unsigned char *buf,
921 unsigned char *end,
922 size_t *out_len )
923{
Jerry Yu955ddd72022-04-22 22:27:33 +0800924 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800925 unsigned char *p = buf;
Jerry Yud9436a12022-04-20 22:28:09 +0800926 unsigned char *p_extensions_len;
Jerry Yu955ddd72022-04-22 22:27:33 +0800927 size_t output_len; /* Length of buffer used by function */
Jerry Yu3bf2c642022-03-30 22:02:12 +0800928
929 *out_len = 0;
930
Jerry Yucfc04b32022-04-21 09:31:58 +0800931 /* ...
932 * ProtocolVersion legacy_version = 0x0303; // TLS 1.2
933 * ...
934 * with ProtocolVersion defined as:
935 * uint16 ProtocolVersion;
Jerry Yu3bf2c642022-03-30 22:02:12 +0800936 */
937 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
938 MBEDTLS_PUT_UINT16_BE( 0x0303, p, 0 );
939 p += 2;
940
Jerry Yu1c3e6882022-04-20 21:23:40 +0800941 /* ...
942 * Random random;
943 * ...
Jerry Yucfc04b32022-04-21 09:31:58 +0800944 * with Random defined as:
945 * opaque Random[MBEDTLS_SERVER_HELLO_RANDOM_LEN];
Jerry Yu1c3e6882022-04-20 21:23:40 +0800946 */
Jerry Yu3bf2c642022-03-30 22:02:12 +0800947 MBEDTLS_SSL_CHK_BUF_PTR( p, end, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
Jerry Yu955ddd72022-04-22 22:27:33 +0800948 memcpy( p, &ssl->handshake->randbytes[MBEDTLS_CLIENT_HELLO_RANDOM_LEN],
949 MBEDTLS_SERVER_HELLO_RANDOM_LEN );
950 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello, random bytes",
Jerry Yu3bf2c642022-03-30 22:02:12 +0800951 p, MBEDTLS_SERVER_HELLO_RANDOM_LEN );
952 p += MBEDTLS_SERVER_HELLO_RANDOM_LEN;
953
Jerry Yucfc04b32022-04-21 09:31:58 +0800954 /* ...
955 * opaque legacy_session_id_echo<0..32>;
956 * ...
Jerry Yu3bf2c642022-03-30 22:02:12 +0800957 */
958 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 + ssl->session_negotiate->id_len );
959 *p++ = (unsigned char)ssl->session_negotiate->id_len;
960 if( ssl->session_negotiate->id_len > 0 )
961 {
962 memcpy( p, &ssl->session_negotiate->id[0],
963 ssl->session_negotiate->id_len );
964 p += ssl->session_negotiate->id_len;
Jerry Yu955ddd72022-04-22 22:27:33 +0800965
Jerry Yu3bf2c642022-03-30 22:02:12 +0800966 MBEDTLS_SSL_DEBUG_BUF( 3, "session id", ssl->session_negotiate->id,
967 ssl->session_negotiate->id_len );
968 }
969
Jerry Yucfc04b32022-04-21 09:31:58 +0800970 /* ...
971 * CipherSuite cipher_suite;
972 * ...
973 * with CipherSuite defined as:
974 * uint8 CipherSuite[2];
Jerry Yu3bf2c642022-03-30 22:02:12 +0800975 */
976 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
977 MBEDTLS_PUT_UINT16_BE( ssl->session_negotiate->ciphersuite, p, 0 );
978 p += 2;
979 MBEDTLS_SSL_DEBUG_MSG( 3,
980 ( "server hello, chosen ciphersuite: %s ( id=%d )",
981 mbedtls_ssl_get_ciphersuite_name(
982 ssl->session_negotiate->ciphersuite ),
983 ssl->session_negotiate->ciphersuite ) );
984
Jerry Yucfc04b32022-04-21 09:31:58 +0800985 /* ...
986 * uint8 legacy_compression_method = 0;
987 * ...
988 */
Jerry Yu3bf2c642022-03-30 22:02:12 +0800989 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 1 );
990 *p++ = 0x0;
991
Jerry Yucfc04b32022-04-21 09:31:58 +0800992 /* ...
993 * Extension extensions<6..2^16-1>;
994 * ...
995 * struct {
996 * ExtensionType extension_type; (2 bytes)
997 * opaque extension_data<0..2^16-1>;
998 * } Extension;
999 */
Jerry Yu3bf2c642022-03-30 22:02:12 +08001000 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yud9436a12022-04-20 22:28:09 +08001001 p_extensions_len = p;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001002 p += 2;
1003
Jerry Yue74e04a2022-04-21 09:23:16 +08001004 if( ( ret = ssl_tls13_write_server_hello_supported_versions_ext(
Jerry Yu3bf2c642022-03-30 22:02:12 +08001005 ssl, p, end, &output_len ) ) != 0 )
1006 {
Jerry Yu955ddd72022-04-22 22:27:33 +08001007 MBEDTLS_SSL_DEBUG_RET(
1008 1, "ssl_tls13_write_server_hello_supported_versions_ext", ret );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001009 return( ret );
1010 }
1011 p += output_len;
1012
Jerry Yu3bf2c642022-03-30 22:02:12 +08001013 if( mbedtls_ssl_conf_tls13_some_ephemeral_enabled( ssl ) )
1014 {
1015 ret = ssl_tls13_write_key_share_ext( ssl, p, end, &output_len );
1016 if( ret != 0 )
1017 return( ret );
1018 p += output_len;
1019 }
Jerry Yu3bf2c642022-03-30 22:02:12 +08001020
Jerry Yud9436a12022-04-20 22:28:09 +08001021 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001022
Jerry Yud9436a12022-04-20 22:28:09 +08001023 MBEDTLS_SSL_DEBUG_BUF( 4, "server hello extensions",
1024 p_extensions_len, p - p_extensions_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001025
Jerry Yud9436a12022-04-20 22:28:09 +08001026 *out_len = p - buf;
Jerry Yu3bf2c642022-03-30 22:02:12 +08001027
Jerry Yud9436a12022-04-20 22:28:09 +08001028 MBEDTLS_SSL_DEBUG_BUF( 3, "server hello", buf, *out_len );
Jerry Yu3bf2c642022-03-30 22:02:12 +08001029
1030 return( ret );
Jerry Yu56404d72022-03-30 17:36:13 +08001031}
1032
Jerry Yue110d252022-05-05 10:19:22 +08001033static int ssl_tls13_finalize_write_server_hello( mbedtls_ssl_context *ssl )
1034{
1035 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf86eb752022-05-06 11:16:55 +08001036 ret = mbedtls_ssl_tls13_compute_handshake_transform( ssl );
Jerry Yue110d252022-05-05 10:19:22 +08001037 if( ret != 0 )
1038 {
Jerry Yuf86eb752022-05-06 11:16:55 +08001039 MBEDTLS_SSL_DEBUG_RET( 1,
1040 "mbedtls_ssl_tls13_compute_handshake_transform",
Jerry Yue110d252022-05-05 10:19:22 +08001041 ret );
1042 return( ret );
1043 }
1044
1045 mbedtls_ssl_set_outbound_transform( ssl,
1046 ssl->handshake->transform_handshake );
1047 MBEDTLS_SSL_DEBUG_MSG(
Jerry Yuf86eb752022-05-06 11:16:55 +08001048 3, ( "switching to handshake transform for outbound data" ) );
Jerry Yue110d252022-05-05 10:19:22 +08001049
1050 return( ret );
1051}
1052
Jerry Yu5b64ae92022-03-30 17:15:02 +08001053static int ssl_tls13_write_server_hello( mbedtls_ssl_context *ssl )
1054{
Jerry Yu637a3f12022-04-20 21:37:58 +08001055 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
Jerry Yuf4b27e42022-03-30 17:32:21 +08001056 unsigned char *buf;
1057 size_t buf_len, msg_len;
1058
1059 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write server hello" ) );
1060
Jerry Yuf4b27e42022-03-30 17:32:21 +08001061 MBEDTLS_SSL_PROC_CHK( ssl_tls13_prepare_server_hello( ssl ) );
1062
Jerry Yu3bf2c642022-03-30 22:02:12 +08001063 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001064 MBEDTLS_SSL_HS_SERVER_HELLO, &buf, &buf_len ) );
1065
Jerry Yu3bf2c642022-03-30 22:02:12 +08001066 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_server_hello_body( ssl, buf,
1067 buf + buf_len,
Jerry Yuf4b27e42022-03-30 17:32:21 +08001068 &msg_len ) );
1069
Jerry Yu3bf2c642022-03-30 22:02:12 +08001070 mbedtls_ssl_add_hs_msg_to_checksum(
Jerry Yuf4b27e42022-03-30 17:32:21 +08001071 ssl, MBEDTLS_SSL_HS_SERVER_HELLO, buf, msg_len );
1072
Jerry Yu3bf2c642022-03-30 22:02:12 +08001073 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
Jerry Yuf4b27e42022-03-30 17:32:21 +08001074 ssl, buf_len, msg_len ) );
Jerry Yu637a3f12022-04-20 21:37:58 +08001075
Jerry Yue110d252022-05-05 10:19:22 +08001076 MBEDTLS_SSL_PROC_CHK( ssl_tls13_finalize_write_server_hello( ssl ) );
1077
Jerry Yu637a3f12022-04-20 21:37:58 +08001078 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_ENCRYPTED_EXTENSIONS );
Jerry Yue110d252022-05-05 10:19:22 +08001079
Jerry Yuf4b27e42022-03-30 17:32:21 +08001080cleanup:
1081
1082 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write server hello" ) );
1083 return( ret );
Jerry Yu5b64ae92022-03-30 17:15:02 +08001084}
1085
1086/*
Jerry Yu4d3841a2022-04-16 12:37:19 +08001087 * Handler for MBEDTLS_SSL_ENCRYPTED_EXTENSIONS
1088 */
Jerry Yu4d3841a2022-04-16 12:37:19 +08001089
1090/*
1091 * struct {
1092 * Extension extensions<0..2 ^ 16 - 1>;
1093 * } EncryptedExtensions;
1094 *
1095 */
1096static int ssl_tls13_write_encrypted_extensions_body( mbedtls_ssl_context *ssl,
1097 unsigned char *buf,
1098 unsigned char *end,
1099 size_t *out_len )
1100{
Jerry Yu4d3841a2022-04-16 12:37:19 +08001101 unsigned char *p = buf;
1102 size_t extensions_len = 0;
Jerry Yu8937eb42022-05-03 12:12:14 +08001103 unsigned char *p_extensions_len;
Jerry Yu9da5e5a2022-05-03 15:46:09 +08001104
Jerry Yu4d3841a2022-04-16 12:37:19 +08001105 *out_len = 0;
1106
1107 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 2 );
Jerry Yu8937eb42022-05-03 12:12:14 +08001108 p_extensions_len = p;
Jerry Yu4d3841a2022-04-16 12:37:19 +08001109 p += 2;
1110
Jerry Yu8937eb42022-05-03 12:12:14 +08001111 ((void) ssl);
Jerry Yu4d3841a2022-04-16 12:37:19 +08001112
Jerry Yu8937eb42022-05-03 12:12:14 +08001113 extensions_len = ( p - p_extensions_len ) - 2;
1114 MBEDTLS_PUT_UINT16_BE( extensions_len, p_extensions_len, 0 );
1115
1116 *out_len = p - buf;
Jerry Yu4d3841a2022-04-16 12:37:19 +08001117
1118 MBEDTLS_SSL_DEBUG_BUF( 4, "encrypted extensions", buf, *out_len );
1119
1120 return( 0 );
1121}
1122
1123static int ssl_tls13_write_encrypted_extensions( mbedtls_ssl_context *ssl )
1124{
1125 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1126 unsigned char *buf;
Jerry Yu39730a72022-05-03 12:14:04 +08001127 size_t buf_len, msg_len;
Jerry Yu4d3841a2022-04-16 12:37:19 +08001128
Jerry Yuab452cc2022-04-28 15:27:08 +08001129 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08001130
Jerry Yu4d3841a2022-04-16 12:37:19 +08001131 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
1132 MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, &buf, &buf_len ) );
1133
1134 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_encrypted_extensions_body(
1135 ssl, buf, buf + buf_len, &msg_len ) );
1136
1137 mbedtls_ssl_add_hs_msg_to_checksum(
1138 ssl, MBEDTLS_SSL_HS_ENCRYPTED_EXTENSIONS, buf, msg_len );
1139
Jerry Yu4d3841a2022-04-16 12:37:19 +08001140 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
1141 ssl, buf_len, msg_len ) );
1142
Jerry Yu8937eb42022-05-03 12:12:14 +08001143#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1144 if( mbedtls_ssl_tls13_some_psk_enabled( ssl ) )
1145 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1146 else
XiaokangQiana987e1d2022-05-07 01:25:58 +00001147 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CERTIFICATE_REQUEST );
Jerry Yu8937eb42022-05-03 12:12:14 +08001148#else
1149 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_FINISHED );
1150#endif
1151
Jerry Yu4d3841a2022-04-16 12:37:19 +08001152cleanup:
1153
Jerry Yuab452cc2022-04-28 15:27:08 +08001154 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write encrypted extensions" ) );
Jerry Yu4d3841a2022-04-16 12:37:19 +08001155 return( ret );
1156}
1157
XiaokangQiancec9ae62022-05-06 07:28:50 +00001158#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
XiaokangQiana987e1d2022-05-07 01:25:58 +00001159#define SSL_CERTIFICATE_REQUEST_SEND_REQUEST 0
1160#define SSL_CERTIFICATE_REQUEST_SKIP 1
1161/* Coordination:
1162 * Check whether a CertificateRequest message should be written.
1163 * Returns a negative code on failure, or
1164 * - SSL_CERTIFICATE_REQUEST_SEND_REQUEST
1165 * - SSL_CERTIFICATE_REQUEST_SKIP
1166 * indicating if the writing of the CertificateRequest
1167 * should be skipped or not.
1168 */
1169static int ssl_tls13_certificate_request_coordinate( mbedtls_ssl_context *ssl )
1170{
1171 int authmode;
1172
1173 authmode = ssl->conf->authmode;
1174
1175 if( authmode == MBEDTLS_SSL_VERIFY_NONE )
1176 return( SSL_CERTIFICATE_REQUEST_SKIP );
1177
1178 return( SSL_CERTIFICATE_REQUEST_SEND_REQUEST );
1179}
1180
XiaokangQiancec9ae62022-05-06 07:28:50 +00001181/*
1182 * struct {
1183 * opaque certificate_request_context<0..2^8-1>;
1184 * Extension extensions<2..2^16-1>;
1185 * } CertificateRequest;
1186 *
1187 */
1188static int ssl_tls13_write_certificate_request_body( mbedtls_ssl_context *ssl,
1189 unsigned char *buf,
1190 const unsigned char *end,
1191 size_t *out_len )
1192{
1193 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1194 unsigned char *p = buf;
XiaokangQianec6efb92022-05-06 09:53:10 +00001195 size_t output_len = 0;
XiaokangQiancec9ae62022-05-06 07:28:50 +00001196 unsigned char *p_extensions_len;
1197
1198 *out_len = 0;
1199
1200 /* Check if we have enough space:
1201 * - certificate_request_context (1 byte)
1202 * - extensions length (2 bytes)
1203 */
1204 MBEDTLS_SSL_CHK_BUF_PTR( p, end, 3 );
1205
1206 /*
1207 * Write certificate_request_context
1208 */
1209 /*
1210 * We use a zero length context for the normal handshake
1211 * messages. For post-authentication handshake messages
1212 * this request context would be set to a non-zero value.
1213 */
1214 *p++ = 0x0;
1215
1216 /*
1217 * Write extensions
1218 */
1219 /* The extensions must contain the signature_algorithms. */
1220 p_extensions_len = p;
1221 p += 2;
XiaokangQianec6efb92022-05-06 09:53:10 +00001222 ret = mbedtls_ssl_write_sig_alg_ext( ssl, p, end, &output_len );
XiaokangQiancec9ae62022-05-06 07:28:50 +00001223 if( ret != 0 )
1224 return( ret );
1225
XiaokangQianec6efb92022-05-06 09:53:10 +00001226 p += output_len;
XiaokangQianaad9b0a2022-05-09 01:11:21 +00001227 MBEDTLS_PUT_UINT16_BE( p - p_extensions_len - 2, p_extensions_len, 0 );
XiaokangQiancec9ae62022-05-06 07:28:50 +00001228
1229 *out_len = p - buf;
1230
1231 return( 0 );
1232}
1233
1234static int ssl_tls13_write_certificate_request( mbedtls_ssl_context *ssl )
1235{
1236 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
1237
1238 MBEDTLS_SSL_DEBUG_MSG( 2, ( "=> write certificate request" ) );
1239
1240 MBEDTLS_SSL_PROC_CHK_NEG( ssl_tls13_certificate_request_coordinate( ssl ) );
1241
1242 if( ret == SSL_CERTIFICATE_REQUEST_SEND_REQUEST )
1243 {
1244 unsigned char *buf;
1245 size_t buf_len, msg_len;
1246
1247 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_start_handshake_msg( ssl,
1248 MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, &buf, &buf_len ) );
1249
1250 MBEDTLS_SSL_PROC_CHK( ssl_tls13_write_certificate_request_body(
1251 ssl, buf, buf + buf_len, &msg_len ) );
1252
1253 mbedtls_ssl_add_hs_msg_to_checksum(
1254 ssl, MBEDTLS_SSL_HS_CERTIFICATE_REQUEST, buf, msg_len );
1255
1256 MBEDTLS_SSL_PROC_CHK( mbedtls_ssl_finish_handshake_msg(
1257 ssl, buf_len, msg_len ) );
1258 }
1259 else if( ret == SSL_CERTIFICATE_REQUEST_SKIP )
1260 {
1261 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= skip write certificate request" ) );
1262 ret = 0;
1263 }
1264 else
1265 {
1266 MBEDTLS_SSL_DEBUG_MSG( 1, ( "should never happen" ) );
1267 ret = MBEDTLS_ERR_SSL_INTERNAL_ERROR;
1268 goto cleanup;
1269 }
1270
1271 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_SERVER_CERTIFICATE );
1272cleanup:
1273
1274 MBEDTLS_SSL_DEBUG_MSG( 2, ( "<= write certificate request" ) );
1275 return( ret );
1276}
1277#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1278
Jerry Yu4d3841a2022-04-16 12:37:19 +08001279/*
XiaokangQiane8ff3502022-04-22 02:34:40 +00001280 * TLS 1.3 State Machine -- server side
XiaokangQian7807f9f2022-02-15 10:04:37 +00001281 */
Jerry Yu27561932021-08-27 17:07:38 +08001282int mbedtls_ssl_tls13_handshake_server_step( mbedtls_ssl_context *ssl )
Jerry Yub9930e72021-08-06 17:11:51 +08001283{
XiaokangQian08037552022-04-20 07:16:41 +00001284 int ret = MBEDTLS_ERR_ERROR_CORRUPTION_DETECTED;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001285
1286 if( ssl->state == MBEDTLS_SSL_HANDSHAKE_OVER || ssl->handshake == NULL )
1287 return( MBEDTLS_ERR_SSL_BAD_INPUT_DATA );
1288
Jerry Yue3b34122021-09-28 17:53:35 +08001289 MBEDTLS_SSL_DEBUG_MSG( 2, ( "tls13 server state: %s(%d)",
1290 mbedtls_ssl_states_str( ssl->state ),
1291 ssl->state ) );
Jerry Yu6e81b272021-09-27 11:16:17 +08001292
XiaokangQian7807f9f2022-02-15 10:04:37 +00001293 switch( ssl->state )
1294 {
1295 /* start state */
1296 case MBEDTLS_SSL_HELLO_REQUEST:
XiaokangQian7807f9f2022-02-15 10:04:37 +00001297 mbedtls_ssl_handshake_set_state( ssl, MBEDTLS_SSL_CLIENT_HELLO );
1298
XiaokangQian08037552022-04-20 07:16:41 +00001299 ret = 0;
XiaokangQian7807f9f2022-02-15 10:04:37 +00001300 break;
1301
XiaokangQian7807f9f2022-02-15 10:04:37 +00001302 case MBEDTLS_SSL_CLIENT_HELLO:
1303
XiaokangQian4080a7f2022-04-11 09:55:18 +00001304 ret = ssl_tls13_process_client_hello( ssl );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001305 if( ret != 0 )
XiaokangQian4080a7f2022-04-11 09:55:18 +00001306 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_process_client_hello", ret );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001307
1308 break;
1309
Jerry Yu5b64ae92022-03-30 17:15:02 +08001310 case MBEDTLS_SSL_SERVER_HELLO:
1311 ret = ssl_tls13_write_server_hello( ssl );
1312 break;
1313
Xiaofei Baicba64af2022-02-15 10:00:56 +00001314 case MBEDTLS_SSL_ENCRYPTED_EXTENSIONS:
Jerry Yu4d3841a2022-04-16 12:37:19 +08001315 ret = ssl_tls13_write_encrypted_extensions( ssl );
Xiaofei Baicba64af2022-02-15 10:00:56 +00001316 if( ret != 0 )
1317 {
Jerry Yu4d3841a2022-04-16 12:37:19 +08001318 MBEDTLS_SSL_DEBUG_RET( 1, "ssl_tls13_write_encrypted_extensions", ret );
1319 return( ret );
Xiaofei Baicba64af2022-02-15 10:00:56 +00001320 }
1321 break;
1322
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00001323#if defined(MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED)
1324 case MBEDTLS_SSL_CERTIFICATE_REQUEST:
Xiaofei Bai5ee73d82022-03-14 02:48:30 +00001325 ret = ssl_tls13_write_certificate_request( ssl );
Xiaofei Bai9ca09d42022-02-14 12:57:18 +00001326 break;
1327#endif /* MBEDTLS_KEY_EXCHANGE_WITH_CERT_ENABLED */
1328
XiaokangQian7807f9f2022-02-15 10:04:37 +00001329 default:
1330 MBEDTLS_SSL_DEBUG_MSG( 1, ( "invalid state %d", ssl->state ) );
XiaokangQian060d8672022-04-21 09:24:56 +00001331 return( MBEDTLS_ERR_SSL_FEATURE_UNAVAILABLE );
XiaokangQian7807f9f2022-02-15 10:04:37 +00001332 }
1333
1334 return( ret );
Jerry Yub9930e72021-08-06 17:11:51 +08001335}
Jerry Yu3cc4c2a2021-08-06 16:29:08 +08001336
Jerry Yufb4b6472022-01-27 15:03:26 +08001337#endif /* MBEDTLS_SSL_SRV_C && MBEDTLS_SSL_PROTO_TLS1_3 */