A tool for managing secrets.
Go Other
Latest commit f1c8b77 Jan 13, 2017 @vishalnayak vishalnayak committed on GitHub Merge pull request #2273 from hashicorp/doc-remove-429-code
doc: remove unused 429 code from docs to avoid confusion
Permalink
Failed to load latest commit information.
api Use Vault client's scheme for auto discovery (#2146) Dec 2, 2016
audit When a JWT wrapping token is returned, audit the inner token both for Jan 5, 2017
builtin Merge pull request #2152 from mr-tron/master Jan 13, 2017
cli Rejig where the reload functions live Sep 30, 2016
command init: pgp-keys input validations Jan 12, 2017
helper Add Duo pushinfo capabilities (#2118) Dec 19, 2016
http rekey: pgp keys input validation Jan 12, 2017
logical Port over some work to make the system views a bit nicer Jan 13, 2017
meta Update text around cubbyhole/response Sep 29, 2016
physical Add require consistent flag to Consul Lock Jan 13, 2017
scripts Prep for 0.6.3 Dec 6, 2016
shamir Fix shamir test that is failing on valid results Dec 16, 2016
terraform/aws Bump TF varibles number Dec 16, 2016
vault add initialize method to noopbackend Jan 13, 2017
vendor Bump deps Jan 13, 2017
version Fix revocation of leases when num_uses goes to 0 (#2190) Dec 16, 2016
website doc: remove unused 429 code from docs to avoid confusion Jan 14, 2017
.gitattributes Update git attributes to fix Linguist Jul 1, 2016
.gitignore Update gitignore Dec 14, 2016
.travis.yml Clustering enhancements (#1747) Aug 19, 2016
CHANGELOG.md changelog++ Jan 13, 2017
CONTRIBUTING.md Update contribution guide Jan 27, 2016
LICENSE Initial commit Feb 25, 2015
Makefile Update Makefile protoc commands Jan 6, 2017
README.md Add gitter badge Oct 6, 2016
main.go Add canonical import path to main package for those using golang-builder Nov 5, 2015
main_test.go Add canonical import path to main package for those using golang-builder Nov 5, 2015
make.bat s/TF_ACC/VAULT_ACC Apr 5, 2016

README.md

Vault Build Status Join the chat at https://gitter.im/hashicorp-vault/Lobby

Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault, please responsibly disclose by contacting us at security@hashicorp.com.

Vault

Vault is a tool for securely accessing secrets. A secret is anything that you want to tightly control access to, such as API keys, passwords, certificates, and more. Vault provides a unified interface to any secret, while providing tight access control and recording a detailed audit log.

A modern system requires access to a multitude of secrets: database credentials, API keys for external services, credentials for service-oriented architecture communication, etc. Understanding who is accessing what secrets is already very difficult and platform-specific. Adding on key rolling, secure storage, and detailed audit logs is almost impossible without a custom solution. This is where Vault steps in.

The key features of Vault are:

  • Secure Secret Storage: Arbitrary key/value secrets can be stored in Vault. Vault encrypts these secrets prior to writing them to persistent storage, so gaining access to the raw storage isn't enough to access your secrets. Vault can write to disk, Consul, and more.

  • Dynamic Secrets: Vault can generate secrets on-demand for some systems, such as AWS or SQL databases. For example, when an application needs to access an S3 bucket, it asks Vault for credentials, and Vault will generate an AWS keypair with valid permissions on demand. After creating these dynamic secrets, Vault will also automatically revoke them after the lease is up.

  • Data Encryption: Vault can encrypt and decrypt data without storing it. This allows security teams to define encryption parameters and developers to store encrypted data in a location such as SQL without having to design their own encryption methods.

  • Leasing and Renewal: All secrets in Vault have a lease associated with it. At the end of the lease, Vault will automatically revoke that secret. Clients are able to renew leases via built-in renew APIs.

  • Revocation: Vault has built-in support for secret revocation. Vault can revoke not only single secrets, but a tree of secrets, for example all secrets read by a specific user, or all secrets of a particular type. Revocation assists in key rolling as well as locking down systems in the case of an intrusion.

For more information, see the introduction section of the Vault website.

Getting Started & Documentation

All documentation is available on the Vault website.

Developing Vault

If you wish to work on Vault itself or any of its built-in systems, you'll first need Go installed on your machine (version 1.7+ is required).

For local dev first make sure Go is properly installed, including setting up a GOPATH. Next, clone this repository into $GOPATH/src/github.com/hashicorp/vault. You can then download any required build tools by bootstrapping your environment:

$ make bootstrap
...

To compile a development version of Vault, run make or make dev. This will put the Vault binary in the bin and $GOPATH/bin folders:

$ make dev
...
$ bin/vault
...

To run tests, type make test. Note: this requires Docker to be installed. If this exits with exit status 0, then everything is working!

$ make test
...

If you're developing a specific package, you can run tests for just that package by specifying the TEST variable. For example below, only vault package tests will be run.

$ make test TEST=./vault
...

Acceptance Tests

Vault has comprehensive acceptance tests covering most of the features of the secret and auth backends.

If you're working on a feature of a secret or auth backend and want to verify it is functioning (and also hasn't broken anything else), we recommend running the acceptance tests.

Warning: The acceptance tests create/destroy/modify real resources, which may incur real costs in some cases. In the presence of a bug, it is technically possible that broken backends could leave dangling data behind. Therefore, please run the acceptance tests at your own risk. At the very least, we recommend running them in their own private account for whatever backend you're testing.

To run the acceptance tests, invoke make testacc:

$ make testacc TEST=./builtin/logical/consul
...

The TEST variable is required, and you should specify the folder where the backend is. The TESTARGS variable is recommended to filter down to a specific resource to test, since testing all of them at once can sometimes take a very long time.

Acceptance tests typically require other environment variables to be set for things such as access keys. The test itself should error early and tell you what to set, so it is not documented here.