{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/587", "result": {"data":{"issuesJson":{"id":"d8d5886c-1878-5ef6-b180-256e1949fa4b","title":"hashicorp/vault: 一个用于密钥管理、加密服务和访问权限管理的工具","number":587,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposhashicorp/vault
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

Vault \"build\" \"ci\" \"vault

\n
\n

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.

\n
\n\n

\"Vault

\n

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.

\n

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.

\n

The key features of Vault are:

\n\n

Documentation, Getting Started, and Certification Exams

\n

Documentation is available on the Vault website.

\n

If you're new to Vault and want to get started with security automation, please
\ncheck out our Getting Started guides
\non HashiCorp's learning platform. There are also additional guides
\nto continue your learning.

\n

For examples of how to interact with Vault from inside your application in different programming languages, see the vault-examples repo. An out-of-the-box sample application is also available.

\n

Show off your Vault knowledge by passing a certification exam. Visit the
\ncertification page
\nfor information about exams and find study materials
\non HashiCorp's learning platform.

\n

Developing Vault

\n

If you wish to work on Vault itself or any of its built-in systems, you'll
\nfirst need Go installed on your machine.

\n

For local dev first make sure Go is properly installed, including setting up a
\nGOPATH, then setting the
\nGOBIN variable to $GOPATH/bin.
\nEnsure that $GOPATH/bin is in your path as some distributions bundle the old version
\nof build tools.

\n

Next, clone this repository. Vault uses Go Modules,
\nso it is recommended that you clone the repository outside of the GOPATH.
\nYou can then download any required build tools by bootstrapping your environment:

\n
$ make bootstrap\n...
\n

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

\n
$ make dev\n...\n$ bin/vault\n...
\n

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

\n
$ make static-dist dev-ui\n...\n$ bin/vault\n...
\n

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

\n
$ make test\n...
\n

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

\n
$ make test TEST=./vault\n...
\n

Troubleshooting

\n

If you encounter an error like could not read Username for 'https://github.com' you may need to adjust your git config like so:

\n
$ git config --global --add url.\"git@github.com:\".insteadOf \"https://github.com/\"
\n

Importing Vault

\n

This repository publishes two libraries that may be imported by other projects:
\ngithub.com/hashicorp/vault/api and github.com/hashicorp/vault/sdk.

\n

Note that this repository also contains Vault (the product), and as with most Go
\nprojects, Vault uses Go modules to manage its dependencies. The mechanism to do
\nthat is the go.mod file. As it happens, the presence of that file
\nalso makes it theoretically possible to import Vault as a dependency into other
\nprojects. Some other projects have made a practice of doing so in order to take
\nadvantage of testing tooling that was developed for testing Vault itself. This
\nis not, and has never been, a supported way to use the Vault project. We aren't
\nlikely to fix bugs relating to failure to import github.com/hashicorp/vault
\ninto your project.

\n

See also the section \"Docker-based tests\" below.

\n

Acceptance Tests

\n

Vault has comprehensive acceptance tests
\ncovering most of the features of the secret and auth methods.

\n

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

\n

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

\n

To run the acceptance tests, invoke make testacc:

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

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

\n

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

\n

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

\n

Docker-based Tests

\n

We have created an experimental new testing mechanism inspired by NewTestCluster.
\nAn example of how to use it:

\n
import (\n  \"testing\"\n  \"github.com/hashicorp/vault/sdk/helper/testcluster/docker\"\n)\n\nfunc Test_Something_With_Docker(t *testing.T) {\n  opts := &docker.DockerClusterOptions{\n    ImageRepo: \"hashicorp/vault\", // or \"hashicorp/vault-enterprise\"\n    ImageTag:    \"latest\",\n  }\n  cluster := docker.NewTestDockerCluster(t, opts)\n  defer cluster.Cleanup()\n  \n  client := cluster.Nodes()[0].APIClient()\n  _, err := client.Logical().Read(\"sys/storage/raft/configuration\")\n  if err != nil {\n    t.Fatal(err)\n  }\n}
\n

Or for Enterprise:

\n
import (\n  \"testing\"\n  \"github.com/hashicorp/vault/sdk/helper/testcluster/docker\"\n)\n\nfunc Test_Something_With_Docker(t *testing.T) {\n  opts := &docker.DockerClusterOptions{\n    ImageRepo: \"hashicorp/vault-enterprise\",\n    ImageTag:  \"latest\",\n\tVaultLicense: licenseString, // not a path, the actual license bytes\n  }\n  cluster := docker.NewTestDockerCluster(t, opts)\n  defer cluster.Cleanup()\n}
\n

Here is a more realistic example of how we use it in practice. DefaultOptions uses
\nhashicorp/vault:latest as the repo and tag, but it also looks at the environment
\nvariable VAULT_BINARY. If populated, it will copy the local file referenced by
\nVAULT_BINARY into the container. This is useful when testing local changes.

\n

Instead of setting the VaultLicense option, you can set the VAULT_LICENSE_CI environment
\nvariable, which is better than committing a license to version control.

\n

Optionally you can set COMMIT_SHA, which will be appended to the image name we
\nbuild as a debugging convenience.

\n
func Test_Custom_Build_With_Docker(t *testing.T) {\n  opts := docker.DefaultOptions(t)\n  cluster := docker.NewTestDockerCluster(t, opts)\n  defer cluster.Cleanup()\n}
\n

There are a variety of helpers in the github.com/hashicorp/vault/sdk/helper/testcluster
\npackage, e.g. these tests below will create a pair of 3-node clusters and link them using
\nPR or DR replication respectively, and fail if the replication state doesn't become healthy
\nbefore the passed context expires.

\n

Again, as written, these depend on having a Vault Enterprise binary locally and the env
\nvar VAULT_BINARY set to point to it, as well as having VAULT_LICENSE_CI set.

\n
func TestStandardPerfReplication_Docker(t *testing.T) {\n  opts := docker.DefaultOptions(t)\n  r, err := docker.NewReplicationSetDocker(t, opts)\n  if err != nil {\n      t.Fatal(err)\n  }\n  defer r.Cleanup()\n\n  ctx, cancel := context.WithTimeout(context.Background(), time.Minute)\n  defer cancel()\n  err = r.StandardPerfReplication(ctx)\n  if err != nil {\n    t.Fatal(err)\n  }\n}\n\nfunc TestStandardDRReplication_Docker(t *testing.T) {\n  opts := docker.DefaultOptions(t)\n  r, err := docker.NewReplicationSetDocker(t, opts)\n  if err != nil {\n    t.Fatal(err)\n  }\n  defer r.Cleanup()\n\n  ctx, cancel := context.WithTimeout(context.Background(), time.Minute)\n  defer cancel()\n  err = r.StandardDRReplication(ctx)\n  if err != nil {\n    t.Fatal(err)\n  }\n}
\n

Finally, here's an example of running an existing OSS docker test with a custom binary:

\n
$ GOOS=linux make dev\n$ VAULT_BINARY=$(pwd)/bin/vault go test -run 'TestRaft_Configuration_Docker' ./vault/external_tests/raft/raft_binary\nok      github.com/hashicorp/vault/vault/external_tests/raft/raft_binary        20.960s
","updatedAt":"2025-05-22T01:52:09Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"hashicorp","color":"5ab310"}},{"node":{"name":"Secret","color":"25891f"}}]},"comments":{"edges":[]}}},"pageContext":{"number":587,"previous":{"title":"astral-sh/uv: 一个用 Rust 编写的极快的 Python 包和项目管理器。","number":586},"next":{"title":"vectordotdev/vector: 高性能、高可靠、可观察的数据管道, 性能比 Logstash 强很多","number":588}}}, "staticQueryHashes": ["151096407","2861350382"]}