Type for ELS key store key properties. More...

#include <mcuxClEls_Types.h>

Data Fields
struct {
uint32_t value
	Accesses the bit field as a full word; initialize with a combination of constants from MCUXCLELS_KEYPROPERTY_VALUE_. More...

}	word
	Access mcuxClEls_KeyProp_t word-wise. More...

struct {
uint32_t ksize:1
	Key size. More...

uint32_t __pad0__:4
	RFU. More...

uint32_t kactv:1
	Status flag to indicate whether the key slot contains an active key or not. More...

uint32_t kbase:1
	Status flag to indicate whether the key slot is a base slot or the second slot of a 256-bit key. More...

uint32_t fgp:1
	Hardware feature flag: General purpose key slot. More...

uint32_t frtn:1
	Hardware feature flag: Retention key slot. More...

uint32_t fhwo:1
	Hardware feature flag: Hardware-out key slot. More...

uint32_t __pad1__:3
	RFU. More...

uint32_t ucmac:1
	Usage permission for CMAC. More...

uint32_t uksk:1
	Usage permission for key signing. More...

uint32_t urtf:1
	Usage permission for RTF signing. More...

uint32_t uckdf:1
	Usage permission for CKDF. More...

uint32_t uhkdf:1
	Usage permission for HKDF. More...

uint32_t uecsg:1
	Usage permission for ECDSA signing. More...

uint32_t uecdh:1
	Usage permission for Elliptic Curve Diffie-Hellman. More...

uint32_t uaes:1
	Usage permission for AES. More...

uint32_t uhmac:1
	Usage permission for HMAC. More...

uint32_t ukwk:1
	Usage permission for key wrapping. More...

uint32_t ukuok:1
	Usage permission for key unwrapping, but not for key wrapping. More...

uint32_t utlspms:1
	Usage permission as a TLS premaster secret. More...

uint32_t utlsms:1
	Usage permission as a TLS master secret. More...

uint32_t ukgsrc:1
	Usage permission as input for ECC key generation. More...

uint32_t uhwo:1
	Usage permission in a hardware-out key slot. More...

uint32_t wrpok:1
	Usage permission to wrap. More...

uint32_t duk:1
	Device-unique key flag. More...

uint32_t upprot_priv:1
	Access restriction to privileged mode. More...

uint32_t upprot_sec:1
	Access restriction to TrustZone secure mode. More...

}	bits
	Access mcuxClEls_KeyProp_t bit-wise. More...

Detailed Description

Type for ELS key store key properties.

Examples: mcuxClEls_Ecc_Keygen_Sign_Verify_example.c, mcuxClEls_Tls_Master_Key_Session_Keys_example.c, and mcuxClKey_example.c.

Field Documentation

◆ value

uint32_t mcuxClEls_KeyProp_t::value

Accesses the bit field as a full word; initialize with a combination of constants from MCUXCLELS_KEYPROPERTY_VALUE_.

Examples: mcuxClKey_example.c.

◆ word

struct { ... } mcuxClEls_KeyProp_t::word

Access mcuxClEls_KeyProp_t word-wise.

Examples: mcuxClKey_example.c.

◆ ksize

uint32_t mcuxClEls_KeyProp_t::ksize

Key size.

Examples: mcuxClKey_example.c.

◆ pad0

uint32_t mcuxClEls_KeyProp_t::__pad0__

RFU.

◆ kactv

uint32_t mcuxClEls_KeyProp_t::kactv

Status flag to indicate whether the key slot contains an active key or not.

Examples: mcuxClKey_example.c.

◆ kbase

uint32_t mcuxClEls_KeyProp_t::kbase

Status flag to indicate whether the key slot is a base slot or the second slot of a 256-bit key.

◆ fgp

uint32_t mcuxClEls_KeyProp_t::fgp

Hardware feature flag: General purpose key slot.

◆ frtn

uint32_t mcuxClEls_KeyProp_t::frtn

Hardware feature flag: Retention key slot.

◆ fhwo

uint32_t mcuxClEls_KeyProp_t::fhwo

Hardware feature flag: Hardware-out key slot.

◆ pad1

uint32_t mcuxClEls_KeyProp_t::__pad1__

RFU.

◆ ucmac

uint32_t mcuxClEls_KeyProp_t::ucmac

Usage permission for CMAC.

◆ uksk

uint32_t mcuxClEls_KeyProp_t::uksk

Usage permission for key signing.

◆ urtf

uint32_t mcuxClEls_KeyProp_t::urtf

Usage permission for RTF signing.

◆ uckdf

uint32_t mcuxClEls_KeyProp_t::uckdf

Usage permission for CKDF.

◆ uhkdf

uint32_t mcuxClEls_KeyProp_t::uhkdf

Usage permission for HKDF.

◆ uecsg

uint32_t mcuxClEls_KeyProp_t::uecsg

Usage permission for ECDSA signing.

◆ uecdh

uint32_t mcuxClEls_KeyProp_t::uecdh

Usage permission for Elliptic Curve Diffie-Hellman.

◆ uaes

uint32_t mcuxClEls_KeyProp_t::uaes

Usage permission for AES.

◆ uhmac

uint32_t mcuxClEls_KeyProp_t::uhmac

Usage permission for HMAC.

◆ ukwk

uint32_t mcuxClEls_KeyProp_t::ukwk

Usage permission for key wrapping.

◆ ukuok

uint32_t mcuxClEls_KeyProp_t::ukuok

Usage permission for key unwrapping, but not for key wrapping.

◆ utlspms

uint32_t mcuxClEls_KeyProp_t::utlspms

Usage permission as a TLS premaster secret.

◆ utlsms

uint32_t mcuxClEls_KeyProp_t::utlsms

Usage permission as a TLS master secret.

Examples: mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ ukgsrc

uint32_t mcuxClEls_KeyProp_t::ukgsrc

Usage permission as input for ECC key generation.

◆ uhwo

uint32_t mcuxClEls_KeyProp_t::uhwo

Usage permission in a hardware-out key slot.

◆ wrpok

uint32_t mcuxClEls_KeyProp_t::wrpok

Usage permission to wrap.

◆ duk

uint32_t mcuxClEls_KeyProp_t::duk

Device-unique key flag.

◆ upprot_priv

uint32_t mcuxClEls_KeyProp_t::upprot_priv

Access restriction to privileged mode.

Examples: mcuxClEls_Ecc_Keygen_Sign_Verify_example.c, and mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ upprot_sec

uint32_t mcuxClEls_KeyProp_t::upprot_sec

Access restriction to TrustZone secure mode.

Examples: mcuxClEls_Ecc_Keygen_Sign_Verify_example.c, and mcuxClEls_Tls_Master_Key_Session_Keys_example.c.

◆ bits

struct { ... } mcuxClEls_KeyProp_t::bits

Access mcuxClEls_KeyProp_t bit-wise.

Examples: mcuxClEls_Ecc_Keygen_Sign_Verify_example.c, mcuxClEls_Tls_Master_Key_Session_Keys_example.c, and mcuxClKey_example.c.

Data Fields