A tool for secrets management, encryption as a service, and privileged access management
Go JavaScript HTML CSS Shell HCL Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Update issue templates May 18, 2018
.hooks Fix hook Sep 4, 2017
api Remove injection into top routes (#5101) Aug 14, 2018
audit Changes the way policies are reported in audit logs (#4747) Jun 14, 2018
builtin Make AWS credential types more explicit (#4360) Aug 16, 2018
command Remove injection into top routes (#5101) Aug 14, 2018
helper Add check of truncated length (#5109) Aug 15, 2018
http Fix http tests Aug 14, 2018
logical Remove injection into top routes (#5101) Aug 14, 2018
physical Add support for "sovereign" Azure cloud environments (#4997) Aug 15, 2018
plugins Make base62.Random truncation optional (#5100) Aug 14, 2018
scripts Re-add dockertest and fix up imports and update script (#4909) Jul 11, 2018
shamir Errwrap everywhere (#4252) Apr 5, 2018
terraform/aws Prep for 0.10.4 Jul 25, 2018
ui Add tokenGroups and tokenGroupsGlobalAndUniversal (#4936) Aug 13, 2018
vault ACL Templating (#4994) Aug 15, 2018
vendor Alibaba Object Storage support (#4783) Aug 13, 2018
version Prep for 0.10.4 Jul 25, 2018
website Make AWS credential types more explicit (#4360) Aug 16, 2018
.gitattributes Update git attributes to fix Linguist Jul 1, 2016
.gitignore VSI (#4985) Jul 25, 2018
.travis.yml Bump Travis Go version Jun 9, 2018
CHANGELOG.md changelog++ Aug 15, 2018
CONTRIBUTING.md Update contribution guide Jan 27, 2016
LICENSE Initial commit Feb 25, 2015
Makefile FoundationDB physical backend (#4900) Jul 16, 2018
README.md Mrktfix (#4411) Apr 20, 2018
main.go Drop cli and meta packages Oct 24, 2017
main_test.go Add canonical import path to main package for those using golang-builder Nov 5, 2015
make.bat Spelling (#4119) Mar 20, 2018

README.md

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


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 Logo

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.10.1+ 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 methods.

If you're working on a feature of a secret or auth method 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.

For more information on Vault Enterprise features, visit the Vault Enterprise site.