docs: highlight encryption-key location, backup, and override (closes #8)#11
Merged
Conversation
Addresses #8 — make key custody impossible to miss: - Encryption tutorial + FAQ now state where the local KEK lives (kek.bin in the keyring directory, <config>/keyring; doctor prints the resolved path), warn prominently that losing it makes every backup under it unrecoverable, tell operators to back the keyring directory up separately, and document the PG_HARDSTORAGE_KEYRING_DIR override (the "parameter to change the key dir" the issue asked for already exists as that env var). - Fixed a stale "GCP/Azure/Vault KMS slated for v0.5+" note in the encryption tutorial (those providers ship today) and a missed AES-256-GCM-SIV-as-default line in the FAQ (ships plain AES-256-GCM). Closes #8.
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
1 participant
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.
Addresses #8 (highlight encryption-key importance).
The asks
kek.binin the keyring directory (<config>/keyring;pg_hardstorage doctorprints the resolved path), losing it makes every backup under it mathematically unrecoverable, and the keyring directory must be backed up separately from the repository (or use a cloud KMS scheme).PG_HARDSTORAGE_KEYRING_DIRenvironment variable (resolved ininternal/paths). Now documented in both places.Also fixed while here (consistency with the v1.0.3 correctness sweep): a stale "GCP/Azure/Vault KMS slated for v0.5+" note (those providers ship today) and a missed "AES-256-GCM-SIV by default" line in the FAQ.
Note: the marketing site's
/examplespage (referenced in the issue) lives in a separate repo; this PR covers docs.pghardstorage.org. The same key-backup callout should be added there too.