MCUX CLNS MCUX Crypto Library Normal Secure |

Macros
MCUXCLCSS_KEYPROPERTY_
mcuxClCss » mcuxClCss_Types » mcuxClCss_Types_Macros

Constants for initalizing mcuxClCss_KeyProp_t.bits. More...

## Macros

#define | MCUXCLCSS_KEYPROPERTY_KEY_SIZE_128
| This value of mcuxClCss_KeyProp_t.ksize indicates a 128 bit key. More...
#define | MCUXCLCSS_KEYPROPERTY_KEY_SIZE_256
| This value of mcuxClCss_KeyProp_t.ksize indicates a 256 bit key. More...
#define | MCUXCLCSS_KEYPROPERTY_ACTIVE_TRUE
| This value of mcuxClCss_KeyProp_t.kactv indicates that the slot contains an active key. More...
#define | MCUXCLCSS_KEYPROPERTY_ACTIVE_FALSE
| This value of mcuxClCss_KeyProp_t.kactv indicates that the slot does not contain active key. More...
#define | MCUXCLCSS_KEYPROPERTY_BASE_SLOT
| This value of mcuxClCss_KeyProp_t.kbase indicates that the slot is the base slot of a 2-slot key. More...
#define | MCUXCLCSS_KEYPROPERTY_SECOND_SLOT
| This value of mcuxClCss_KeyProp_t.kbase indicates that the slot is the second slot of a 2-slot key. More...
#define | MCUXCLCSS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_TRUE
| This value of mcuxClCss_KeyProp_t.fgp indicates that the slot is a retention key slot or a hardware out key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_FALSE
| This value of mcuxClCss_KeyProp_t.fgp indicates that the slot is a neither retention key slot nor hardware out key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_RETENTION_SLOT_TRUE
| This value of mcuxClCss_KeyProp_t.frtn indicates that the slot is a retention key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_RETENTION_SLOT_FALSE
| This value of mcuxClCss_KeyProp_t.frtn indicates that the slot is not a retention key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_HW_OUT_SLOT_TRUE
| This value of mcuxClCss_KeyProp_t.fhwo indicates that the slot is a hardware out key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_HW_OUT_SLOT_FALSE
| This value of mcuxClCss_KeyProp_t.fhwo indicates that the slot is not a hardware out key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_CMAC_TRUE
| This value of mcuxClCss_KeyProp_t.ucmac indicates that the key can be used for CMAC. More...
#define | MCUXCLCSS_KEYPROPERTY_CMAC_FALSE
| This value of mcuxClCss_KeyProp_t.ucmac indicates that the key cannot be used for CMAC. More...
#define | MCUXCLCSS_KEYPROPERTY_KSK_TRUE
| This value of mcuxClCss_KeyProp_t.uksk indicates that the key can be used for key signing. More...
#define | MCUXCLCSS_KEYPROPERTY_KSK_FALSE
| This value of mcuxClCss_KeyProp_t.uksk indicates that the key cannot be used for key signing. More...
#define | MCUXCLCSS_KEYPROPERTY_RTF_TRUE
| This value of mcuxClCss_KeyProp_t.urtf indicates that the key can be used for RTF signing. More...
#define | MCUXCLCSS_KEYPROPERTY_RTF_FALSE
| This value of mcuxClCss_KeyProp_t.urtf indicates that the key cannot be used for RTF signing. More...
#define | MCUXCLCSS_KEYPROPERTY_CKDF_TRUE
| This value of mcuxClCss_KeyProp_t.uckdf indicates that the key can be used for CKDF. More...
#define | MCUXCLCSS_KEYPROPERTY_CKDF_FALSE
| This value of mcuxClCss_KeyProp_t.uckdf indicates that the key cannot be used for CKDF. More...
#define | MCUXCLCSS_KEYPROPERTY_HKDF_TRUE
| This value of mcuxClCss_KeyProp_t.uhkdf indicates that the key can be used for HKDF. More...
#define | MCUXCLCSS_KEYPROPERTY_HKDF_FALSE
| This value of mcuxClCss_KeyProp_t.uhkdf indicates that the key cannot be used for HKDF. More...
#define | MCUXCLCSS_KEYPROPERTY_ECC_TRUE
| This value of mcuxClCss_KeyProp_t.uecsg indicates that the key can be used for ECC signing. More...
#define | MCUXCLCSS_KEYPROPERTY_ECC_FALSE
| This value of mcuxClCss_KeyProp_t.uecsg indicates that the key cannot be used for ECC signing. More...
#define | MCUXCLCSS_KEYPROPERTY_ECC_DH_PRIVATE_TRUE
| This value of mcuxClCss_KeyProp_t.uecdh indicates that the key is a ECC Diffie Hellman private key. More...
#define | MCUXCLCSS_KEYPROPERTY_ECC_DH_PRIVATE_FALSE
| This value of mcuxClCss_KeyProp_t.uecdh indicates that the key is not an ECC Diffie Hellman private key. More...
#define | MCUXCLCSS_KEYPROPERTY_AES_TRUE
| This value of mcuxClCss_KeyProp_t.uaes indicates that the key is an AES key. More...
#define | MCUXCLCSS_KEYPROPERTY_AES_FALSE
| This value of mcuxClCss_KeyProp_t.uaes indicates that the key is not an AES key. More...
#define | MCUXCLCSS_KEYPROPERTY_HMAC_TRUE
| This value of mcuxClCss_KeyProp_t.uhmac indicates that the key is an HMAC key. More...
#define | MCUXCLCSS_KEYPROPERTY_HMAC_FALSE
| This value of mcuxClCss_KeyProp_t.uhmac indicates that the key is not an HMAC key. More...
#define | MCUXCLCSS_KEYPROPERTY_KWK_TRUE
| This value of mcuxClCss_KeyProp_t.ukwk indicates that the key is a Key Wrapping Key. More...
#define | MCUXCLCSS_KEYPROPERTY_KWK_FALSE
| This value of mcuxClCss_KeyProp_t.ukwk indicates that the key is not a Key Wrapping Key. More...
#define | MCUXCLCSS_KEYPROPERTY_KUOK_TRUE
| This value of mcuxClCss_KeyProp_t.ukuok indicates that the key is a Key Unwrapping Only Key. More...
#define | MCUXCLCSS_KEYPROPERTY_KUOK_FALSE
| This value of mcuxClCss_KeyProp_t.ukuok indicates that the key is not a Key Unwrapping Only Key. More...
#define | MCUXCLCSS_KEYPROPERTY_TLS_PREMASTER_SECRET_TRUE
| This value of mcuxClCss_KeyProp_t.utlspms indicates that the key is a TLS Premaster Secret. More...
#define | MCUXCLCSS_KEYPROPERTY_TLS_PREMASTER_SECRET_FALSE
| This value of mcuxClCss_KeyProp_t.utlspms indicates that the key is not a TLS Premaster Secret. More...
#define | MCUXCLCSS_KEYPROPERTY_TLS_MASTER_SECRET_TRUE
| This value of mcuxClCss_KeyProp_t.utlsms indicates that the key is a TLS Master Secret. More...
#define | MCUXCLCSS_KEYPROPERTY_TLS_MASTER_SECRET_FALSE
| This value of mcuxClCss_KeyProp_t.utlsms indicates that the key is not a TLS Master Secret. More...
#define | MCUXCLCSS_KEYPROPERTY_INPUT_FOR_ECC_TRUE
| This value of mcuxClCss_KeyProp_t.ukgsrc indicates that the key can be used as key material input for ECC key generation. More...
#define | MCUXCLCSS_KEYPROPERTY_INPUT_FOR_ECC_FALSE
| This value of mcuxClCss_KeyProp_t.ukgsrc indicates that the key cannot be used as key material input for ECC key generation. More...
#define | MCUXCLCSS_KEYPROPERTY_HW_OUT_TRUE
| This value of mcuxClCss_KeyProp_t.uhwo indicates that the key can be used in a hardware out key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_HW_OUT_FALSE
| This value of mcuxClCss_KeyProp_t.uhwo indicates that the key cannot be used in a hardware out key slot. More...
#define | MCUXCLCSS_KEYPROPERTY_WRAP_TRUE
| This value of mcuxClCss_KeyProp_t.wrpok indicates that the key can be wrapped. More...
#define | MCUXCLCSS_KEYPROPERTY_WRAP_FALSE
| This value of mcuxClCss_KeyProp_t.wrpok indicates that the key cannot be wrapped. More...
#define | MCUXCLCSS_KEYPROPERTY_DEVICE_UNIQUE_TRUE
| This value of mcuxClCss_KeyProp_t.duk indicates that the key is a Device Unique Key. More...
#define | MCUXCLCSS_KEYPROPERTY_DEVICE_UNIQUE_FALSE
| This value of mcuxClCss_KeyProp_t.duk indicates that the key is not a Device Unique Key. More...
#define | MCUXCLCSS_KEYPROPERTY_PRIVILEGED_TRUE
| This value of mcuxClCss_KeyProp_t.upprot_priv indicates that the caller must be in privileged mode to use the key. More...
#define | MCUXCLCSS_KEYPROPERTY_PRIVILEGED_FALSE
| This value of mcuxClCss_KeyProp_t.upprot_priv indicates that the caller does not need to be in privileged mode to use the key. More...
#define | MCUXCLCSS_KEYPROPERTY_SECURE_TRUE
| This value of mcuxClCss_KeyProp_t.upprot_sec indicates that the caller must be in secure mode to use the key. More...
#define | MCUXCLCSS_KEYPROPERTY_SECURE_FALSE
| This value of mcuxClCss_KeyProp_t.upprot_sec indicates that the caller does not need to be in secure mode to use the key. More...

