MCUX CLNS
MCUX Crypto Library Normal Secure
mcuxClSession_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 
19 #ifndef MCUXCLSESSION_FUNCTIONS_H_
20 #define MCUXCLSESSION_FUNCTIONS_H_
21 
22 #include <mcuxClCore_Platform.h>
24 #include <mcuxCsslFlowProtection.h>
25 #include <mcuxClSession_Types.h>
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 /**********************************************
32  * FUNCTIONS
33  **********************************************/
58 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_init)
60  mcuxClSession_Handle_t pSession,
61  uint32_t * const pCpuWaBuffer,
62  uint32_t cpuWaLength,
63  uint32_t * const pPkcWaBuffer,
64  uint32_t pkcWaLength
65  /* TBD: sclRandom_Context_t * const rngCtx */
66 );
67 
77 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_setRtf)
79  mcuxClSession_Handle_t pSession,
80  uint8_t * const pRtf,
81  mcuxClSession_Rtf_t RtfOptions
82 );
83 
84 
94 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_cleanup)
96  mcuxClSession_Handle_t pSession
97 );
98 
109 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_destroy)
111  mcuxClSession_Handle_t pSession
112 );
113  /* mcuxClSession_Functions */
117 
118 
119 #ifdef __cplusplus
120 } /* extern "C" */
121 #endif
122 
123 #endif /* MCUXCLSESSION_FUNCTIONS_H_ */
mcuxClSession_Descriptor_t *const mcuxClSession_Handle_t
Type for mcuxClSession Handle.
Definition: mcuxClSession_Types.h:124
#define MCUX_CSSL_FP_FUNCTION_DECL(...)
Declaration of a flow protected function.
Definition: mcuxCsslFlowProtection.h:125
Type definitions for the mcuxClSession component.
uint32_t mcuxClSession_Rtf_t
Type for mcuxClSession RTF configuration flags.
Definition: mcuxClSession_Types.h:85
Definition of function identifiers for the flow protection mechanism.
uint32_t mcuxClSession_Status_t
Type for mcuxClSession status codes.
Definition: mcuxClSession_Types.h:75
Provides the API for the CSSL flow protection mechanism.
MCUX_CSSL_FP_PROTECTED_TYPE(mcuxClSession_Status_t) mcuxClSession_init(mcuxClSession_Handle_t pSession
Initialize a Crypto Library session.
Definition: mcuxCsslFlowProtection_example.c:137