Skip to content

Latest commit

 

History

History
73 lines (54 loc) · 3.35 KB

readme.md

File metadata and controls

73 lines (54 loc) · 3.35 KB
Raw

vault4summon: this project implements a CyberArk Summon provider using Hashicorp Vault as secrets provider.

This project is distributed under the terms of the European Union Public Licence (EUPL) Version 1.2 or newer.` You can find the latest version of the EUPL licence here.

Quick start

  • Get vault4summon
    • Download it or build it if you have a Go compiler. I use always the latest increment and try to upgrade as soon as possible to the latest version.
  • Install
    • Install Summon if you don't have it already installed
    • Copy vault4summon to /usr/local/lib/summon/
  • Configure
    • Set the environment variables to access Hashicorp Vault. vault4summon supports same environment variables as 'vault kv get' command.
  • Create a secrets.yml file
  • Use Summon

Summon provider contract

Providers for Summon are easy to write. Given the identifier of a secret, they either return its value or an error.

There is the contract:

  • They take one and only one argument, the identifier of a secret (a string). The argument can also be a flag with value -v or --version. The provider must return his version on stdout.

  • If retrieval is successful, they return the value on stdout with exit code 0.

  • If an error occurs, they return an error message on stderr with a non-0 exit code.

  • The default path for providers is /usr/local/lib/summon/. If one provider is in that path, summon will use it. If multiple providers are in the path, you can specify which one to use with the --provider flag, or the environment variable SUMMON_PROVIDER. If your providers are placed outside the default path, give summon the full path to them.

  • Variable IDs are used as identifiers for fetching Secrets. These are made up of a secret name (required) and secret key path (optional).

The Vault CLI to retrieve a secret is

vault kv get -field=mysecretkeypath secret/name

This provider has 2 implemented formats for Variable ID:

So the two commands below return the same value

summon --provider vault4summon --yaml 'hello: !var secret/name#mysecretkeypath' printenv hello

summon --provider vault4summon --yaml 'hello: !var secret/name/mysecretkeypath' printenv hello

Contributing guidelines

If you would like to contribute code to vault4summon you can do so through GitHub by forking the repository and sending a pull request.

When submitting code, please make efforts to follow existing conventions and style in order to keep the code as readable as possible. Please also make sure your code compiles and passes tests.