Find a file
Calvin Leung Huang 9622a351ae docs: add sys/pprof API docs (#7562)
* docs: add sys/pprof api docs

* fix header
2019-10-07 11:55:17 -04:00
.circleci ci: 'atomically' update .circleci/config.yml (#7449) 2019-09-09 15:11:37 +01:00
.github add code of conduct (#6049) 2019-01-15 17:30:33 -08:00
.hooks pre-commit: no fail if circleci missing or too old (#6990) 2019-06-26 15:49:42 +01:00
api go mod vendor and go mod tidy 2019-10-04 09:14:37 -04:00
audit Call goimports as well as gofmt when doing a make fmt (#7148) 2019-07-18 21:04:56 -04:00
builtin Add AES128-GCM96 support to transit (#7555) 2019-10-03 16:11:43 -04:00
command Remove unused code in kv_get.go (#7583) 2019-10-07 10:18:04 -04:00
helper sys: add host-info endpoint (#7330) 2019-10-03 09:43:52 -07:00
http Add config parameter to allow unauthenticated metrics access (#7550) 2019-10-04 09:29:51 +02:00
physical raft: fix TestRaft_Snapshot_Take_Restore (#7443) 2019-09-06 15:20:08 -07:00
plugins/database Combined Database backend: Add Static Account support to MongoDB (#7003) 2019-07-05 14:57:01 -04:00
scripts Bump Go in Dockerfile to 1.12.9 2019-09-09 14:45:14 -04:00
sdk update go.mod and sdk/go.mod 2019-10-04 09:40:23 -07:00
shamir fix typo in comment (#5843) 2018-11-26 09:27:31 -05:00
terraform/aws Prep for 1.2.2 2019-08-14 16:54:16 -04:00
ui do not swallow ControlGroupErrors when viewing or editing kvv2 secrets (#7504) 2019-10-04 13:15:33 -07:00
vault Typo (#7586) 2019-10-07 08:08:18 -07:00
vendor go mod vendor and go mod tidy 2019-10-04 09:14:37 -04:00
website docs: add sys/pprof API docs (#7562) 2019-10-07 11:55:17 -04:00
.gitattributes Update git attributes to fix Linguist 2016-07-01 15:54:16 -04:00
.gitignore Add lockfile for website (#6940) 2019-06-20 17:53:12 -04:00
CHANGELOG.md Update CHANGELOG.md 2019-10-04 14:17:41 -07:00
CONTRIBUTING.md Update contribution guide 2016-01-27 15:17:11 -05:00
go.mod update go.mod and sdk/go.mod 2019-10-04 09:40:23 -07:00
go.sum go mod vendor and go mod tidy 2019-10-04 09:14:37 -04:00
LICENSE Initial commit 2015-02-24 16:15:59 -08:00
main.go Drop cli and meta packages 2017-10-24 09:27:19 -04:00
main_test.go Add canonical import path to main package for those using golang-builder 2015-11-05 16:44:20 -05:00
make.bat Spelling (#4119) 2018-03-20 14:54:10 -04:00
Makefile Update ui dependencies (#7244) 2019-08-19 15:45:39 -05:00
README.md Update Go version in readme 2019-09-27 08:30:02 -07:00

Vault CircleCI 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 getting started guide on Hashicorp's learning platform.

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. Go version 1.12.7+ is required. Note: version 1.13.x is not yet supported.

For local dev first make sure Go is properly installed, including setting up a GOPATH. Ensure that $GOPATH/bin is in your path as some distributions bundle old version of build tools. Next, clone this repository. Vault uses Go Modules, so it is recommended that you clone the repository outside of the GOPATH. 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 compile a development version of Vault Enterprise, run make premdev. Keep in mind this binary will contain a perpetual built-in license and should thus be protected from unauthorized use. Running make premdev will put the Vault binary in the bin and $GOPATH/bin folders:

$ make premdev
...
$ bin/vault
...

To compile a development version of Vault with the UI, run make static-dist dev-ui. This will put the Vault binary in the bin and $GOPATH/bin folders:

$ make static-dist dev-ui
...
$ 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.