ict/secrets

Manage, encode ans store your secrets easily

v1.0.0 2023-05-20 11:26 UTC

Requires

• php: >=8.1
• ext-ctype: *
• ext-iconv: *
• symfony/console: 6.*
• symfony/dotenv: 6.*
• symfony/flex: ^2
• symfony/framework-bundle: 6.*
• symfony/runtime: 6.*
• symfony/yaml: 6.*

Replaces

• symfony/polyfill-ctype: *
• symfony/polyfill-iconv: *
• symfony/polyfill-php72: *
• symfony/polyfill-php73: *
• symfony/polyfill-php74: *
• symfony/polyfill-php80: *
• symfony/polyfill-php81: *

MIT

• Nacho Colomina

README

Introduction

This bundle allows developers to encrypt its keys ans store them using redis as a vault

Requirements

• This bundle requires sodium extension and predis to be installed.

Installation

Install it using composer:

composer require ict/secrets:dev-main

Configuration

Bundle requires the following configuration:

ict_secrets:
  hash_alg: 'sha512' # Any type supported by php hash function
  encoder: sodium
  store:
    type: redis
    config:
      uri: 'your redis uri connection'

At the moment, only sodium encoder and redis vault are allowed.

How to use it

Inject Vault service:

use Ict\Secrets\Vault\VaultStorageInterface;

..........

public function __construct(    
    private readonly VaultStorageInterface $vaultStorage
)

Store a secret

$this->vaultStorage->storeKeys('your_encription_keys_name')->storeSecret('your_secret_name', 'your_secret_value');

your_encription_keys_name is used to store the encription keys by which your secrets will be encripted

Retrieve a secret

$secretVal = $this->vaultStorage->getSecret($secretKey)

Remove a secret

$secretVal = $this->vaultStorage->removeSecret($secretKey)