Skip to main content

Key

The Key holds the information about the cryptographic key and its lifecycle. It represents the cryptographic key in a human-readable format. Key holds the following information:

  • Key management details
  • Attributes of the Key
  • Association with other related objects like Certificate
  • History of events associated with the Key
  • Wrapped content of other related parts of the Key, for example public/private key, or split/component parts

In addition to the above details, the following are mapped to the Key for the ease of management:

  • Token Profile it belongs to and managed by
  • Owner of the Key
  • Group it belongs to
  • Optionally description of the Key

Attributes

Key attributes hold information related to the platform. It can contain Custom Attributes as well as Metadata Attributes.

Metadata Attributes provides any additional information about the Key that can be technology specific. They can be used for further processing of the Key by different components and modules of the platform.

Key state

Every key has defined its state during its lifecycle. The state of the Key defines its lifecycle phase and operations that can be performed. Once the Key is created, it is in the Pre-active state and must be activated before it can be used for any cryptographic operation.

The following states are supported:

StateDescription
Pre-activeThe Key is created and ready to be used once activated, or activate date is reached
ActiveThe Key is ready to be used
DeactivatedThe Key is not ready to be used
CompromisedThe Key is compromised and cannot be used, however it still exists
DestroyedThe Key is destroyed and mark for removal, however it is still in the inventory for the auditing purposes

The transition Key state diagram is as follows:

Key usage

Every key has defined its key usages. The key usage can restrict the type of cryptographic operation that can be performed using the Key.

The following key usages are supported:

Key UsageDescription
EncryptAllows to request encryption operation using the Key
DecryptAllows to request decryption operation using the Key
SignAllows to request signing operation using the Key
VerifyAllows to request verification operation using the Key
WrapAllows to request wrapping operation using the Key
UnwrapAllows to request unwrapping operation using the Key

The supported key usages and key types combinations are:

Key TypeKey Usage
Public KeyEncrypt, Verify, Wrap
Private KeyDecrypt, Sign, Unwrap
Secret KeyEncrypt, Decrypt, Sign, Verify, Wrap, Unwrap