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
/**************************************************************************/
/* */
/* 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 Crypto Component */
/** */
/** Transport Layer Security (TLS) */
/** */
/**************************************************************************/
/**************************************************************************/
#define NX_SECURE_SOURCE_CODE
#include "nx_crypto_tls_prf_sha512.h"
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_crypto_method_prf_sha512_init PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function initializes the PRF crypto module with SHA512. */
/* */
/* INPUT */
/* */
/* method Crypto Method Object */
/* key Key */
/* key_size_in_bits Size of the key, in bits */
/* handle Handle, specified by user */
/* crypto_metadata Metadata area */
/* crypto_metadata_size Size of the metadata area */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* None */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
NX_CRYPTO_KEEP UINT _nx_crypto_method_prf_sha512_init(struct NX_CRYPTO_METHOD_STRUCT *method,
UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
VOID **handle,
VOID *crypto_metadata,
ULONG crypto_metadata_size)
{
NX_CRYPTO_TLS_PRF_SHA512 *prf;
NX_CRYPTO_PHASH *phash;
NX_CRYPTO_PARAMETER_NOT_USED(handle);
NX_CRYPTO_STATE_CHECK
if ((method == NX_CRYPTO_NULL) || (key == NX_CRYPTO_NULL) || (crypto_metadata == NX_CRYPTO_NULL))
{
return(NX_CRYPTO_PTR_ERROR);
}
/* Verify the metadata addrsss is 4-byte aligned. */
if((((ULONG)crypto_metadata) & 0x3) != 0)
{
return(NX_CRYPTO_PTR_ERROR);
}
if(crypto_metadata_size < sizeof(NX_CRYPTO_TLS_PRF_SHA512))
{
return(NX_CRYPTO_PTR_ERROR);
}
/* Get our control block. */
prf = (NX_CRYPTO_TLS_PRF_SHA512 *)crypto_metadata;
phash = &(prf -> nx_secure_tls_prf_phash_info);
/* Set the secret using the key value. */
phash -> nx_crypto_phash_secret = key;
/* This is the length of secret in bytes actually */
phash -> nx_crypto_phash_secret_length = key_size_in_bits;
return(NX_CRYPTO_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_crypto_method_prf_sha512_cleanup PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function cleans up the crypto metadata. */
/* */
/* INPUT */
/* */
/* crypto_metadata Crypto metadata */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* NX_CRYPTO_MEMSET Set the memory */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
NX_CRYPTO_KEEP UINT _nx_crypto_method_prf_sha512_cleanup(VOID *crypto_metadata)
{
NX_CRYPTO_STATE_CHECK
#ifdef NX_SECURE_KEY_CLEAR
if (!crypto_metadata)
return (NX_CRYPTO_SUCCESS);
/* Clean up the crypto metadata. */
NX_CRYPTO_MEMSET(crypto_metadata, 0, sizeof(NX_CRYPTO_TLS_PRF_SHA512));
#else
NX_CRYPTO_PARAMETER_NOT_USED(crypto_metadata);
#endif/* NX_SECURE_KEY_CLEAR */
return(NX_CRYPTO_SUCCESS);
}
/**************************************************************************/
/* */
/* FUNCTION RELEASE */
/* */
/* _nx_crypto_method_prf_sha512_operation PORTABLE C */
/* 6.1 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This function encrypts and decrypts a message using */
/* the PRF SHA512 algorithm. */
/* */
/* INPUT */
/* */
/* op PRF operation */
/* handle Crypto handle */
/* method Cryption Method Object */
/* key Encryption Key */
/* key_size_in_bits Key size in bits */
/* input Input data */
/* input_length_in_byte Input data size */
/* iv_ptr Initial vector */
/* output Output buffer */
/* output_length_in_byte Output buffer size */
/* crypto_metadata Metadata area */
/* crypto_metadata_size Metadata area size */
/* packet_ptr Pointer to packet */
/* nx_crypto_hw_process_callback Callback function pointer */
/* */
/* OUTPUT */
/* */
/* status Completion status */
/* */
/* CALLS */
/* */
/* _nx_crypto_phash_process Implement the PHASH process */
/* */
/* CALLED BY */
/* */
/* Application Code */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), improved */
/* buffer length verification, */
/* verified memcpy use cases, */
/* resulting in version 6.1 */
/* */
/**************************************************************************/
NX_CRYPTO_KEEP UINT _nx_crypto_method_prf_sha512_operation(UINT op, /* Encrypt, Decrypt, Authenticate */
VOID *handle, /* Crypto handler */
struct NX_CRYPTO_METHOD_STRUCT *method,
UCHAR *key,
NX_CRYPTO_KEY_SIZE key_size_in_bits,
UCHAR *input,
ULONG input_length_in_byte,
UCHAR *iv_ptr,
UCHAR *output,
ULONG output_length_in_byte,
VOID *crypto_metadata,
ULONG crypto_metadata_size,
VOID *packet_ptr,
VOID (*nx_crypto_hw_process_callback)(VOID *packet_ptr, UINT status))
{
UINT status;
NX_CRYPTO_TLS_PRF_SHA512 *prf;
NX_CRYPTO_PHASH *phash;
NX_CRYPTO_PARAMETER_NOT_USED(handle);
NX_CRYPTO_PARAMETER_NOT_USED(iv_ptr);
NX_CRYPTO_PARAMETER_NOT_USED(packet_ptr);
NX_CRYPTO_PARAMETER_NOT_USED(nx_crypto_hw_process_callback);
NX_CRYPTO_STATE_CHECK
/* Verify the metadata addrsss is 4-byte aligned. */
if((method == NX_CRYPTO_NULL) || (key == NX_CRYPTO_NULL) || (crypto_metadata == NX_CRYPTO_NULL) || ((((ULONG)crypto_metadata) & 0x3) != 0))
{
return(NX_CRYPTO_PTR_ERROR);
}
if(crypto_metadata_size < sizeof(NX_CRYPTO_TLS_PRF_SHA512))
{
return(NX_CRYPTO_PTR_ERROR);
}
/* This must be a PRF operation. */
if (op != NX_CRYPTO_PRF)
{
return(NX_CRYPTO_NOT_SUCCESSFUL);
}
/* Get our control block. */
prf = (NX_CRYPTO_TLS_PRF_SHA512 *)crypto_metadata;
phash = &(prf -> nx_secure_tls_prf_phash_info);
/* Install the label_seed_buffer to the phash structure as the buffer of phash seed. */
phash -> nx_crypto_phash_seed = prf -> nx_secure_tls_prf_label_seed_buffer;
if ((key_size_in_bits + input_length_in_byte) > sizeof(prf -> nx_secure_tls_prf_label_seed_buffer))
{
return(NX_CRYPTO_SIZE_ERROR);
}
/* Concatenate label and seed. */
NX_CRYPTO_MEMCPY(phash -> nx_crypto_phash_seed, key, key_size_in_bits); /* Use case of memcpy is verified. */
NX_CRYPTO_MEMCPY(&phash -> nx_crypto_phash_seed[key_size_in_bits], input, input_length_in_byte); /* Use case of memcpy is verified. */
phash -> nx_crypto_phash_seed_length = key_size_in_bits + input_length_in_byte;
/* Install the temp_A_buffer to the phash structure. */
phash -> nx_crypto_phash_temp_A = prf -> nx_secure_tls_prf_temp_A_buffer;
phash -> nx_crypto_phash_temp_A_size = sizeof(prf -> nx_secure_tls_prf_temp_A_buffer);
/* Install the hmac method to the phash structure. */
phash -> nx_crypto_hmac_method = &crypto_method_hmac_sha512;
/* Install metadata buffer for the hmac method. */
phash -> nx_crypto_hmac_metadata = prf -> nx_secure_tls_prf_hmac_metadata_area;
phash -> nx_crypto_hmac_metadata_size = sizeof(prf -> nx_secure_tls_prf_hmac_metadata_area);
/* Install the buffer for hmac output. */
phash -> nx_crypto_hmac_output = prf -> nx_secure_tls_prf_temp_hmac_output_buffer;
phash -> nx_crypto_hmac_output_size = sizeof(prf -> nx_secure_tls_prf_temp_hmac_output_buffer);
/* Clear the output buffer for the generic phash routine will show the output by XOR. */
NX_CRYPTO_MEMSET(output, 0, output_length_in_byte);
/* Invoke generic phash routine. */
status = _nx_crypto_phash(phash, output, output_length_in_byte);
return status;
}