Skip to content
SHC Docs

shc vault escrow

record where the vault unlock key and the backup key are escrowed

Two keys decide whether an estate can be recovered after it is lost: the vault unlock key (the master password) and the backup repository key that opens every off-site archive. Both live only inside the estate unless someone copies them out.

Escrow each key out of band, somewhere outside this estate (a password manager, a printed sheet in a safe, a CI variable on another system), then record that you did:

shc vault escrow record --what unlock-key --where ‘1Password, vault Infra, item SHC master’ shc vault escrow record --what backup-key --where ‘printed sheet, office safe’

SHC never holds, moves or checks the escrowed copy. A receipt holds the label, a note, who and when, and the key’s generation, so it goes stale when the key changes: shc vault rotate makes the unlock-key receipt stale, shc backup key rotate the backup-key one. shc doctor (vault.unlock_key_escrow) fails until every key that needs a receipt has a current one. Bare shc vault escrow is status.

shc vault escrow [flags]
-h, --help help for escrow
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-p, --password string vault password (visible in the process list, prefer --password-file)
--password-file string read the vault password from a file (mode 0600 expected); use '-' to read stdin. Takes precedence over --password and never puts the secret in argv
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)