detailnet/dfw-varcrypt-module

Zend Framework 2 Module for dfw-varcrypt

Zend Framework 2 Module for dfw-varcrypt

, _(*1)

Introduction

This module integrates the DETAIL Framework library for for working with encrypted environment variables with Zend Framework 2., _(*2)

Requirements

Zend Framework 2 Skeleton Application (or compatible architecture), _(*3)

Installation

Install the module through Composer using the following steps:, _(*4)

1. cd my/project/directory, _(*5)

2. Create a composer.json file with following contents (or update your existing file accordingly):, _(*6)

   json { "require": { "detailnet/dfw-varcrypt-module": "1.x-dev" } }, _(*7)

3. Install Composer via curl -s http://getcomposer.org/installer | php (on Windows, download the installer and execute it with PHP), _(*8)

4. Run php composer.phar self-update, _(*9)

5. Run php composer.phar install, _(*10)

6. Open configs/application.config.php and add following key to your modules:, _(*11)

   php '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', ), ), ),, _(*12)

7. Copy vendor/detailnet/dfw-varcrypt-module/config/detail_varcrypt.local.php.dist into your application's config/autoload directory, rename it to detail_varcrypt.local.php and make the appropriate changes., _(*13)

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., _(*14)

Here's an example for providing MongoDB credentials as a single environment variable:, _(*15)

1. Define credentials as JSON:, _(*16)

   json { "server": "localhost", "user": "root", "password": "root", "port": 27017, "dbname": null, "options": [] }, _(*17)

2. Make sure an encryption key is set in detail_varcrypt.local.php., _(*18)

3. Encode JSON: php public/index.php varcrypt encode-value {"server": ...}
4. Save the output as environment variable (e.g. MONGO).
5. 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., _(*19)

1. Add the environment variable to the module's config (in detail_varcrypt.local.php):, _(*20)

   php 'detail_varcrypt' => array( 'listeners' => array( 'Detail\VarCrypt\Listener\MultiEncryptorListener' => array( 'apply_variables' => array( 'mongo', ), ), ), ),, _(*21)

2. Access environment variables as you normally would:, _(*22)

   php array( 'doctrine' => array( 'connection' => array( 'odm_default' => array( 'server' => getenv('MONGO_SERVER') ?: 'localhost', ... ), ), ), ), _(*23)