Files
selfpost/docs/schema-migrations.md
T
mixandClaude Opus 5.5 c171fb5bc7
test / test (push) Canceled after 0s
from-header-binding: the sender check, what it costs, its pages; guide, architecture, security
A message's From: line is held against the application that sends it, under
the rule Postfix holds the envelope sender to. OpenDKIM chooses the key by
that line, so until now an application could have mail signed as another
domain of the server or as the server itself.

The check (internal/milter/sender.go)
- A role of the panel on a socket of its own (SENDER_CHECK_SOCKET), first in
  smtpd_milters and strict: default_action=tempfail. The journal milter keeps
  its socket and stays fail-open. postfix-wrapper waits for the new socket.
- It reads no database: what an application may send as comes from Postfix's
  own sender_login_maps, what the server signs for from OpenDKIM's
  SigningTable. Both are read again when they change; one that cannot be
  read defers mail.
- One From: field, one address, allowed by the envelope's lookup; then no
  other name of the SigningTable may appear anywhere in the raw line.
  Refused: 550 5.7.1 naming the line, reduced to printable ASCII.
- A refusal is a send-log row with reason "from" and the header address
  (migration 0006), written by another goroutine and not waited for. The
  journal's refusals record their reason too (limit, client), and the
  notifier takes only a limit's.

What it costs (docs/plans/from-header-binding.md, Statistics)
- The role marks itself alive every 2 s; at start the gap since the mark is
  downtime, counted from Postfix's start if later and not at all when
  supervisord says Postfix is not running.
- The log tailer counts the connections Postfix turned away: a warning that
  names the socket, then milter-reject "Service unavailable" from the same
  smtpd. Seen on the stand: the client is refused from CONNECT on and leaves
  at AUTH (454), so no MAIL line is ever written.
- sender_check_days, a row per UTC day, kept a year.

Pages
- Health: the card "Sender check", the socket's row, and the cards layout -
  boxes numbered by importance in two stacks read in rows; the left stack
  polls, the three readings of the right one are swapped in by id.
- Outbound log: a refused row says why in its tag (wrong From, wrong client,
  rate-limited); the message's page shows the From: line and what the
  application may send as.
- Help: topic "Sender check", word for word the mockup's.

Found by the stand, fixed here: the names for the second look came from the
sender bindings, and a domain with a key and no application yet was not
among them.

e2e: negative_journal_milter_fail_open is gone - it proved that mail passes
with the panel down, which is no longer so. In its place
sender_check_holds_the_from_line (another domain's From:, the hostname's, a
stranger's, an address off the list, another sender in the display name -
refused; own addresses - delivered) and panel_down_defers_mail (4xx with the
panel stopped, the container alive, mail again after, downtime and one
deferred message on Health, the card warning).

Test server, this tree before the last cosmetic edits (a fixture row, a
fact's size, docs): go vet ok, go test 23 packages ok, make e2e ok (337 s).
Locally after them: internal/web/view ok.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-12 19:35:43 +03:00

8.8 KiB

SQLite schema and migrations

What this file is. A living reference for the embedded SQLite schema: the 2.0 baseline, the migrations added after it, and how a database is opened. When you add or review a migration, update this file in the same change.

Source of truth in code: internal/store/migrations/*.sql, applied by internal/store/store.go (migrate()).

Related: architecture.md § Persistence; plans/panel-redesign.md § No compatibility; development.md § Documentation.


Current snapshot

Field Value
Chain head user_version = 5
Files 0001_init.sql (the 2.0 baseline), 0002_inbound_spam_log.sql, 0003_send_log_lines.sql, 0004_notifications.sql, 0005_send_log_rejected_index.sql, 0006_sender_check.sql
File mark PRAGMA application_id = 0x53503230 ("SP20")
Database file /data/selfpost.db (bind mount)
Compatibility 2.x MINOR releases must boot a 2.0.0 data directory. Nothing is carried over from 1.x.

2.0 starts from an empty data directory

Decided by the owner on 2026-09-21: the redesign is a breaking release, the 1.x migration chain (0001 … 0010, with its admin table created in the first file and dropped in the fifth) is deleted from the binary, and there is no upgrade path. The only live 1.x installation is the owner's and is set up again on 2.0. The 1.x chain stays in git history (last present at 1.9.5).

What that means in practice:

  • A fresh /data gets the baseline and nothing else.
  • A 1.x database is refused, not migrated. store.Open returns ErrForeignSchema for a file that has a schema version but not the 2.x application_id. Without that check a 1.x file at user_version = 10 would read as "already migrated" and the panel would start on tables it does not know. The file is not modified. The same applies to restoring a 1.x full backup into a 2.0 container.
  • A database whose version is higher than the build knows is refused too.
  • Domains can still be carried by hand: a 1.x domain export (JSON, with the DKIM key and applications) imports into 2.0 — the transfer format is not the database.

How migrations run

  1. Migrations are embedded at build time (//go:embed migrations/*.sql).
  2. Filenames are sorted lexicographically; file order = version number.
  3. PRAGMA user_version records progress: after file i (0-based), version is i + 1.
  4. Each pending migration runs in its own transaction, then bumps user_version.
  5. There is no down-migration; fixes ship as a new 00NN_*.sql file.

Implication: once 2.0.0 is released, 0001_init.sql is never edited again and no file is deleted, renamed or reordered — every 2.x database has already run it. 2.0.0 and 2.0.1 shipped with the baseline alone; the features after them add files, the first being 0002_inbound_spam_log.sql of inbound-antispam-panel (2.1.0), then 0003_send_log_lines.sql of delivery-log-storage (2.2.0), 0004_notifications.sql and 0005_send_log_rejected_index.sql of panel-notifications (2.3.0), and 0006_sender_check.sql of from-header-binding (2.4.0).


Migration chain

Ver File Shipped Kind Summary
1 0001_init.sql 2.0.0 DDL The whole 2.0 schema, below
2 0002_inbound_spam_log.sql 2.1.0 DDL inbound_spam_log, inbound_spam_list and two indexes; nothing existing changes
3 0003_send_log_lines.sql 2.2.0 DDL send_log_lines and one index; nothing existing changes
4 0004_notifications.sql 2.3.0 DDL users.notify (default 1: every user starts with notifications on) and notify_state
5 0005_send_log_rejected_index.sql 2.3.0 DDL idx_send_log_rejected, a partial index of the refused rows of send_log by time; a file of its own because the test installation had run 0004 before the review asked for it
6 0006_sender_check.sql 2.4.0 DDL send_log.reason and send_log.header_from (both default '': a row refused earlier keeps no reason), and sender_check_days

Kind: DDL — schema only; data — INSERT/UPDATE that must stay correct for operators upgrading from older 2.x images.


Schema at head (v2)

Table Role
settings Key/value settings of the instance — what is true whoever is signed in (send-log retention). Nothing that belongs to a user
users Panel logins. role is global or domain; email is the user's own address; notify is the user's own switch for notification e-mails (v4); all_domains / all_inbound_domains widen a domain user to every domain of that direction
sessions Panel login sessions (token hash, owning user by id and deleted with them, sliding idle expiry)
domains Sending (outbound) domains. dmarc_rua is where aggregate reports go ('' = no reports)
user_domains Outbound domains assigned to a domain user
applications SASL applications per domain, with the client-IP restriction (auth_ip_restrict, auth_allowed_ips)
application_addresses Explicit From addresses (list mode)
rate_limits Level-2 limits per domain / application, manual or auto
send_log Delivery journal
logtail_state Log-tailer read position
inbound_domains Inbound relay domains
inbound_transports Upstream host / port / TLS per inbound domain
inbound_recipients Allow-list when recipient_mode = list
user_inbound_domains Inbound domains assigned to a domain user — granted separately from the outbound ones
dmarc_reports Parsed aggregate report summaries
dmarc_report_records Per-source rows inside a report
inbound_spam_log Inbound antispam journal: one row per recipient of a message offered on port 25, with the decision (accept, reject, tempfail, quarantine) and who made it (rspamd, postfix, selfpost). Metadata only (v2)
inbound_spam_list Allow / deny entries for the external filter (address, domain, ip), instance-wide; unique per list (v2)
notify_state What the panel has already written to its users about, one row per subject (dns:<domain>, cert, queue, limit:<domain>), so that each thing is said once and a restart says nothing again (v4)
send_log_lines The mail.log lines Postfix wrote under a queue id, with the line's own time; what a message's page shows once the log has rotated. No reference to send_log: a line belongs to a row by queue id and time, and goes when no row carries its id (v3)

TestBaselineSchema (internal/store/schema_test.go) pins every table, column and index of this list; TestOpenMigratesA20Database opens a database that holds the baseline alone.

What changed against the last 1.x schema

1.x 2.0 Why
admin created in 0001, dropped in 0005 never exists the reason for the squash
users.role = global / domain_admin global / domain the role is a reach, not a rank — everyone in the panel is an administrator
users.dmarc_report_email users.email a user's e-mail is theirs; it is what the panel writes to, and a domain's report address can be filled with it
instance setting dmarc_report_email (mirror of the global user's field); domains.dmarc_rua NULL = inherit the instance default domains.dmarc_rua alone: the address, '' = no reports a domain's report address is one of three explicit choices — no reports, hosted, a typed address; nothing is inherited and no user's default exists (2026-10-10)
— user_inbound_domains inbound is delegated per user, separately from outbound
— users.all_domains, users.all_inbound_domains "All" includes domains added later
rate_limits.allowed_ips (unused since 1.9.0) gone client IPs belong to the application (auth_allowed_ips)

Where a domain's DMARC reports go

domains.dmarc_rua is the address itself and the only thing stored; '' means no reports, and it is what a new domain has. The choice shown in Domain settings is derived from it: '' is no reports, the address SelfPost derives for the domain and the server's hostname (dmarc.HostedReportAddress, offered while hosted reports are enabled) is hosted, anything else is an address typed for the domain. Nothing refers to a user: deleting one changes no domain.


Adding a migration

  1. Add internal/store/migrations/00NN_short_name.sql (next number).
  2. Update the table in Migration chain, the snapshot at the top, and the affected rows of Schema at head.
  3. Update TestBaselineSchema if tables, columns or indexes change, and add a test that opens a database at the previous version and migrates it.
  4. A data migration states in a comment which 2.x versions it is written for.