## Detailed Description

Constants for initalizing mcuxClCss_KeyProp_t.bits.

## Macro Definition Documentation

## ◆ MCUXCLCSS_KEYPROPERTY_KEY_SIZE_128

#define MCUXCLCSS_KEYPROPERTY_KEY_SIZE_128

This value of mcuxClCss_KeyProp_t.ksize indicates a 128 bit key.

Examples
  mcuxClKey_example.c, and mcuxClMac_cmac_oneshot_example.c.

## ◆ MCUXCLCSS_KEYPROPERTY_KEY_SIZE_256

#define MCUXCLCSS_KEYPROPERTY_KEY_SIZE_256

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

## ◆ MCUXCLCSS_KEYPROPERTY_ACTIVE_TRUE

#define MCUXCLCSS_KEYPROPERTY_ACTIVE_TRUE

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

Examples
  mcuxClKey_example.c, and mcuxClMac_cmac_oneshot_example.c.

## ◆ MCUXCLCSS_KEYPROPERTY_ACTIVE_FALSE

#define MCUXCLCSS_KEYPROPERTY_ACTIVE_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_BASE_SLOT

#define MCUXCLCSS_KEYPROPERTY_BASE_SLOT

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

## ◆ MCUXCLCSS_KEYPROPERTY_SECOND_SLOT

