decrypt-kms-env

Simple utility for decrypting secure environment variables encrypted using KMS.

Usage

From a Dockerfile/shell

Use v1.x when you need to decrypt secure environment variables in a Dockerfile or shell script. In a failure situation, such as an with an incorrectly encrypted environment variable, this method will result in the process exiting with a non-zero exit code.

This method follows a simple convention whereby:

Encrypted environment variable blobs are prefixed with secure: (e.g., MySecretVar=secure:abcde1234),
Values are decrypted in-place. Scrubbed debug output is provided so you can confirm env vars have been decrypted and set.

Example usage in a Dockerfile:

# Install
RUN curl -sL https://github.com/mapbox/decrypt-kms-env/archive/v1.0.6.tar.gz | tar --gunzip --extract --strip-components=1 --exclude=readme.md --directory=/usr/local

# Decrypt vars and start app
RUN . decrypt-kms-env && \
    npm start

Example Shell usage:

> . decrypt-kms-env
Decrypted SecureValueA=************1231
Decrypted SecureValueB=************913X

From JavaScript/Lambda function

Use v3.x. If you don't have access to a shell to set env vars before starting your app, you can run decrypt-kms-env via JS.

Install:

npm install @mapbox/decrypt-kms-env --save

Use in JS:

var dke = require('@mapbox/decrypt-kms-env');

dke(process.env, function(err, scrubbed) {
  if (err) throw err;
  // Values in process.env are now decrypted.

  // To debug use `scrubbed` instead of logging `process.env` directly.
  // console.log(scrubbed);
});

Point Total	Qualitative Description	Scaled Grade
28+ points	Strongly adheres to eng. standards	5
23-27 points	Adheres to eng. standards fairly well	4
18-22 points	Adheres to some eng. standards	3
13-17 points	Starting to adhere to some eng. standards	2
9-12 points	Following a limited number of eng. standard practices	1
< 9 points	Needs significant work, does not follow most standards	0

mapbox / decrypt-kms-env Goto Github PK

decrypt-kms-env's Introduction

decrypt-kms-env

Usage

From a Dockerfile/shell

Example usage in a Dockerfile:

Example Shell usage:

From JavaScript/Lambda function

decrypt-kms-env's People

Contributors

Stargazers

Watchers

Forkers

decrypt-kms-env's Issues

Required Elements

Rubric

Repo grade: 15 - Scaled Grade 2

Suggestions

Recommend Projects

Recommend Topics

Recommend Org