@ovotech/ssm-env-secrets
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

SSM ENV Secrets

CircleCI npm (scoped)

This function is loads data from AWS Systems Manager (SSM) Parameter Store. This way you can securely store secrets and retrieve them at runtime in production, but rely on dummy values in dev/testing.

This module ships with TypeScript types.

Using

yarn add @ovotech/ssm-env-secrets

If you have a parameter in SSM Parameter store called my-secret-key with your secret value. And your env vars look like this:

NODE_ENV=something
API_ID=my-id
API_KEY=ssm://my-secret-key

Then you can load the secret values with:

import { loadSSMSecrets } from '@ovotech/ssm-env-secrets';
import { SSM } from 'aws-sdk';

const ssm = new SSM({ region: 'eu-west-1' });
const env = loadSSMSecrets(ssm, process.env);

console.log(env.API_KEY); // will hold the decrypted value of "my-secret-key" parameter

Running the tests

The tests require a running ssm mock server, and we're using localstack for that. You'll need to start the ssm server:

SERVICES=ssm localstack start

After which you can run all the tests:

yarn test

Coding style (linting, etc) tests

Style is maintained with prettier and tslint

yarn lint

Deployment

To deploy a new version, push to master and then create a new release. CircleCI will automatically build and deploy a the version to the npm registry.

Contributing

Have a bug? File an issue with a simple example that reproduces this so we can take a look & confirm.

Want to make a change? Submit a PR, explain why it's useful, and make sure you've updated the docs (this file) and the tests (see test/S3DataSource.spec.ts). You can run the tests with SERVICES=ssm localstack start and yarn test.

Responsible Team

  • Boost Internal Tools (BIT)

License

This project is licensed under Apache 2 - see the LICENSE file for details

Readme

Keywords

none

Package Sidebar

Install

npm i @ovotech/ssm-env-secrets

Weekly Downloads

2

Version

1.0.1

License

Apache-2.0

Unpacked Size

9.69 kB

Total Files

17

Last publish

Collaborators

  • ovox
  • oep-accounts-bot
  • ovo.backstage.admins
  • bookings-team
  • orion-bot
  • bizval-bot
  • oeptariffs
  • props
  • metering-reads-health-bot
  • ovotech-identity
  • paceteamkaluza
  • trading-and-dispatch
  • retail-payg-tech
  • accrecovo
  • ovo.trading.tech
  • qe-team
  • ovotech-smart-thermostat
  • rise-team
  • engagement-insights
  • myovo-self-serve-service-account
  • mars-rover
  • ape-team
  • kaluza-devex
  • ohs-aurora
  • kaluza-rnr
  • ipa-bot
  • kawbot
  • data.discovery.ovo
  • ovotech-sg
  • ovotech-qs
  • ovoenergyapps
  • homemoves
  • ovo-oot-bot
  • cp-ui-tooling
  • ovo-bit-tech
  • sir_hiss