Skip to main content

Cryptography Provider v1

Deprecated

Cryptography Provider v1 is deprecated since 2.20.0. New connectors implement Cryptography Provider v2, the default interface. Core keeps serving v1 for the tokens bound to it.

Overview​

Cryptography Provider has capability of cryptographic token management and cryptographic key operations that is connected with specific technology like hardware security module, security vault, etc. Cryptographic keys that are created and used in the context of Cryptography Provider are managed by the implementation of Connector and can be used in the platform to execute cryptographic operation with the key.

Entity Provider key management

The Entity Provider Connectors are also capable of key management operations that allow to create private key and sign CSR. These capabilities are available only for the entities managed by the Entity Provider Connector. The Crypto Provider brings key management capabilities for the entire platform.

Using Cryptography Provider, the platform can generate new key pairs, sign the certification signing request, decrypt incoming requests to issue certificate, and many more.

How it works​

Cryptography Provider implements specific technology capable of managing and using cryptographic keys. Independently of the connected technology, it provides interfaces to manage cryptographic tokens and cryptographic keys in a consistent way. The token is considered to be logical unit maintaining its cryptographic keys and there can be as many tokens as required with proper authentication or activation data.

When there is a need to use cryptographic key, platform can request operation on top of some specific key and the operation will be executed in the technology through the Cryptography Provider implementation. Supported operations are:

  • Create / Destroy Key
  • Encrypt / Decrypt
  • Sign / Verify
  • Generate random data

Provider objects​

Token​

Token represents the logical separation of cryptographic keys. One token can contain multiple cryptographic keys. Each Cryptography Provider connector can have multiple tokens. The token is identified by its name and it is unique within the Cryptography Provider connector. Tokens can be managed in the platform.

Token can have the following status:

StatusDescription
ACTIVEToken is active and can be used for key management cryptographic operations
INACTIVEToken is inactive and should be activated before any key management or cryptographic operations is executed
WARNINGToken seems to be connected and activated, however, something might be wrong, see more details
CONNECTEDToken is connected but cannot be activated
DISCONNECTEDToken is disconnected from the technology and cannot be used
UNKNONWUnknown state, see logs or details of the Connector

Token Profile​

Token Profile represents key management and cryptographic operations service that can be consumed by clients and users. Each Token Profile can be associated with only one Token, but multiple Token Profiles can be assigned with the same Token. Token Profile consists of additional management, compliance, and security rules that apply for the service, like key management interface (PKCS#11, KMIP), or key usage policy (signing, encryption, etc.). Token Profile is identified by its name and it is unique within the platform.

Inventory of Keys​

Every Key that is created is stored in the inventory of cryptographic keys. Inventory of cryptographic keys is a list of all keys that are created in the platform. The inventory is used to track the keys and their usage. Attributes of the Keys are managed consistently in the platform and each Key is associated with the Token Profile that is used to manage it.

The following diagram shows the relationship between Token, Token Profile, and Keys in the inventory.

Inventory of Keys diagram

Inventory of Keys diagram

100%Scroll to explore · Esc to close
Inventory of Keys diagram
Inventory of Keys diagram
Open full diagram ↗

Processes​

The following processes are associated with the Cryptography Provider and management of the Token and Key objects.

Token instance management​

Create Token instance​

Create Token instance diagram

Create Token instance diagram

100%Scroll to explore · Esc to close
Create Token instance diagram
Create Token instance diagram
Open full diagram ↗

Get Token instance details​

Get Token instance details diagram

Get Token instance details diagram

100%Scroll to explore · Esc to close
Get Token instance details diagram
Get Token instance details diagram
Open full diagram ↗

Update Token instance​

Update Token instance diagram

Update Token instance diagram

100%Scroll to explore · Esc to close
Update Token instance diagram
Update Token instance diagram
Open full diagram ↗

Remove Token instance​

When the Token is removed, it does not necessarily mean that it was removed from the Connector and all Keys were destroyed.

Remove Token instance diagram

Remove Token instance diagram

100%Scroll to explore · Esc to close
Remove Token instance diagram
Remove Token instance diagram
Open full diagram ↗

Get Token instance status​

Status of the Token can be regularly checked by the platform. See the list of possible states of the Token.

Get Token instance status diagram

Get Token instance status diagram

100%Scroll to explore · Esc to close
Get Token instance status diagram
Get Token instance status diagram
Open full diagram ↗

Activate Token instance​

Token can be activated when is in the CONNECTED or INACTIVE state. Activation of the Token is required before any key management and cryptographic operations can be performed.

Activate Token instance diagram

Activate Token instance diagram

100%Scroll to explore · Esc to close
Activate Token instance diagram
Activate Token instance diagram
Open full diagram ↗

Deactivate Token instance​

Deactivate Token instance diagram

Deactivate Token instance diagram

100%Scroll to explore · Esc to close
Deactivate Token instance diagram
Deactivate Token instance diagram
Open full diagram ↗

Key management​

Following are supported processes for key management operations.

Create Key​

Create Key diagram

Create Key diagram

100%Scroll to explore · Esc to close
Create Key diagram
Create Key diagram
Open full diagram ↗

Destroy Key​

Destroy Key diagram

Destroy Key diagram

100%Scroll to explore · Esc to close
Destroy Key diagram
Destroy Key diagram
Open full diagram ↗

Cryptographic operations​

The following processes are associated with the operations that are performed with cryptographic Key.

Encrypt data with Key​

Encrypt data with Key diagram

Encrypt data with Key diagram

100%Scroll to explore · Esc to close
Encrypt data with Key diagram
Encrypt data with Key diagram
Open full diagram ↗

Decrypt data with Key​

Decrypt data with Key diagram

Decrypt data with Key diagram

100%Scroll to explore · Esc to close
Decrypt data with Key diagram
Decrypt data with Key diagram
Open full diagram ↗

Sign data with Key​

Sign data with Key diagram

Sign data with Key diagram

100%Scroll to explore · Esc to close
Sign data with Key diagram
Sign data with Key diagram
Open full diagram ↗

Verify data with Key​

Verify data with Key diagram

Verify data with Key diagram

100%Scroll to explore · Esc to close
Verify data with Key diagram
Verify data with Key diagram
Open full diagram ↗

Generate random data​

Generate random data diagram

Generate random data diagram

100%Scroll to explore · Esc to close
Generate random data diagram
Generate random data diagram
Open full diagram ↗

Specification and example​

The Cryptography Provider implements Common Interfaces and the following additional interfaces:

The OpenAPI specification of the Cryptography Provider can be found here: Connector API - Cryptography Provider.