1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
|
/***************************************************************************
* Copyright (c) 2024 Microsoft Corporation
* Copyright (c) 2025-present Eclipse ThreadX Contributors
*
* This program and the accompanying materials are made available under the
* terms of the MIT License which is available at
* https://opensource.org/licenses/MIT.
*
* SPDX-License-Identifier: MIT
**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Secure Component */
/** */
/** Transport Layer Security (TLS) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_tls.h"
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
UINT _nx_secure_tls_send_clienthello_psk_extension(NX_SECURE_TLS_SESSION *tls_session,
UCHAR *packet_buffer, ULONG *packet_offset,
ULONG extension_length_offset, ULONG total_extensions_length,
ULONG *extension_length, ULONG available_size);
#endif
#ifndef NX_SECURE_TLS_CLIENT_DISABLED
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_send_clienthello PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function populates an NX_PACKET with a ClientHello message, */
/* which kicks off a TLS handshake when sent to a remote TLS server. */
/* */
/* INPUT */
/* */
/* tls_session TLS control block */
/* send_packet Outgoing TLS packet */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_secure_tls_handshake_hash_init Initialize the finished hash */
/* _nx_secure_tls_newest_supported_version */
/* Get the version of TLS to use */
/* _nx_secure_tls_send_clienthello_extensions */
/* Send TLS ClientHello extension*/
/* [nx_secure_tls_session_time_function] Get the current time for the */
/* TLS timestamp */
/* */
/* CALLED BY */
/* */
/* _nx_secure_tls_client_handshake TLS client state machine */
/* _nx_secure_tls_session_renegotiate Renegotiate TLS session */
/* _nx_secure_tls_session_start Start TLS session */
/* */
/**************************************************************************/
UINT _nx_secure_tls_send_clienthello(NX_SECURE_TLS_SESSION *tls_session, NX_PACKET *send_packet)
{
ULONG length;
ULONG extension_offset;
UINT gmt_time;
UINT random_value;
UINT i;
USHORT ciphersuite;
USHORT ciphersuites_length;
UCHAR *ciphersuites_length_ptr;
UCHAR *packet_buffer;
USHORT protocol_version;
USHORT newest_version;
UINT status;
UINT fallback_enabled = NX_FALSE;
const NX_SECURE_TLS_CRYPTO *crypto_table;
ULONG extension_length, total_extensions_length;
/* ClientHello structure:
* | 2 | 4 + 28 | 1 | <SID len> | 2 | <CS Len> | 1 | <Comp Len> | 2 | <Ext. Len> |
* | TLS version | Random (time + random) | SID length | Session ID | CS Len | Ciphersuites |Comp Len | Compression |Ext. Len | Extensions |
*/
packet_buffer = send_packet -> nx_packet_append_ptr;
/* Initialize the handshake hashes used for the Finished message. */
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
if(!tls_session->nx_secure_tls_1_3)
#endif
{
_nx_secure_tls_handshake_hash_init(tls_session);
}
/* Use our length as an index into the buffer. */
length = 0;
/* First two bytes of the hello following the header are the TLS major and minor version numbers. */
/* For TLS 1.2 is always enabled, there is no need to check returned protocol_version. */
_nx_secure_tls_protocol_version_get(tls_session, &protocol_version, NX_SECURE_TLS);
/* Get the newest supported version to see if we have a version fallback. */
_nx_secure_tls_newest_supported_version(tls_session, &newest_version, NX_SECURE_TLS);
if(protocol_version != newest_version)
{
/* The version we are using is not the latest, indicate fallback with SCSV. */
fallback_enabled = NX_TRUE;
}
/* Length of the ciphersuites list that follows. The client can send any number of suites for the
* server to choose from, with a 2-byte length field. */
crypto_table = tls_session -> nx_secure_tls_crypto_table;
ciphersuites_length = (USHORT)((crypto_table -> nx_secure_tls_ciphersuite_lookup_table_size << 1));
#ifdef NX_SECURE_TLS_USE_SCSV_CIPHPERSUITE
/* If this is an initial handshake (and not a response to a HelloRequest for session re-negotiation)
then include the length of the SCSV pseudo-ciphersuite (if enabled). */
#ifndef NX_SECURE_TLS_DISABLE_SECURE_RENEGOTIATION
if (!tls_session -> nx_secure_tls_renegotiation_handshake && tls_session -> nx_secure_tls_client_state != NX_SECURE_TLS_CLIENT_STATE_RENEGOTIATING)
#endif
{
ciphersuites_length = (USHORT)(ciphersuites_length + 2);
}
#endif
/* If we are falling back to an earlier TLS version, include the fallback notification SCSV. */
if(fallback_enabled)
{
ciphersuites_length = (USHORT)(ciphersuites_length + 2);
}
if (((ULONG)(send_packet -> nx_packet_data_end) - (ULONG)(send_packet -> nx_packet_append_ptr)) <
(9u + sizeof(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random) +
tls_session -> nx_secure_tls_session_id_length + ciphersuites_length))
{
/* Packet buffer is too small. */
return(NX_SECURE_TLS_PACKET_BUFFER_TOO_SMALL);
}
packet_buffer[length] = (UCHAR)((protocol_version & 0xFF00) >> 8);
packet_buffer[length + 1] = (UCHAR)(protocol_version & 0x00FF);
tls_session -> nx_secure_tls_protocol_version = protocol_version;
length += 2;
/* Set the Client random data, used in key generation. First 4 bytes is GMT time. */
gmt_time = 0;
if (tls_session -> nx_secure_tls_session_time_function != NX_NULL)
{
gmt_time = tls_session -> nx_secure_tls_session_time_function();
}
NX_CHANGE_ULONG_ENDIAN(gmt_time);
NX_SECURE_MEMCPY(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random, (UCHAR *)&gmt_time, sizeof(gmt_time)); /* Use case of memcpy is verified. lgtm[cpp/banned-api-usage-required-any] */
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
if (tls_session -> nx_secure_tls_client_state == NX_SECURE_TLS_CLIENT_STATE_HELLO_RETRY)
{
NX_SECURE_MEMCPY(&packet_buffer[length], tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random,
sizeof(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random)); /* Use case of memcpy is verified. */
}
else
#endif
{
/* Next 28 bytes is random data. */
for (i = 4; i <= 28; i += (UINT)sizeof(random_value))
{
random_value = (UINT)NX_RAND();
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random[i] = (UCHAR)(random_value);
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random[i + 1] = (UCHAR)(random_value >> 8);
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random[i + 2] = (UCHAR)(random_value >> 16);
tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random[i + 3] = (UCHAR)(random_value >> 24);
}
/* Copy the random data into the packet. */
NX_SECURE_MEMCPY(&packet_buffer[length], tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random, /* lgtm[cpp/banned-api-usage-required-any] */
sizeof(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random)); /* Use case of memcpy is verified. */
}
length += sizeof(tls_session -> nx_secure_tls_key_material.nx_secure_tls_client_random);
/* Session ID length is one byte. As session resumption is not implemented yet, ClientHello doesn't include Session ID now. */
tls_session -> nx_secure_tls_session_id_length = 0;
packet_buffer[length] = tls_session -> nx_secure_tls_session_id_length;
length++;
/* TLS 1.0-1.2. */
ciphersuites_length_ptr = &packet_buffer[length];
length += 2;
/* Our chosen ciphersuites. In sending a ClientHello, we need to include all the ciphersuites
* we are interested in speaking. This will be a list of ciphersuites the user has chosen to support
* and all of them will be presented to the remote server in this initial message. */
ciphersuites_length = 0;
for (i = 0; i < crypto_table -> nx_secure_tls_ciphersuite_lookup_table_size; i++)
{
ciphersuite = crypto_table -> nx_secure_tls_ciphersuite_lookup_table[i].nx_secure_tls_ciphersuite;
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
if ((tls_session -> nx_secure_tls_1_3 == NX_FALSE) && ((ciphersuite >> 8) == 0x13))
{
/* Ciphersuites for TLS 1.3 can not be used by TLS 1.2. */
continue;
}
#endif
packet_buffer[length] = (UCHAR)((ciphersuite & 0xFF00) >> 8);
packet_buffer[length + 1] = (UCHAR)(ciphersuite & 0x00FF);
length += 2;
ciphersuites_length = (USHORT)(ciphersuites_length + 2);
}
#ifdef NX_SECURE_TLS_USE_SCSV_CIPHPERSUITE
/* Only send SCSV on initial ClientHello. The SCSV is used for compatibility with OLD TLS 1.0
and SSLv3.0 servers and generally shouldn't be needed. */
#ifndef NX_SECURE_TLS_DISABLE_SECURE_RENEGOTIATION
if (!tls_session -> nx_secure_tls_renegotiation_handshake && tls_session -> nx_secure_tls_client_state != NX_SECURE_TLS_CLIENT_STATE_RENEGOTIATING)
#endif
{
/* For the secure rengotiation indication extension, we need to send a
Signalling Ciphersuite Value (SCSV) as detailled in RFC5746. */
ciphersuite = TLS_EMPTY_RENEGOTIATION_INFO_SCSV;
packet_buffer[length] = (UCHAR)((ciphersuite & 0xFF00) >> 8);
packet_buffer[length + 1] = (UCHAR)(ciphersuite & 0x00FF);
length += 2;
ciphersuites_length = (USHORT)(ciphersuites_length + 2);
}
#endif
/* If we are falling back to an earlier TLS version, include the fallback notification SCSV. */
if(fallback_enabled)
{
ciphersuite = TLS_FALLBACK_NOTIFY_SCSV;
packet_buffer[length] = (UCHAR)((ciphersuite & 0xFF00) >> 8);
packet_buffer[length + 1] = (UCHAR)(ciphersuite & 0x00FF);
length += 2;
ciphersuites_length = (USHORT)(ciphersuites_length + 2);
}
ciphersuites_length_ptr[0] = (UCHAR)((ciphersuites_length & 0xFF00) >> 8);
ciphersuites_length_ptr[1] = (UCHAR)(ciphersuites_length & 0x00FF);
/* Compression methods length - one byte. For now we only have the NULL method, for a length of 1. */
packet_buffer[length] = 0x1;
length++;
/* Compression methods - for now this is NULL. */
packet_buffer[length] = 0x0;
length++;
/* ============ TLS ClientHello extensions. ============= */
/* Save an offset to the beginning of the extensions so we can fill in the length
once all the extensions are added. */
extension_offset = length;
total_extensions_length = 0;
/* The extensions length field is two bytes. */
length += 2;
status = _nx_secure_tls_send_clienthello_extensions(tls_session, packet_buffer, &length, &extension_length,
((ULONG)send_packet -> nx_packet_data_end -
(ULONG)packet_buffer));
if (status)
{
return(status);
}
total_extensions_length += extension_length;
/* !!! NOTE !!! The TLS 1.3 PSK extension MUST be the LAST extension in the ClientHello! (RFC 8446, Section 4.2.11) */
#if (NX_SECURE_TLS_TLS_1_3_ENABLED)
/* Send TLS 1.3 PSK extension, but only if there is a PSK to send. */
if(tls_session->nx_secure_tls_1_3 && tls_session->nx_secure_tls_credentials.nx_secure_tls_psk_count > 0)
{
status = _nx_secure_tls_send_clienthello_psk_extension(tls_session, packet_buffer, &length,
extension_offset, total_extensions_length,
&extension_length,
((ULONG)send_packet -> nx_packet_data_end - (ULONG)packet_buffer));
if(status != NX_SUCCESS)
{
return(status);
}
total_extensions_length += extension_length;
}
#endif
/* Put the extensions length into the packet at our original offset and add
the total to our packet length. */
packet_buffer[extension_offset] = (UCHAR)((total_extensions_length & 0xFF00) >> 8);
packet_buffer[extension_offset + 1] = (UCHAR)(total_extensions_length & 0x00FF);
/* Finally, we have a complete length and can put it into the buffer. Before that,
save off and return the number of bytes we wrote and need to send. */
send_packet -> nx_packet_append_ptr = send_packet -> nx_packet_append_ptr + length;
send_packet -> nx_packet_length = send_packet -> nx_packet_length + length;
return(status);
}
#endif /* NX_SECURE_TLS_CLIENT_DISABLED */
|
