Download the PHP package pvsv1984/secure-env-php without Composer
On this page you can find all versions of the php package pvsv1984/secure-env-php. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download pvsv1984/secure-env-php
More information about pvsv1984/secure-env-php
Files in pvsv1984/secure-env-php
Package secure-env-php
Short Description Encrypt environment files for production use.
License MIT
Informations about the package secure-env-php
Secure Env PHP
Env encryption and decryption library.
Prevent committing and exposing vulnerable plain-text environment variables in production environments.
You can view a more in-depth tutorial on Medium.
Installation
Install secure-env-php using Composer
.env
Create an .env
file in your project with environment variables.
Encrypting
Execute vendor/bin/encrypt-env
in your project directory and follow the command prompts to encrypt your .env
file. You can press enter to accept the default values in the square brackets.
Encryption Prompts
- Path to your .env file you want to encrypt.
- Input "y" or "yes" to generate a new secret key file. Otherwise input path to secret key file when prompted.
- Your choice of encryption algorith or accept the default provided. For a list of supported algorithms visit: https://secure.php.net/manual/en/function.openssl-get-cipher-methods.php.
- Path to save the encrypted environment file.
After you've successfully completed the prompts you should now have an encrypted environment file.
Import and Instantiate
Import into namespace environment
Instantiate class with your decryption arguments. First argument is path to your encrypted env file, second argument is path to your secret key file, and optionally a third argument can be set for your choice of encryption algorithm, (this needs to match the algorithm you used to encrypt your env file).
Decryption Options
parameter | description | default |
---|---|---|
1. path | Path to encrypted file | .env.enc |
2. secret | Path to key file or secret string | |
3. algo | Encryption algorithm | aes256 |
Retrieving Env Values
After instantiating the SecureEnvPHP class you can retrieve your values in your project by calling getenv
with your variable names, such as getenv('DB_HOST')
.
Full Example
Acknowledgements
Secure Env PHP is inspired by https://github.com/kunalpanchal/secure-env for NodeJS.