Skip to content

fix: complete pattern mapping + correct signing key docs - #25

Merged
devonartis merged 2 commits into
developfrom
fix/review-findings-round2
Apr 13, 2026
Merged

fix: complete pattern mapping + correct signing key docs#25
devonartis merged 2 commits into
developfrom
fix/review-findings-round2

Conversation

@devonartis

Copy link
Copy Markdown
Owner

Summary

Fixes two unresolved findings from code review:

  • Finding 2 — Component mapping incomplete: Pattern table now maps all 8 EAC v1.3 components with correct numbering per docs/concepts.md. Component 6 (Mutual Authentication / mutauth) documented as present but not wired. Components 7 (Delegation Chain) and 8 (Operational Observability) added with packages, types, and functions.

  • Finding 3 — Restart behavior contradicts persistent signing key: Removed false claim that "all previously issued tokens become unverifiable after restart (new signing keys)." The Ed25519 key persists via internal/keystore — tokens survive restarts. Corrected the single-broker note to describe the actual risk: split-brain in-memory state, not signing keys.

Verification

  • Checked component numbering against docs/concepts.md (authoritative source)
  • Verified internal/keystore/keystore.go:LoadOrGenerate() persists key to disk
  • Verified mutauth package exists but is not imported in cmd/broker/main.go
  • Scanned all docs for stale "new signing key" / "unverifiable after restart" — none remaining

Test plan

  • go build ./... passes
  • go test ./... -short all packages pass
  • CI gates-passed green

Finding 2: Pattern component table now maps all 8 EAC v1.3 components
with correct numbering per docs/concepts.md. Component 6 (Mutual
Authentication / mutauth) documented as present but not wired into
the broker. Components 7 (Delegation) and 8 (Observability) added
with their Go packages, types, and functions.

Finding 3: Removed false claim in Security Assumptions that "all
previously issued tokens become unverifiable after restart (new
signing keys)." The Ed25519 signing key is persistent via
internal/keystore — tokens survive broker restarts. Corrected the
single-broker-instance note to describe the actual split-brain risk
(in-memory transient state, not the signing key).
@github-actions

github-actions Bot commented Apr 13, 2026

Copy link
Copy Markdown

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA f9f919e.
Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.

Scanned Files

None

Missed spots from PR #24's LicenseRef rename:
- Dockerfile OCI label (org.opencontainers.image.licenses)
- docs/api/openapi.yaml license name field
- docs/getting-started-operator.md OCI label reference
- CHANGELOG.md historical entries updated to match corrected value

Verified: zero bare PolyForm-Internal-Use-1.0.0 identifiers remain
outside of human-readable prose ("PolyForm Internal Use License 1.0.0").
@devonartis
devonartis merged commit de42c5f into develop Apr 13, 2026
20 checks passed
@devonartis
devonartis deleted the fix/review-findings-round2 branch April 13, 2026 19:19
devonartis added a commit that referenced this pull request Apr 13, 2026
The component table in PR #25 added mutauth but the top-line count
and directory layout weren't updated to match.
devonartis added a commit that referenced this pull request Apr 13, 2026
The component table in PR #25 added mutauth but the top-line count
and directory layout weren't updated to match.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant