jc-it/secrets

Secrets storage

v1.0.0 2022-01-12 15:44 UTC

Requires

• php: >=8.0

Requires (Dev)

• captainhook/plugin-composer: ^5.3
• mikey179/vfsstream: ^1.6
• phpstan/extension-installer: ^1.1
• phpstan/phpstan: ^1.2
• phpstan/phpstan-phpunit: ^1.0
• phpstan/phpstan-strict-rules: ^1.1
• phpunit/phpunit: ^9.5
• ramsey/conventional-commits: ^1.3
• symfony/console: ^5.4.2
• symplify/easy-coding-standard: ^9.4

MIT

• Joey Claessen

README

This package provides secret storage.

Installation

The preferred way to install this extension is through composer.

Either run

$ composer require jc-it/secrets

or add

"jc-it/secrets": "^<latest version>"

to the require section of your composer.json file.

Configuration

It is recommended to use this package only in configuration files before your application is loaded, this way they won't be dumped by your application on chrashes or something unexpected.

$secrets = new \JCIT\secrets\Secrets(
    new \JCIT\secrets\storages\Chained(
        new \JCIT\secrets\storages\Cache(getenv()),
        new \JCIT\secrets\storages\Json('/run/env.json'),
        new \JCIT\secrets\storages\Filesystem(__DIR__ . '/secrets'),
    )
);

Note that the order in the Chained storage does matter, wherever a secret is found first that value will be returned.

Usage

After initialization, just call the following code:

$secrets->get('<secret>', '<optional default value>');

To be sure the secret is set use:

$secrets->getAndThrowOnNull('<secret>');

Extension

In order to implement your own storage, just extend the \JCIT\secrets\interfaces\StorageInterface.

TODO

• Write extractor based on https://github.com/JC-IT/yii2-secrets/blob/master/src/actions/Extract.php

Credits

• Joey Claessen