MCUX CLNS MCUX Crypto Library Normal Secure |

mcuxClKey_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
20 #ifndef MCUXCLKEY_FUNCTIONS_H_
21 #define MCUXCLKEY_FUNCTIONS_H_
22
23 #include <mcuxClSession.h>
24 #include <mcuxClKey_Types.h>
25 #include <mcuxCsslFlowProtection.h>
26
27 /**********************************************
28 * FUNCTIONS
29 **********************************************/
57 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClKey_init)
58 mcuxClKey_Status_Protected_t mcuxClKey_init(
59 mcuxClSession_Handle_t session,
60 mcuxClKey_Handle_t key,
61 const mcuxClKey_Type_t * type,
62 const mcuxClKey_Protection_t * protection,
63 const uint8_t * const srcKeyData,
64 const uint8_t * const srcAuxData,
65 uint32_t srcAuxSlot
66 );
67
84 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClKey_loadCopro)
85 mcuxClKey_Status_Protected_t mcuxClKey_loadCopro(
86 mcuxClSession_Handle_t session,
87 mcuxClKey_Handle_t key,
88 uint32_t dstSlot
89 );
90
107 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClKey_loadMemory)
108 mcuxClKey_Status_Protected_t mcuxClKey_loadMemory(
109 mcuxClSession_Handle_t session,
110 mcuxClKey_Handle_t key,
111 uint32_t * dstData
112 );
113
129 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClKey_flush)
130 mcuxClKey_Status_Protected_t mcuxClKey_flush(
131 mcuxClSession_Handle_t session,
132 mcuxClKey_Handle_t key
133 );
134
150 MCUX_CSSL_FP_FUNCTION_DECL(mcuxClKey_setKeyproperties)
151 mcuxClKey_Status_Protected_t mcuxClKey_setKeyproperties(
152 mcuxClKey_Handle_t key,
153 mcuxClCss_KeyProp_t key_properties
154 );
155 /* mcuxClKey_Functions */
159
160 #endif /* MCUXCLKEY_FUNCTIONS_H_ */
mcuxClKey_loadMemory
mcuxClKey_Status_Protected_t mcuxClKey_loadMemory(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, uint32_t *dstData)
Load key into destination memory buffer.
mcuxClCss_KeyProp_t
Type for CSS key store key properties.
Definition: mcuxClCss_Types.h:196
mcuxClSession_Handle_t
mcuxClSession_Descriptor_t *const mcuxClSession_Handle_t
Type for mcuxClSession Handle.
Definition: mcuxClSession_Types.h:110
mcuxClKey_setKeyproperties
mcuxClKey_Status_Protected_t mcuxClKey_setKeyproperties(mcuxClKey_Handle_t key, mcuxClCss_KeyProp_t key_properties)
Set the requested key properties of the destination key.
mcuxClKey_Descriptor
Type of the key handle.
Definition: mcuxClKey_Types.h:104
mcuxClKey_Status_Protected_t
uint64_t mcuxClKey_Status_Protected_t
Type for Key component error codes, returned by functions with code-flow protection.
Definition: mcuxClKey_Types.h:68
mcuxClKey_Type
Type to map algorithm id and size.
Definition: mcuxClKey_KeyTypes.h:53
mcuxClKey_flush
mcuxClKey_Status_Protected_t mcuxClKey_flush(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key)
Flush key from destination which can be a key slot of coprocessor or memory buffer.
mcuxClKey_init
mcuxClKey_Status_Protected_t mcuxClKey_init(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, const mcuxClKey_Type_t *type, const mcuxClKey_Protection_t *protection, const uint8_t *const srcKeyData, const uint8_t *const srcAuxData, uint32_t srcAuxSlot)
Initializes a key handle.
mcuxClKey_Protection
Type to map load and flush functions.
Definition: mcuxClKey_Types.h:138
mcuxClSession.h
Top-level include file for the mcuxClSession component.
mcuxCsslFlowProtection.h
Provides the API for the CSSL flow protection mechanism.
mcuxClKey_loadCopro
mcuxClKey_Status_Protected_t mcuxClKey_loadCopro(mcuxClSession_Handle_t session, mcuxClKey_Handle_t key, uint32_t dstSlot)
Load key into destination key slot of a coprocessor.
mcuxClKey_Types.h
Type definitions for the mcuxClKey component.
MCUX_CSSL_FP_FUNCTION_DECL
#define MCUX_CSSL_FP_FUNCTION_DECL(id)
Declaration of a flow protected function.
Definition: mcuxCsslFlowProtection.h:119