Download the PHP package violet88/silverstripe-vault without Composer
On this page you can find all versions of the php package violet88/silverstripe-vault. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download violet88/silverstripe-vault
More information about violet88/silverstripe-vault
Files in violet88/silverstripe-vault
Package silverstripe-vault
Short Description A SilverStripe module for encrypting and decrypting data using the HashiCorp Vault API
License BSD-3-Clause
Informations about the package silverstripe-vault
SilverStripe Vault Module
This module provides a way to store sensitive data securely using the Vault service (specifically the Transit API).
Requirements
- SilverStripe ^4 || ^5
- PHP ^7.4 || ^8.0
- Vault Server with Transit API enabled
Installation
Install the module using composer.
Configuration
Vault
The module requires transit to be enabled on the Vault server. The following policy can be used to enable transit.
The transit engine can be enabled using the following command.
SilverStripe
Configuration File
The module requires a Vault server to be configured. The server can be configured in the vault.yml
file.
Additionally, a default key can be configured in the vault.yml
file.
If no key is configured, the module will use the following defaults.
Keys will be created automatically if they do not exist, be sure to set Vault permissions accordingly.
Environment Variables
Along with the vault.yml
file, the module supports the following environment variables.
Setting these environment variables will override the corresponding values set in the vault.yml
file.
Usage
The module provides an Encrypted
field type that automatically encrypts and decrypts data when it is saved and retrieved from the database.
The datatype supports automatic casting, to use it simply pass the cast type as well as any of it's parameters.
Filtering
The module provides an EncryptedSearch
that can be used to filter data by encrypted fields. Keep in mind that the filter will only return exact matches.
Tasks
The module provides tasks for encrypting and decrypting all data and rotating the default key.
Disclaimers
- Violet88 is not responsible for any loss of data or other damages caused by the use of this module. Use at your own risk.
All versions of silverstripe-vault with dependencies
silverstripe/framework Version ^4 || ^5
silverstripe/admin Version ^1.0 || ^2.0