docs: close DESIGN.md gaps uncovered in audit#32
Merged
jgowdy-godaddy merged 1 commit intomainfrom Apr 17, 2026
Merged
Conversation
Stale / inaccurate claims corrected: - Binary cache format section described flags bit 0 as reserved and offset 14 as an unused 8-byte slot. Actually flag bit 0 is FLAG_HAS_OKTA_SESSION and offset 14 is okta_session_expiration. Offset 26+N is the Okta session ciphertext length, not a reserved payload. Rewrite to match awsenc-core/src/cache.rs. - Open Question #3 (concurrent profile access) resolved via fs4 advisory flock in awsenc serve — mark as resolved instead of open. - Bridge method list added 'delete' as alias for 'destroy' to match enclaveapp-tpm-bridge's backward-compat handling. - Phases 1-5 restructured from 'planned' tense to completed-state summaries. Phase 6 (WebAuthn) is the only remaining roadmap item; secondary_role explicitly documented as intentionally out of scope. Missing docs added: - --wizard flag on awsenc install (force interactive wizard even when flags supply every required field). - Global --keyring flag (force Linux keyring backend).
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
2 participants
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.
Summary
Audit of `DESIGN.md` vs code caught several stale claims and missing pieces.
Stale claims corrected
Missing docs added
Test plan