MCUX CLNS
MCUX Crypto Library Normal Secure
 
Loading...
Searching...
No Matches

Constants for initalizing mcuxClEls_KeyProp_t.bits. More...

Macros

#define MCUXCLELS_KEYPROPERTY_KEY_SIZE_128
 This value of mcuxClEls_KeyProp_t.ksize indicates a 128 bit key.
 
#define MCUXCLELS_KEYPROPERTY_KEY_SIZE_256
 This value of mcuxClEls_KeyProp_t.ksize indicates a 256 bit key.
 
#define MCUXCLELS_KEYPROPERTY_ACTIVE_TRUE
 This value of mcuxClEls_KeyProp_t.kactv indicates that the slot contains an active key.
 
#define MCUXCLELS_KEYPROPERTY_ACTIVE_FALSE
 This value of mcuxClEls_KeyProp_t.kactv indicates that the slot does not contain active key.
 
#define MCUXCLELS_KEYPROPERTY_BASE_SLOT
 This value of mcuxClEls_KeyProp_t.kbase indicates that the slot is the base slot of a 2-slot key.
 
#define MCUXCLELS_KEYPROPERTY_SECOND_SLOT
 This value of mcuxClEls_KeyProp_t.kbase indicates that the slot is the second slot of a 2-slot key.
 
#define MCUXCLELS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_TRUE
 This value of mcuxClEls_KeyProp_t.fgp indicates that the slot is a retention key slot or a hardware out key slot.
 
#define MCUXCLELS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_FALSE
 This value of mcuxClEls_KeyProp_t.fgp indicates that the slot is a neither retention key slot nor hardware out key slot.
 
#define MCUXCLELS_KEYPROPERTY_RETENTION_SLOT_TRUE
 This value of mcuxClEls_KeyProp_t.frtn indicates that the slot is a retention key slot.
 
#define MCUXCLELS_KEYPROPERTY_RETENTION_SLOT_FALSE
 This value of mcuxClEls_KeyProp_t.frtn indicates that the slot is not a retention key slot.
 
#define MCUXCLELS_KEYPROPERTY_HW_OUT_SLOT_TRUE
 This value of mcuxClEls_KeyProp_t.fhwo indicates that the slot is a hardware out key slot.
 
#define MCUXCLELS_KEYPROPERTY_HW_OUT_SLOT_FALSE
 This value of mcuxClEls_KeyProp_t.fhwo indicates that the slot is not a hardware out key slot.
 
#define MCUXCLELS_KEYPROPERTY_CMAC_TRUE
 This value of mcuxClEls_KeyProp_t.ucmac indicates that the key can be used for CMAC.
 
#define MCUXCLELS_KEYPROPERTY_CMAC_FALSE
 This value of mcuxClEls_KeyProp_t.ucmac indicates that the key cannot be used for CMAC.
 
#define MCUXCLELS_KEYPROPERTY_KSK_TRUE
 This value of mcuxClEls_KeyProp_t.uksk indicates that the key can be used for key signing.
 
#define MCUXCLELS_KEYPROPERTY_KSK_FALSE
 This value of mcuxClEls_KeyProp_t.uksk indicates that the key cannot be used for key signing.
 
#define MCUXCLELS_KEYPROPERTY_RTF_TRUE
 This value of mcuxClEls_KeyProp_t.urtf indicates that the key can be used for RTF signing.
 
#define MCUXCLELS_KEYPROPERTY_RTF_FALSE
 This value of mcuxClEls_KeyProp_t.urtf indicates that the key cannot be used for RTF signing.
 
#define MCUXCLELS_KEYPROPERTY_CKDF_TRUE
 This value of mcuxClEls_KeyProp_t.uckdf indicates that the key can be used for CKDF.
 
#define MCUXCLELS_KEYPROPERTY_CKDF_FALSE
 This value of mcuxClEls_KeyProp_t.uckdf indicates that the key cannot be used for CKDF.
 
