Download the PHP package detailnet/dfw-varcrypt-module without Composer

Zend Framework 2 Module for dfw-varcrypt

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:

1. cd my/project/directory

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

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

4. Run php composer.phar self-update

5. Run php composer.phar install

6. Open configs/application.config.php and add following key to your modules:

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.

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:

1. Define credentials as JSON:

2. Make sure an encryption key is set in detail_varcrypt.local.php.
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.

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

2. Access environment variables as you normally would: