gocloud.dev: gocloud.dev/secrets/vault Index | Examples | Files

package vault

import "gocloud.dev/secrets/vault"

Package vault provides a secrets implementation using the Transit Secrets Engine of Vault by Hashicorp. Use OpenKeeper to construct a *secrets.Keeper.


For secrets.OpenKeeper, vault registers for the scheme "vault". The default URL opener will dial a Vault server using the environment variables "VAULT_SERVER_URL" and "VAULT_SERVER_TOKEN". To customize the URL opener, or for more details on the URL format, see URLOpener. See https://gocloud.dev/concepts/urls/ for background information.


vault does not support any types for As.


ctx := context.Background()

// secrets.OpenKeeper creates a *secrets.Keeper from a URL.
// The default opener dials a default Vault server based on the environment
keeper, err := secrets.OpenKeeper(ctx, "vault://mykey")
if err != nil {
defer keeper.Close()



Package Files



const Scheme = "vault"

Scheme is the URL scheme vault registers its URLOpener under on secrets.DefaultMux.

func Dial Uses

func Dial(ctx context.Context, cfg *Config) (*api.Client, error)

Dial gets a Vault client.

func OpenKeeper Uses

func OpenKeeper(client *api.Client, keyID string, opts *KeeperOptions) *secrets.Keeper

OpenKeeper returns a *secrets.Keeper that uses the Transit Secrets Engine of Vault by Hashicorp. See the package documentation for an example.


// Get a client to use with the Vault API.
ctx := context.Background()
client, err := vault.Dial(ctx, &vault.Config{
    Token: "<Client (Root) Token>",
    APIConfig: api.Config{
        Address: "",
if err != nil {

// Construct a *secrets.Keeper.
keeper := vault.OpenKeeper(client, "my-key", nil)
defer keeper.Close()

// Now we can use keeper to encrypt or decrypt.
plaintext := []byte("Hello, Secrets!")
ciphertext, err := keeper.Encrypt(ctx, plaintext)
if err != nil {
decrypted, err := keeper.Decrypt(ctx, ciphertext)
if err != nil {
_ = decrypted

type Config Uses

type Config struct {
    // Token is the access token the Vault client uses to talk to the server.
    // See https://www.vaultproject.io/docs/concepts/tokens.html for more
    // information.
    Token string
    // APIConfig is used to configure the creation of the client.
    APIConfig api.Config

Config is the authentication configurations of the Vault server.

type KeeperOptions Uses

type KeeperOptions struct{}

KeeperOptions controls Keeper behaviors. It is provided for future extensibility.

type URLOpener Uses

type URLOpener struct {
    // Client must be non-nil.
    Client *api.Client

    // Options specifies the options to pass to OpenKeeper.
    Options KeeperOptions

URLOpener opens Vault URLs like "vault://mykey".

The URL Host + Path are used as the keyID.

No query parameters are supported.

func (*URLOpener) OpenKeeperURL Uses

func (o *URLOpener) OpenKeeperURL(ctx context.Context, u *url.URL) (*secrets.Keeper, error)

OpenKeeperURL opens the Keeper URL.

Package vault imports 11 packages (graph) and is imported by 1 packages. Updated 2019-05-16. Refresh now. Tools for package owners.