#define MCUXCLELS_KEYPROPERTY_HKDF_TRUE
 This value of mcuxClEls_KeyProp_t.uhkdf indicates that the key can be used for HKDF.
 
#define MCUXCLELS_KEYPROPERTY_HKDF_FALSE
 This value of mcuxClEls_KeyProp_t.uhkdf indicates that the key cannot be used for HKDF.
 
#define MCUXCLELS_KEYPROPERTY_ECC_TRUE
 This value of mcuxClEls_KeyProp_t.uecsg indicates that the key can be used for ECC signing.
 
#define MCUXCLELS_KEYPROPERTY_ECC_FALSE
 This value of mcuxClEls_KeyProp_t.uecsg indicates that the key cannot be used for ECC signing.
 
#define MCUXCLELS_KEYPROPERTY_ECC_DH_PRIVATE_TRUE
 This value of mcuxClEls_KeyProp_t.uecdh indicates that the key is a ECC Diffie Hellman private key.
 
#define MCUXCLELS_KEYPROPERTY_ECC_DH_PRIVATE_FALSE
 This value of mcuxClEls_KeyProp_t.uecdh indicates that the key is not an ECC Diffie Hellman private key.
 
#define MCUXCLELS_KEYPROPERTY_AES_TRUE
 This value of mcuxClEls_KeyProp_t.uaes indicates that the key is an AES key.
 
#define MCUXCLELS_KEYPROPERTY_AES_FALSE
 This value of mcuxClEls_KeyProp_t.uaes indicates that the key is not an AES key.
 
#define MCUXCLELS_KEYPROPERTY_HMAC_TRUE
 This value of mcuxClEls_KeyProp_t.uhmac indicates that the key is an HMAC key.
 
#define MCUXCLELS_KEYPROPERTY_HMAC_FALSE
 This value of mcuxClEls_KeyProp_t.uhmac indicates that the key is not an HMAC key.
 
#define MCUXCLELS_KEYPROPERTY_KWK_TRUE
 This value of mcuxClEls_KeyProp_t.ukwk indicates that the key is a Key Wrapping Key.
 
#define MCUXCLELS_KEYPROPERTY_KWK_FALSE
 This value of mcuxClEls_KeyProp_t.ukwk indicates that the key is not a Key Wrapping Key.
 
#define MCUXCLELS_KEYPROPERTY_KUOK_TRUE
 This value of mcuxClEls_KeyProp_t.ukuok indicates that the key is a Key Unwrapping Only Key.
 
#define MCUXCLELS_KEYPROPERTY_KUOK_FALSE
 This value of mcuxClEls_KeyProp_t.ukuok indicates that the key is not a Key Unwrapping Only Key.
 
#define MCUXCLELS_KEYPROPERTY_TLS_PREMASTER_SECRET_TRUE
 This value of mcuxClEls_KeyProp_t.utlspms indicates that the key is a TLS Premaster Secret.
 
#define MCUXCLELS_KEYPROPERTY_TLS_PREMASTER_SECRET_FALSE
 This value of mcuxClEls_KeyProp_t.utlspms indicates that the key is not a TLS Premaster Secret.
 
#define MCUXCLELS_KEYPROPERTY_TLS_MASTER_SECRET_TRUE
 This value of mcuxClEls_KeyProp_t.utlsms indicates that the key is a TLS Master Secret.
 
#define MCUXCLELS_KEYPROPERTY_TLS_MASTER_SECRET_FALSE
 This value of mcuxClEls_KeyProp_t.utlsms indicates that the key is not a TLS Master Secret.
 
#define MCUXCLELS_KEYPROPERTY_INPUT_FOR_ECC_TRUE
 This value of mcuxClEls_KeyProp_t.ukgsrc indicates that the key can be used as key material input for ECC key generation.
 
#define MCUXCLELS_KEYPROPERTY_INPUT_FOR_ECC_FALSE
 This value of mcuxClEls_KeyProp_t.ukgsrc indicates that the key cannot be used as key material input for ECC key generation.
 
