detailnet / dfw-varcrypt-module
Zend Framework 2 Module for dfw-varcrypt
Requires
- php: >=5.4.0
- detailnet/dfw-core: ~0.2
- detailnet/dfw-varcrypt: ~0.1.1
- keboola/php-encryption: ~0.2.1
- psr/log: ~1.0
- zendframework/zend-config: 2.*
- zendframework/zend-console: 2.*
- zendframework/zend-loader: 2.*
- zendframework/zend-modulemanager: 2.*
- zendframework/zend-mvc: 2.*
- zendframework/zend-servicemanager: 2.*
- zendframework/zend-view: 2.*
Requires (Dev)
- phpmd/phpmd: ~2.1.3
- phpunit/phpunit: ~4.4.5
- satooshi/php-coveralls: dev-master
- squizlabs/php_codesniffer: ~2.2.0
This package is auto-updated.
Last update: 2021-05-31 13:16:42 UTC
README
Introduction
This module integrates the DETAIL Framework library for for working with encrypted environment variables with Zend Framework 2.
Requirements
Zend Framework 2 Skeleton Application (or compatible architecture)
Installation
Install the module through Composer using the following steps:
-
cd my/project/directory
-
Create a
composer.json
file with following contents (or update your existing file accordingly):{ "require": { "detailnet/dfw-varcrypt-module": "1.x-dev" } }
-
Install Composer via
curl -s http://getcomposer.org/installer | php
(on Windows, download the installer and execute it with PHP) -
Run
php composer.phar self-update
-
Run
php composer.phar install
-
Open
configs/application.config.php
and add following key to yourmodules
:'service_manager' => array( 'delegators' => array( 'ModuleManager' => array( // By attaching this delegator the module Detail\VarCrypt is loaded before // all other modules so that the encrypted environment variables can be // applied before the configs of the other modules are merged/applied. 'Detail\VarCrypt\Factory\ModuleManager\ModuleManagerDelegatorFactory', ), ), ),
-
Copy
vendor/detailnet/dfw-varcrypt-module/config/detail_varcrypt.local.php.dist
into your application'sconfig/autoload
directory, rename it todetail_varcrypt.local.php
and make the appropriate changes.
Usage
Save/encode config
Before the module can be used, a config (simple string or JSON encoded string) needs to be encoded and provided as environment variable.
Here's an example for providing MongoDB credentials as a single environment variable:
-
Define credentials as JSON:
{ "server": "localhost", "user": "root", "password": "root", "port": 27017, "dbname": null, "options": [] }
-
Make sure an encryption key is set in
detail_varcrypt.local.php
. -
Encode JSON:
php public/index.php varcrypt encode-value {"server": ...}
-
Save the output as environment variable (e.g.
MONGO
). -
Test that the environment variable can be accessed (at least from the CLI):
php public/index.php varcrypt decode-variable MONGO
Apply/decode config
The following steps are necessary, to use an encrypted/encoded environment variable in a ZF2 app.
-
Add the environment variable to the module's config (in
detail_varcrypt.local.php
):'detail_varcrypt' => array( 'listeners' => array( 'Detail\VarCrypt\Listener\MultiEncryptorListener' => array( 'apply_variables' => array( 'mongo', ), ), ), ),
-
Access environment variables as you normally would:
array( 'doctrine' => array( 'connection' => array( 'odm_default' => array( 'server' => getenv('MONGO_SERVER') ?: 'localhost', ... ), ), ), )