Env-hide NPM | npm.io

Env-Hide

Secure your .env file with a password/ Secret SALT and use it in your project. Encrypt / decrypt your .env files. Hide your environment variables from the world. You can set that Secret salt as System Env using AWS task defination, or directly using your cloud service provider to enhance the overall app security. Hide your environment variables.

Install

npm install -g env-hide

Usage CLI

Usage: env-hide -k YOUR_SECRET_KEY

Options:

  -k, --key          YOUR_SECURITY_SALT (required)
  -o, --operation    encrypt/decrypt (required)
  -h, --help         output usage information
  -p, --path         file path (optional)
  -a, --algo         algorith to use, default: 'aes-256-ctr' (optional)
  -f, --file         output decrypted file? true/false (optional)

Encrypt .env using cli

    env-hide -o encrypt -k YOUR_SECRET_KEY

Decrypt .env.enc to OUTPUT Original .env using cli

    env-hide -o decrypt -k YOUR_SECRET_KEY -f true

Encrypt .env to Generate .env.enc (NODE JS)

const envHide = require('env-hide');
envHide.encrypt({ key: SECRET_KEY_SALT});

Decrypt .env.enc (NODE JS)

const envHide = require('env-hide');

const envs = envHide.decrypt({ key: SECRET_KEY_SALT});
console.log(envs);

Argument Keys :decrypt({})

Parameter	Type	Description
`key`	`string`	secret_key, default: `null`, required:`true`
`algo`	`string`	algo to decrypt: `aes-256-ctr`
`enc`	`string`	enc file name , default: `.env.enc`
`addToProcess`	`boolean`	automatically add to process.env, default: `true`
`realOutput`	`boolean`	return actual output(decrypted) of encrpted file, default: `false`
`outputDecryptFile`	`boolean`	automatically create original .env file back, default: `false`

Argument Keys :encrypt({})

Parameter	Type	Description
`key`	`string`	secret_key, default: `null`, required:`true`
`algo`	`string`	algo to decrypt: `aes-256-ctr`
`env`	`string`	env file to encrypt , default: `.env`
`output`	`boolean`	return encryted output, default: `false`