Files
rengine/reports/sections/document_control/section.py
T
Yogesh OjhaandClaude Opus 5 724ebd42bb feat(reports): a section declares its role, its order and what it asks at generate time
Choosing what a report contains required editing a template. That is the wrong
place for a decision made per report, and the scan launch flow already
established the alternative: a saved configuration seeds the run, the run may
depart from it, and the saved configuration is never touched.

Three declarations put sections on the same footing as stages. SectionRole
separates the content a reader asked for from the furniture around it, so a
picker can offer twenty-one choices and include the cover, the contents and the
reference matter without being asked. Section.order fixes the reading order,
which until now was however the directories happened to sort — the executive
summary came after attack paths because "a" precedes "e". Section.launch_fields
names the settings worth surfacing when the report is generated rather than
only in the builder, mirroring Stage.launch_fields; the findings section
declares its severities, its detail depth, its roll-up and its asset cap.

The estimate had to become honest for any of this to be worth showing. It
counted every finding in the scan whatever the section filtered to, so dropping
three severities moved nothing. It now counts through the same severity filter
the section applies and prices each tier separately, from the real per-severity
issue counts rather than an assumed split: 28 pages against 26 rendered for a
full template, 10 against 9 for critical and high alone.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01AW5pitnosX8LEFEYxH8gFS
2026-09-06 17:14:01 +05:30

58 lines
2.3 KiB
Python

from __future__ import annotations
from reports.base import RenderContext, Section
from reports.config import SectionConfig, flag, paragraph
from shared.definitions.reports import SectionGroup, SectionRole
_DEFAULT_CONFIDENTIALITY = (
"This document contains information about security weaknesses in systems operated by "
"the client named on the cover. Distribute it only to the people listed below."
)
class DocumentControlConfig(SectionConfig):
show_distribution: bool = flag(True, title="Show distribution list")
show_revisions: bool = flag(True, title="Show revision history")
show_confidentiality: bool = flag(True, title="Show confidentiality statement")
show_disclaimer: bool = flag(True, title="Show disclaimer")
confidentiality: str = paragraph(
_DEFAULT_CONFIDENTIALITY,
title="Confidentiality statement",
description="Used when the branding field is empty.",
)
class DocumentControlSection(Section):
name = "document_control"
title = "Document control"
description = "Version, distribution, revision history and handling instructions."
group = SectionGroup.FRONT_MATTER.value
order = 20
role = SectionRole.FURNITURE.value
default_enabled = False
config_model = DocumentControlConfig
def build(self, ctx: RenderContext, cfg: DocumentControlConfig) -> dict:
branding = ctx.branding
facts = [
("Document", ctx.spec.title),
("Reference", branding.document_id),
("Version", branding.version),
("Classification", branding.classification),
("Client", branding.client_name),
("Author", branding.author or branding.prepared_by),
("Issued", ctx.now.strftime("%d %B %Y")),
("Subject", ctx.data.subject),
]
return {
"facts": [(label, value) for label, value in facts if value],
"distribution": branding.distribution if cfg.show_distribution else [],
"revisions": branding.revisions if cfg.show_revisions else [],
"confidentiality": (
branding.confidentiality_statement or cfg.confidentiality
)
if cfg.show_confidentiality
else "",
"disclaimer": branding.disclaimer if cfg.show_disclaimer else "",
}