Vault for Tokens overview

Edit on GitHub
You are browsing a previous version of the document. The latest version is 202204.0.

Vault for Tokens provides the functionality to store sensitive data. This feature doesn’t have any GUI and consists of two modules: Spryker.UtilEncryption and Spryker.Vault.

Spryker.UtilEncryption provides data encryption / decryption functionality and Spryker.Vault module uses this functionality to store and retrieve data from the database.

Module relations of Vault for Tokens

The database structure includes the following fields:

  • dataType
  • dataKey
  • data

dataType and dataKey entries are used for the distinction between the provided data. Thus, multiple and various entries of data can be filtered and stored in the vault.

The database fields are mandatory and should contain either an empty string or a string with value.

By default, we provide encryption algorithm AES256. The encryption functionality won’t be used until the ENCRYPTION_KEY is set in the project config file. You can change the encryption algorithm in the module config on the project level.

The feature supports special characters and different writing systems.