docs(backend): track sprint-0 follow-ups + flag integration migration gap

- `tasks/todo.md`: B0.5 description updated (re2 hard dep, no fallback);
  add a "Backend follow-ups (sprint 1+)" section with M1-M7 + N1-N6 from
  the code-review verdict.
- `CHANGELOG.md`: backend skeleton bullets refreshed (no re fallback,
  streaming blob store, audit + scope on CRUD, 56 unit tests); new
  "Code-review remediation" subsection lists B1 / MA1-MA6 / N4 / N6 / M8
  with one-line rationale each.
- `tests/integration/conftest.py`: leave `db.create_all()` in place but
  add an inline TODO (N6) pointing at the Alembic switchover that will
  exercise the F11 seed + audit-log role grants in CI.
This commit is contained in:
knacky
2026-05-22 05:25:04 +02:00
parent 3a3e3ff0ec
commit e77ca906d4
3 changed files with 84 additions and 8 deletions

View File

@@ -41,8 +41,10 @@ UX wireframes (mock data). No real connector, no reporting until PR1/PR2/PR3 lan
- `C2Connector` ABC + `Payload` / `TaskHandle` / `TaskResult` / `TaskStatus` dataclasses +
`PayloadType` enum + `ConnectorFactory` keyed on `c2_type`. Mythic payload map populated;
Home stays empty until PR2.
- Jinja2 `SandboxedEnvironment` + `regex_extract` filter (google-re2 with `re` fallback) +
`{{ outputs.text }}` / `{{ outputs.blob() }}` accessors (10 MB cap, UTF-8 → latin-1).
- Jinja2 `SandboxedEnvironment` + `regex_extract` filter (`google-re2` hard dependency per
D-011 / B1 — `RuntimeError` at boot if absent, no `re` fallback) + `{{ outputs.text }}` /
`{{ outputs.blob() }}` accessors reading gzip-compressed blobs (10 MB cap after
decompression, UTF-8 → latin-1).
- Group-based RBAC: `Permission` + `GroupName` + `GROUP_PERMISSIONS` mirror the F11 matrix;
`@require_perm` decorator + `AuthUser` Flask-Login wrapper that resolves the permission set
from the user's groups.
@@ -51,10 +53,15 @@ UX wireframes (mock data). No real connector, no reporting until PR1/PR2/PR3 lan
- Hash-chained append-only audit writer (sprint 0 fills `prev_hash` / `row_hash` at insert;
verifier shipped in v2).
- Flat CRUD blueprints: engagements / hosts / TTPs / scenarios + scenario steps. F3 invariant
enforced (host.c2_type must match scenario.c2_type at compose time).
enforced (host.c2_type must match scenario.c2_type at compose time). Every mutation calls
the hash-chained audit writer (MA5); created rows carry `created_by_id` (MA4); listings and
per-engagement routes scope to `engagement_member` for RT operators (MA6 / F11).
- Content-addressed gzip blob store (`mimic.storage.blob`): streaming write with a `max_bytes`
cap (raises `BlobTooLarge` mid-stream — MA2), atomic rename, `0o750` directory mode.
- `mimic-cli` (click): `user create`, `db dump`, `db restore`.
- pytest baseline: **38 unit tests passing**, integration scaffold ready for testcontainers
Postgres (`/healthz` smoke included).
- pytest baseline: **56 unit tests passing** (templating, regex_extract, password, soc_token,
RBAC matrix, connector factory, audit hash, blob CAS, migration seed parity). Integration
scaffold ready for testcontainers Postgres (`/healthz` smoke included).
#### Spec deltas applied in this sprint
@@ -69,3 +76,31 @@ Implementation arbitrations logged in this sprint:
- **D-013** — `audit_log` hash chain (`prev_hash` / `row_hash`) shipped v1.
- **D-014** — UUID columns use SQLAlchemy 2 native `Uuid` mapping; no `type_annotation_map`
on the declarative base (Flask-SQLAlchemy incompatibility).
#### Code-review remediation (`12d131c` → `feature/backend-skeleton`)
- **B1** — Dropped the `re` stdlib fallback in `regex_extract`. `google-re2` is now a hard
dependency (B1 / D-011); the module raises `RuntimeError` at import if absent.
- **MA1** — Removed `scripts/postgres-init/00-roles.sql` (no more hardcoded `CHANGE_ME`
password). Audit-writer role provisioning is the playbook's responsibility (D-010);
`backend/README.md` documents the manual dev-only `CREATE ROLE` command.
- **MA2** — `store_blob` now accepts a binary stream + `max_bytes`, streams sha256+gzip in
64 KB chunks, and raises `BlobTooLarge` mid-stream (cleans up the temp file). No more
whole-buffer RAM load.
- **MA3** — Inlined the F11 permission matrix in the initial Alembic migration; the runtime
matrix is no longer imported there. A new unit test
(`test_migration_seed_matches_current_matrix`) fails if the two drift apart.
- **MA4** — `created_by_id = current_user.id` set in `engagement`, `ttp`, and `scenario`
create endpoints.
- **MA5** — Every mutation endpoint now writes an audit row through the hash-chained
`AuditWriter` (F13).
- **MA6** — RT operators only see engagements they are members of (`engagement_member` join
on list, membership probe on `get`/`put`/`delete`/`host`/`scenario`/...). RT leads bypass.
- **N4** — `gunicorn` declared in `pyproject.toml` dependencies (the Dockerfile `CMD` now
resolves correctly).
- **N6** — `tests/integration/conftest.py` keeps `db.create_all()` for now; commented TODO to
switch over to Alembic once the playbook owns the audit role.
- **M8** — Initial migration docstring no longer mentions `ttp_version`.
Verification on the latest commit: `ruff check`, `ruff format --check`, `mypy --strict`, and
`pytest tests/unit` all pass; 56 unit tests green.