#define MCUXCLELS_KEYPROPERTY_HW_OUT_TRUE
 This value of mcuxClEls_KeyProp_t.uhwo indicates that the key can be used in a hardware out key slot.
 
#define MCUXCLELS_KEYPROPERTY_HW_OUT_FALSE
 This value of mcuxClEls_KeyProp_t.uhwo indicates that the key cannot be used in a hardware out key slot.
 
#define MCUXCLELS_KEYPROPERTY_WRAP_TRUE
 This value of mcuxClEls_KeyProp_t.wrpok indicates that the key can be wrapped.
 
#define MCUXCLELS_KEYPROPERTY_WRAP_FALSE
 This value of mcuxClEls_KeyProp_t.wrpok indicates that the key cannot be wrapped.
 
#define MCUXCLELS_KEYPROPERTY_DEVICE_UNIQUE_TRUE
 This value of mcuxClEls_KeyProp_t.duk indicates that the key is a Device Unique Key.
 
#define MCUXCLELS_KEYPROPERTY_DEVICE_UNIQUE_FALSE
 This value of mcuxClEls_KeyProp_t.duk indicates that the key is not a Device Unique Key.
 
#define MCUXCLELS_KEYPROPERTY_PRIVILEGED_TRUE
 This value of mcuxClEls_KeyProp_t.upprot_priv indicates that the caller must be in privileged mode to use the key.
 
#define MCUXCLELS_KEYPROPERTY_PRIVILEGED_FALSE
 This value of mcuxClEls_KeyProp_t.upprot_priv indicates that the caller does not need to be in privileged mode to use the key.
 
#define MCUXCLELS_KEYPROPERTY_SECURE_TRUE
 This value of mcuxClEls_KeyProp_t.upprot_sec indicates that the caller must be in secure mode to use the key.
 
#define MCUXCLELS_KEYPROPERTY_SECURE_FALSE
 This value of mcuxClEls_KeyProp_t.upprot_sec indicates that the caller does not need to be in secure mode to use the key.
 

Detailed Description

Constants for initalizing mcuxClEls_KeyProp_t.bits.

Macro Definition Documentation

◆ MCUXCLELS_KEYPROPERTY_KEY_SIZE_128

#define MCUXCLELS_KEYPROPERTY_KEY_SIZE_128

◆ MCUXCLELS_KEYPROPERTY_KEY_SIZE_256

#define MCUXCLELS_KEYPROPERTY_KEY_SIZE_256

This value of mcuxClEls_KeyProp_t.ksize indicates a 256 bit key.

◆ MCUXCLELS_KEYPROPERTY_ACTIVE_TRUE

#define MCUXCLELS_KEYPROPERTY_ACTIVE_TRUE

This value of mcuxClEls_KeyProp_t.kactv indicates that the slot contains an active key.

Examples
mcuxClKey_example.c, and mcuxClMacModes_Els_Cmac_Aes128_Oneshot_Example.c.

◆ MCUXCLELS_KEYPROPERTY_ACTIVE_FALSE

#define MCUXCLELS_KEYPROPERTY_ACTIVE_FALSE

This value of mcuxClEls_KeyProp_t.kactv indicates that the slot does not contain active key.

◆ MCUXCLELS_KEYPROPERTY_BASE_SLOT

#define MCUXCLELS_KEYPROPERTY_BASE_SLOT

This value of mcuxClEls_KeyProp_t.kbase indicates that the slot is the base slot of a 2-slot key.

◆ MCUXCLELS_KEYPROPERTY_SECOND_SLOT

#define MCUXCLELS_KEYPROPERTY_SECOND_SLOT

This value of mcuxClEls_KeyProp_t.kbase indicates that the slot is the second slot of a 2-slot key.

◆ MCUXCLELS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_TRUE

#define MCUXCLELS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_TRUE

This value of mcuxClEls_KeyProp_t.fgp indicates that the slot is a retention key slot or a hardware out key slot.

◆ MCUXCLELS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_FALSE

#define MCUXCLELS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_FALSE

This value of mcuxClEls_KeyProp_t.fgp indicates that the slot is a neither retention key slot nor hardware out key slot.

