docs(reports): Phase B implementation plan (OSCAL SAR + CSV, async)#639
Merged
Conversation
Adds §12 to reports_design.md: the Framework Attestation phase (the scale-correct bulk path for auditors/GRC), grounded in a 2026-06-21 infra audit. Resolves the §10 decisions Phase B touches: - OSCAL version: stay on 1.0.6 (the per-scan emitter delegates to the Kensa library, which emits 1.0.6; the version is Kensa-controlled, so align down rather than force a Kensa change for the prototype's 1.1.2). - Fleet OSCAL shape: single assessment-results, evidence REFERENCED by content hash (not inlined) and streamed to the blob (avoids the 1000-page problem in OSCAL form; sharding deferred). - Snapshot storage: bulk content blob-stored + compressed (executive stays inline). Slices B0 fleet framework catalog (also closes the deferred A1 framework picker) -> B1 attestation kind + CSV face -> B2 fleet OSCAL SAR face -> B3 async generation + report.ready event (the in-app notification bell's first producer). All inputs exist (scanresult OSCAL, scan_results evidence, host_rule_state.last_scan_id join, csvSafe, queue, eventbus); the gaps are the framework catalog, the SAR assembler, the async job, and the report.ready event.
github-actions
Bot
added
documentation
remyluslosius
added a commit
that referenced
this pull request
Jun 22, 2026
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.
The next step on the reports roadmap: a concrete, decision-resolved plan for Phase B (Framework Attestation — fleet OSCAL SAR + CSV, async), mirroring how Phase A started with the #630 plan. Adds §12 to
reports_design.md.Grounded in an infra audit
Mapped what Phase B builds on (all present): the per-scan OSCAL emitter (
scanresult→ KensaExportOSCALScan, 1.0.6), the content-addressed evidence store (scan_results/scan_evidence), the fleet "latest scan per host" join (host_rule_state.last_scan_id), the audit-CSV pattern (csvSafe+ truncation header), the generic job queue, and the SSE event bus. The real gaps: a fleet framework catalog, a fleet SAR assembler, the async report job, and areport.readyevent.Decisions resolved (§10)
assessment-results, evidence referenced by hash (not inlined), streamed — inlining 100+ hosts × ~500 rules × 256 KiB evidence is the 1000-page problem in OSCAL form. Sharding deferred.Slices
GET /reports/frameworks); also closes the A1 deferred framework-picker gap.attestationkind + CSV face (one row per host×rule; reusescsvSafe).report.readyevent (the in-app notification bell's first real producer) + the bounded PDF attestation.Recommended order B0 → B1 → B2 → B3. Docs only; no code. The actual build follows once you're happy with the plan.