MCUX CLNS MCUX Crypto Library Normal Secure |

mcuxClSession_Functions.h
Go to the documentation of this file.
1 /*--------------------------------------------------------------------------*/
2 /* Copyright 2020-2021 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 MCUXCLSESSION_FUNCTIONS_H_
18 #define MCUXCLSESSION_FUNCTIONS_H_
19
20 #include <mcuxClSession_Types.h>
21 #include <mcuxCsslFlowProtection.h>
22
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26
27 /**********************************************
28 * FUNCTIONS
29 **********************************************/
49 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_init)
50 mcuxClSession_Status_Protected_t mcuxClSession_init(
51 mcuxClSession_Handle_t session,
52 uint32_t * const cpuWaBuffer,
53 uint32_t cpuWaSize,
54 uint32_t * const pkcWaBuffer,
55 uint32_t pkcWaSize
56 /* TBD: sclRandom_Context_t * const rngCtx */
57 );
58
67 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_setRtf)
68 mcuxClSession_Status_Protected_t mcuxClSession_setRtf(
69 mcuxClSession_Handle_t session,
70 mcuxClSession_Rtf_t RtfOptions
71 );
72
82 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_cleanup)
83 mcuxClSession_Status_Protected_t mcuxClSession_cleanup(
84 mcuxClSession_Handle_t session
85 );
86
97 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClSession_destroy)
98 mcuxClSession_Status_Protected_t mcuxClSession_destroy(
99 mcuxClSession_Handle_t session
100 );
101 /* mcuxClSession_Functions */
105
106
107 #ifdef __cplusplus
108 } /* extern "C" */
109 #endif
110
111 #endif /* MCUXCLSESSION_FUNCTIONS_H_ */
mcuxClSession_Handle_t
mcuxClSession_Descriptor_t *const mcuxClSession_Handle_t
Type for mcuxClSession Handle.
Definition: mcuxClSession_Types.h:110
mcuxClSession_Status_Protected_t
uint64_t mcuxClSession_Status_Protected_t
Type for mcuxClSession protected status codes.
Definition: mcuxClSession_Types.h:72
mcuxClSession_destroy
mcuxClSession_Status_Protected_t mcuxClSession_destroy(mcuxClSession_Handle_t session)
Destroy a Crypto Library session.
mcuxClSession_Types.h
Type definitions for the mcuxClSession component.
mcuxClSession_Rtf_t
uint32_t mcuxClSession_Rtf_t
Type for mcuxClSession RTF configuration flags.
Definition: mcuxClSession_Types.h:77
mcuxClSession_setRtf
mcuxClSession_Status_Protected_t mcuxClSession_setRtf(mcuxClSession_Handle_t session, mcuxClSession_Rtf_t RtfOptions)
Set the RTF option in a Crypto Library session.
mcuxClSession_init
mcuxClSession_Status_Protected_t mcuxClSession_init(mcuxClSession_Handle_t session, uint32_t *const cpuWaBuffer, uint32_t cpuWaSize, uint32_t *const pkcWaBuffer, uint32_t pkcWaSize)
Initialize a Crypto Library session.
mcuxCsslFlowProtection.h
Provides the API for the CSSL flow protection mechanism.
mcuxClSession_cleanup
mcuxClSession_Status_Protected_t mcuxClSession_cleanup(mcuxClSession_Handle_t session)
Clean up a Crypto Library session.
MCUX_CSSL_FP_FUNCTION_DECL
#define MCUX_CSSL_FP_FUNCTION_DECL(id)
Declaration of a flow protected function.
Definition: mcuxCsslFlowProtection.h:119