MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClKey_Types.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------*/
2 /* Copyright 2020-2023 NXP */
3 /* */
4 /* NXP Confidential. This software is owned or controlled by NXP and may */
5 /* only be used strictly in accordance with the applicable license terms. */
6 /* By expressly accepting such terms or by downloading, installing, */
7 /* activating and/or otherwise using the software, you are agreeing that */
8 /* you have read, and that you agree to comply with and are bound by, such */
9 /* license terms. If you do not agree to be bound by the applicable license */
10 /* terms, then you may not retain, install, activate or otherwise use the */
11 /* software. */
12 /*--------------------------------------------------------------------------*/
13 
19 #ifndef MCUXCLKEY_TYPES_H_
20 #define MCUXCLKEY_TYPES_H_
21 
22 #include <stdint.h>
23 #include <stdbool.h>
24 #include <mcuxClConfig.h> // Exported features flags header
25 #include <mcuxCsslAnalysis.h>
26 #include <mcuxCsslFlowProtection.h>
28 #include <mcuxClCore_Buffer.h>
29 
30 #ifdef __cplusplus
31 extern "C" {
32 #endif
33 
34 /**********************************************
35  * TYPEDEFS
36  **********************************************/
47 typedef uint32_t mcuxClKey_Status_t;
48 
52 typedef uint16_t mcuxClKey_AlgorithmId_t;
53 
57 typedef uint32_t mcuxClKey_Size_t;
58 
63 
64 /* Forward declaration */
65 struct mcuxClKey_Protection;
66 
73 struct mcuxClKey_Descriptor;
74 
81 typedef struct mcuxClKey_Descriptor mcuxClKey_Descriptor_t;
82 
89 
96 struct mcuxClKey_TypeDescriptor;
97 
104 typedef struct mcuxClKey_TypeDescriptor mcuxClKey_TypeDescriptor_t;
105 
112 
119 
126 struct mcuxClKey_ProtectionDescriptor;
127 
134 typedef struct mcuxClKey_ProtectionDescriptor mcuxClKey_ProtectionDescriptor_t;
135 
142 
143 
150 struct mcuxClKey_GenerationDescriptor;
151 
158 typedef struct mcuxClKey_GenerationDescriptor mcuxClKey_GenerationDescriptor_t;
159 
166 
167 
168 
169  /* mcuxClKey_Types */
173 
174 #ifdef __cplusplus
175 } /* extern "C" */
176 #endif
177 
178 #endif /* MCUXCLKEY_TYPES_H_ */
mcuxClKey_Status_t mcuxClKey_Status_Protected_t
Deprecated type for Key component error codes, returned by functions with code-flow protection.
Definition: mcuxClKey_Types.h:62
struct mcuxClKey_TypeDescriptor mcuxClKey_TypeDescriptor_t
Key type descriptor type.
Definition: mcuxClKey_Types.h:104
const mcuxClKey_TypeDescriptor_t * mcuxClKey_Type_t
Key type handle type.
Definition: mcuxClKey_Types.h:111
uint16_t mcuxClKey_AlgorithmId_t
Type for algorithm based key id.
Definition: mcuxClKey_Types.h:52
struct mcuxClKey_GenerationDescriptor mcuxClKey_GenerationDescriptor_t
Key generation descriptor type.
Definition: mcuxClKey_Types.h:158
mcuxClKey_Descriptor_t *const mcuxClKey_Handle_t
Key handle type.
Definition: mcuxClKey_Types.h:88
struct mcuxClKey_Descriptor mcuxClKey_Descriptor_t
Key descriptor type.
Definition: mcuxClKey_Types.h:81
mcuxClKey_TypeDescriptor_t * mcuxClKey_CustomType_t
Custom key type handle type.
Definition: mcuxClKey_Types.h:118
Provides the API for the CSSL flow protection mechanism.
uint32_t mcuxClKey_Status_t
Type for Key component error codes.
Definition: mcuxClKey_Types.h:47
const mcuxClKey_GenerationDescriptor_t *const mcuxClKey_Generation_t
Key generation type.
Definition: mcuxClKey_Types.h:165
uint32_t mcuxClKey_Size_t
Type for algorithm based key size.
Definition: mcuxClKey_Types.h:57
const mcuxClKey_ProtectionDescriptor_t * mcuxClKey_Protection_t
Key protection mechanism type.
Definition: mcuxClKey_Types.h:141
Definition of function identifiers for the flow protection mechanism.
#define MCUX_CSSL_FP_PROTECTED_TYPE(resultType)
Based on a given base type, builds a return type with flow protection.
Definition: mcuxCsslFlowProtection.h:81
struct mcuxClKey_ProtectionDescriptor mcuxClKey_ProtectionDescriptor_t
Key protection mechanism descriptor type.
Definition: mcuxClKey_Types.h:134