mix
27aeadc71d
test / test (push) Waiting to run
Receive DMARC aggregate reports on port 25 and show parsed summaries in the panel. Close Unreleased; pin compose and docs to 1.7.0. Co-authored-by: Cursor <cursoragent@cursor.com>
80 lines
3.2 KiB
Markdown
80 lines
3.2 KiB
Markdown
# Plan: dmarc-reports
|
|
|
|
**Status:** done — shipped in `[1.7.0]` (2026-08-18); security review (Fable)
|
|
of the ingest path pending.
|
|
|
|
---
|
|
|
|
## Goal
|
|
|
|
SelfPost **receives** DMARC aggregate reports on SMTP, parses them inside the
|
|
image, and **shows summaries in the panel** — pass/fail by source, hints when
|
|
`tighten p=` is reasonable. No external DMARC SaaS and no IMAP workflow for the
|
|
operator.
|
|
|
|
## Scope
|
|
|
|
**In:**
|
|
- Inbound SMTP for configured report addresses only (not a general backup-MX).
|
|
- gzip + XML aggregate parsing → SQLite summaries per sending domain.
|
|
- Panel page and/or per-domain section: recent reports, third-party senders,
|
|
delivery health of report ingestion.
|
|
- Reuse the `dmarc_report_email` setting (moved off the old `admin` table into
|
|
`settings` by migration `0005`) and `domains.dmarc_rua` for DNS templates;
|
|
when enabled, suggest a SelfPost-hosted report address.
|
|
|
|
**Out:**
|
|
- Forensic reports (`ruf=`).
|
|
- Full dashboards, APIs, email alerting.
|
|
- Mailboxes for people (IMAP/POP3/webmail).
|
|
|
|
## Architecture (sketch)
|
|
|
|
1. Receiving MTAs → SMTP to SelfPost (hub MX).
|
|
2. Postfix virtual alias or dedicated listener → panel ingest worker.
|
|
3. Parse XML → `dmarc_reports` table (domain, reporter, counts, date).
|
|
4. Panel reads SQLite; links from domain DNS card.
|
|
|
|
May share port-25 plumbing with [inbound-relay.md](inbound-relay.md) but must
|
|
remain a separate, opt-in feature that does not forward mail upstream.
|
|
|
|
## Done when
|
|
|
|
- Operator can point `rua=` at an address SelfPost accepts and see parsed
|
|
summaries in the panel within one reporting cycle.
|
|
- With the feature off, outbound-only behaviour is unchanged.
|
|
- Documented in [guide.md](../guide.md); migrations are backward-compatible.
|
|
|
|
## Risks
|
|
|
|
- Attack surface of accepting mail (mitigate: strict recipient allow-list).
|
|
- Report volume and retention (mitigate: caps + pruning).
|
|
|
|
## Implementation checklist
|
|
|
|
**Ingest path.** `DMARC_REPORTS_ENABLE=true` enables `smtp/inet` on 25 (shared
|
|
with inbound relay when both are on). Postfix `relay_domains` +
|
|
`transport_maps` route allow-listed recipients to a `dmarc-ingest` pipe
|
|
(`panel -dmarc-ingest`). `check_recipient_access` on `dmarc_recipients` is the
|
|
allow-list; no SASL, no local mailboxes.
|
|
|
|
**Schema.** Migration `0008_dmarc_reports.sql`: `dmarc_reports` (summary per
|
|
aggregate) + `dmarc_report_records` (per-source rows). Dedup on
|
|
`(reporter, report_id, domain)`.
|
|
|
|
**Retention.** Max 500 reports; drop older than 90 days; prune after each
|
|
ingest.
|
|
|
|
Target version cut: **`1.7.0`** (MINOR). One commit per step; code only after
|
|
roadmap status is **agreed**. Expand the sketch sections above before step 1
|
|
if still thin. See [development.md](../development.md) § Plan checklists.
|
|
|
|
- [x] Expand plan: ingest path, `dmarc_reports` schema, retention caps — **Sonnet**
|
|
- [x] Opt-in inbound SMTP for report addresses only (allow-list) — **Opus**
|
|
- [x] Worker: gzip/XML parse → SQLite — **Opus**
|
|
- [x] Panel: domain roll-up + parsed report (panel-ui mockups) — **Sonnet**
|
|
- [x] Tie-in `dmarc_report_email` / `domains.dmarc_rua` — **Sonnet**
|
|
- [x] Tests and [guide.md](../guide.md) — **Sonnet**
|
|
- [ ] Security review ingest path — **Fable**
|
|
- [x] `go vet`, `go test` on touched packages — **Haiku**
|