A tool for secrets management, encryption as a service, and privileged access management
Switch branches/tags
0.10.2-extra-db-debug 0.11-upgrade-notes 0.11.5 0.11.6 011-news-update allthingsclowd-patch-1 allthingsclowd-patch-2 api-comma-string-cleanup apidoc approle-status-code audit-hmac auth-polish auto-to-auto-migration aws-ec2-alias base64-barrier-config bootstrap-pki casandra-tests catch-ignored-cg-error catsby-patch-1 cgriggs01-vip-guide combined-db context-aware-backends cubbyhole-upgrade-debug-0.6.5 cubbyhole-upgrade-debug data-version database-grpc-plugins db-cockroachdb db-roll-creds demo-vagrant derived-logging docs-ad-secrets-api docs-aws-sts-updates docs-basic-concepts-tokens docs-hsm-reqs docs-namespaces-concepts docs-openapi-path-help docs-ref-architecture dynamo encrypted-key-storage exp-router-middleware f-flat-revoke f-std-logs fix-2080 fix-broken-link fix-max-request-duration fixpartnerdocs gojay hclog-refactor identity-list-data init-cubbyhole inparse intro-redirect issue-4957 jbardin/panic-at-the-hashstructure je.netlify-deploy je.new-docs je.website-local-run-docs jwt-on-ice jwt-sermo-to-square kv-mount-versioning-init ldap-alias-fix ldap-testing lease-restore-shutdown llupdates locksutil-uses-slice master matt-debug metrics-secrets-engine-transit move-identity-docs mrktfix namespace-docs-updates namespace-edit namespaces-docs nomad-token-length ns-only-msg oas-path-help openapi-path-updates oss-identity-port paddy_command_config partnerships-docs partnerships-patch plugin-env-test pr-5741/hashicorp/ui/specify-node-version profile-0.10.3 rel-0.9.3 replication revert-5415-partnership-broken-links roooms-patch-1 seal-key-upgrade sethvargo/context-doc sidebar-links stable-website storagepacker_v2 synthesized-config token-store-cleanup tokenhelper ts-memdb tune-up type-enhancements ui-no-babel-polyfill ui-no-jquery ui-replication-use-features ui-wizard-secrets-pause ui-wizards-machines ui/mask-ldap-config unseal-keys-uuid update-aws-deps-lite update-aws-deps urlencoded-params vlt041-storage wizard-secrets-auth
Nothing to show
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github ask-a-question: remove mobile link (#5426) Sep 27, 2018
.hooks The big one (#5346) Sep 18, 2018
api Update backwards compat fix from 5913 Dec 12, 2018
audit Batch tokens (#755) Oct 15, 2018
builtin Strip empty strings from database revocation stmts (#5955) Dec 14, 2018
command Update backwards compat fix from 5913 Dec 12, 2018
helper Strip empty strings from database revocation stmts (#5955) Dec 14, 2018
http Update handler_test.go Nov 19, 2018
logical Strip empty strings from database revocation stmts (#5955) Dec 14, 2018
physical Update encoding.go Nov 19, 2018
plugins Merge branch 'master-oss' into 1.0-beta-oss Oct 19, 2018
scripts Attempt to fix dockerfile again Dec 14, 2018
shamir fix typo in comment (#5843) Nov 26, 2018
terraform/aws Prep for release Dec 14, 2018
ui add an auth-config adapter for jwt so that configs can be saved prope… Dec 12, 2018
vault Default seal type to Shamir on older seal configs (#5956) Dec 14, 2018
vendor Update plugins Dec 14, 2018
version Prep for release Dec 14, 2018
website Upgrade guide for 0.11.6 Dec 14, 2018
.gitattributes Update git attributes to fix Linguist Jul 1, 2016
.gitignore New Docs Website (#5535) Oct 19, 2018
.travis.yml UI - new token renew banner (#5662) Nov 5, 2018
CHANGELOG.md Update plugins Dec 14, 2018
CONTRIBUTING.md Update contribution guide Jan 27, 2016
LICENSE Initial commit Feb 25, 2015
Makefile UI husky (#5752) Nov 14, 2018
README.md Update intro link in README (#5775) Nov 13, 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 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 (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.