Your suggested change has been received. Thank you.

close
Thales Logo

All

  • All
back

NAE Key Management Operations

Getting key attributes of a versioned key

search

Please Note:

printsuggest an edit

Getting key attributes of a versioned key

copy link to clipboardTo retrieve key attributes of a versioned key

Call the I_C_GetKeyAttributes API. To retrieve information on the latest version, you can call the function as you do when using a non-versioned key. To retrieve information for a specific key, use the version number prefix (#n).

copy link to clipboardExample

rc = I_C_GetKeyAttributes(sess, my_versioned_key, &systemAttributeList,&customAttributeList);
rc = I_C_GetKeyAttributes(sess, "my_versioned_key#4", &systemAttributeList,&customAttributeList);

All attributes (except KeyVersionNumber and Fingerprint) are the same for all key versions.

This function returns the following values - in the system and custom attribute lists. The values specific to versioned keys are in bold.

AttributeDescription
KeySizeThe size of the key (in bits).
AlgorithmAn algorithm that can be used with the key. Multiple instances may be present - one for each supported algorithm.
FingerprintA hash of the key bytes.
VersionedIs this a versioned key?
KeyVersionNumberThe version number of this key.
NumKeyVersionsThe total number of key versions for this key.
NumActiveVersionsThe number of versions in the active state.
NumRestrictedVersionsThe number of versions in the restricted state.
NumRetiredVersionsThe number of versions in the retired state.
NumWipedVersionsThe number of versions in the wiped state.
DeletableCan this key be deleted?
ExportableCan this key be exported?
EncryptCan session user encrypt with this key?
DecryptCan session user decrypt with this key?
SignCan session user sign with this key?
SignVCan session user verify signature with this key?
MACCan session user compute a MAC with this key?
MACVCan session user verify a MAC with this key?
UsePrivateCan session user decrypt with the private key?
UsePublicCan session user encrypt with this public key?
CustomAttributeListThe list of custom attributes, if they exist.

On this page