1.0.1 • Published 3 years ago

haven-secrets-cli v1.0.1

Weekly downloads
5
License
MIT
Repository
github
Last release
3 years ago

LS-BrandDev-Haven_logo-full-on_light

shields.io npm version badge shields.io npm license badge shields.io github closed pull requests badge shields.io custom website link badge

Haven is an open-source, centralized secrets manager. It protects your application secrets through a combination of encryption, access control, and injection-at-runtime. It’s easy to set up, and offers an intuitive GUI to set fine-grained access controls and to view logs. Haven allows small teams to securely manage all of their projects’ secrets---and to do so with a minimum of hassle so that they can get back to developing their applications without sacrificing security.

This package allows you to use a CLI to interact with your Haven instance. If you would prefer a GUI, use the Haven UI package instead. Both of these use the Haven package under the hood to interact with the AWS architecture that makes up Haven.

Usage as Admin

To use, you must first have an AWS account set up, your default credentials setup in ~/.aws/credentials and your region setup in ~/.aws/config.

Example ~/.aws/credentials:

[default]
aws_access_key_id=AKIAIOSFODNN7EXAMPLE
aws_secret_access_key=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Example ~/.aws/config:

[default]
region=us-west-2
output=json

After that, simply:

  1. Install the npm package globally (sudo npm -g install haven-secrets-cli)
  2. Run haven setup ${region} specifying what supported region you want your Haven instance to be setup.
  3. After setup, run any of the commands mentioned in the next section.
  4. To create a new user, run haven addUser ${userName} passing in the user's name. This will
  5. To teardown, simply run haven teardown.

Usage as Developer

you don't need an AWS account setup since all users of a Haven instance use the account used during the setup by Admin

  1. Install the npm package globally (sudo npm -g install haven-secrets-cli)
  2. Place the havenAccountInfo.json file into a ~/.haven directory.
  3. Run haven userSetup within an hour after the Admin created your acccount.

Commands

Dependencies

  • Node.js 12.x or greater
  • npm packages (installed during npm install):
    • commander
    • haven-secrets-core
    • prompts