Outline ![]()
Files ![]()
loading...
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
/**************************************************************************/
/* */
/* Copyright (c) Microsoft Corporation. All rights reserved. */
/* */
/* This software is licensed under the Microsoft Software License */
/* Terms for Microsoft Azure RTOS. Full text of the license can be */
/* found in the LICENSE file at https://aka.ms/AzureRTOS_EULA */
/* and in the root directory of this software. */
/* */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/** */
/** NetX Secure Component */
/** */
/** Transport Layer Security (TLS) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_secure_tls.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_secure_tls_generate_premaster_secret PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, 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 */
/* */
/* tls_session TLS control block */
/* id TLS or DTLS */
/* */
/* 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_dtls_client_handshake DTLS client state machine */
/* _nx_secure_tls_client_handshake TLS client state machine */
/* _nx_secure_tls_process_client_key_exchange */
/* Process ClientKeyExchange */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), update */
/* ECC find curve method, */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
UINT _nx_secure_tls_generate_premaster_secret(NX_SECURE_TLS_SESSION *tls_session, UINT id)
{
UINT *buffer_ptr;
UINT i;
UINT status = NX_SECURE_TLS_SUCCESS;
USHORT protocol_version;
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
UCHAR *psk_data;
UINT psk_length;
UINT index;
#endif
#ifdef NX_SECURE_ENABLE_ECC_CIPHERSUITE
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;
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE */
if (tls_session -> nx_secure_tls_session_ciphersuite == NX_NULL)
{
/* Likely internal error since at this point ciphersuite negotiation was theoretically completed. */
return(NX_SECURE_TLS_UNKNOWN_CIPHERSUITE);
}
#ifdef NX_SECURE_ENABLE_ECC_CIPHERSUITE
if (tls_session -> nx_secure_tls_session_ciphersuite -> nx_secure_tls_public_cipher -> nx_crypto_algorithm == NX_CRYPTO_KEY_EXCHANGE_ECDHE)
{
return(NX_SECURE_TLS_SUCCESS);
}
else if (tls_session -> nx_secure_tls_session_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_session -> nx_secure_tls_credentials.nx_secure_tls_certificate_store,
&server_certificate);
if (status || server_certificate == NX_NULL)
{
/* 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(tls_session, (USHORT)(ec_pubkey -> nx_secure_ec_named_curve), &curve_method_cert, NX_NULL);
if(status != NX_SUCCESS)
{
return(status);
}
if (curve_method_cert == NX_NULL)
{
/* The remote certificate is using an unsupported curve. */
return(NX_SECURE_TLS_UNSUPPORTED_ECC_CURVE);
}
ecdh_method = tls_session -> nx_secure_tls_session_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,
tls_session -> nx_secure_public_cipher_metadata_area,
tls_session -> nx_secure_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,
tls_session -> nx_secure_public_cipher_metadata_area,
tls_session -> nx_secure_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_session -> nx_secure_tls_key_material.nx_secure_tls_new_key_material_data[1];
extended_output.nx_crypto_extended_output_length_in_byte = sizeof(tls_session -> nx_secure_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),
tls_session -> nx_secure_public_cipher_metadata_area,
tls_session -> nx_secure_public_cipher_metadata_size,
NX_NULL, NX_NULL);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
tls_session -> nx_secure_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_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret;
extended_output.nx_crypto_extended_output_length_in_byte = sizeof(tls_session -> nx_secure_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),
tls_session -> nx_secure_public_cipher_metadata_area,
tls_session -> nx_secure_public_cipher_metadata_size,
NX_NULL, NX_NULL);
if (status != NX_CRYPTO_SUCCESS)
{
return(status);
}
tls_session -> nx_secure_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(tls_session -> nx_secure_public_cipher_metadata_area);
if(status != NX_CRYPTO_SUCCESS)
{
return(status);
}
}
return(NX_SECURE_TLS_SUCCESS);
}
#endif /* NX_SECURE_ENABLE_ECC_CIPHERSUITE */
#ifdef NX_SECURE_ENABLE_PSK_CIPHERSUITES
/* Check for PSK ciphersuites. */
if (tls_session -> nx_secure_tls_session_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 (tls_session -> nx_secure_tls_socket_type == NX_SECURE_TLS_SESSION_TYPE_SERVER)
{
/* Server just uses its PSK. */
psk_data = tls_session -> nx_secure_tls_credentials.nx_secure_tls_psk_store[0].nx_secure_tls_psk_data;
psk_length = tls_session -> nx_secure_tls_credentials.nx_secure_tls_psk_store[0].nx_secure_tls_psk_data_size;
}
else
{
/* Client has to search for the PSK based on the identity hint. */
status = _nx_secure_tls_psk_find(tls_session, &psk_data, &psk_length, tls_session -> nx_secure_tls_credentials.nx_secure_tls_remote_psk_id,
tls_session -> nx_secure_tls_credentials.nx_secure_tls_remote_psk_id_size, NX_NULL);
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_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret))
{
/* No more PSK space. */
return(NX_SECURE_TLS_NO_MORE_PSK_SPACE);
}
tls_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret[0] = (UCHAR)(psk_length >> 8);
tls_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret[1] = (UCHAR)psk_length;
index += 2;
NX_SECURE_MEMSET(&tls_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret[index], 0, psk_length);
index += psk_length;
tls_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret[index] = (UCHAR)(psk_length >> 8);
tls_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret[index + 1] = (UCHAR)psk_length;
index += 2;
NX_SECURE_MEMCPY(&tls_session -> nx_secure_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_session -> nx_secure_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. */
tls_session -> nx_secure_tls_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 (tls_session -> nx_secure_tls_session_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. */
tls_session -> nx_secure_tls_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_session -> nx_secure_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 . */
_nx_secure_tls_protocol_version_get(tls_session, &protocol_version, id);
buffer_ptr[0] = ((ULONG)protocol_version << 16) | (buffer_ptr[0] & 0x0000FFFF);
NX_CHANGE_ULONG_ENDIAN(buffer_ptr[0]);
tls_session -> nx_secure_tls_key_material.nx_secure_tls_pre_master_secret_size = 48;
return(status);
}