MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClCipher_Functions.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 
17 #ifndef MCUXCLCIPHER_FUNCTIONS_H_
18 #define MCUXCLCIPHER_FUNCTIONS_H_
19 
20 #include <mcuxClConfig.h> // Exported features flags header
21 #include <mcuxClSession_Types.h>
22 #include <mcuxClKey_Types.h>
23 #include <mcuxClCipher_Types.h>
24 #include <mcuxClCore_Platform.h>
25 #include <mcuxClCore_Buffer.h>
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 
81  mcuxClSession_Handle_t session,
85  uint32_t ivLength,
87  uint32_t inLength,
88  mcuxCl_Buffer_t pOut,
89  uint32_t * const pOutLength
90 );
91 
92 
93 
121  mcuxClSession_Handle_t session,
122  mcuxClCipher_Context_t * const pContext,
123  mcuxClKey_Handle_t key,
124  mcuxClCipher_Mode_t mode,
126  uint32_t ivLength
127 ); /* init */
128 
153  mcuxClSession_Handle_t session,
154  mcuxClCipher_Context_t * const pContext,
156  uint32_t inLength,
157  mcuxCl_Buffer_t pOut,
158  uint32_t * const pOutLength
159 ); /* update */
160 
181  mcuxClSession_Handle_t session,
182  mcuxClCipher_Context_t * const pContext,
183  mcuxCl_Buffer_t pOut,
184  uint32_t * const pOutLength
185 ); /* finalize */
186 
187 
188 
189 
190 
191 #ifdef __cplusplus
192 } /* extern "C" */
193 #endif
194 
195 #endif /* MCUXCLCIPHER_FUNCTIONS_H_ */
Type definitions for the mcuxClCipher component.
mcuxClCipher_Status_t mcuxClCipher_finish(mcuxClSession_Handle_t session, mcuxClCipher_Context_t *const pContext, mcuxCl_Buffer_t pOut, uint32_t *const pOutLength)
Multi-part encryption/decryption finalization function.
struct mcuxClCipher_Context mcuxClCipher_Context_t
Cipher context type.
Definition: mcuxClCipher_Types.h:100
mcuxClKey_Descriptor_t *const mcuxClKey_Handle_t
Key handle type.
Definition: mcuxClKey_Types.h:88
uint32_t mcuxClCipher_Status_t
Cipher status code.
Definition: mcuxClCipher_Types.h:108
mcuxClCipher_Status_t mcuxClCipher_init(mcuxClSession_Handle_t session, mcuxClCipher_Context_t *const pContext, mcuxClKey_Handle_t key, mcuxClCipher_Mode_t mode, mcuxCl_InputBuffer_t pIv, uint32_t ivLength)
Multi-part encryption/decryption initialization function.
mcuxClCipher_Status_t mcuxClCipher_process(mcuxClSession_Handle_t session, mcuxClCipher_Context_t *const pContext, mcuxCl_InputBuffer_t pIn, uint32_t inLength, mcuxCl_Buffer_t pOut, uint32_t *const pOutLength)
Multi-part encryption/decryption processing function.
const mcuxClCipher_ModeDescriptor_t *const mcuxClCipher_Mode_t
Cipher mode/algorithm type.
Definition: mcuxClCipher_Types.h:61
Type definitions for the mcuxClSession component.
#define MCUX_CSSL_FP_FUNCTION_DECL(...)
Declaration of a flow protected function.
Definition: mcuxCsslFlowProtection.h:125
mcuxClSession_Descriptor_t *const mcuxClSession_Handle_t
Type for mcuxClSession Handle.
Definition: mcuxClSession_Types.h:133
mcuxClCipher_Status_t mcuxClCipher_crypt(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, mcuxClCipher_Mode_t mode, mcuxCl_InputBuffer_t pIv, uint32_t ivLength, mcuxCl_InputBuffer_t pIn, uint32_t inLength, mcuxCl_Buffer_t pOut, uint32_t *const pOutLength)
One-shot encryption/decryption function.
#define MCUX_CSSL_FP_PROTECTED_TYPE(resultType)
Based on a given base type, builds a return type with flow protection.
Definition: mcuxCsslFlowProtection.h:81
Type definitions for the mcuxClKey component.
uint8_t *const mcuxCl_Buffer_t
Generic buffer typeThis type provides a pointer to the memory location that can be used for both read...
Definition: mcuxClCore_Buffer.h:51
const uint8_t *const mcuxCl_InputBuffer_t
Input buffer typeThis type provides a pointer to the memory location that should be used to read inpu...
Definition: mcuxClCore_Buffer.h:42