Files
rengine/reports/base.py
T
Yogesh OjhaandClaude Opus 5 0b853e04b6 chore: production-readiness review across the tree
A full static review of the 3.0 tree, run as two fan-out passes with every
finding verified against the running stack rather than taken on inspection.

Correctness and security
- instance settings encrypted the mask over the stored AI key: `!= MASK` never
  matched `••••••••abcd`, so saving settings destroyed the key and `test_ai`
  posted the mask as a bearer token
- the MFA token was replayable for its full five-minute life; the gate now
  checks revocation and consumes the token after a successful exchange
- logout revoked nothing for a bearer client while answering "Logged out"
- `POST /api-keys/{id}/test` returned the plaintext key inside httpx's error
  string, which embeds the whole URL
- an interest rule could be edited or deleted through another project's id
- redis ran the celery broker under `allkeys-lru`, free to evict a queued task
  or a chord counter; now `noeviction`
- nuclei's stored command carried the OAST token and every auth header
- a finalize step could poison the session and leave a scan RUNNING for ever
- `is:issue` raised TypeError on every search
- offset paging repeated and skipped rows in four dimensions
- a cancelled run kept a stale `scans.*_found` rollup
- every PDF report raised `KeyError: 'software'`
- `version_key` truncated a wide numeric run and inverted release ordering
- psycopg raises a NUL as a bare ValueError, above StatementError, so every
  savepoint guard was blind to the case it was written for

Performance
- endpoints.host had no trigram index: 35.9ms seq scan -> 0.389ms
- free text compiled to one OR, not the prescribed UNION ALL: 132ms -> 41ms
- `/http-assets/summary` and `/ips/summary` materialised whole tables
- the cross-link `ip` kind ran an estate query per page and drew nothing

Frontend
- `$effect` loaders that read the state they write, an unbounded request loop
  on a failing endpoint
- error states that rendered as empty states
- 2FA backup codes were unusable while the copy said they worked
- a "Scan history" dialog that always reported none
- ~400 duplicated lines across five filter bars, now one component

Build and tooling
- every scanner installed at @latest; all 13 pinned to the measured versions
- CI built `web/`, gone since 2.x, with tags that cannot be valid
- the prettier pre-commit hook discarded its filenames and always passed
- the test suite destroyed itself when run twice

Also: subdomains from public code, via a pinned github-subdomains source and a
GitHub API key that subfinder receives too; sublist3r and oneforall removed
after measuring one unique host in 89 across four targets.

Verified: 853 tests, ruff clean over eleven packages, svelte-check 0 errors,
the count-is-a-promise gate at 131 checks and 0 mismatches, and 143 GET routes
with no 5xx. Four migrations, each with an exercised downgrade.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01DVkdx5ynZ6aof5kLFczmhX
2026-09-13 18:03:29 +05:30

91 lines
2.8 KiB
Python

"""A section is a unit of the document: what it needs, what it configures, what it renders."""
from __future__ import annotations
from abc import ABC, abstractmethod
from dataclasses import dataclass, field
from datetime import datetime
from typing import TYPE_CHECKING, ClassVar
from reports.config import SectionConfig
from shared.definitions.reports import ReportSpec, SectionGroup, SectionRole
if TYPE_CHECKING:
from reports.analysis.brief import ReportBrief
from reports.data.source import ReportSource
from reports.narrate.base import Narrator
from shared.definitions.report_theme import ThemeTokens
@dataclass
class RenderContext:
spec: ReportSpec
theme: ThemeTokens
data: ReportSource
brief: ReportBrief
narrator: Narrator
now: datetime
preview: bool = False
warnings: list[str] = field(default_factory=list)
@property
def style(self):
return self.spec.style
@property
def branding(self):
return self.spec.branding
@property
def palette(self) -> dict[str, str]:
colour = self.theme.color
return {
"ink": colour.ink,
"ink_soft": colour.ink_soft,
"ink_faint": colour.ink_faint,
"surface": colour.surface,
"accent": colour.accent,
"accent_ink": colour.accent_ink,
"rule": colour.rule,
}
def sev(self, severity: str | None) -> str:
table = self.theme.color.severity
return table.get((severity or "unknown").lower(), self.theme.color.ink_faint)
def hue(self, index: int) -> str:
scale = self.theme.color.chart or [self.theme.color.accent]
return scale[index % len(scale)]
def warn(self, message: str) -> None:
if message not in self.warnings:
self.warnings.append(message)
class Section(ABC):
name: ClassVar[str]
title: ClassVar[str]
description: ClassVar[str] = ""
group: ClassVar[str] = SectionGroup.SUMMARY.value
role: ClassVar[str] = SectionRole.CONTENT.value
order: ClassVar[int] = 100
launch_fields: ClassVar[frozenset[str]] = frozenset()
requires: ClassVar[frozenset[str]] = frozenset()
repeatable: ClassVar[bool] = False
default_enabled: ClassVar[bool] = True
in_toc: ClassVar[bool] = True
page_break: ClassVar[str] = "auto"
template: ClassVar[str] = ""
config_model: ClassVar[type[SectionConfig]] = SectionConfig
@classmethod
def template_name(cls) -> str:
return cls.template or f"{cls.name}/section.html"
def available(self, ctx: RenderContext) -> bool:
return not self.requires or bool(self.requires & ctx.data.covered_dimensions)
@abstractmethod
def build(self, ctx: RenderContext, cfg: SectionConfig) -> dict | None:
"""Template variables, or None when the section has nothing to say."""