feat(credentials): encrypt the vault at rest - #121
Merged
Conversation
The vault holds the target's prior values so a bad rotation can be undone — the one place raw credentials touch disk. It was written as plain JSON at mode 0600, and a permission bit is all that was protecting it. That stops another user on the same box. It does nothing about a backup, a synced home directory, a lifted disk, or any process running as the owner, and those are the cases where a credential store is worth reading. Each run is now sealed to this machine's identity: a fresh DEK per write, the payload sealed with it, the DEK sealed to the identity public key. So the file opens with the secret key in identity.json and nothing else. The key names go inside the ciphertext along with the values — knowing that an endpoint holds STRIPE_LIVE_KEY is worth something by itself. A DEK per run rather than one for the store: reusing a key would make a single compromise open every rollback ever captured, and there is nothing to gain by it, since the wrapped DEK travels in the file. Plaintext vaults written before this still open. Refusing them would strand the rollback data they exist to hold, and a vault reader that cannot read yesterday's vault takes away the thing the vault is for. The store's vault methods become async, which the three callers in the engine already sat inside async functions to accommodate. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
vu1nz Security Review0 finding(s) in PR #? No security issues found. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Replaces #120, which GitHub auto-closed when its base branch (
fix/one-vault-xdg) was deleted on merging #119. Same commit, rebased ontomaster; base ismasterthis time so nothing can strand it again.Why
The vault holds the target's prior values so a bad rotation can be undone — the one place raw credentials touch disk. It was written as plain JSON:
{ "STRIPE_LIVE_KEY": "sk_live_…", "DATABASE_URL": "postgres://user:pass@…" }…protected by nothing but mode
0600. A permission bit stops another user on the same box. It does nothing about a backup, a synced home directory, a lifted disk, or any process running as the owner — which are the cases where a credential store is worth reading.What
Each run is sealed to this machine's identity:
crypto_box_seal)identity.jsonand nothing else{ "version": 2, "wrappedKey": "…", "sealed": { "nonce": "…", "ciphertext": "…" } }Key names are inside the ciphertext too. Knowing an endpoint holds
STRIPE_LIVE_KEYis worth something on its own, so the whole bag is sealed, not just the values.A DEK per run, not one per store. Reusing a key would make a single compromise open every rollback ever captured, and there is nothing to gain — the wrapped DEK travels in the file.
Compatibility
version: 2distinguishes them.asyncfunctions inengine.ts, so this is threeawaits.<path>to roll this run back" — rather than a decode failure out of libsodium.The tradeoff, stated plainly
The vault is now only as recoverable as
identity.json. Lose that file and old rollback data is unreadable. That is the point — it is what makes a copied file useless — but it makes the identity key load-bearing for rollback, not just for team vault access.Tests
src/vault-encryption.test.ts, 7 tests. Against the pre-encryption tree, 3 fail — including the one that matters, "does not write the secret to disk in the clear". The other 4 are guards that must hold either way (round-trip,0600, legacy plaintext, missing-vault).plugin-credential-sharing52 pass ·cli44 pass ·npm run build:cliclean, all re-run on this rebase.🤖 Generated with Claude Code