◆ MCUXCLELS_KEYPROPERTY_RETENTION_SLOT_TRUE

#define MCUXCLELS_KEYPROPERTY_RETENTION_SLOT_TRUE

This value of mcuxClEls_KeyProp_t.frtn indicates that the slot is a retention key slot.

◆ MCUXCLELS_KEYPROPERTY_RETENTION_SLOT_FALSE

#define MCUXCLELS_KEYPROPERTY_RETENTION_SLOT_FALSE

This value of mcuxClEls_KeyProp_t.frtn indicates that the slot is not a retention key slot.

◆ MCUXCLELS_KEYPROPERTY_HW_OUT_SLOT_TRUE

#define MCUXCLELS_KEYPROPERTY_HW_OUT_SLOT_TRUE

This value of mcuxClEls_KeyProp_t.fhwo indicates that the slot is a hardware out key slot.

◆ MCUXCLELS_KEYPROPERTY_HW_OUT_SLOT_FALSE

#define MCUXCLELS_KEYPROPERTY_HW_OUT_SLOT_FALSE

This value of mcuxClEls_KeyProp_t.fhwo indicates that the slot is not a hardware out key slot.

◆ MCUXCLELS_KEYPROPERTY_CMAC_TRUE

#define MCUXCLELS_KEYPROPERTY_CMAC_TRUE

This value of mcuxClEls_KeyProp_t.ucmac indicates that the key can be used for CMAC.

Examples
mcuxClMacModes_Els_Cmac_Aes128_Oneshot_Example.c.

◆ MCUXCLELS_KEYPROPERTY_CMAC_FALSE

#define MCUXCLELS_KEYPROPERTY_CMAC_FALSE

This value of mcuxClEls_KeyProp_t.ucmac indicates that the key cannot be used for CMAC.

◆ MCUXCLELS_KEYPROPERTY_KSK_TRUE

#define MCUXCLELS_KEYPROPERTY_KSK_TRUE

This value of mcuxClEls_KeyProp_t.uksk indicates that the key can be used for key signing.

◆ MCUXCLELS_KEYPROPERTY_KSK_FALSE

#define MCUXCLELS_KEYPROPERTY_KSK_FALSE

This value of mcuxClEls_KeyProp_t.uksk indicates that the key cannot be used for key signing.

◆ MCUXCLELS_KEYPROPERTY_RTF_TRUE

#define MCUXCLELS_KEYPROPERTY_RTF_TRUE

This value of mcuxClEls_KeyProp_t.urtf indicates that the key can be used for RTF signing.

◆ MCUXCLELS_KEYPROPERTY_RTF_FALSE

#define MCUXCLELS_KEYPROPERTY_RTF_FALSE

This value of mcuxClEls_KeyProp_t.urtf indicates that the key cannot be used for RTF signing.

◆ MCUXCLELS_KEYPROPERTY_CKDF_TRUE

#define MCUXCLELS_KEYPROPERTY_CKDF_TRUE

This value of mcuxClEls_KeyProp_t.uckdf indicates that the key can be used for CKDF.

◆ MCUXCLELS_KEYPROPERTY_CKDF_FALSE

#define MCUXCLELS_KEYPROPERTY_CKDF_FALSE

This value of mcuxClEls_KeyProp_t.uckdf indicates that the key cannot be used for CKDF.

◆ MCUXCLELS_KEYPROPERTY_HKDF_TRUE

#define MCUXCLELS_KEYPROPERTY_HKDF_TRUE

This value of mcuxClEls_KeyProp_t.uhkdf indicates that the key can be used for HKDF.

◆ MCUXCLELS_KEYPROPERTY_HKDF_FALSE

#define MCUXCLELS_KEYPROPERTY_HKDF_FALSE

This value of mcuxClEls_KeyProp_t.uhkdf indicates that the key cannot be used for HKDF.

◆ MCUXCLELS_KEYPROPERTY_ECC_TRUE

#define MCUXCLELS_KEYPROPERTY_ECC_TRUE

This value of mcuxClEls_KeyProp_t.uecsg indicates that the key can be used for ECC signing.

◆ MCUXCLELS_KEYPROPERTY_ECC_FALSE

#define MCUXCLELS_KEYPROPERTY_ECC_FALSE

This value of mcuxClEls_KeyProp_t.uecsg indicates that the key cannot be used for ECC signing.

◆ MCUXCLELS_KEYPROPERTY_ECC_DH_PRIVATE_TRUE

#define MCUXCLELS_KEYPROPERTY_ECC_DH_PRIVATE_TRUE

This value of mcuxClEls_KeyProp_t.uecdh indicates that the key is a ECC Diffie Hellman private key.

◆ MCUXCLELS_KEYPROPERTY_ECC_DH_PRIVATE_FALSE

#define MCUXCLELS_KEYPROPERTY_ECC_DH_PRIVATE_FALSE

This value of mcuxClEls_KeyProp_t.uecdh indicates that the key is not an ECC Diffie Hellman private key.

◆ MCUXCLELS_KEYPROPERTY_AES_TRUE

#define MCUXCLELS_KEYPROPERTY_AES_TRUE

This value of mcuxClEls_KeyProp_t.uaes indicates that the key is an AES key.

◆ MCUXCLELS_KEYPROPERTY_AES_FALSE

#define MCUXCLELS_KEYPROPERTY_AES_FALSE

This value of mcuxClEls_KeyProp_t.uaes indicates that the key is not an AES key.

◆ MCUXCLELS_KEYPROPERTY_HMAC_TRUE

#define MCUXCLELS_KEYPROPERTY_HMAC_TRUE

This value of mcuxClEls_KeyProp_t.uhmac indicates that the key is an HMAC key.

◆ MCUXCLELS_KEYPROPERTY_HMAC_FALSE

#define MCUXCLELS_KEYPROPERTY_HMAC_FALSE

This value of mcuxClEls_KeyProp_t.uhmac indicates that the key is not an HMAC key.

◆ MCUXCLELS_KEYPROPERTY_KWK_TRUE

#define MCUXCLELS_KEYPROPERTY_KWK_TRUE

This value of mcuxClEls_KeyProp_t.ukwk indicates that the key is a Key Wrapping Key.

◆ MCUXCLELS_KEYPROPERTY_KWK_FALSE

#define MCUXCLELS_KEYPROPERTY_KWK_FALSE

This value of mcuxClEls_KeyProp_t.ukwk indicates that the key is not a Key Wrapping Key.

◆ MCUXCLELS_KEYPROPERTY_KUOK_TRUE

#define MCUXCLELS_KEYPROPERTY_KUOK_TRUE

This value of mcuxClEls_KeyProp_t.ukuok indicates that the key is a Key Unwrapping Only Key.

◆ MCUXCLELS_KEYPROPERTY_KUOK_FALSE

#define MCUXCLELS_KEYPROPERTY_KUOK_FALSE

This value of mcuxClEls_KeyProp_t.ukuok indicates that the key is not a Key Unwrapping Only Key.

◆ MCUXCLELS_KEYPROPERTY_TLS_PREMASTER_SECRET_TRUE

#define MCUXCLELS_KEYPROPERTY_TLS_PREMASTER_SECRET_TRUE

This value of mcuxClEls_KeyProp_t.utlspms indicates that the key is a TLS Premaster Secret.

Examples
mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ MCUXCLELS_KEYPROPERTY_TLS_PREMASTER_SECRET_FALSE

#define MCUXCLELS_KEYPROPERTY_TLS_PREMASTER_SECRET_FALSE

This value of mcuxClEls_KeyProp_t.utlspms indicates that the key is not a TLS Premaster Secret.

◆ MCUXCLELS_KEYPROPERTY_TLS_MASTER_SECRET_TRUE

#define MCUXCLELS_KEYPROPERTY_TLS_MASTER_SECRET_TRUE

