Files
rengine/shared/utils/text.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

46 lines
1.4 KiB
Python

"""Text for postgres and for a reader: NUL is rejected outright, in text and in json alike."""
from __future__ import annotations
import re
from typing import Any
from sqlalchemy.exc import StatementError
_NUL = "\x00"
_CTRL = re.compile(r"[\x00-\x08\x0b\x0c\x0e-\x1f\x7f]")
# asyncpg raises DBAPIError for a NUL; psycopg raises a bare ValueError while binding
REFUSED_ROW = (StatementError, ValueError)
def strip_nul(value: str) -> str:
"""Drop only what postgres refuses to store."""
return value.replace(_NUL, "") if _NUL in value else value
def strip_control(value: str) -> str:
"""strip_nul plus the other control characters, for text a person reads back."""
return _CTRL.sub("", value)
def scrub(value: Any) -> Any:
"""strip_nul through strings, lists and dicts on their way to a column."""
if isinstance(value, str):
return strip_nul(value)
if isinstance(value, list):
return [scrub(item) for item in value]
if isinstance(value, dict):
return {scrub(k): scrub(v) for k, v in value.items()}
return value
def plural(count: int, word: str, many: str | None = None) -> str:
"""The form of a word that matches a count."""
return word if count == 1 else (many or f"{word}s")
def counted(count: int, word: str, many: str | None = None) -> str:
"""A count and the form of its word that matches it."""
return f"{count} {plural(count, word, many)}"