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
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
/**************************************************************************/
/* */
/* 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 */
/** */
/** Crypto */
/** */
/**************************************************************************/
/**************************************************************************/
/**************************************************************************/
/* */
/* COMPONENT DEFINITION RELEASE */
/* */
/* nx_crypto.h PORTABLE C */
/* 6.1.10 */
/* AUTHOR */
/* */
/* Timothy Stapko, Microsoft Corporation */
/* */
/* DESCRIPTION */
/* */
/* This file defines the NetX Security Encryption component. */
/* */
/* RELEASE HISTORY */
/* */
/* DATE NAME DESCRIPTION */
/* */
/* 05-19-2020 Timothy Stapko Initial Version 6.0 */
/* 09-30-2020 Timothy Stapko Modified comment(s), */
/* disabled unaligned access */
/* by default, and added */
/* crypto standalone support, */
/* resulting in version 6.1 */
/* 06-02-2021 Bhupendra Naphade Modified comment(s), */
/* Renamed FIPS symbol and */
/* fips memory functions, */
/* resulting in version 6.1.7 */
/* 01-31-2022 Timothy Stapko Modified comment(s), */
/* added missing symbol, */
/* resulting in version 6.1.10 */
/* */
/**************************************************************************/
#ifndef _NX_CRYPTO_H_
#define _NX_CRYPTO_H_
/* Determine if a C++ compiler is being used. If so, ensure that standard
C is used to process the API information. */
#ifdef __cplusplus
/* Yes, C++ compiler is present. Use standard C. */
extern "C" {
#endif
/* Default to disabling standalone use of nx_crypto. To use nx_crypto in
standalone define NX_CRYPTO_STANDALONE_ENABLE*/
/*
#define NX_CRYPTO_STANDALONE_ENABLE
*/
#ifndef NX_CRYPTO_STANDALONE_ENABLE
#include "nx_api.h"
#else
#include "nx_crypto_port.h"
#endif
#ifdef NX_LITTLE_ENDIAN
#define NX_CRYPTO_LITTLE_ENDIAN 1
#endif
/* Deprecated definition, provided only for backward compatibility */
#ifdef NX_CRYPTO_FIPS
#ifndef NX_CRYPTO_SELF_TEST
#define NX_CRYPTO_SELF_TEST
#endif /* NX_CRYPTO_SELF_TEST */
#endif /* NX_CRYPTO_FIPS */
#include "nx_crypto_const.h"
#include <stdlib.h>
#include <string.h>
#ifdef NX_CRYPTO_SELF_TEST
VOID *_nx_crypto_self_test_memcpy(void *dest, const void *src, size_t size);
VOID *_nx_crypto_self_test_memmove(void *dest, const void *src, size_t size);
VOID *_nx_crypto_self_test_memset(void *dest, int value, size_t size);
int _nx_crypto_self_test_memcmp(const void *dest, const void *src, size_t size);
UINT _nx_crypto_drbg(UINT bits, UCHAR *result);
#ifdef _NX_CRYPTO_INITIALIZE_
VOID *(*volatile _nx_crypto_memset_ptr)(void *dest, int value, size_t size) = _nx_crypto_self_test_memset;
VOID *(*volatile _nx_crypto_memcpy_ptr)(void *dest, const void *src, size_t size) = _nx_crypto_self_test_memcpy;
#else
extern VOID *(*volatile _nx_crypto_memset_ptr)(void *dest, int value, size_t size);
extern VOID *(*volatile _nx_crypto_memcpy_ptr)(void *dest, const void *src, size_t size);
#endif
#ifndef NX_CRYPTO_MEMCPY
#define NX_CRYPTO_MEMCPY _nx_crypto_memcpy_ptr
#endif
#ifndef NX_CRYPTO_MEMMOVE
#define NX_CRYPTO_MEMMOVE _nx_crypto_self_test_memmove
#endif
#ifndef NX_CRYPTO_MEMSET
#define NX_CRYPTO_MEMSET _nx_crypto_memset_ptr
#endif
#ifndef NX_CRYPTO_MEMCMP
#define NX_CRYPTO_MEMCMP _nx_crypto_self_test_memcmp
#endif
#ifndef NX_CRYPTO_RBG
#define NX_CRYPTO_RBG _nx_crypto_drbg
#endif
#define NX_CRYPTO_CONST
#else /* NON NX_CRYPTO_SELF_TEST build. */
#ifdef _NX_CRYPTO_INITIALIZE_
VOID *(*volatile _nx_crypto_memset_ptr)(void *dest, int value, size_t size) = memset;
VOID *(*volatile _nx_crypto_memcpy_ptr)(void *dest, const void *src, size_t size) = memcpy;
#else
extern VOID *(*volatile _nx_crypto_memset_ptr)(void *dest, int value, size_t size);
extern VOID *(*volatile _nx_crypto_memcpy_ptr)(void *dest, const void *src, size_t size);
#endif
#ifndef NX_CRYPTO_MEMCPY
#define NX_CRYPTO_MEMCPY _nx_crypto_memcpy_ptr
#endif
#ifndef NX_CRYPTO_MEMMOVE
#define NX_CRYPTO_MEMMOVE memmove
#endif
#ifndef NX_CRYPTO_MEMSET
#define NX_CRYPTO_MEMSET _nx_crypto_memset_ptr
#endif
#ifndef NX_CRYPTO_MEMCMP
#define NX_CRYPTO_MEMCMP memcmp
#endif
#ifndef NX_CRYPTO_RBG
#define NX_CRYPTO_RBG _nx_crypto_huge_number_rbg
#endif
#define NX_CRYPTO_CONST const
#endif
#if !defined(NX_CRYPTO_CHANGE_ULONG_ENDIAN) && defined(NX_CHANGE_ULONG_ENDIAN)
#define NX_CRYPTO_CHANGE_ULONG_ENDIAN NX_CHANGE_ULONG_ENDIAN
#endif
#if !defined(NX_CRYPTO_CHANGE_USHORT_ENDIAN) && defined(NX_CHANGE_USHORT_ENDIAN)
#define NX_CRYPTO_CHANGE_USHORT_ENDIAN NX_CHANGE_USHORT_ENDIAN
#endif
#ifndef NX_CRYPTO_INTEGRITY_TEST
#define NX_CRYPTO_INTEGRITY_TEST
#endif
#ifndef NX_CRYPTO_RAND
#ifndef NX_CRYPTO_STANDALONE_ENABLE
#define NX_CRYPTO_RAND NX_RAND
#else
#define NX_CRYPTO_RAND rand
#endif
#endif
#ifndef NX_CRYPTO_SRAND
#ifndef NX_CRYPTO_STANDALONE_ENABLE
#define NX_CRYPTO_SRAND NX_SRAND
#else
#define NX_CRYPTO_SRAND srand
#endif
#endif
#ifdef NX_CRYPTO_SELF_TEST
/* NX_CRYPTO_SELF_TEST build forces NX_SECURE_KEY_CLEAR to be set */
#ifndef NX_SECURE_KEY_CLEAR
#define NX_SECURE_KEY_CLEAR
#endif /* NX_SECURE_KEY_CLEAR */
#ifdef _NX_CRYPTO_INITIALIZE_
unsigned int _nx_crypto_library_state = NX_CRYPTO_LIBRARY_STATE_UNINITIALIZED;
#else
extern unsigned int _nx_crypto_library_state;
#endif
#define NX_CRYPTO_STATE_CHECK \
if((_nx_crypto_library_state & (NX_CRYPTO_LIBRARY_STATE_OPERATIONAL | NX_CRYPTO_LIBRARY_STATE_POST_IN_PROGRESS)) == 0) \
return(NX_CRYPTO_INVALID_LIBRARY);
#else
#define NX_CRYPTO_STATE_CHECK
#endif /* NX_CRYPTO_SELF_TEST */
/* Keep functions not used which is compiler specific. */
#ifndef NX_CRYPTO_KEEP
#define NX_CRYPTO_KEEP
#endif /* NX_CRYPTO_KEEP */
#ifndef NX_CRYPTO_HARDWARE_RAND_INITIALIZE
#define NX_CRYPTO_HARDWARE_RAND_INITIALIZE
#endif /* NX_CRYPTO_HARDWARE_RAND_INITIALIZE */
#ifndef NX_CRYPTO_PARAMETER_NOT_USED
#define NX_CRYPTO_PARAMETER_NOT_USED(p) ((void)(p))
#endif /* NX_CRYPTO_PARAMETER_NOT_USED */
/* Note that both input and output packets are prepared by the
caller. For encryption/decryption operations, the callee shall
use the output buffer for encrypted or decrypted data. For
authentication operations, the callee shall use the output
buffer for the digest.
'crypto_metadata' Pointer to a storage space managed by the underlying crypto method.
The content of this block is defined by each sa in use.
'crypto_metadata_size' is the size of the crypto context block, in bytes. */
typedef struct NX_CRYPTO_INFO_STRUCT
{
USHORT nx_crypto_op; /* Encrypt, Decrypt, Authenticate, Verify */
NX_CRYPTO_KEY_SIZE nx_crypto_key_size_in_bits;
UCHAR *nx_crypto_key;
UCHAR *nx_crypto_iv_ptr;
UCHAR *nx_crypto_input;
UCHAR *nx_crypto_output;
USHORT nx_crypto_input_length_in_byte;
USHORT nx_crypto_output_length_in_byte;
VOID *nx_crypto_metadata;
USHORT nx_crypto_metadata_size;
USHORT nx_crypto_algorithm;
volatile UINT nx_crypto_status;
VOID (*nx_crypto_hw_process_callback)(VOID *packet_ptr, UINT status);
} NX_CRYPTO_INFO;
/* Notes on *nx_crypto_operation:
The crypto method strcuture contains a function pointer: nx_crypto_operation.
This function pointer should be set for the crypto method in use. The arguments to this function are:
nx_crypto_operation(UINT operation, UINT protocol, NX_CRYPTO_METHOD* crypto_method_ptr, NX_PACKET *packet_ptr)
ESP/AH process invokes this function, specifies the operation to perform (encrypt, decrypt,
digest computation, and the packet (data) to be performed on.
This routine shall return SUCCESS/FAILURE on return. */
typedef struct NX_CRYPTO_METHOD_STRUCT
{
/* Name of the algorithm. For example:
NX_CRYPTO_ENCRYPTOIN_3DES_CBC or NX_CRYPTO_AUTHENTICATION_HMAC_SHA1_96.
Refer to nx_crypto.h for a list of symbols used in this field. User may
wish to extend the list. */
UINT nx_crypto_algorithm;
/* Size of the key, in bits. */
NX_CRYPTO_KEY_SIZE nx_crypto_key_size_in_bits;
/* Size of the IV block, in bits. This is used for encryption. */
USHORT nx_crypto_IV_size_in_bits;
/* Size of the ICV block, in bits. This is used for authentication. */
USHORT nx_crypto_ICV_size_in_bits;
/* Size of the crypto block, in bytes. */
ULONG nx_crypto_block_size_in_bytes;
/* Size of the meta data area, in bytes. */
ULONG nx_crypto_metadata_area_size;
/* nx_cyrpto_init function initializes the underlying crypto
method with the "key" information. If the crytpo method requires
the storage of additional session information, this nx_crypto_init
routine must allocate memory as needed, and pass a handle
back to the caller in the parameter "handler". When NetX IPSec
invokes this crypto method, the handle is passed to crypto operation.
'crypto_metadata' Pointer to a storage space managed by the underlying crypto method.
The content of this block is defined by each sa in use.
'crypto_metadata_size' is the size of the crypto context block, in bytes. */
UINT (*nx_crypto_init)(struct NX_CRYPTO_METHOD_STRUCT *method,
UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
VOID **handler,
VOID *crypto_metadata,
ULONG crypto_metadata_size);
/* When the SA is no longer needed, NetX IPSec calls nx_crypto_cleanup
function and passes in the handler, so that the underlying
method can clean up the resource, if needed. */
UINT (*nx_crypto_cleanup)(VOID *crypto_metadata);
/* Function pointer to the actual crypto or hash operation.
For crypto operation, this function returns NX_CRYPTO_SUCCESS or
appropriate error code.
Note that both input and output buffers are prepared by the
caller. For encryption/decryption operations, the callee shall
use the output buffer for encrypted or decrypted data. For
authentication operations, the callee shall use the output
buffer for the digest.
'crypto_metadata' Pointer to a storage space managed by the underlying crypto method.
The content of this block is defined by each sa in use.
'crypto_metadata_size' is the size of the crypto context block, in bytes. */
UINT (*nx_crypto_operation)(UINT op, /* Encrypt, Decrypt, Authenticate */
VOID *handler, /* 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));
} NX_CRYPTO_METHOD;
/* Define structure for extended usage of output argument in nx_crypto_operation.
* Crypto algorithm may return dynamic length of output, such as ECJPAKE.*/
typedef struct NX_CRYPTO_EXTENDED_OUTPUT_STRUCT
{
/* Pointer to output buffer. */
UCHAR *nx_crypto_extended_output_data;
/* Length of output buffer. */
ULONG nx_crypto_extended_output_length_in_byte;
/* Actual size of output buffer used. */
ULONG nx_crypto_extended_output_actual_size;
} NX_CRYPTO_EXTENDED_OUTPUT;
/* This defines the maximum number of cipher roles for a given ciphersuite. */
#define NX_CRYPTO_MAX_CIPHER_ROLES 8
/* Structure to associate a NX_CRYPTO_METHOD ID with a particular
role (defined by the intended application, e.g. TLS, X.509). */
typedef struct NX_CRYPTO_ROLE_ENTRY_STRUCT
{
/* Crypto method id. */
UINT nx_crypto_role_cipher_id;
/* Crypto role id. */
UINT nx_crypto_role_id;
} NX_CRYPTO_ROLE_ENTRY;
/* New-style API structures for TLS support. */
typedef struct NX_CRYPTO_CIPHERSUITE_STRUCT
{
/* IANA-defined ciphersuite identifier (used by TLS). */
USHORT nx_crypto_ciphersuite_id;
/* Disambiguation ID for overlapping ciphersuite IDs. (e.g. NX_CRYPTO_TLS, NX_CRYPTO_X509). */
USHORT nx_crypto_internal_id;
/* We need the key size for TLS operations using symmetric key ciphers. For example,
unlike RSA and ECC, the AES key size is needed in TLS to calculate key material.
For ciphersuites not using a symmetric cipher (e.g. X.509 suites) this should be 0. */
UINT nx_crypto_symmetric_key_size;
/* Array of cipher IDs and their associated roles. */
NX_CRYPTO_ROLE_ENTRY nx_crypto_ciphers[NX_CRYPTO_MAX_CIPHER_ROLES];
/* Bitmap for protocol versions which can use this ciphersuite. */
UINT nx_crypto_version;
} NX_CRYPTO_CIPHERSUITE;
/* APIs. */
#define nx_crypto_initialize _nx_crypto_initialize
UINT _nx_crypto_initialize(VOID);
#ifdef NX_CRYPTO_SELF_TEST
#define nx_crypto_method_self_test _nx_crypto_method_self_test
#define nx_crypto_module_state_get _nx_crypto_module_state_get
/* int nx_crypto_rand(void); */
INT _nx_crypto_method_self_test(INT);
UINT _nx_crypto_module_state_get(VOID);
#endif
#ifdef __cplusplus
}
#endif
#endif /* _NX_CRYPTO_H_ */
Details ![]()
Show: from Types: Columns: ![]( "Show Project Names")
![]( "Show Locations")
![]( "Show Referring Symbols")
![]( "Show Scope")
This file uses the notable symbols shown below. Click anywhere in the file to view more details.