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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
|
/***************************************************************************
* 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"
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_psk_identity_lookup PORTABLE C */
/* 6.x */
/* AUTHOR */
/* */
/* Eclipse ThreadX Contributors */
/* */
/* DESCRIPTION */
/* */
/* This function searches the PSK store for an entry matching a peer */
/* PSK identity. */
/* */
/* INPUT */
/* */
/* tls_credentials TLS credentials */
/* psk_data Destination for PSK data */
/* psk_length Destination for PSK length */
/* psk_identity PSK identity data */
/* identity_length PSK identity length */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_mutex_get Get TLS protection */
/* tx_mutex_put Release TLS protection */
/* */
/* CALLED BY */
/* */
/* _nx_secure_generate_premaster_secret Generate pre-master secret */
/* */
/**************************************************************************/
static UINT _nx_secure_tls_psk_identity_lookup(NX_SECURE_TLS_CREDENTIALS *tls_credentials, UCHAR **psk_data, UINT *psk_length,
UCHAR *psk_identity, UINT identity_length)
{
UINT psk_list_size;
UINT i;
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
psk_list_size = tls_credentials -> nx_secure_tls_psk_count;
/* Loop through all PSKs, looking for a matching identity string. */
for (i = 0; i < psk_list_size; ++i)
{
if (identity_length == tls_credentials -> nx_secure_tls_psk_store[i].nx_secure_tls_psk_id_size)
{
if (NX_SECURE_MEMCMP(tls_credentials -> nx_secure_tls_psk_store[i].nx_secure_tls_psk_id,
psk_identity, identity_length) == 0)
{
*psk_data = tls_credentials -> nx_secure_tls_psk_store[i].nx_secure_tls_psk_data;
*psk_length = tls_credentials -> nx_secure_tls_psk_store[i].nx_secure_tls_psk_data_size;
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
return(NX_SUCCESS);
}
}
}
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
return(NX_SECURE_TLS_NO_MATCHING_PSK);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_client_psk_save PORTABLE C */
/* 6.x */
/* AUTHOR */
/* */
/* Eclipse ThreadX Contributors */
/* */
/* DESCRIPTION */
/* */
/* This function saves the PSK store entry selected by the server */
/* identity hint so the client sends the matching identity in */
/* ClientKeyExchange. */
/* */
/* INPUT */
/* */
/* tls_credentials TLS credentials */
/* psk_store_index Selected PSK store index */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* tx_mutex_get Get TLS protection */
/* tx_mutex_put Release TLS protection */
/* */
/* CALLED BY */
/* */
/* _nx_secure_generate_premaster_secret Generate pre-master secret */
/* */
/**************************************************************************/
static UINT _nx_secure_tls_client_psk_save(NX_SECURE_TLS_CREDENTIALS *tls_credentials, UINT psk_store_index)
{
UINT status;
/* Get the protection. */
tx_mutex_get(&_nx_secure_tls_protection, TX_WAIT_FOREVER);
if (psk_store_index < tls_credentials -> nx_secure_tls_psk_count)
{
NX_SECURE_MEMCPY(&tls_credentials -> nx_secure_tls_client_psk,
&tls_credentials -> nx_secure_tls_psk_store[psk_store_index],
sizeof(NX_SECURE_TLS_PSK_STORE)); /* Use case of memcpy is verified. */
status = NX_SUCCESS;
}
else
{
status = NX_SECURE_TLS_NO_MATCHING_PSK;
}
/* Release the protection. */
tx_mutex_put(&_nx_secure_tls_protection);
return(status);
}
#endif
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_generate_premaster_secret PORTABLE C */
/* 6.4.3 */
/* AUTHOR */
/* */
/* Yanwu Cai, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function generates the Pre-Master Secret for TLS Client */
/* instances. It is sent to the remote host and used as the seed for */
/* session key generation. */
/* */
/* INPUT */
/* */
/* ciphersuite Selected cipher suite */
/* protocol_version Selected TLS version */
/* tls_key_material TLS key material */
/* tls_credentials TLS credentials */
/* session_type Server or client session */
/* received_remote_credentials Indicates credentials received*/
/* public_cipher_metadata Metadata for public cipher */
/* public_cipher_metadata_size Size of public cipher metadata*/
/* tls_ecc_curves ECC curves */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_secure_tls_psk_find Find PSK from store */
/* _nx_secure_tls_find_curve_method Find named curve used */
/* [nx_crypto_init] Initialize crypto */
/* [nx_crypto_operation] Crypto operation */
/* */
/* CALLED BY */
/* */
/* _nx_secure_tls_generate_premaster_secret */
/* Generate pre-master secret */
/* */
/**************************************************************************/
UINT _nx_secure_generate_premaster_secret(const NX_SECURE_TLS_CIPHERSUITE_INFO *ciphersuite, USHORT protocol_version, NX_SECURE_TLS_KEY_MATERIAL *tls_key_material,
NX_SECURE_TLS_CREDENTIALS *tls_credentials, UINT session_type, USHORT *received_remote_credentials,
VOID *public_cipher_metadata, ULONG public_cipher_metadata_size, VOID *tls_ecc_curves)
{
UINT *buffer_ptr;
UINT i;
UINT status = NX_SECURE_TLS_SUCCESS;
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
UCHAR *psk_data;
UINT psk_length;
UINT index;
UINT psk_store_index;
#endif
#if defined(NX_SECURE_ENABLE_ECC_CIPHERSUITE) && !defined(NX_SECURE_DISABLE_X509)
NX_SECURE_X509_CERT *server_certificate;
const NX_CRYPTO_METHOD *curve_method_cert;
const NX_CRYPTO_METHOD *ecdh_method;
NX_SECURE_EC_PUBLIC_KEY *ec_pubkey;
VOID *handler = NX_NULL;
NX_CRYPTO_EXTENDED_OUTPUT extended_output;
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
UCHAR pre_master_secret_cpy[NX_SECURE_TLS_PREMASTER_SIZE];
UINT pre_master_secret_size;
#endif
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE && !NX_SECURE_DISABLE_X509 */
#if !defined(NX_SECURE_ENABLE_ECC_CIPHERSUITE) || defined(NX_SECURE_DISABLE_X509)
NX_PARAMETER_NOT_USED(public_cipher_metadata);
NX_PARAMETER_NOT_USED(public_cipher_metadata_size);
NX_PARAMETER_NOT_USED(tls_ecc_curves);
#endif
#ifndef NX_SECURE_ENABLE_PSK_CIPHERSUITES
NX_PARAMETER_NOT_USED(session_type);
NX_PARAMETER_NOT_USED(ciphersuite);
NX_PARAMETER_NOT_USED(tls_credentials);
NX_PARAMETER_NOT_USED(public_cipher_metadata);
NX_PARAMETER_NOT_USED(public_cipher_metadata_size);
NX_PARAMETER_NOT_USED(tls_ecc_curves);
#ifndef NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE
NX_PARAMETER_NOT_USED(received_remote_credentials);
#endif
#endif
#if defined(NX_SECURE_ENABLE_ECC_CIPHERSUITE) && !defined(NX_SECURE_DISABLE_X509)
if (ciphersuite -> nx_secure_tls_public_cipher -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECDHE)
{
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
if(ciphersuite->nx_secure_tls_public_auth->nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_PSK)
{
/* From RFC 5489:
The premaster secret is formed as follows. First, perform the ECDH
computation as described in Section 5.10 of [RFC4492]. Let Z be the
octet string produced by this computation. Next, concatenate a
uint16 containing the length of Z (in octets), Z itself, a uint16
containing the length of the PSK (in octets), and the PSK itself.
*/
if (session_type == NX_SECURE_TLS_SESSION_TYPE_SERVER)
{
/* Server searches for the PSK based on the identity requested by the client. */
status = _nx_secure_tls_psk_identity_lookup(tls_credentials, &psk_data, &psk_length,
tls_credentials -> nx_secure_tls_remote_psk_id,
tls_credentials -> nx_secure_tls_remote_psk_id_size);
}
else
{
/* Client has to search for the PSK based on the identity hint. */
status = _nx_secure_tls_psk_find(tls_credentials, &psk_data, &psk_length,
tls_credentials -> nx_secure_tls_remote_psk_id,
tls_credentials -> nx_secure_tls_remote_psk_id_size, &psk_store_index);
if (status == NX_SUCCESS)
{
status = _nx_secure_tls_client_psk_save(tls_credentials, psk_store_index);
}
}
if (status != NX_SUCCESS)
{
return(status);
}
pre_master_secret_size = tls_key_material->nx_secure_tls_pre_master_secret_size;
if ((2 + pre_master_secret_size + 2 + psk_length) > sizeof(tls_key_material -> nx_secure_tls_pre_master_secret))
{
/* No more PSK space. */
return(NX_SECURE_TLS_NO_MORE_PSK_SPACE);
}
index = 0;
NX_SECURE_MEMCPY(pre_master_secret_cpy, tls_key_material->nx_secure_tls_pre_master_secret, pre_master_secret_size);
tls_key_material->nx_secure_tls_pre_master_secret[index++] = (pre_master_secret_size >> 8) & 0xFF;
tls_key_material->nx_secure_tls_pre_master_secret[index++] = pre_master_secret_size & 0xFF;
NX_SECURE_MEMCPY(tls_key_material->nx_secure_tls_pre_master_secret + index, pre_master_secret_cpy, pre_master_secret_size);
index += pre_master_secret_size;
tls_key_material->nx_secure_tls_pre_master_secret[index++] = (psk_length >> 8) & 0xFF;
tls_key_material->nx_secure_tls_pre_master_secret[index++] = psk_length & 0xFF;
NX_SECURE_MEMCPY(tls_key_material->nx_secure_tls_pre_master_secret + index, psk_data, psk_length);
tls_key_material->nx_secure_tls_pre_master_secret_size += (4 + psk_length);
*received_remote_credentials = NX_TRUE;
/* Clear out the Pre-Master Secret (we don't need it anymore and keeping it in memory is dangerous). */
#ifdef NX_SECURE_KEY_CLEAR
NX_SECURE_MEMSET(pre_master_secret_cpy, 0x0, sizeof(pre_master_secret_cpy));
#endif /* NX_SECURE_KEY_CLEAR */
}
#endif
return(NX_SECURE_TLS_SUCCESS);
}
else if (ciphersuite -> nx_secure_tls_public_cipher -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECDH)
{
/* Get reference to remote server certificate so we can find out the named curve. */
status = _nx_secure_x509_remote_endpoint_certificate_get(&tls_credentials -> nx_secure_tls_certificate_store,
&server_certificate);
if (status)
{
/* No certificate found, error! */
return(NX_SECURE_TLS_CERTIFICATE_NOT_FOUND);
}
ec_pubkey = &server_certificate -> nx_secure_x509_public_key.ec_public_key;
/* Find out which named curve the remote certificate is using. */
status = _nx_secure_tls_find_curve_method((NX_SECURE_TLS_ECC *)tls_ecc_curves, (USHORT)(ec_pubkey -> nx_secure_ec_named_curve), &curve_method_cert, NX_NULL);
if(status != NX_SUCCESS)
{
return(status);
}
ecdh_method = ciphersuite -> nx_secure_tls_public_cipher;
if (ecdh_method -> nx_crypto_operation == NX_NULL)
{
return(NX_SECURE_TLS_MISSING_CRYPTO_ROUTINE);
}
if (ecdh_method -> nx_crypto_init != NX_NULL)
{
status = ecdh_method -> nx_crypto_init((NX_CRYPTO_METHOD*)ecdh_method,
NX_NULL,
0,
&handler,
public_cipher_metadata,
public_cipher_metadata_size);
if(status != NX_CRYPTO_SUCCESS)
{
return(status);
}
}
status = ecdh_method -> nx_crypto_operation(NX_CRYPTO_EC_CURVE_SET, handler,
(NX_CRYPTO_METHOD*)ecdh_method, NX_NULL, 0,
(UCHAR *)curve_method_cert, sizeof(NX_CRYPTO_METHOD *), NX_NULL,
NX_NULL, 0,
public_cipher_metadata,
public_cipher_metadata_size,
NX_NULL, NX_NULL);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
/* Store public key in the nx_secure_tls_new_key_material_data. */
extended_output.nx_crypto_extended_output_data = &tls_key_material -> nx_secure_tls_new_key_material_data[1];
extended_output.nx_crypto_extended_output_length_in_byte = sizeof(tls_key_material -> nx_secure_tls_new_key_material_data) - 1;
extended_output.nx_crypto_extended_output_actual_size = 0;
status = ecdh_method -> nx_crypto_operation(NX_CRYPTO_DH_SETUP, handler,
(NX_CRYPTO_METHOD*)ecdh_method, NX_NULL, 0,
NX_NULL, 0, NX_NULL,
(UCHAR *)&extended_output,
sizeof(extended_output),
public_cipher_metadata,
public_cipher_metadata_size,
NX_NULL, NX_NULL);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
tls_key_material -> nx_secure_tls_new_key_material_data[0] = (UCHAR)extended_output.nx_crypto_extended_output_actual_size;
extended_output.nx_crypto_extended_output_data = tls_key_material -> nx_secure_tls_pre_master_secret;
extended_output.nx_crypto_extended_output_length_in_byte = sizeof(tls_key_material -> nx_secure_tls_pre_master_secret);
extended_output.nx_crypto_extended_output_actual_size = 0;
status = ecdh_method -> nx_crypto_operation(NX_CRYPTO_DH_CALCULATE, handler,
(NX_CRYPTO_METHOD*)ecdh_method, NX_NULL, 0,
(UCHAR *)ec_pubkey -> nx_secure_ec_public_key,
ec_pubkey -> nx_secure_ec_public_key_length, NX_NULL,
(UCHAR *)&extended_output,
sizeof(extended_output),
public_cipher_metadata,
public_cipher_metadata_size,
NX_NULL, NX_NULL);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
tls_key_material -> nx_secure_tls_pre_master_secret_size = extended_output.nx_crypto_extended_output_actual_size;
if (ecdh_method -> nx_crypto_cleanup)
{
status = ecdh_method -> nx_crypto_cleanup(public_cipher_metadata);
if(status != NX_CRYPTO_SUCCESS)
{
return(status);
}
}
return(NX_SECURE_TLS_SUCCESS);
}
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE && !NX_SECURE_DISABLE_X509 */
#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)
{
/* Now, using the identity as a key, find the PSK in our PSK store. */
if (session_type == NX_SECURE_TLS_SESSION_TYPE_SERVER)
{
/* Server searches for the PSK based on the identity requested by the client. */
status = _nx_secure_tls_psk_identity_lookup(tls_credentials, &psk_data, &psk_length,
tls_credentials -> nx_secure_tls_remote_psk_id,
tls_credentials -> nx_secure_tls_remote_psk_id_size);
if (status != NX_SUCCESS)
{
return(status);
}
}
else
{
/* Client has to search for the PSK based on the identity hint. */
status = _nx_secure_tls_psk_find(tls_credentials, &psk_data, &psk_length, tls_credentials -> nx_secure_tls_remote_psk_id,
tls_credentials -> nx_secure_tls_remote_psk_id_size, &psk_store_index);
if (status != NX_SUCCESS)
{
return(status);
}
status = _nx_secure_tls_client_psk_save(tls_credentials, psk_store_index);
if (status != NX_SUCCESS)
{
return(status);
}
}
/* From RFC 4279:
The premaster secret is formed as follows: if the PSK is N octets
long, concatenate a uint16 with the value N, N zero octets, a second
uint16 with the value N, and the PSK itself.
| 2 | <N> | 2 | <N> |
| N | 0 | N | PSK |
*/
index = 0;
if ((2 + psk_length + 2 + psk_length) > sizeof(tls_key_material -> nx_secure_tls_pre_master_secret))
{
/* No more PSK space. */
return(NX_SECURE_TLS_NO_MORE_PSK_SPACE);
}
tls_key_material -> nx_secure_tls_pre_master_secret[0] = (UCHAR)(psk_length >> 8);
tls_key_material -> nx_secure_tls_pre_master_secret[1] = (UCHAR)psk_length;
index += 2;
NX_SECURE_MEMSET(&tls_key_material -> nx_secure_tls_pre_master_secret[index], 0, psk_length);
index += psk_length;
tls_key_material -> nx_secure_tls_pre_master_secret[index] = (UCHAR)(psk_length >> 8);
tls_key_material -> nx_secure_tls_pre_master_secret[index + 1] = (UCHAR)psk_length;
index += 2;
NX_SECURE_MEMCPY(&tls_key_material -> nx_secure_tls_pre_master_secret[index], psk_data, psk_length); /* Use case of memcpy is verified. */
index += psk_length;
/* Save the pre-master secret size for later use. */
tls_key_material -> nx_secure_tls_pre_master_secret_size = 2 + psk_length + 2 + psk_length;
/* We are using PSK for our credentials and now that we have generated keys we can consider the
remote host's credentials to have been received. */
*received_remote_credentials = NX_TRUE;
return(NX_SECURE_TLS_SUCCESS);
}
#endif
#ifdef NX_SECURE_ENABLE_ECJPAKE_CIPHERSUITE
/* When using ECJ-PAKE ciphersuite, pre-master secret is already generated. */
if (ciphersuite -> nx_secure_tls_public_auth -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECJPAKE)
{
/* If using EC-JPAKE, credentials are passed differently - if we get here credentials should be OK. */
*received_remote_credentials = NX_TRUE;
return(NX_SECURE_TLS_SUCCESS);
}
#endif
/* Generate the Pre-Master Secret that is used to generate the key material
used in the session. For TLS 1.1, the secret consists of two bytes
representing the highest protocol version the client supports, followed
by 46 random bytes. */
buffer_ptr = (UINT *)tls_key_material -> nx_secure_tls_pre_master_secret;
/* Generate 48 bytes of random data, fill in the version afterwards. */
for (i = 0; i < 12; i++)
{
/* Fill with 12 ULONG randoms, then fix first two bytes to protocol version after. */
*(buffer_ptr + i) = (UINT)NX_RAND();
}
/* First two bytes are newest version supported by client . */
buffer_ptr[0] = ((ULONG)protocol_version << 16) | (buffer_ptr[0] & 0x0000FFFF);
NX_CHANGE_ULONG_ENDIAN(buffer_ptr[0]);
tls_key_material -> nx_secure_tls_pre_master_secret_size = 48;
return(status);
}
|