This value of mcuxClEls_KeyProp_t.utlsms indicates that the key is a TLS Master Secret.

Examples
mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ MCUXCLELS_KEYPROPERTY_TLS_MASTER_SECRET_FALSE

#define MCUXCLELS_KEYPROPERTY_TLS_MASTER_SECRET_FALSE

This value of mcuxClEls_KeyProp_t.utlsms indicates that the key is not a TLS Master Secret.

◆ MCUXCLELS_KEYPROPERTY_INPUT_FOR_ECC_TRUE

#define MCUXCLELS_KEYPROPERTY_INPUT_FOR_ECC_TRUE

This value of mcuxClEls_KeyProp_t.ukgsrc indicates that the key can be used as key material input for ECC key generation.

◆ MCUXCLELS_KEYPROPERTY_INPUT_FOR_ECC_FALSE

#define MCUXCLELS_KEYPROPERTY_INPUT_FOR_ECC_FALSE

This value of mcuxClEls_KeyProp_t.ukgsrc indicates that the key cannot be used as key material input for ECC key generation.

◆ MCUXCLELS_KEYPROPERTY_HW_OUT_TRUE

#define MCUXCLELS_KEYPROPERTY_HW_OUT_TRUE

This value of mcuxClEls_KeyProp_t.uhwo indicates that the key can be used in a hardware out key slot.

◆ MCUXCLELS_KEYPROPERTY_HW_OUT_FALSE

#define MCUXCLELS_KEYPROPERTY_HW_OUT_FALSE

This value of mcuxClEls_KeyProp_t.uhwo indicates that the key cannot be used in a hardware out key slot.

◆ MCUXCLELS_KEYPROPERTY_WRAP_TRUE

#define MCUXCLELS_KEYPROPERTY_WRAP_TRUE

This value of mcuxClEls_KeyProp_t.wrpok indicates that the key can be wrapped.

◆ MCUXCLELS_KEYPROPERTY_WRAP_FALSE

#define MCUXCLELS_KEYPROPERTY_WRAP_FALSE

This value of mcuxClEls_KeyProp_t.wrpok indicates that the key cannot be wrapped.

◆ MCUXCLELS_KEYPROPERTY_DEVICE_UNIQUE_TRUE

#define MCUXCLELS_KEYPROPERTY_DEVICE_UNIQUE_TRUE

This value of mcuxClEls_KeyProp_t.duk indicates that the key is a Device Unique Key.

◆ MCUXCLELS_KEYPROPERTY_DEVICE_UNIQUE_FALSE

#define MCUXCLELS_KEYPROPERTY_DEVICE_UNIQUE_FALSE

This value of mcuxClEls_KeyProp_t.duk indicates that the key is not a Device Unique Key.

◆ MCUXCLELS_KEYPROPERTY_PRIVILEGED_TRUE

#define MCUXCLELS_KEYPROPERTY_PRIVILEGED_TRUE

This value of mcuxClEls_KeyProp_t.upprot_priv indicates that the caller must be in privileged mode to use the key.

◆ MCUXCLELS_KEYPROPERTY_PRIVILEGED_FALSE

#define MCUXCLELS_KEYPROPERTY_PRIVILEGED_FALSE

This value of mcuxClEls_KeyProp_t.upprot_priv indicates that the caller does not need to be in privileged mode to use the key.

Examples
mcuxClEls_Ecc_Keygen_Sign_Verify_example.c, and mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ MCUXCLELS_KEYPROPERTY_SECURE_TRUE

#define MCUXCLELS_KEYPROPERTY_SECURE_TRUE

This value of mcuxClEls_KeyProp_t.upprot_sec indicates that the caller must be in secure mode to use the key.

Examples
mcuxClEls_Ecc_Keygen_Sign_Verify_example.c, and mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ MCUXCLELS_KEYPROPERTY_SECURE_FALSE

#define MCUXCLELS_KEYPROPERTY_SECURE_FALSE

This value of mcuxClEls_KeyProp_t.upprot_sec indicates that the caller does not need to be in secure mode to use the key.