Wondering what’s next for npm?Check out our public roadmap! »

dotenvenc

2.0.1 • Public • Published

dotenvenc

Encrypt and decrypt your .env so it doesn't expose sensitive information (passwords, tokens etc.)

Use case

You have a .env file in your project (usually at the app's root folder) and are using it with a package like dotenv to expose its contents as environment variables in your app. But your .env contains sensitive information (passwords, tokens etc.) in clear-text so you don't want to place it in your versioned code. Using dotenvenc you generate from .env an encrypted version .env.enc and only share this in your project. In your code you regenerate .env from .env.enc at runtime when you need to access the sensitive data.

NOTE: this package is meaningful only if used in combination with a package like dotenv which actually creates the environment variables found in the generated decrypted .env file.

TIP: add .env in your .gitignore so it's guaranteed to never get versioned.

Installation

Install and save as a local dependency in your project:

npm i dotenvenc

Encryption

Step 1

Generate the encrypted .env.enc from the clear-text .env (for this file's format, consult the dotenv docs) using the installed command line script dotenvenc:

<PROJECT_PATH>/node_modules/.bin/dotenvenc myPassword

or equivalently with the explicit '-e' flag:

<PROJECT_PATH>/node_modules/.bin/dotenvenc -e myPassword

You need to do this once in the beginning or when you make changes to your .env.

This script will search for the .env in the folder where you execute the command and will move up till it either finds it or till it reaches the app's root folder (app's root is considered to be the folder that contains a package.json and is the location where commonly .env and consequently .env.enc are stored).

NOTE: If you have npm@5.2.0 or better, then you have in your path also npx, so the above command is simply:

npx dotenvenc myPassword

Step 2

Save the key myPassword as environment variable in your .bashrc or .bash_profile:

export DOTENVENC_KEY='myPassword';

You can choose any name for this variable.

Decryption

Once you have created the .env.enc (by default will be stored in same folder where .env was found), you need to regenerate the clear-text .env at runtime to access the password, tokens etc.

There are two ways to do this.

Option 1: Javascript code

From inside your project you regenerate the .env and, combined with something like dotenv, create from it the corresponding environment variables to use in your code.

require('dotenvenc')('myPassword'); // will only regenerate `.env`; it will not create any environment variables from it
require('dotenv').config(); // this will read the generated `.env` and populate process.env.* accordingly

Example

Assuming your .env with the sensitive data is:

DB_PASS='mySupercalifragilisticexpialidociousPassword'
CHASTITIY_KEY='youShallNotPass'

and you have generated .env.enc with the key myPassword which you saved in environment variale DOTENVENC_KEY (see Ecryption above).

Then in your project code:

require('dotenvenc')(process.env.DOTENVENC_KEY);
require('dotenv').config();
// From here on you have access the passwords through process.env.DB_PASS and process.env.CHASTITIY_KEY

Option 2: Command line

Using the script mentioned earlier with the -d flag:

<PROJECT_PATH>/node_modules/.bin/dotenvenc -d myPassword

This can be useful if you corrupt your .env (remember that .env is an unversioned file). With the dotenvenc script you can recreate it to its last functioning state from your .env.enc unless you corrupted that one too by running the Encryption step above on the corrupted .env (then you done!)

NOTE: this only regenerates the .env from the encrypted .env.enc file (no environment variables are created from its contents).

Testing

There are two sample files used for the tests.

File .env.sample with contents:

FOO=bar

and its encrypted counterpart file .env.enc.sample.

To run the tests:

npm t

Inspired by

Install

npm i dotenvenc

DownloadsWeekly Downloads

565

Version

2.0.1

License

none

Unpacked Size

29.9 kB

Total Files

10

Last publish

Collaborators

  • avatar