Repository navigation
docs(state-key): the mode is fixed at install and read from the volume on every boot - #52
Merged
Merged
Conversation
Bugs5382
marked this pull request as ready for review
September 30, 2026 16:08
…e on every boot Signed-off-by: Bugs5382 <12115015+Bugs5382@users.noreply.github.com>
Bugs5382
force-pushed
the
docs/297-state-key-mode-fixed
branch
from
September 30, 2026 16:29
4aebd3d to
142d1ba
Compare
Contributor
Author
|
Merging for the v0.1.0 test run: CI green and mergeable at merge time. |
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.
What and why
Companion to CryptOS-PKI/cryptos-node#305. A node now reads its state-key mode from the state partition's LUKS2 header on every boot after the first. Before, it fell back to the image's build-time default and couldn't unlock its disk when the config had picked another mode. The mode is fixed at install, and a
config applythat names a differentstate_key.modeis refused withFailedPrecondition.concepts/tpm-sealed-keys.md: the "Match state_key.mode to the image" caution described the bug. It becomes "The mode is fixed at install", covering where the mode is read and what happens on a change.nodeidcan also be chosen withstate_key.modeon any image.reference/machine-config.md,state_key: the field row says the mode is fixed at install. The prose says later boots read it from the LUKS2 header, so it survives reboots and upgrades to an image with a differentSTATEKEY. The error table gains the refusal message.reference/machine-config.md, apply outcomes: state key moves from "reboot needed" to a new "refused" line.Refs CryptOS-PKI/cryptos-node#297
Merge together with CryptOS-PKI/cryptos-node#305.
Verification
How this was verified
npm run buildpasses locally with no broken links or anchors. Every statement and the quoted error text were checked against the code change in CryptOS-PKI/cryptos-node#305 (config.StateKey.CheckSealed,sealedStateKey) and its tests.Before merging: add a closing comment summarizing what was actually done in this PR
(not just the checked boxes).