#define MCUXCLCSS_KEYPROPERTY_SECOND_SLOT

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

## ◆ MCUXCLCSS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_TRUE

#define MCUXCLCSS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_FALSE

#define MCUXCLCSS_KEYPROPERTY_GENERAL_PURPOSE_SLOT_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_RETENTION_SLOT_TRUE

#define MCUXCLCSS_KEYPROPERTY_RETENTION_SLOT_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_RETENTION_SLOT_FALSE

#define MCUXCLCSS_KEYPROPERTY_RETENTION_SLOT_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HW_OUT_SLOT_TRUE

#define MCUXCLCSS_KEYPROPERTY_HW_OUT_SLOT_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HW_OUT_SLOT_FALSE

#define MCUXCLCSS_KEYPROPERTY_HW_OUT_SLOT_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_CMAC_TRUE

#define MCUXCLCSS_KEYPROPERTY_CMAC_TRUE

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

Examples
  mcuxClMac_cmac_oneshot_example.c.

## ◆ MCUXCLCSS_KEYPROPERTY_CMAC_FALSE

#define MCUXCLCSS_KEYPROPERTY_CMAC_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_KSK_TRUE

#define MCUXCLCSS_KEYPROPERTY_KSK_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_KSK_FALSE

#define MCUXCLCSS_KEYPROPERTY_KSK_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_RTF_TRUE

#define MCUXCLCSS_KEYPROPERTY_RTF_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_RTF_FALSE

#define MCUXCLCSS_KEYPROPERTY_RTF_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_CKDF_TRUE

#define MCUXCLCSS_KEYPROPERTY_CKDF_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_CKDF_FALSE

