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 /**   CTR Mode                                                            */
19 /**                                                                       */
20 /**************************************************************************/
21 /**************************************************************************/
22 
23 
24 /**************************************************************************/
25 /*                                                                        */
26 /*  APPLICATION INTERFACE DEFINITION                       RELEASE        */
27 /*                                                                        */
28 /*    nx_crypto_ctr.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 CTR 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_CTR_H
50 #define NX_CRYPTO_CTR_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 #define NX_CRYPTO_CTR_BLOCK_SIZE 16
66 
67 typedef struct NX_CRYPTO_CTR_STRUCT
68 {
69 
70     /* Counter block. */
71     UCHAR nx_crypto_ctr_counter_block[NX_CRYPTO_CTR_BLOCK_SIZE];
72 } NX_CRYPTO_CTR;
73 
74 /* The CTR mode is symmetric - encryption and decryption are the same operation. */
75 NX_CRYPTO_KEEP UINT _nx_crypto_ctr_encrypt(VOID *crypto_metadata, NX_CRYPTO_CTR *ctr_metadata,
76                                            UINT (*crypto_function)(VOID *, UCHAR *, UCHAR *, UINT),
77                                            UCHAR *input, UCHAR *output, UINT length, UINT block_size);
78 NX_CRYPTO_KEEP UINT _nx_crypto_ctr_encrypt_init(NX_CRYPTO_CTR *ctr_metadata, UCHAR *iv, UINT iv_len,
79                                                 UCHAR *nonce, UINT nonce_len);
80 #define _nx_crypto_ctr_decrypt   _nx_crypto_ctr_encrypt
81 
82 
83 #ifdef __cplusplus
84 }
85 #endif
86 
87 
88 #endif /* NX_CRYPTO_CTR_H */
89 
90