1 /**************************************************************************/
2 /*                                                                        */
3 /*       Copyright (c) Microsoft Corporation. All rights reserved.        */
4 /*                                                                        */
5 /*       This software is licensed under the Microsoft Software License   */
6 /*       Terms for Microsoft Azure RTOS. Full text of the license can be  */
7 /*       found in the LICENSE file at https://aka.ms/AzureRTOS_EULA       */
8 /*       and in the root directory of this software.                      */
9 /*                                                                        */
10 /**************************************************************************/
11 
12 
13 /**************************************************************************/
14 /**************************************************************************/
15 /**                                                                       */
16 /** NetX Crypto Component                                                 */
17 /**                                                                       */
18 /**   NULL Cipher                                                         */
19 /**                                                                       */
20 /**************************************************************************/
21 /**************************************************************************/
22 
23 
24 /**************************************************************************/
25 /*                                                                        */
26 /*  APPLICATION INTERFACE DEFINITION                       RELEASE        */
27 /*                                                                        */
28 /*    nx_crypto_null.h                                    PORTABLE C      */
29 /*                                                           6.1          */
30 /*  AUTHOR                                                                */
31 /*                                                                        */
32 /*    Timothy Stapko, Microsoft Corporation                               */
33 /*                                                                        */
34 /*  DESCRIPTION                                                           */
35 /*                                                                        */
36 /*    This file defines the basic Application Interface (API) to the      */
37 /*    NetX Crypto NULL module.                                            */
38 /*                                                                        */
39 /*  RELEASE HISTORY                                                       */
40 /*                                                                        */
41 /*    DATE              NAME                      DESCRIPTION             */
42 /*                                                                        */
43 /*  05-19-2020     Timothy Stapko           Initial Version 6.0           */
44 /*  09-30-2020     Timothy Stapko           Modified comment(s),          */
45 /*                                            resulting in version 6.1    */
46 /*                                                                        */
47 /**************************************************************************/
48 
49 #ifndef NX_CRYPTO_NULL_H
50 #define NX_CRYPTO_NULL_H
51 
52 /* Determine if a C++ compiler is being used.  If so, ensure that standard
53    C is used to process the API information.  */
54 #ifdef __cplusplus
55 
56 /* Yes, C++ compiler is present.  Use standard C.  */
57 extern   "C" {
58 
59 #endif
60 
61 /* Include the ThreadX and port-specific data type file.  */
62 
63 #include "nx_crypto.h"
64 
65 /* Function prototypes */
66 
67 UINT _nx_crypto_method_null_operation(UINT op,      /* Encrypt, Decrypt, Authenticate */
68                                       VOID *handle, /* Crypto handler */
69                                       struct NX_CRYPTO_METHOD_STRUCT *method,
70                                       UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
71                                       UCHAR *input, ULONG input_length_in_byte,
72                                       UCHAR *iv_ptr,
73                                       UCHAR *output, ULONG output_length_in_byte,
74                                       VOID *crypto_metadata, ULONG crypto_metadata_size,
75                                       VOID *packet_ptr,
76                                       VOID (*nx_crypto_hw_process_callback)(VOID *packet_ptr, UINT status));
77 
78 UINT _nx_crypto_method_null_init(struct NX_CRYPTO_METHOD_STRUCT *method,
79                                  UCHAR *key, NX_CRYPTO_KEY_SIZE key_size_in_bits,
80                                  VOID **handle,
81                                  VOID *crypto_metadata, ULONG crypto_metadata_size);
82 
83 UINT _nx_crypto_method_null_cleanup(VOID *crypto_metadata);
84 
85 #ifdef __cplusplus
86 }
87 #endif
88 
89 #endif /* NX_CRYPTO_NULL_H */
90 
91