#define MCUXCLCSS_KEYPROPERTY_CKDF_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HKDF_TRUE

#define MCUXCLCSS_KEYPROPERTY_HKDF_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HKDF_FALSE

#define MCUXCLCSS_KEYPROPERTY_HKDF_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_ECC_TRUE

#define MCUXCLCSS_KEYPROPERTY_ECC_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_ECC_FALSE

#define MCUXCLCSS_KEYPROPERTY_ECC_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_ECC_DH_PRIVATE_TRUE

#define MCUXCLCSS_KEYPROPERTY_ECC_DH_PRIVATE_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_ECC_DH_PRIVATE_FALSE

#define MCUXCLCSS_KEYPROPERTY_ECC_DH_PRIVATE_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_AES_TRUE

#define MCUXCLCSS_KEYPROPERTY_AES_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_AES_FALSE

#define MCUXCLCSS_KEYPROPERTY_AES_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HMAC_TRUE

#define MCUXCLCSS_KEYPROPERTY_HMAC_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HMAC_FALSE

#define MCUXCLCSS_KEYPROPERTY_HMAC_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_KWK_TRUE

#define MCUXCLCSS_KEYPROPERTY_KWK_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_KWK_FALSE

#define MCUXCLCSS_KEYPROPERTY_KWK_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_KUOK_TRUE

#define MCUXCLCSS_KEYPROPERTY_KUOK_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_KUOK_FALSE

#define MCUXCLCSS_KEYPROPERTY_KUOK_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_TLS_PREMASTER_SECRET_TRUE

#define MCUXCLCSS_KEYPROPERTY_TLS_PREMASTER_SECRET_TRUE

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

Examples
  tls_master_key_session_keys.c.

## ◆ MCUXCLCSS_KEYPROPERTY_TLS_PREMASTER_SECRET_FALSE

#define MCUXCLCSS_KEYPROPERTY_TLS_PREMASTER_SECRET_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_TLS_MASTER_SECRET_TRUE

#define MCUXCLCSS_KEYPROPERTY_TLS_MASTER_SECRET_TRUE

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

Examples
  tls_master_key_session_keys.c.

## ◆ MCUXCLCSS_KEYPROPERTY_TLS_MASTER_SECRET_FALSE

#define MCUXCLCSS_KEYPROPERTY_TLS_MASTER_SECRET_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_INPUT_FOR_ECC_TRUE

#define MCUXCLCSS_KEYPROPERTY_INPUT_FOR_ECC_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_INPUT_FOR_ECC_FALSE

#define MCUXCLCSS_KEYPROPERTY_INPUT_FOR_ECC_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HW_OUT_TRUE

#define MCUXCLCSS_KEYPROPERTY_HW_OUT_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_HW_OUT_FALSE

#define MCUXCLCSS_KEYPROPERTY_HW_OUT_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_WRAP_TRUE

#define MCUXCLCSS_KEYPROPERTY_WRAP_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_WRAP_FALSE

#define MCUXCLCSS_KEYPROPERTY_WRAP_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_DEVICE_UNIQUE_TRUE

#define MCUXCLCSS_KEYPROPERTY_DEVICE_UNIQUE_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_DEVICE_UNIQUE_FALSE

#define MCUXCLCSS_KEYPROPERTY_DEVICE_UNIQUE_FALSE

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

## ◆ MCUXCLCSS_KEYPROPERTY_PRIVILEGED_TRUE

#define MCUXCLCSS_KEYPROPERTY_PRIVILEGED_TRUE

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

## ◆ MCUXCLCSS_KEYPROPERTY_PRIVILEGED_FALSE

#define MCUXCLCSS_KEYPROPERTY_PRIVILEGED_FALSE

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

Examples
  ecc_keygen_sign_verify.c, and tls_master_key_session_keys.c.

## ◆ MCUXCLCSS_KEYPROPERTY_SECURE_TRUE

#define MCUXCLCSS_KEYPROPERTY_SECURE_TRUE

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

Examples
  ecc_keygen_sign_verify.c, and tls_master_key_session_keys.c.

## ◆ MCUXCLCSS_KEYPROPERTY_SECURE_FALSE

#define MCUXCLCSS_KEYPROPERTY_SECURE_FALSE

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