SECRETS

Secrets is a tool to help manage your application's development secrets within a Team.

Installation

Keybase 0.18 or later is required.

$ brew tap bugcrowd/cartons
$ brew install bugcrowd/cartons/secrets

How it Works

Secrets encrypts your secrets to a .secrets directory, which should then be committed to git. This coupling of secrets with code ensures that when the application is executed, it will have the correct secrets configuration. To grant your team mates access to the secrets repository simply do secrets members add ${keybase_username}.

The encryption is performed by the local Keybase service running on your machine. This allows Secrets to pass off all the hard work of making sure encryption is done right to Keybase. It also means Secrets doesn't need access to your Keybase authentication details. As long as you are logged into Keybase on your local machine Secrets can communicate to it via a socket.

Usage

Initialize a Secrets repository

$ secrets init

Set a variable

$ secrets set key=value

Get a variable

$ secret get key

Export all variables in a human friendly format

$ secrets export

Export all variables in JSON format

$ secrets export -f json

List all members

$ secrets members

Add one or more members

All members added to secrets require a Keybase device key.

$ secrets members add ${keybase_username}

Remove one or more members

$ secrets members remove ${keybase_username}

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.