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
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
|
/***************************************************************************
* 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
**************************************************************************/
// Some portions generated by Codex gpt-5.5.
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Secure Component */
/** */
/** Transport Layer Security (TLS) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_tls.h"
#ifndef NX_SECURE_DISABLE_X509
static UCHAR _nx_secure_client_padded_pre_master[600];
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_generate_client_key_exchange PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yanwu Cai, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function encrypts the Pre-Master Secret (generated earlier) */
/* and populates the buffer with the complete ClientKeyExchange */
/* message (to be sent by the caller). It also will send ephemeral */
/* keys for ciphersuites that require them. */
/* */
/* INPUT */
/* */
/* ciphersuite Selected cipher suite */
/* tls_key_material TLS key material */
/* tls_credentials TLS credentials */
/* data_buffer Pointer to output buffer */
/* buffer_length Length of data buffer */
/* output_size Size of data written to buffer*/
/* public_cipher_metadata Metadata for public cipher */
/* public_cipher_metadata_size Size of public cipher metadata*/
/* public_auth_metadata Metadata for public auth */
/* public_auth_metadata_size Size of public auth metadata */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_secure_x509_remote_endpoint_certificate_get */
/* Get cert for remote host */
/* [nx_crypto_operation] Public-key ciphers */
/* [nx_crypto_init] Initialize Crypto Method */
/* */
/* CALLED BY */
/* */
/* _nx_secure_tls_send_client_key_exchange */
/* Send ClientKeyExchange */
/* */
/**************************************************************************/
UINT _nx_secure_generate_client_key_exchange(const NX_SECURE_TLS_CIPHERSUITE_INFO *ciphersuite,
NX_SECURE_TLS_KEY_MATERIAL *tls_key_material, NX_SECURE_TLS_CREDENTIALS *tls_credentials,
UCHAR *data_buffer, ULONG buffer_length, ULONG *output_size,
VOID *public_cipher_metadata, ULONG public_cipher_metadata_size,
VOID *public_auth_metadata, ULONG public_auth_metadata_size)
{
#if defined(NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE) || !defined(NX_SECURE_DISABLE_X509)
UINT status;
const NX_CRYPTO_METHOD *public_cipher_method;
VOID *handler = NX_NULL;
#endif
UINT data_size;
UCHAR *encrypted_data_ptr;
#ifndef NX_SECURE_DISABLE_X509
UCHAR rand_byte;
UINT i;
NX_SECURE_X509_CERT *remote_certificate;
#endif
#ifdef NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE
NX_CRYPTO_EXTENDED_OUTPUT extended_output;
#endif /* NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE */
/* Send a ClientKeyExchange message.
* Structure:
* | 2 | <Length> |
* | Length | Encrypted Pre-Master Secret |
*
* ECDHE ephemeral key structure:
* | 2 | <Length> |
* | Length | EC Diffie-Hellman Client Params |
*/
#ifndef NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE
NX_PARAMETER_NOT_USED(public_auth_metadata);
NX_PARAMETER_NOT_USED(public_auth_metadata_size);
#endif
#ifdef NX_SECURE_DISABLE_X509
NX_PARAMETER_NOT_USED(tls_key_material);
NX_PARAMETER_NOT_USED(public_cipher_metadata);
NX_PARAMETER_NOT_USED(public_cipher_metadata_size);
#endif
#ifdef NX_SECURE_ENABLE_ECC_CIPHERSUITE
if (ciphersuite -> nx_secure_tls_public_cipher -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECDH ||
ciphersuite -> nx_secure_tls_public_cipher -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECDHE)
{
data_size = (UINT)(1 + tls_key_material -> nx_secure_tls_new_key_material_data[0]);
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
if (ciphersuite -> nx_secure_tls_public_auth -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_PSK)
{
if ((tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size >
sizeof(tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id)) ||
(data_size > sizeof(tls_key_material -> nx_secure_tls_new_key_material_data)) ||
(((ULONG)data_size + 2u + tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size) > buffer_length))
{
/* Packet buffer too small. */
return(NX_SECURE_TLS_PACKET_BUFFER_TOO_SMALL);
}
data_buffer[0] = (UCHAR)((tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size & 0xFF00) >> 8);
data_buffer[1] = (UCHAR)(tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size & 0x00FF);
NX_SECURE_MEMCPY(&data_buffer[2], tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id,
tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size); /* Use case of memcpy is verified. */
NX_SECURE_MEMCPY(&data_buffer[2 + tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size],
tls_key_material -> nx_secure_tls_new_key_material_data, data_size); /* Use case of memcpy is verified. */
data_size += 2 + tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size;
}
else
#endif /* NX_SECURE_ENABLE_PSK_CIPHERSUITES */
{
if ((data_size > sizeof(tls_key_material -> nx_secure_tls_new_key_material_data)) ||
(data_size > buffer_length))
{
/* Packet buffer too small. */
return(NX_SECURE_TLS_PACKET_BUFFER_TOO_SMALL);
}
NX_SECURE_MEMCPY(data_buffer, tls_key_material -> nx_secure_tls_new_key_material_data, data_size); /* Use case of memcpy is verified. */
}
}
else
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE */
{
/* Pointer to the output encrypted pre-master secret. */
encrypted_data_ptr = &data_buffer[2];
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
/* Check for PSK ciphersuites. */
if (ciphersuite -> nx_secure_tls_public_auth -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_PSK)
{
if ((tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size >
sizeof(tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id)) ||
((buffer_length < 2u) || (tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size >
(buffer_length - 2u))))
{
/* Packet buffer too small. */
return(NX_SECURE_TLS_PACKET_BUFFER_TOO_SMALL);
}
/* Send the PSK Identity string to the remote server along with its length. */
NX_SECURE_MEMCPY(encrypted_data_ptr, tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id,
tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size); /* Use case of memcpy is verified. */
/* Make sure our size is correct. */
data_size = tls_credentials -> nx_secure_tls_client_psk.nx_secure_tls_psk_id_size;
/* Put the length into our outgoing packet buffer. */
data_buffer[0] = (UCHAR)((data_size & 0xFF00) >> 8);
data_buffer[1] = (UCHAR)(data_size & 0x00FF);
data_size += 2;
}
else
#endif
#ifdef NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE
if (ciphersuite -> nx_secure_tls_public_auth -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECJPAKE)
{
data_size = 0;
public_cipher_method = ciphersuite -> nx_secure_tls_public_auth;
extended_output.nx_crypto_extended_output_data = data_buffer;
extended_output.nx_crypto_extended_output_length_in_byte = buffer_length;
extended_output.nx_crypto_extended_output_actual_size = 0;
status = public_cipher_method -> nx_crypto_operation(NX_CRYPTO_ECJPAKE_CLIENT_KEY_EXCHANGE_GENERATE,
handler,
(NX_CRYPTO_METHOD*)public_cipher_method,
NX_NULL, 0,
NX_NULL, 0, NX_NULL,
(UCHAR *)&extended_output,
sizeof(extended_output),
public_auth_metadata,
public_auth_metadata_size,
NX_NULL, NX_NULL);
if (status)
{
return(status);
}
data_size += extended_output.nx_crypto_extended_output_actual_size;
}
else
#endif
{
#ifndef NX_SECURE_DISABLE_X509
/* Extract the data to be verified from the remote certificate processed earlier. */
status = _nx_secure_x509_remote_endpoint_certificate_get(&tls_credentials -> nx_secure_tls_certificate_store,
&remote_certificate);
if (status)
{
/* No certificate found, error! */
return(NX_SECURE_TLS_NO_CERT_SPACE_ALLOCATED);
}
/* Get the public cipher method from the ciphersuite. */
public_cipher_method = ciphersuite -> nx_secure_tls_public_cipher;
/* If using RSA, the length is equal to the key size. */
data_size = remote_certificate -> nx_secure_x509_public_key.rsa_public_key.nx_secure_rsa_public_modulus_length;
/* check data_size */
if ((data_size < NX_SECURE_TLS_RSA_PREMASTER_SIZE + 1) ||
(buffer_length < (2u + data_size)))
{
/* Invalid certificate modulus length. */
return(NX_SECURE_TLS_INVALID_CERTIFICATE);
}
/* PKCS#1 v1.5 padding. The scheme is to start with the block type (0x00, 0x02 for PKCS#1)
then pad with non-zero bytes (random is cryptographically more secure), followed with
a single 0 byte right before the payload, which comes at the end of the RSA block. */
NX_SECURE_MEMSET(_nx_secure_client_padded_pre_master, 0x0, sizeof(_nx_secure_client_padded_pre_master));
_nx_secure_client_padded_pre_master[1] = 0x2; /* Block type is 0x00, 0x02 */
for (i = 2; i < (data_size - NX_SECURE_TLS_RSA_PREMASTER_SIZE - 1); ++i)
{
/* PKCS#1 padding must be random, but CANNOT be 0. */
do
{
rand_byte = (UCHAR)NX_RAND();
} while (rand_byte == 0);
_nx_secure_client_padded_pre_master[i] = rand_byte;
}
/* Now put the pre-master data into the padded buffer - must be at the end. */
NX_SECURE_MEMCPY(&_nx_secure_client_padded_pre_master[data_size - NX_SECURE_TLS_RSA_PREMASTER_SIZE],
tls_key_material -> nx_secure_tls_pre_master_secret, NX_SECURE_TLS_RSA_PREMASTER_SIZE); /* Use case of memcpy is verified. */
if (public_cipher_method -> nx_crypto_init != NX_NULL)
{
/* Initialize the crypto method with public key. */
status = public_cipher_method -> nx_crypto_init((NX_CRYPTO_METHOD*)public_cipher_method,
(UCHAR *)remote_certificate -> nx_secure_x509_public_key.rsa_public_key.nx_secure_rsa_public_modulus,
(NX_CRYPTO_KEY_SIZE)(remote_certificate -> nx_secure_x509_public_key.rsa_public_key.nx_secure_rsa_public_modulus_length << 3),
&handler,
public_cipher_metadata,
public_cipher_metadata_size);
if(status != NX_CRYPTO_SUCCESS)
{
#ifdef NX_SECURE_KEY_CLEAR
NX_SECURE_MEMSET(_nx_secure_client_padded_pre_master, 0, sizeof(_nx_secure_client_padded_pre_master));
#endif /* NX_SECURE_KEY_CLEAR */
return(status);
}
}
if (public_cipher_method -> nx_crypto_operation != NX_NULL)
{
/* Now encrypt the pre-master secret using the public key provided by the remote host
and place the result in the outgoing packet buffer. */
status = public_cipher_method -> nx_crypto_operation(NX_CRYPTO_DECRYPT,
handler,
(NX_CRYPTO_METHOD*)public_cipher_method,
(UCHAR *)remote_certificate -> nx_secure_x509_public_key.rsa_public_key.nx_secure_rsa_public_exponent,
(NX_CRYPTO_KEY_SIZE)(remote_certificate -> nx_secure_x509_public_key.rsa_public_key.nx_secure_rsa_public_exponent_length << 3),
_nx_secure_client_padded_pre_master,
data_size,
NX_NULL,
encrypted_data_ptr,
data_size,
public_cipher_metadata,
public_cipher_metadata_size,
NX_NULL, NX_NULL);
if(status != NX_CRYPTO_SUCCESS)
{
#ifdef NX_SECURE_KEY_CLEAR
NX_SECURE_MEMSET(_nx_secure_client_padded_pre_master, 0, sizeof(_nx_secure_client_padded_pre_master));
#endif /* NX_SECURE_KEY_CLEAR */
return(status);
}
}
if (public_cipher_method -> nx_crypto_cleanup)
{
status = public_cipher_method -> nx_crypto_cleanup(public_cipher_metadata);
if(status != NX_CRYPTO_SUCCESS)
{
#ifdef NX_SECURE_KEY_CLEAR
NX_SECURE_MEMSET(_nx_secure_client_padded_pre_master, 0, sizeof(_nx_secure_client_padded_pre_master));
#endif /* NX_SECURE_KEY_CLEAR */
return(status);
}
}
/* Put the length into our outgoing packet buffer. */
data_buffer[0] = (UCHAR)((data_size & 0xFF00) >> 8);
data_buffer[1] = (UCHAR)(data_size & 0x00FF);
data_size += 2;
#else
return(NX_NOT_SUPPORTED);
#endif /* NX_SECURE_DISABLE_X509 */
}
}
/* Let the caller know how many bytes we wrote. +2 for the length we just added. */
*output_size = data_size;
#if defined(NX_SECURE_KEY_CLEAR) && !defined(NX_SECURE_DISABLE_X509)
NX_SECURE_MEMSET(_nx_secure_client_padded_pre_master, 0, sizeof(_nx_secure_client_padded_pre_master));
#endif /* NX_SECURE_KEY_CLEAR && !NX_SECURE_DISABLE_X509 */
return(NX_SECURE_TLS_SUCCESS);
}
|
