vault_dump

Vault Dump

Description

Dumps and restores secrets from Hashicorp Vault into GPG2 encrypted JSON files.

Disclaimer

⚠ This is a personal project and my first real venture into Golang, I cannot guarantee that a restore will be consistent with what was previously backed up. Use this code at your own risk!

Supported secret mount types

• KV (v1)
• KV (v2)
• Transit

Usage

For help, run ./vault_dump --help

Dump and restore secrets from Hashicorp Vault

Usage:
  vault_dump [flags]
  vault_dump [command]

Available Commands:
  completion  generate the autocompletion script for the specified shell
  dump        Dump Vault to an encrypted JSON file
  help        Help about any command
  restore     Restore an encrypted JSON dump to Vault

Flags:
  -x, --debug     enable debug output
  -h, --help      help for vault_dump
  -j, --json      print logs in JSON format
  -v, --version   show vault_dump version

Use "vault_dump [command] --help" for more information about a command.

Dump prerequisites

To dump, you need to ensure you have the following:

• Network access to your Vault instance, with the VAULT_ADDR environment variable defined.

• To be authenticated with Vault (uses VAULT_TOKEN environment variable or .vault-token file in your home directory).

• An GPG2 key that you have the private key for, you only need the public key to encrypt, however to decrypt you will need the corresponding private key.

• Permission to list and read secrets, sample policy below:

  path "*" {
      capabilities = ["read", "list"]
  }
  

Example dump command using multiple public keys:

$ ./vault_dump \
    dump \
    --file="$(date +%s).json.asc" \
    --key=me.at.email.com.pub \  # This is one public key
    --key=you.at.email.com.pub   # This is another public key

Example dump command using a private key (not recommended):

$ ./vault_dump \
    dump \
    --file="$(date +%s).json.asc" \
    --passphrase="yo_r-Str0ng-Pa55-phRaSe" \ # This can also be specified with VAULT_DUMP_PASSPHRASE environment variable
    --key=me.at.email.com.asc  # This is a private key

Restore prerequisites

To restore a dump, you will need the following:

• Network access to your Vault instance, with the VAULT_ADDR environment variable defined.
• To be authenticated with Vault (uses VAULT_TOKEN environment variable or .vault-token file in your home directory).
• The secret portion of the GPG key used to encrypt the dump.
• The passphrase for the GPG key secret.
• Mount points to already be present in Vault (vault_dump will attempt to re-create mounts if you specify the --recreate-mounts flag, however this is not default behavior).
• Write access to each mount.

Example command:

$ ./vault_dump \
    restore \
    --file="somedump.json.asc" \
    --passphrase="yo_r-Str0ng-Pa55-phRaSe" \ # This can also be specified with VAULT_DUMP_PASSPHRASE environment variable
    [email protected] \ # This is a private key
    --recreate-mounts # attempts to re-create mounts from a dump.

Container image

You can download the container image from hub.docker.com:

$ docker pull pyratlabs/vault-dump:latest
$ podman pull docker.io/pyratlabs/vault-dump:latest

License

BSD 3-Clause