@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

    Keywords

    none

    Install

    npm i @ovotech/ssm-env-secrets

    DownloadsWeekly Downloads

    8

    Version

    1.0.1

    License

    Apache-2.0

    Unpacked Size

    9.69 kB

    Total Files

    17

    Last publish

    Collaborators

    • markberesford301
    • ovo-homeplan
    • rupson
    • oeptariffs
    • nisheeth
    • fgkramer-klz
    • tony.ross
    • bvjones
    • data.discovery.ovo
    • ralitsa
    • fraserhamiltonovo
    • accrecovo
    • luigi.riefolo
    • andy-heywood-ovo
    • rmcnovo
    • mgdigital-mike
    • sureshmandalapu
    • ggerikp
    • xnejp03
    • emmapr123
    • andrew-brook-rad
    • a.calderwood
    • sulgee.kim
    • sseccombe
    • samcooper720x
    • lughino
    • vlabinskyy-corgi
    • amayuk
    • jagreenwood1
    • mbayoumy
    • radek_tomasek
    • clarencedglee
    • ovocms
    • ovotech-sme-team
    • gjain-npm-ovo
    • kenneth-gray
    • philip-ovo
    • nevenablagoeva
    • pete-woodland
    • orion-migration-team
    • ovotech-sg
    • chanex
    • ovotech-qs
    • kelveden
    • ovotech-paym
    • ovotech-payments
    • ovotech-live
    • ovotech-payg
    • freddybushboy
    • sarahlikeshiny
    • r.midyk
    • ovotech-boost
    • agaovo
    • filose
    • tomverran-ovo
    • props
    • vanyakurdup
    • yesdaveovo
    • rob-ovo
    • ellafutkowska
    • ikerin
    • mwidurek
    • andreaborsos
    • tomshawovo
    • dmytro.kubatko
    • ovotech-identity
    • mike.panayotov
    • iuna4e
    • lcatallo
    • orex-team
    • ahvargas
    • cwkaluza
    • smart-heat-uat
    • smart-heat-prod
    • potsec
    • rosario-ovo
    • tech.international
    • tozzy
    • jvmovo
    • boost-smile
    • nicolasov
    • ovo.cms.devs
    • mkohlmyr
    • sketchingdev
    • mrkiplin
    • ovo-devices
    • sophiepoole
    • joepurnell-ovo
    • gmbovo
    • molbalazs
    • joewhittles
    • sampennington64
    • marcusgriff
    • amelia.ovo
    • juliabutterly
    • chris.smith
    • sophiesillmanovo
    • marcesquerra
    • pedoublety
    • ovo-engagement
    • tokict
    • marcuskielly
    • david.chellapah.ovo
    • kupxc
    • harrisonbaxter
    • apjm
    • shnist
    • mikemchugh
    • sarahbeharry
    • ursularodgers
    • inlustra
    • andrewjtn
    • tarlingovo
    • troyb95
    • david.ovo
    • ovoenergyapps
    • marina-ovo
    • tom-g-dane
    • homemoves
    • samwest
    • sophiefield
    • simonmclean-ovo
    • jamesbaum
    • robert-g-j
    • peterwilkins
    • paceteamkaluza
    • henrywoodsend
    • ovo-oot-bot
    • stuharv-ovo
    • eddiec86
    • richardjonesovo
    • csherwin
    • g-tibbs
    • puzzledbytheweb
    • adryanovo
    • lewright
    • pedro.caldeira
    • aidenscott2016
    • keirlawson
    • dwfullerton
    • gordok
    • darrenthomas-sse
    • seagullmouse
    • markwood23
    • timsteeleovo
    • jacktreble
    • gordon-rennie-ovo
    • adam-mcdevitt
    • jkiely
    • ovo-dc
    • orion-digital-support-experience
    • ovotech-smart-thermostat
    • yahmad
    • inbrewj
    • kelemensanyi
    • wtaylor-ovo
    • jrdavenport
    • dleyland-ovo
    • rob.desbois
    • sicrossley
    • joey.ciechanowicz
    • lewisdick-ovo
    • sjmann
    • stevemossovo
    • nbrites
    • eduardolaranjo
    • unibozu
    • cp-ui-tooling
    • lenardprattovo
    • dieman89
    • jensraaby-ovo
    • anthonysmithovo
    • jacobthwaitesovo
    • tom.sherman
    • tomlloyd
    • matyas-ovo
    • jamesnoble1
    • phil-pinkowski
    • ovo-aarongibbison
    • nebuladesignsystem
    • ovo-matt-hodges
    • luke-adams-ovo
    • ovolly
    • j_kapella
    • mike.walters
    • bgzstephen
    • matthewbursteinovo
    • kslat3r
    • petro.pavlenko
    • mtardugno-ovo
    • vslepkan
    • zoelanham
    • suhaelovo
    • jchoskins
    • vholovko
    • tom.mottram.kaluza
    • anhnguyenis
    • eddwilliamsovo
    • ewan-m
    • mishabruml
    • maciek-kaluza
    • mollyboyle
    • vmary
    • babickd
    • mugishau
    • vkobyletskyi_ovo
    • mykola.p
    • peterh-ovo
    • dvidg
    • ahmediieovo
    • nickfitton-ovo
    • apgoodier
    • dave.allison
    • tom-greenwood
    • oep-accounts-bot
    • cbousie
    • j.okeefe
    • kir_exp
    • ursula_rodgers
    • jgarciapaj
    • petegrace
    • retrojetpacks
    • benaston13
    • ovo-bit-tech
    • fulvio.ovo
    • blair.calderwood.radically
    • pedromss
    • petro.shevchuk.corgi
    • v.kolesnyk
    • simonlewissse
    • benm13563
    • joolskaluza
    • s.sosnytskyi
    • vlavrynenko-nix
    • jifarra-kaluza
    • jameswelshkaluza
    • kimnil
    • carolinelywood
    • mike-gregory-kaluza
    • vasil.dininski
    • olesiapaslavska
    • sir_hiss
    • humancatfood
    • javapyscript
    • csillabarna
    • luca.sale
    • friendigo
    • oroberts221
    • pedro.costa.kaluza
    • jelaxshan
    • onishchenko
    • kevin.gilmore
    • annebeth-ovo
    • kostyagromov92
    • quartin
    • crack.design
    • georgexcollins
    • kapikaluza
    • v.vasylets
    • iovana.pavlovici
    • filosganga
    • chris.brindley
    • engagement-insights
    • hentielouw
    • jaws-bot
    • leaski
    • elliekempster91
    • zoejm
    • rekaelek-ovo
    • nathanmarshovo
    • robturnerovo
    • dsingh07
    • ovo-james
    • jthomasovo
    • vitalii_khudenko