Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
10ba866f0e | ||
|
|
5e4b91c4e9 |
@@ -1,23 +0,0 @@
|
|||||||
name: Mail-Pflichttest-Gate
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
paths:
|
|
||||||
- "mail/**"
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
pflichttest-gate:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
- uses: actions/setup-go@v5
|
|
||||||
with:
|
|
||||||
go-version: "1.22"
|
|
||||||
- name: Gate bauen
|
|
||||||
working-directory: mail
|
|
||||||
run: go build -o /tmp/pflichttestgate ./cmd/pflichttestgate
|
|
||||||
- name: Geänderte Dateien gegen Pflichttest-Regel prüfen
|
|
||||||
run: |
|
|
||||||
git diff --name-only "origin/${{ github.base_ref }}...HEAD" | /tmp/pflichttestgate
|
|
||||||
@@ -0,0 +1,18 @@
|
|||||||
|
version: "2"
|
||||||
|
|
||||||
|
run:
|
||||||
|
timeout: 3m
|
||||||
|
|
||||||
|
linters:
|
||||||
|
default: none
|
||||||
|
enable:
|
||||||
|
- govet
|
||||||
|
- staticcheck
|
||||||
|
- errcheck
|
||||||
|
- unused
|
||||||
|
- ineffassign
|
||||||
|
|
||||||
|
formatters:
|
||||||
|
enable:
|
||||||
|
- gofmt
|
||||||
|
- goimports
|
||||||
@@ -0,0 +1,19 @@
|
|||||||
|
.PHONY: build lint fmt test check
|
||||||
|
|
||||||
|
build:
|
||||||
|
go build ./...
|
||||||
|
|
||||||
|
lint:
|
||||||
|
golangci-lint run ./...
|
||||||
|
|
||||||
|
fmt:
|
||||||
|
gofmt -l .
|
||||||
|
@test -z "$$(gofmt -l .)" || (echo "gofmt-Verstoesse gefunden, siehe oben" && exit 1)
|
||||||
|
|
||||||
|
test:
|
||||||
|
go test ./... -p 1 -count=1
|
||||||
|
|
||||||
|
check: build
|
||||||
|
go vet ./...
|
||||||
|
golangci-lint run ./...
|
||||||
|
go test ./... -p 1 -count=1
|
||||||
@@ -0,0 +1,62 @@
|
|||||||
|
# NEXARCH Archive
|
||||||
|
|
||||||
|
Zentrales, modulübergreifendes Modul für Aufbewahrung, WORM, Compliance und
|
||||||
|
Backup. Dieses Verzeichnis enthält bisher `internal/backup` (BAK-01,
|
||||||
|
Datenbank-Backup-Strategie) — weitere Bausteine folgen ticketweise.
|
||||||
|
|
||||||
|
## BAK-01: Datenbank-Backup
|
||||||
|
|
||||||
|
`cmd/backup-cli` — Aufrufpunkt für systemd-Timer (siehe
|
||||||
|
`../deploy/systemd/nexarch-archive-backup-*.timer`):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export NEXARCH_BACKUP_PG_USER=nexarch_backup
|
||||||
|
export NEXARCH_BACKUP_PG_PASSWORD=...
|
||||||
|
export NEXARCH_BACKUP_DIR=/var/nexarch-archiv/backups/postgres # NICHT auf einem ephemeren Test-Dataset (siehe Betrieb)
|
||||||
|
export NEXARCH_BACKUP_KEEP_GENERATIONS=7 # optional, Default 7
|
||||||
|
|
||||||
|
backup-cli full # neue Vollsicherung + Verifikation
|
||||||
|
backup-cli incremental # inkrementelle Sicherung gegen die neueste Generation
|
||||||
|
backup-cli rotate # entfernt alle bis auf die neuesten N Generationen
|
||||||
|
```
|
||||||
|
|
||||||
|
Voraussetzung: die konfigurierte Postgres-Rolle braucht das
|
||||||
|
`REPLICATION`-Attribut (`pg_basebackup` nutzt eine
|
||||||
|
Replikationsverbindung), und `summarize_wal = on` muss serverseitig gesetzt
|
||||||
|
sein (PostgreSQL 17s natives inkrementelles Backup, keine WAL-Archivierung
|
||||||
|
nötig).
|
||||||
|
|
||||||
|
## BAK-02: Objekt-Storage-Backup
|
||||||
|
|
||||||
|
`cmd/objectbackup-cli` sichert einen lokalen Verzeichnisbaum (den
|
||||||
|
FDN-03-`LocalDriver`-Basisordner direkt, oder — für S3-gestützte
|
||||||
|
Deployments — einen vorgelagerten `rclone`-Spiegel) mit
|
||||||
|
[restic](https://restic.net) (Content-defined Chunking, verschlüsseltes
|
||||||
|
Repository, geprüftes Tooling statt Eigenbau):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
export NEXARCH_OBJECTBACKUP_REPO_DIR=/var/nexarch-archiv/backups/objects
|
||||||
|
export NEXARCH_OBJECTBACKUP_PASSWORD=...
|
||||||
|
export NEXARCH_OBJECTBACKUP_KEEP_SNAPSHOTS=30 # optional, Default 7
|
||||||
|
|
||||||
|
objectbackup-cli backup /var/nexarch-objects # Sicherung + Verifikation
|
||||||
|
objectbackup-cli check # vollständiges Lesen aller Datenblöcke
|
||||||
|
objectbackup-cli rotate # restic forget --keep-last N --prune
|
||||||
|
```
|
||||||
|
|
||||||
|
## Betrieb: Backup-Zielverzeichnis
|
||||||
|
|
||||||
|
Backup-Ziele liegen unter `/var/nexarch-archiv/` (persistentes ZFS-Dataset,
|
||||||
|
`zfs/data/subvol-1131-disk-0` auf 192.168.1.131), NIEMALS unter
|
||||||
|
`/var/nexarch-test/` (ephemeres Dataset, wird von den `reset-test-env.sh`-
|
||||||
|
Skripten der anderen Module geleert). ZFS-seitige Snapshots/Replikation
|
||||||
|
dieses Datasets sind ein eigenständiges Infra-Runbook (siehe
|
||||||
|
`../../STORAGE-KONZEPT.md` Abschnitt 7), kein Ticket-Code — `zfs
|
||||||
|
dedup=on` bewusst NICHT setzen (hoher RAM-Bedarf), Deduplizierung läuft
|
||||||
|
ausschließlich App-seitig über restic.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
```bash
|
||||||
|
make check # build + vet + lint + test, analog Core/DMS
|
||||||
|
```
|
||||||
@@ -0,0 +1,107 @@
|
|||||||
|
// backup-cli ist der Aufrufpunkt für BAK-01, gedacht für systemd-Timer
|
||||||
|
// (siehe deploy/systemd/) — "automatisiert nach Zeitplan" (Akzeptanzkriterium
|
||||||
|
// 1) entsteht durch die Zeitplan-Definition im Timer-Unit, nicht durch
|
||||||
|
// einen eigenen In-Prozess-Scheduler (kein zusätzlicher Dauerprozess nötig,
|
||||||
|
// passt zur Produkt-DNA "kein Anwendungsserver mit unnötigem
|
||||||
|
// Ressourcenverbrauch").
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/backup"
|
||||||
|
)
|
||||||
|
|
||||||
|
func loadConfig() backup.Config {
|
||||||
|
cfg := backup.Config{
|
||||||
|
Host: os.Getenv("NEXARCH_BACKUP_PG_HOST"),
|
||||||
|
Port: os.Getenv("NEXARCH_BACKUP_PG_PORT"),
|
||||||
|
User: os.Getenv("NEXARCH_BACKUP_PG_USER"),
|
||||||
|
Password: os.Getenv("NEXARCH_BACKUP_PG_PASSWORD"),
|
||||||
|
BackupDir: os.Getenv("NEXARCH_BACKUP_DIR"),
|
||||||
|
}
|
||||||
|
if cfg.Host == "" {
|
||||||
|
cfg.Host = "localhost"
|
||||||
|
}
|
||||||
|
if cfg.Port == "" {
|
||||||
|
cfg.Port = "5432"
|
||||||
|
}
|
||||||
|
if cfg.User == "" || cfg.Password == "" || cfg.BackupDir == "" {
|
||||||
|
log.Fatal("NEXARCH_BACKUP_PG_USER, NEXARCH_BACKUP_PG_PASSWORD und NEXARCH_BACKUP_DIR muessen gesetzt sein")
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func latestManifest(backupDir string) (string, error) {
|
||||||
|
generations, err := backup.ListGenerations(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
return "", err
|
||||||
|
}
|
||||||
|
if len(generations) == 0 {
|
||||||
|
return "", fmt.Errorf("keine vorhandene generation fuer inkrementelle sicherung gefunden - zuerst 'full' ausfuehren")
|
||||||
|
}
|
||||||
|
latest := generations[len(generations)-1]
|
||||||
|
full := backupDir + "/" + latest + "/" + backup.FullBackupDirName + "/" + backup.BackupManifestFile
|
||||||
|
if _, err := os.Stat(full); err == nil {
|
||||||
|
return full, nil
|
||||||
|
}
|
||||||
|
return "", fmt.Errorf("kein backup_manifest in der neuesten generation %q gefunden", latest)
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if len(os.Args) < 2 {
|
||||||
|
log.Fatal("aufruf: backup-cli <full|incremental|verify|rotate> [args]")
|
||||||
|
}
|
||||||
|
cfg := loadConfig()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
switch os.Args[1] {
|
||||||
|
case "full":
|
||||||
|
genID := backup.NewGenerationID(time.Now())
|
||||||
|
manifest, err := backup.FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("vollsicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
dir := manifest[:len(manifest)-len("/"+backup.BackupManifestFile)]
|
||||||
|
if err := backup.Verify(dir); err != nil {
|
||||||
|
log.Fatalf("verifikation der vollsicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("vollsicherung %q erstellt und verifiziert: %s\n", genID, manifest)
|
||||||
|
|
||||||
|
case "incremental":
|
||||||
|
manifest, err := latestManifest(cfg.BackupDir)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
generations, _ := backup.ListGenerations(cfg.BackupDir)
|
||||||
|
genID := generations[len(generations)-1]
|
||||||
|
incID := backup.NewGenerationID(time.Now())
|
||||||
|
newManifest, err := backup.IncrementalBackup(ctx, cfg, genID, incID, manifest)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("inkrementelle sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
dir := newManifest[:len(newManifest)-len("/"+backup.BackupManifestFile)]
|
||||||
|
if err := backup.Verify(dir); err != nil {
|
||||||
|
log.Fatalf("verifikation der inkrementellen sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("inkrementelle sicherung %q erstellt und verifiziert: %s\n", incID, newManifest)
|
||||||
|
|
||||||
|
case "rotate":
|
||||||
|
keep := 7
|
||||||
|
if v := os.Getenv("NEXARCH_BACKUP_KEEP_GENERATIONS"); v != "" {
|
||||||
|
_, _ = fmt.Sscanf(v, "%d", &keep)
|
||||||
|
}
|
||||||
|
removed, err := backup.Rotate(cfg.BackupDir, keep)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("rotation fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("rotation abgeschlossen, %d generation(en) entfernt: %v\n", len(removed), removed)
|
||||||
|
|
||||||
|
default:
|
||||||
|
log.Fatalf("unbekannter befehl %q", os.Args[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,75 @@
|
|||||||
|
// objectbackup-cli ist der Aufrufpunkt für BAK-02, für systemd-Timer
|
||||||
|
// gedacht (siehe deploy/systemd/) — "automatisiert nach Zeitplan" entsteht
|
||||||
|
// durch die Timer-Definition, kein eigener Dauerprozess (dieselbe
|
||||||
|
// Begründung wie BAK-01 / cmd/backup-cli).
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"log"
|
||||||
|
"os"
|
||||||
|
"strconv"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/archive/internal/objectbackup"
|
||||||
|
)
|
||||||
|
|
||||||
|
func loadConfig() objectbackup.Config {
|
||||||
|
cfg := objectbackup.Config{
|
||||||
|
RepoDir: os.Getenv("NEXARCH_OBJECTBACKUP_REPO_DIR"),
|
||||||
|
Password: os.Getenv("NEXARCH_OBJECTBACKUP_PASSWORD"),
|
||||||
|
}
|
||||||
|
if cfg.RepoDir == "" || cfg.Password == "" {
|
||||||
|
log.Fatal("NEXARCH_OBJECTBACKUP_REPO_DIR und NEXARCH_OBJECTBACKUP_PASSWORD muessen gesetzt sein")
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if len(os.Args) < 2 {
|
||||||
|
log.Fatal("aufruf: objectbackup-cli <backup <quellverzeichnis>|check|rotate>")
|
||||||
|
}
|
||||||
|
cfg := loadConfig()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := objectbackup.InitRepo(ctx, cfg); err != nil {
|
||||||
|
log.Fatalf("repository initialisieren: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
switch os.Args[1] {
|
||||||
|
case "backup":
|
||||||
|
if len(os.Args) < 3 {
|
||||||
|
log.Fatal("aufruf: objectbackup-cli backup <quellverzeichnis>")
|
||||||
|
}
|
||||||
|
summary, err := objectbackup.Backup(ctx, cfg, os.Args[2])
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
if err := objectbackup.Check(ctx, cfg, false); err != nil {
|
||||||
|
log.Fatalf("verifikation nach sicherung fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Printf("sicherung %q erstellt und verifiziert (neu=%d geaendert=%d unveraendert=%d)\n",
|
||||||
|
summary.SnapshotID, summary.FilesNew, summary.FilesChanged, summary.FilesUnmodified)
|
||||||
|
|
||||||
|
case "check":
|
||||||
|
if err := objectbackup.Check(ctx, cfg, true); err != nil {
|
||||||
|
log.Fatalf("verifikation fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Println("verifikation (mit vollstaendigem lesen) erfolgreich")
|
||||||
|
|
||||||
|
case "rotate":
|
||||||
|
keep := 7
|
||||||
|
if v := os.Getenv("NEXARCH_OBJECTBACKUP_KEEP_SNAPSHOTS"); v != "" {
|
||||||
|
if n, err := strconv.Atoi(v); err == nil {
|
||||||
|
keep = n
|
||||||
|
}
|
||||||
|
}
|
||||||
|
if err := objectbackup.Forget(ctx, cfg, keep); err != nil {
|
||||||
|
log.Fatalf("rotation fehlgeschlagen: %v", err)
|
||||||
|
}
|
||||||
|
fmt.Println("rotation abgeschlossen")
|
||||||
|
|
||||||
|
default:
|
||||||
|
log.Fatalf("unbekannter befehl %q", os.Args[1])
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,87 @@
|
|||||||
|
# BAK-01 – Prüfprotokoll: Datenbank-Backup-Strategie
|
||||||
|
|
||||||
|
Welle 1, keine Vorbedingungen. Neues Modul-Verzeichnis `code/archive/`
|
||||||
|
(gleiches Monorepo-Muster wie `code/dms/`), eigenes Go-Modul
|
||||||
|
`gitea.perlbach24.de/scripte/nexarch/archive`.
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: PostgreSQL-17-natives inkrementelles Backup
|
||||||
|
|
||||||
|
`pg_dump` kennt nur logische Vollsicherungen — "inkrementell" im Sinne des
|
||||||
|
Tickets erfordert das physische Backup-Verfahren. Gewählt: PostgreSQL 17s
|
||||||
|
natives `pg_basebackup --incremental` (WAL-Summarization), NICHT klassisches
|
||||||
|
WAL-Archiving (`archive_mode`), weil letzteres einen Neustart der
|
||||||
|
(geteilten, auch von Core/DMS-Tests genutzten) Postgres-Instanz auf
|
||||||
|
192.168.1.131 erfordert hätte. Stattdessen `summarize_wal = on` gesetzt —
|
||||||
|
nur ein `pg_reload_conf()`, kein Neustart, keine Unterbrechung laufender
|
||||||
|
Verbindungen (per Health-Check nach der Änderung bestätigt).
|
||||||
|
|
||||||
|
Voraussetzung geschaffen: Rolle `nexarch_backup` mit `REPLICATION`-Attribut
|
||||||
|
angelegt (Postgres verlangt eine Replikationsverbindung für
|
||||||
|
`pg_basebackup`), `pg_hba.conf` erlaubte lokale Replikationsverbindungen
|
||||||
|
bereits.
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `internal/backup.FullBackup`/`IncrementalBackup` — rufen `pg_basebackup`
|
||||||
|
über `os/exec` auf, Ergebnis landet in einer Generationsstruktur
|
||||||
|
(`<BackupDir>/<Generation>/full/` bzw. `.../incremental/<ID>/`).
|
||||||
|
- `internal/backup.Verify` — öffnet `base.tar.gz` vollständig (gzip- UND
|
||||||
|
tar-Stream, jeder Eintrag bis zum Ende gelesen, nicht nur Kopfdaten) —
|
||||||
|
Akzeptanzkriterium 2: Verifikation auf Lesbarkeit, nicht nur Erstellung.
|
||||||
|
- `internal/backup.Rotate`/`ListGenerations` — Generationen sind nach
|
||||||
|
Zeitstempel-ID sortierbar, `Rotate` entfernt die ältesten bis auf `keep`
|
||||||
|
komplett (inklusive aller abhängigen Inkremente).
|
||||||
|
- `cmd/backup-cli` — `full`/`incremental`/`rotate`, aufgerufen von
|
||||||
|
systemd-Timern (`deploy/systemd/nexarch-archive-backup-*.timer`) —
|
||||||
|
"automatisiert nach Zeitplan" (Akzeptanzkriterium 1) entsteht durch die
|
||||||
|
Timer-Definition, kein zusätzlicher Dauerprozess nötig.
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Sicherung gegen Testdatenbank erfolgreich erstellt und verifiziert | **bestanden** — `TestFullBackup_CreatesVerifiedBackup` gegen die echte Postgres-17-Instanz auf 192.168.1.131 (kein Mock), zusätzlich `TestIncrementalBackup_IsSmallerThanFull`: inkrementelle Sicherung real deutlich kleiner als Vollsicherung (167 KB vs. 16 MB bei der ersten manuellen Probe) — beweist echte inkrementelle Übertragung, nicht nur eine zweite Vollsicherung |
|
||||||
|
| 2 | Verifikation erkennt eine absichtlich beschädigte Sicherungsdatei | **bestanden** — `TestVerify_DetectsCorruptedFile`: 64 Bytes in der Mitte von `base.tar.gz` gekippt, `Verify` schlägt danach fehl (unbeschädigt zuvor erfolgreich) |
|
||||||
|
| 3 | Rotationsregel entfernt nachweislich nur die ältesten Generationen | **bestanden** — `TestRotate_RemovesOnlyOldestGenerations`: 5 Generationen, `keep=2`, exakt die 3 ältesten entfernt, die 2 neuesten nachweislich unangetastet |
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131 (nicht nur Testcode)
|
||||||
|
|
||||||
|
Anders als die zuletzt in DMS gefundenen "Baustein existiert, ist aber
|
||||||
|
nirgends verdrahtet"-Fälle (FDN-03/FDN-09 gegen Core) wurde hier die
|
||||||
|
komplette Kette tatsächlich installiert und ausgeführt:
|
||||||
|
|
||||||
|
- `backup-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- `/etc/nexarch/archive-backup.env` mit den Verbindungsdaten (0600)
|
||||||
|
- 3 systemd-Timer installiert und aktiviert (`enable --now`):
|
||||||
|
Vollsicherung täglich 02:00 UTC, Inkrement stündlich, Rotation täglich
|
||||||
|
03:00 UTC (`systemctl list-timers` bestätigt alle drei scharf)
|
||||||
|
- Jeder der drei Dienste (`full`/`incremental`/`rotate`) einmal manuell über
|
||||||
|
`systemctl start` ausgelöst (nicht nur `go test` direkt) — alle drei mit
|
||||||
|
`status=0/SUCCESS`, Journal bestätigt inhaltlich korrekte Ausgabe
|
||||||
|
(Vollsicherung erstellt+verifiziert, Inkrement erstellt+verifiziert
|
||||||
|
gegen die richtige Vorgänger-Generation, Rotation lief ohne Fehler)
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 4/4 Tests ok, 0 Fehlschläge (echter Postgres 17, kein Mock)
|
||||||
|
```
|
||||||
|
|
||||||
|
## Nachtrag (BAK-02-Sitzung): Backup-Zielverzeichnis korrigiert
|
||||||
|
|
||||||
|
`NEXARCH_BACKUP_DIR` zeigte ursprünglich auf `/var/backups/nexarch`
|
||||||
|
(Root-Dateisystem des Containers, kein dediziertes Dataset) — korrigiert auf
|
||||||
|
`/var/nexarch-archiv/backups/postgres` (persistentes ZFS-Dataset), siehe
|
||||||
|
`docs/BAK-02-PRUEFPROTOKOLL.md` Abschnitt „Korrektur an BAK-01" für Details.
|
||||||
|
Vollsicherung nach der Korrektur erneut über systemd ausgelöst, landet
|
||||||
|
nachweislich am neuen Ort.
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
real erfüllt — inklusive tatsächlicher systemd-Timer-Installation und
|
||||||
|
manuell ausgelöstem End-to-End-Lauf aller drei Dienste auf dem Testhost,
|
||||||
|
nicht nur isolierter Testcode.
|
||||||
@@ -0,0 +1,93 @@
|
|||||||
|
# BAK-02 – Prüfprotokoll: Objekt-Storage-Backup/Snapshots
|
||||||
|
|
||||||
|
Welle 1, keine Vorbedingungen.
|
||||||
|
|
||||||
|
## Grundsatzentscheidung: restic statt Eigenbau
|
||||||
|
|
||||||
|
Nutzerentscheidung: restic statt einer Neuimplementierung, weil restic alle
|
||||||
|
vier Akzeptanzkriterien mit ausgereiftem, breit geprüftem Tooling erfüllt
|
||||||
|
(Content-defined Chunking für Dedup, `check --read-data` für
|
||||||
|
Vollständigkeit, `forget --keep-last` für Rotation, Repository-Verschlüsselung
|
||||||
|
ab Werk). Installiert via `apt-get install restic` (Version 0.18.0).
|
||||||
|
|
||||||
|
Backup-Quelle ist ein lokaler Verzeichnisbaum — für den FDN-03-`LocalDriver`
|
||||||
|
direkt dessen Basisverzeichnis. Für S3-gestützte Produktions-Deployments
|
||||||
|
(Betriebsmodus 2/3 aus `STORAGE-KONZEPT.md` Abschnitt 6.2) wäre ein
|
||||||
|
vorgelagerter Sync-Schritt (z. B. `rclone`) nötig, um Bucket-Inhalte lokal
|
||||||
|
zu spiegeln, bevor restic sie sichert — restic sichert Dateibäume, keine
|
||||||
|
S3-Buckets direkt. Das bleibt hier bewusst unimplementiert (kein konkreter
|
||||||
|
S3-Produktionsbestand vorhanden, der das aktuell erfordert), aber
|
||||||
|
architektonisch vorgesehen und dokumentiert (`README.md`).
|
||||||
|
|
||||||
|
## Umsetzung
|
||||||
|
|
||||||
|
- `internal/objectbackup.InitRepo` — idempotent, erkennt "bereits
|
||||||
|
initialisiert" am `restic init`-Fehlertext statt zu scheitern.
|
||||||
|
- `internal/objectbackup.Backup` — `restic backup --json`, parst die
|
||||||
|
`summary`-Zeile (mehrere JSON-Zeilen in der Ausgabe, gezielt die mit
|
||||||
|
`message_type=="summary"` gesucht).
|
||||||
|
- `internal/objectbackup.Check` — `restic check [--read-data]` (Akzeptanz-
|
||||||
|
kriterium 3: Vollständigkeitsprüfung).
|
||||||
|
- `internal/objectbackup.Forget` — `restic forget --keep-last N --prune`
|
||||||
|
(Rotation).
|
||||||
|
- `cmd/objectbackup-cli` — `backup <dir>`/`check`/`rotate`, aufgerufen von
|
||||||
|
systemd-Timern (stündlich/wöchentlich/täglich).
|
||||||
|
|
||||||
|
## Prüfungen
|
||||||
|
|
||||||
|
| # | Prüfung | Ergebnis |
|
||||||
|
|---|---|---|
|
||||||
|
| 1 | Zweiter Sicherungslauf nach unverändertem Bestand überträgt keine Daten erneut | **bestanden** — `TestBackup_UnchangedSecondRunTransmitsNothingNew`: zweiter Lauf gegen unveränderten Bestand liefert `files_new=0`, `files_changed=0`, `files_unmodified=1` |
|
||||||
|
| 2 | Zwei identische Testdateien belegen nachweislich nur einmal Speicherplatz | **bestanden** — `TestBackup_DeduplicatesIdenticalContent`: zwei Dateien mit identischem Inhalt erzeugen `data_blobs=1`, nicht 2 — echter Dedup-Nachweis über restics Content-defined Chunking, nicht nur Namensvergleich |
|
||||||
|
| 3 | Vollständigkeitsprüfung erkennt ein fehlendes Objekt in der Sicherung | **bestanden** — `TestCheck_DetectsCorruptedPack`: ein Byte in einer echten Repository-Pack-Datei gekippt, `Check(readData=true)` schlägt danach fehl (unbeschädigt zuvor erfolgreich) — dieselbe Vorgehensweise wie die manuelle Recherche vor der Implementierung |
|
||||||
|
|
||||||
|
Zusätzlich (nicht explizit als Pflichtprüfung gefordert, aber Teil von
|
||||||
|
Akzeptanzkriterium 3 „lässt sich einzeln prüfen"): `TestForget_
|
||||||
|
KeepsOnlyRequestedSnapshotCount` — 3 Sicherungsläufe, `Forget(keepLast=1)`
|
||||||
|
reduziert auf genau 1 verbleibenden Snapshot.
|
||||||
|
|
||||||
|
## Korrektur an BAK-01 im selben Rutsch: Backup-Zielverzeichnis
|
||||||
|
|
||||||
|
Nutzerhinweis aufgegriffen: `NEXARCH_BACKUP_DIR` zeigte bei BAK-01
|
||||||
|
ursprünglich auf `/var/backups/nexarch` (Root-Dateisystem des LXC-
|
||||||
|
Containers, nicht auf einem der beiden dedizierten ZFS-Datasets). Korrigiert
|
||||||
|
auf `/var/nexarch-archiv/backups/postgres` (persistentes Dataset
|
||||||
|
`zfs/data/subvol-1131-disk-0`), NICHT `/var/nexarch-test/` (ephemeres
|
||||||
|
Dataset `ssd-rpool-data/swap/subvol-1131-disk-0`, wird von
|
||||||
|
`reset-test-env.sh`-Skripten anderer Module geleert). `objectbackup-cli`s
|
||||||
|
Repository liegt von Anfang an korrekt unter
|
||||||
|
`/var/nexarch-archiv/backups/objects`. Beide Pfade real auf
|
||||||
|
192.168.1.131 verifiziert (`df`/`mount` bestätigt ZFS-Dataset-Zuordnung),
|
||||||
|
BAK-01s Vollsicherung nach der Korrektur erneut über systemd ausgelöst und
|
||||||
|
bestätigt am neuen Ort gelandet.
|
||||||
|
|
||||||
|
ZFS-seitige Snapshot-/Replikations-Strategie für `nexarch/archiv` bleibt
|
||||||
|
bewusst außerhalb dieses Tickets (Infra-Runbook, siehe
|
||||||
|
`STORAGE-KONZEPT.md` Abschnitt 7 „Backup vs. Storage-Redundanz" sowie den
|
||||||
|
Hinweis, `zfs dedup=on` NICHT zu setzen — App-seitige Dedup über restic
|
||||||
|
genügt, ZFS-Dedup wäre auf dem 4-GB-Testhost ein Speicherrisiko).
|
||||||
|
|
||||||
|
## Echte Verdrahtung auf 192.168.1.131
|
||||||
|
|
||||||
|
- `objectbackup-cli` gebaut nach `/opt/nexarch-archive/bin/`
|
||||||
|
- `/etc/nexarch/archive-objectbackup.env` (0600)
|
||||||
|
- 3 systemd-Timer installiert und aktiviert: Sicherung stündlich (`:30`),
|
||||||
|
Vollständigkeitsprüfung wöchentlich (So. 04:00 UTC), Rotation täglich
|
||||||
|
(03:30 UTC) — `systemctl list-timers` bestätigt alle scharf
|
||||||
|
- Jeder der drei Dienste einmal über `systemctl start` ausgelöst, alle mit
|
||||||
|
`status=0/SUCCESS`; Journal bestätigt inhaltlich korrekte Ausgabe
|
||||||
|
|
||||||
|
## Build/Test-Ergebnis (192.168.1.131, `make check`)
|
||||||
|
|
||||||
|
```
|
||||||
|
go build ./... -> clean
|
||||||
|
go vet ./... -> clean
|
||||||
|
golangci-lint run ./... -> 0 issues
|
||||||
|
go test ./... -p 1 -count=1 -> 2/2 Pakete mit Tests ok (internal/backup, internal/objectbackup), 0 Fehlschläge
|
||||||
|
```
|
||||||
|
|
||||||
|
## Gesamtergebnis
|
||||||
|
|
||||||
|
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
||||||
|
real gegen echtes restic-Tooling erfüllt. BAK-01-Pfadfehler im selben
|
||||||
|
Rutsch korrigiert und erneut end-to-end verifiziert.
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
module gitea.perlbach24.de/scripte/nexarch/archive
|
||||||
|
|
||||||
|
go 1.22
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
// Package backup implementiert BAK-01: automatisierte, inkrementelle
|
||||||
|
// Sicherung der PostgreSQL-Datenbank per pg_basebackup (PostgreSQL 17s
|
||||||
|
// natives inkrementelles Backup über WAL-Summarization, siehe
|
||||||
|
// `summarize_wal`), mit Verifikation jeder Sicherung und
|
||||||
|
// generationsbasierter Rotation. Kein pg_dump-basierter Ansatz, weil
|
||||||
|
// pg_dump ausschließlich logische Vollsicherungen kennt — "inkrementell"
|
||||||
|
// im Sinne des Tickets erfordert das physische, WAL-summary-gestützte
|
||||||
|
// Verfahren aus PostgreSQL 17.
|
||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Config enthält die Verbindungsdaten für pg_basebackup — ausschließlich
|
||||||
|
// über Umgebungsvariablen befüllt, nie im Code (siehe Ticket-Abschluss-
|
||||||
|
// Regel).
|
||||||
|
type Config struct {
|
||||||
|
Host string
|
||||||
|
Port string
|
||||||
|
User string
|
||||||
|
Password string
|
||||||
|
BackupDir string
|
||||||
|
PgBaseBackupPath string // Default "pg_basebackup", überschreibbar für Tests
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Config) binary() string {
|
||||||
|
if c.PgBaseBackupPath != "" {
|
||||||
|
return c.PgBaseBackupPath
|
||||||
|
}
|
||||||
|
return "pg_basebackup"
|
||||||
|
}
|
||||||
|
|
||||||
|
// FullBackupDirName/IncrementalDirName sind die festen Unterverzeichnis-
|
||||||
|
// namen je Generation.
|
||||||
|
const (
|
||||||
|
FullBackupDirName = "full"
|
||||||
|
IncrementalSubdir = "incremental"
|
||||||
|
BackupManifestFile = "backup_manifest"
|
||||||
|
BaseTarGzFile = "base.tar.gz"
|
||||||
|
)
|
||||||
|
|
||||||
|
// NewGenerationID liefert eine sortierbare, eindeutige Generation-Kennung
|
||||||
|
// (RFC3339-artig, dateisystemtauglich) — Generationen werden anhand dieser
|
||||||
|
// Kennung chronologisch sortiert (Rotate, ListGenerations).
|
||||||
|
func NewGenerationID(t time.Time) string {
|
||||||
|
return t.UTC().Format("20060102T150405Z")
|
||||||
|
}
|
||||||
|
|
||||||
|
// FullBackup erstellt eine neue Vollsicherung (Akzeptanzkriterium 1) als
|
||||||
|
// eigene Generation. Liefert den Pfad zum backup_manifest, das spätere
|
||||||
|
// IncrementalBackup-Aufrufe als Referenz brauchen.
|
||||||
|
func FullBackup(ctx context.Context, cfg Config, generationID string) (manifestPath string, err error) {
|
||||||
|
dir := filepath.Join(cfg.BackupDir, generationID, FullBackupDirName)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(dir), 0o750); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: generationsverzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
args := []string{
|
||||||
|
"-h", cfg.Host, "-p", cfg.Port, "-U", cfg.User,
|
||||||
|
"-D", dir, "-Ft", "-z", "--checkpoint=fast", "--no-password",
|
||||||
|
}
|
||||||
|
if err := runPgBaseBackup(ctx, cfg, args); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: vollsicherung: %w", err)
|
||||||
|
}
|
||||||
|
return filepath.Join(dir, BackupManifestFile), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// IncrementalBackup erstellt eine inkrementelle Sicherung gegen die zuletzt
|
||||||
|
// bekannte Vollsicherung ODER die letzte Inkrement-Sicherung (priorManifestPath
|
||||||
|
// zeigt jeweils auf das backup_manifest der Referenz).
|
||||||
|
func IncrementalBackup(ctx context.Context, cfg Config, generationID, incrementID, priorManifestPath string) (manifestPath string, err error) {
|
||||||
|
dir := filepath.Join(cfg.BackupDir, generationID, IncrementalSubdir, incrementID)
|
||||||
|
if err := os.MkdirAll(filepath.Dir(dir), 0o750); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: inkrement-verzeichnis anlegen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
args := []string{
|
||||||
|
"-h", cfg.Host, "-p", cfg.Port, "-U", cfg.User,
|
||||||
|
"-D", dir, "-Ft", "-z", "--checkpoint=fast", "--no-password",
|
||||||
|
"--incremental=" + priorManifestPath,
|
||||||
|
}
|
||||||
|
if err := runPgBaseBackup(ctx, cfg, args); err != nil {
|
||||||
|
return "", fmt.Errorf("backup: inkrementelle sicherung: %w", err)
|
||||||
|
}
|
||||||
|
return filepath.Join(dir, BackupManifestFile), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func runPgBaseBackup(ctx context.Context, cfg Config, args []string) error {
|
||||||
|
cmd := exec.CommandContext(ctx, cfg.binary(), args...)
|
||||||
|
cmd.Env = append(os.Environ(), "PGPASSWORD="+cfg.Password)
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%s fehlgeschlagen: %w (ausgabe: %s)", cfg.binary(), err, string(output))
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,187 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireTestConfig(t *testing.T) Config {
|
||||||
|
t.Helper()
|
||||||
|
user := os.Getenv("TEST_BACKUP_PG_USER")
|
||||||
|
if user == "" {
|
||||||
|
t.Skip("TEST_BACKUP_PG_USER nicht gesetzt, Integrationstest uebersprungen (braucht echten Postgres mit REPLICATION-Rolle)")
|
||||||
|
}
|
||||||
|
return Config{
|
||||||
|
Host: envOr("TEST_BACKUP_PG_HOST", "localhost"),
|
||||||
|
Port: envOr("TEST_BACKUP_PG_PORT", "5432"),
|
||||||
|
User: user,
|
||||||
|
Password: os.Getenv("TEST_BACKUP_PG_PASSWORD"),
|
||||||
|
BackupDir: t.TempDir(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func envOr(key, fallback string) string {
|
||||||
|
if v := os.Getenv(key); v != "" {
|
||||||
|
return v
|
||||||
|
}
|
||||||
|
return fallback
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestFullBackup_CreatesVerifiedBackup ist Pruefung 1: Sicherung gegen
|
||||||
|
// Testdatenbank erfolgreich erstellt und verifiziert.
|
||||||
|
func TestFullBackup_CreatesVerifiedBackup(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
manifest, err := FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := os.Stat(manifest); err != nil {
|
||||||
|
t.Fatalf("backup_manifest fehlt: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
dir := filepath.Dir(manifest)
|
||||||
|
if _, err := os.Stat(filepath.Join(dir, BaseTarGzFile)); err != nil {
|
||||||
|
t.Fatalf("%s fehlt: %v", BaseTarGzFile, err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Verify(dir); err != nil {
|
||||||
|
t.Fatalf("verify: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestIncrementalBackup_IsSmallerThanFull ist der Nachweis fuer
|
||||||
|
// Akzeptanzkriterium 1 (inkrementell): eine echte inkrementelle Sicherung
|
||||||
|
// gegen unveraenderten Bestand ist deutlich kleiner als die Vollsicherung —
|
||||||
|
// beweist, dass tatsaechlich nur Aenderungen uebertragen wurden (PostgreSQL
|
||||||
|
// 17 WAL-Summarization), nicht nochmal alles.
|
||||||
|
func TestIncrementalBackup_IsSmallerThanFull(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
fullManifest, err := FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
fullDir := filepath.Dir(fullManifest)
|
||||||
|
fullSize := fileSize(t, filepath.Join(fullDir, BaseTarGzFile))
|
||||||
|
|
||||||
|
incID := NewGenerationID(time.Now().Add(time.Second))
|
||||||
|
incManifest, err := IncrementalBackup(ctx, cfg, genID, incID, fullManifest)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("incrementalbackup: %v", err)
|
||||||
|
}
|
||||||
|
incDir := filepath.Dir(incManifest)
|
||||||
|
if err := Verify(incDir); err != nil {
|
||||||
|
t.Fatalf("verify (inkrementell): %v", err)
|
||||||
|
}
|
||||||
|
incSize := fileSize(t, filepath.Join(incDir, BaseTarGzFile))
|
||||||
|
|
||||||
|
if incSize >= fullSize {
|
||||||
|
t.Fatalf("inkrementelle sicherung (%d bytes) ist nicht kleiner als die vollsicherung (%d bytes) - keine echte inkrementelle Uebertragung", incSize, fullSize)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func fileSize(t *testing.T, path string) int64 {
|
||||||
|
t.Helper()
|
||||||
|
info, err := os.Stat(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("dateigroesse von %q ermitteln: %v", path, err)
|
||||||
|
}
|
||||||
|
return info.Size()
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestVerify_DetectsCorruptedFile ist Pruefung 2: Verifikation erkennt eine
|
||||||
|
// absichtlich beschaedigte Sicherungsdatei.
|
||||||
|
func TestVerify_DetectsCorruptedFile(t *testing.T) {
|
||||||
|
cfg := requireTestConfig(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
genID := NewGenerationID(time.Now())
|
||||||
|
manifest, err := FullBackup(ctx, cfg, genID)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("fullbackup: %v", err)
|
||||||
|
}
|
||||||
|
dir := filepath.Dir(manifest)
|
||||||
|
|
||||||
|
if err := Verify(dir); err != nil {
|
||||||
|
t.Fatalf("verify (unbeschaedigt) haette erfolgreich sein muessen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Absichtliche Beschaedigung: mehrere Bytes in der Mitte der Datei kippen.
|
||||||
|
path := filepath.Join(dir, BaseTarGzFile)
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("sicherungsdatei lesen: %v", err)
|
||||||
|
}
|
||||||
|
mid := len(data) / 2
|
||||||
|
for i := mid; i < mid+64 && i < len(data); i++ {
|
||||||
|
data[i] ^= 0xFF
|
||||||
|
}
|
||||||
|
if err := os.WriteFile(path, data, 0o600); err != nil {
|
||||||
|
t.Fatalf("beschaedigte sicherungsdatei schreiben: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Verify(dir); err == nil {
|
||||||
|
t.Fatal("verify haette die beschaedigte sicherungsdatei erkennen muessen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestRotate_RemovesOnlyOldestGenerations ist Pruefung 3.
|
||||||
|
func TestRotate_RemovesOnlyOldestGenerations(t *testing.T) {
|
||||||
|
backupDir := t.TempDir()
|
||||||
|
generationIDs := []string{
|
||||||
|
"20260101T000000Z",
|
||||||
|
"20260102T000000Z",
|
||||||
|
"20260103T000000Z",
|
||||||
|
"20260104T000000Z",
|
||||||
|
"20260105T000000Z",
|
||||||
|
}
|
||||||
|
for _, id := range generationIDs {
|
||||||
|
if err := os.MkdirAll(filepath.Join(backupDir, id, FullBackupDirName), 0o750); err != nil {
|
||||||
|
t.Fatalf("generation %q anlegen: %v", id, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
removed, err := Rotate(backupDir, 2)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("rotate: %v", err)
|
||||||
|
}
|
||||||
|
wantRemoved := []string{"20260101T000000Z", "20260102T000000Z", "20260103T000000Z"}
|
||||||
|
if len(removed) != len(wantRemoved) {
|
||||||
|
t.Fatalf("entfernte generationen = %v, want %v", removed, wantRemoved)
|
||||||
|
}
|
||||||
|
for i, w := range wantRemoved {
|
||||||
|
if removed[i] != w {
|
||||||
|
t.Fatalf("entfernte generationen = %v, want %v", removed, wantRemoved)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
remaining, err := ListGenerations(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("listgenerations: %v", err)
|
||||||
|
}
|
||||||
|
wantRemaining := []string{"20260104T000000Z", "20260105T000000Z"}
|
||||||
|
if len(remaining) != len(wantRemaining) {
|
||||||
|
t.Fatalf("verbleibende generationen = %v, want %v", remaining, wantRemaining)
|
||||||
|
}
|
||||||
|
for i, w := range wantRemaining {
|
||||||
|
if remaining[i] != w {
|
||||||
|
t.Fatalf("verbleibende generationen = %v, want %v", remaining, wantRemaining)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Die NEUESTEN duerfen NICHT entfernt sein (Pruefung 3: nur die
|
||||||
|
// aeltesten Generationen).
|
||||||
|
for _, w := range wantRemaining {
|
||||||
|
if _, err := os.Stat(filepath.Join(backupDir, w)); err != nil {
|
||||||
|
t.Fatalf("neueste generation %q wurde faelschlich entfernt: %v", w, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,56 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
"sort"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ListGenerations liefert alle Generation-IDs in backupDir, aufsteigend
|
||||||
|
// sortiert (die GenerationID selbst ist chronologisch sortierbar, siehe
|
||||||
|
// NewGenerationID — kein Blick auf Dateisystem-Zeitstempel nötig, die bei
|
||||||
|
// einem Restore/Kopiervorgang verändert werden könnten).
|
||||||
|
func ListGenerations(backupDir string) ([]string, error) {
|
||||||
|
entries, err := os.ReadDir(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
if os.IsNotExist(err) {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
return nil, fmt.Errorf("backup: sicherungsverzeichnis lesen: %w", err)
|
||||||
|
}
|
||||||
|
var generations []string
|
||||||
|
for _, e := range entries {
|
||||||
|
if e.IsDir() {
|
||||||
|
generations = append(generations, e.Name())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
sort.Strings(generations)
|
||||||
|
return generations, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Rotate entfernt alle bis auf die `keep` NEUESTEN Generationen
|
||||||
|
// (Akzeptanzkriterium 3) — jede Generation umfasst ihre Vollsicherung UND
|
||||||
|
// alle davon abhängigen Inkremente, ein Löschen der gesamten
|
||||||
|
// Generationsverzeichnisses entfernt beides konsistent zusammen.
|
||||||
|
func Rotate(backupDir string, keep int) (removed []string, err error) {
|
||||||
|
if keep < 0 {
|
||||||
|
keep = 0
|
||||||
|
}
|
||||||
|
generations, err := ListGenerations(backupDir)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
if len(generations) <= keep {
|
||||||
|
return nil, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
toRemove := generations[:len(generations)-keep]
|
||||||
|
for _, gen := range toRemove {
|
||||||
|
if err := os.RemoveAll(filepath.Join(backupDir, gen)); err != nil {
|
||||||
|
return removed, fmt.Errorf("backup: generation %q entfernen: %w", gen, err)
|
||||||
|
}
|
||||||
|
removed = append(removed, gen)
|
||||||
|
}
|
||||||
|
return removed, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,54 @@
|
|||||||
|
package backup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"archive/tar"
|
||||||
|
"compress/gzip"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"os"
|
||||||
|
"path/filepath"
|
||||||
|
)
|
||||||
|
|
||||||
|
// ErrCorrupted wird geliefert, wenn eine Sicherungsdatei nicht lesbar ist
|
||||||
|
// (Akzeptanzkriterium 2: Verifikation, nicht nur Erstellungs-Prüfung).
|
||||||
|
var ErrCorrupted = fmt.Errorf("backup: sicherungsdatei ist beschaedigt oder unvollstaendig")
|
||||||
|
|
||||||
|
// Verify prüft, dass base.tar.gz im gegebenen Sicherungsverzeichnis
|
||||||
|
// vollständig lesbar ist — öffnet gzip- UND tar-Stream und liest JEDEN
|
||||||
|
// Eintrag bis zum Ende durch (nicht nur die Kopfdaten), damit ein
|
||||||
|
// abgeschnittener oder mit kaputten Bytes überschriebener Inhalt
|
||||||
|
// zuverlässig auffällt, nicht nur ein defekter Tar-Header.
|
||||||
|
func Verify(backupDir string) error {
|
||||||
|
path := filepath.Join(backupDir, BaseTarGzFile)
|
||||||
|
f, err := os.Open(path)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: %s nicht lesbar: %v", ErrCorrupted, path, err)
|
||||||
|
}
|
||||||
|
defer func() { _ = f.Close() }()
|
||||||
|
|
||||||
|
gz, err := gzip.NewReader(f)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: gzip-header ungueltig: %v", ErrCorrupted, err)
|
||||||
|
}
|
||||||
|
defer func() { _ = gz.Close() }()
|
||||||
|
|
||||||
|
tr := tar.NewReader(gz)
|
||||||
|
entries := 0
|
||||||
|
for {
|
||||||
|
hdr, err := tr.Next()
|
||||||
|
if err == io.EOF {
|
||||||
|
break
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("%w: tar-eintrag ungueltig: %v", ErrCorrupted, err)
|
||||||
|
}
|
||||||
|
if _, err := io.Copy(io.Discard, tr); err != nil {
|
||||||
|
return fmt.Errorf("%w: inhalt von %q nicht vollstaendig lesbar: %v", ErrCorrupted, hdr.Name, err)
|
||||||
|
}
|
||||||
|
entries++
|
||||||
|
}
|
||||||
|
if entries == 0 {
|
||||||
|
return fmt.Errorf("%w: archiv enthaelt keine eintraege", ErrCorrupted)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,156 @@
|
|||||||
|
// Package objectbackup implementiert BAK-02: automatisierte, inkrementelle,
|
||||||
|
// deduplizierende Sicherung des Objekt-Storage-Bestands. Nutzt restic
|
||||||
|
// (Content-defined Chunking, verschlüsseltes Repository ab Werk) statt
|
||||||
|
// Eigenbau — restic erfüllt alle Akzeptanzkriterien mit ausgereiftem,
|
||||||
|
// geprüftem Tooling statt einer weniger robusten Neuimplementierung.
|
||||||
|
//
|
||||||
|
// Backup-Quelle ist ein lokaler Verzeichnisbaum — für den LocalDriver aus
|
||||||
|
// FDN-03 direkt dessen Basisverzeichnis, für S3-gestützte Produktions-
|
||||||
|
// Deployments ein vorgelagerter Sync-Schritt (z.B. rclone) auf einen
|
||||||
|
// lokalen Spiegel, bevor restic ihn sichert (nicht Bestandteil dieser
|
||||||
|
// Kachel — restic selbst sichert Dateibäume, keine S3-Buckets direkt).
|
||||||
|
package objectbackup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"strings"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Config enthält Repository-Ort und -Passwort — ausschließlich über
|
||||||
|
// Umgebungsvariablen befüllt (siehe Ticket-Abschluss-Regel).
|
||||||
|
type Config struct {
|
||||||
|
RepoDir string
|
||||||
|
Password string
|
||||||
|
ResticPath string // Default "restic", überschreibbar für Tests
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Config) binary() string {
|
||||||
|
if c.ResticPath != "" {
|
||||||
|
return c.ResticPath
|
||||||
|
}
|
||||||
|
return "restic"
|
||||||
|
}
|
||||||
|
|
||||||
|
func (c Config) env() []string {
|
||||||
|
return append(os.Environ(), "RESTIC_PASSWORD="+c.Password)
|
||||||
|
}
|
||||||
|
|
||||||
|
func run(ctx context.Context, cfg Config, args ...string) ([]byte, error) {
|
||||||
|
fullArgs := append([]string{"-r", cfg.RepoDir}, args...)
|
||||||
|
cmd := exec.CommandContext(ctx, cfg.binary(), fullArgs...)
|
||||||
|
cmd.Env = cfg.env()
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if err != nil {
|
||||||
|
return output, fmt.Errorf("%s %v fehlgeschlagen: %w (ausgabe: %s)", cfg.binary(), args, err, string(output))
|
||||||
|
}
|
||||||
|
return output, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// InitRepo legt ein neues restic-Repository an, falls es noch nicht
|
||||||
|
// existiert — idempotent, ein bereits initialisiertes Repository ist kein
|
||||||
|
// Fehler (Wiederholte Aufrufe durch systemd-Timer nach einem Neustart
|
||||||
|
// dürfen nicht fehlschlagen).
|
||||||
|
func InitRepo(ctx context.Context, cfg Config) error {
|
||||||
|
output, err := run(ctx, cfg, "init")
|
||||||
|
if err != nil {
|
||||||
|
if strings.Contains(string(output), "config file already exists") {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
return fmt.Errorf("objectbackup: repository initialisieren: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// BackupSummary ist der geparste "summary"-Datensatz aus `restic backup --json`.
|
||||||
|
type BackupSummary struct {
|
||||||
|
SnapshotID string `json:"snapshot_id"`
|
||||||
|
FilesNew int `json:"files_new"`
|
||||||
|
FilesChanged int `json:"files_changed"`
|
||||||
|
FilesUnmodified int `json:"files_unmodified"`
|
||||||
|
DataBlobs int `json:"data_blobs"`
|
||||||
|
TotalBytes int64 `json:"total_bytes_processed"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// Backup sichert sourceDir inkrementell (Akzeptanzkriterium 1: unveränderte
|
||||||
|
// Objekte werden nicht erneut übertragen — restics Content-defined
|
||||||
|
// Chunking erkennt das automatisch, kein manueller Änderungsabgleich
|
||||||
|
// nötig).
|
||||||
|
func Backup(ctx context.Context, cfg Config, sourceDir string) (BackupSummary, error) {
|
||||||
|
output, err := run(ctx, cfg, "backup", sourceDir, "--json")
|
||||||
|
if err != nil {
|
||||||
|
return BackupSummary{}, fmt.Errorf("objectbackup: sicherung: %w", err)
|
||||||
|
}
|
||||||
|
return parseSummary(output)
|
||||||
|
}
|
||||||
|
|
||||||
|
// parseSummary sucht in der zeilenweisen JSON-Ausgabe von `restic backup
|
||||||
|
// --json` (mehrere Fortschritts-/Statuszeilen, GENAU EINE mit
|
||||||
|
// message_type=="summary") die Zusammenfassung.
|
||||||
|
func parseSummary(output []byte) (BackupSummary, error) {
|
||||||
|
lines := strings.Split(strings.TrimSpace(string(output)), "\n")
|
||||||
|
for i := len(lines) - 1; i >= 0; i-- {
|
||||||
|
var probe struct {
|
||||||
|
MessageType string `json:"message_type"`
|
||||||
|
}
|
||||||
|
if err := json.Unmarshal([]byte(lines[i]), &probe); err != nil {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
if probe.MessageType == "summary" {
|
||||||
|
var summary BackupSummary
|
||||||
|
if err := json.Unmarshal([]byte(lines[i]), &summary); err != nil {
|
||||||
|
return BackupSummary{}, fmt.Errorf("objectbackup: summary-zeile dekodieren: %w", err)
|
||||||
|
}
|
||||||
|
return summary, nil
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return BackupSummary{}, fmt.Errorf("objectbackup: keine summary-zeile in der restic-ausgabe gefunden")
|
||||||
|
}
|
||||||
|
|
||||||
|
// Check prüft die Vollständigkeit/Lesbarkeit des Repository
|
||||||
|
// (Akzeptanzkriterium 3 / Pflichtprüfung: Vollständigkeitsprüfung erkennt
|
||||||
|
// fehlendes/beschädigtes Objekt). readData=true liest jeden gespeicherten
|
||||||
|
// Datenblock tatsächlich (teurer, aber die einzige Prüfung, die
|
||||||
|
// Bit-Rot in bereits gespeicherten Paketen erkennt — ohne readData prüft
|
||||||
|
// restic nur Struktur/Indizes, nicht den tatsächlichen Blockinhalt).
|
||||||
|
func Check(ctx context.Context, cfg Config, readData bool) error {
|
||||||
|
args := []string{"check"}
|
||||||
|
if readData {
|
||||||
|
args = append(args, "--read-data")
|
||||||
|
}
|
||||||
|
if _, err := run(ctx, cfg, args...); err != nil {
|
||||||
|
return fmt.Errorf("objectbackup: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Forget entfernt alte Snapshots nach Rotationsregel und gibt den davon
|
||||||
|
// belegten Speicherplatz frei (--prune) — restics Äquivalent zu
|
||||||
|
// BAK-01s Rotate.
|
||||||
|
func Forget(ctx context.Context, cfg Config, keepLast int) error {
|
||||||
|
if _, err := run(ctx, cfg, "forget", "--keep-last", fmt.Sprintf("%d", keepLast), "--prune"); err != nil {
|
||||||
|
return fmt.Errorf("objectbackup: rotation: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
type snapshotEntry struct {
|
||||||
|
ShortID string `json:"short_id"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// SnapshotCount liefert die Anzahl vorhandener Snapshots — für Tests und
|
||||||
|
// Statusabfragen.
|
||||||
|
func SnapshotCount(ctx context.Context, cfg Config) (int, error) {
|
||||||
|
output, err := run(ctx, cfg, "snapshots", "--json")
|
||||||
|
if err != nil {
|
||||||
|
return 0, fmt.Errorf("objectbackup: snapshots auflisten: %w", err)
|
||||||
|
}
|
||||||
|
var snapshots []snapshotEntry
|
||||||
|
if err := json.Unmarshal(output, &snapshots); err != nil {
|
||||||
|
return 0, fmt.Errorf("objectbackup: snapshot-liste dekodieren: %w", err)
|
||||||
|
}
|
||||||
|
return len(snapshots), nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,168 @@
|
|||||||
|
package objectbackup
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"os/exec"
|
||||||
|
"path/filepath"
|
||||||
|
"testing"
|
||||||
|
)
|
||||||
|
|
||||||
|
func requireRestic(t *testing.T) {
|
||||||
|
t.Helper()
|
||||||
|
if _, err := exec.LookPath("restic"); err != nil {
|
||||||
|
t.Skip("restic nicht installiert, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func setupTest(t *testing.T) Config {
|
||||||
|
t.Helper()
|
||||||
|
requireRestic(t)
|
||||||
|
cfg := Config{RepoDir: filepath.Join(t.TempDir(), "repo"), Password: "test-passwort-fuer-objectbackup"}
|
||||||
|
if err := InitRepo(context.Background(), cfg); err != nil {
|
||||||
|
t.Fatalf("initrepo: %v", err)
|
||||||
|
}
|
||||||
|
return cfg
|
||||||
|
}
|
||||||
|
|
||||||
|
func writeFile(t *testing.T, dir, name, content string) {
|
||||||
|
t.Helper()
|
||||||
|
if err := os.WriteFile(filepath.Join(dir, name), []byte(content), 0o600); err != nil {
|
||||||
|
t.Fatalf("testdatei %q schreiben: %v", name, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestBackup_UnchangedSecondRunTransmitsNothingNew ist Pruefung 1:
|
||||||
|
// zweiter Sicherungslauf nach unveraendertem Bestand ueberraegt keine
|
||||||
|
// Daten erneut.
|
||||||
|
func TestBackup_UnchangedSecondRunTransmitsNothingNew(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
writeFile(t, sourceDir, "dokument.pdf", "unveraenderter inhalt")
|
||||||
|
|
||||||
|
first, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("erste sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if first.FilesNew != 1 {
|
||||||
|
t.Fatalf("erste sicherung: files_new = %d, want 1", first.FilesNew)
|
||||||
|
}
|
||||||
|
|
||||||
|
second, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("zweite sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if second.FilesNew != 0 || second.FilesChanged != 0 {
|
||||||
|
t.Fatalf("zweite sicherung (unveraendert): files_new=%d files_changed=%d, want beide 0", second.FilesNew, second.FilesChanged)
|
||||||
|
}
|
||||||
|
if second.FilesUnmodified != 1 {
|
||||||
|
t.Fatalf("zweite sicherung: files_unmodified = %d, want 1", second.FilesUnmodified)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestBackup_DeduplicatesIdenticalContent ist Pruefung 2: zwei identische
|
||||||
|
// Testdateien belegen nachweislich nur einmal Speicherplatz.
|
||||||
|
func TestBackup_DeduplicatesIdenticalContent(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
content := "exakt identischer inhalt in beiden dateien fuer den dedup-nachweis"
|
||||||
|
writeFile(t, sourceDir, "original.pdf", content)
|
||||||
|
writeFile(t, sourceDir, "kopie.pdf", content)
|
||||||
|
|
||||||
|
summary, err := Backup(ctx, cfg, sourceDir)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if summary.FilesNew != 2 {
|
||||||
|
t.Fatalf("erwartet 2 neue dateien, habe %d", summary.FilesNew)
|
||||||
|
}
|
||||||
|
// Zwei Dateien mit IDENTISCHEM Inhalt duerfen nur EINEN data_blob
|
||||||
|
// erzeugen - das ist der Dedup-Nachweis (Akzeptanzkriterium 2).
|
||||||
|
if summary.DataBlobs != 1 {
|
||||||
|
t.Fatalf("data_blobs = %d, want 1 (zwei identische dateien haetten nur einen blob erzeugen duerfen - keine dedup)", summary.DataBlobs)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestCheck_DetectsCorruptedPack ist Pruefung 3: Vollstaendigkeitspruefung
|
||||||
|
// erkennt ein beschaedigtes/fehlendes Objekt in der Sicherung.
|
||||||
|
func TestCheck_DetectsCorruptedPack(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
writeFile(t, sourceDir, "wichtig.pdf", "inhalt, der spaeter absichtlich beschaedigt wird")
|
||||||
|
|
||||||
|
if _, err := Backup(ctx, cfg, sourceDir); err != nil {
|
||||||
|
t.Fatalf("sicherung: %v", err)
|
||||||
|
}
|
||||||
|
if err := Check(ctx, cfg, true); err != nil {
|
||||||
|
t.Fatalf("check (unbeschaedigt) haette erfolgreich sein muessen: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Absichtliche Beschaedigung: ein Byte in einer Pack-Datei im
|
||||||
|
// Repository kippen (dieselbe Fundstelle wie beim manuellen
|
||||||
|
// Nachweis waehrend der Recherche zu diesem Ticket).
|
||||||
|
packDir := filepath.Join(cfg.RepoDir, "data")
|
||||||
|
corrupted := false
|
||||||
|
if err := filepath.Walk(packDir, func(path string, info os.FileInfo, err error) error {
|
||||||
|
if err != nil || info.IsDir() || corrupted {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
data, err := os.ReadFile(path)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
if len(data) < 20 {
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
data[10] ^= 0xFF
|
||||||
|
if err := os.WriteFile(path, data, 0o600); err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
corrupted = true
|
||||||
|
return nil
|
||||||
|
}); err != nil {
|
||||||
|
t.Fatalf("pack-datei beschaedigen: %v", err)
|
||||||
|
}
|
||||||
|
if !corrupted {
|
||||||
|
t.Fatal("keine pack-datei zum beschaedigen gefunden - testaufbau fehlerhaft")
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Check(ctx, cfg, true); err == nil {
|
||||||
|
t.Fatal("check haette die beschaedigte pack-datei erkennen muessen")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// TestForget_KeepsOnlyRequestedSnapshotCount prueft die Rotation.
|
||||||
|
func TestForget_KeepsOnlyRequestedSnapshotCount(t *testing.T) {
|
||||||
|
cfg := setupTest(t)
|
||||||
|
ctx := context.Background()
|
||||||
|
sourceDir := t.TempDir()
|
||||||
|
|
||||||
|
for i := 0; i < 3; i++ {
|
||||||
|
writeFile(t, sourceDir, "f.txt", "version "+string(rune('a'+i)))
|
||||||
|
if _, err := Backup(ctx, cfg, sourceDir); err != nil {
|
||||||
|
t.Fatalf("sicherung %d: %v", i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
before, err := SnapshotCount(ctx, cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("snapshotcount (vorher): %v", err)
|
||||||
|
}
|
||||||
|
if before != 3 {
|
||||||
|
t.Fatalf("erwartet 3 snapshots vor rotation, habe %d", before)
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := Forget(ctx, cfg, 1); err != nil {
|
||||||
|
t.Fatalf("forget: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
after, err := SnapshotCount(ctx, cfg)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("snapshotcount (nachher): %v", err)
|
||||||
|
}
|
||||||
|
if after != 1 {
|
||||||
|
t.Fatalf("erwartet 1 snapshot nach rotation (keep-last 1), habe %d", after)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Datenbank-Vollsicherung (BAK-01)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/backup-cli full
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Datenbank-Vollsicherung (BAK-01)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 02:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Datenbank-Inkrementalsicherung (BAK-01)
|
||||||
|
After=network.target postgresql.service
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/backup-cli incremental
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Datenbank-Inkrementalsicherung (BAK-01)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* *:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Sicherungsgenerationen-Rotation (BAK-01)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-backup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/backup-cli rotate
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Sicherungsgenerationen-Rotation (BAK-01)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 03:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Objekt-Storage-Sicherung (BAK-02)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli backup __OBJECT_SOURCE_DIR__
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Stuendlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Sicherung (BAK-02)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* *:30:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Objekt-Storage-Sicherung Vollstaendigkeitspruefung (BAK-02)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli check
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Woechentlicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Vollstaendigkeitspruefung (BAK-02)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=Sun *-*-* 04:00:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=NEXARCH Archive - Objekt-Storage-Sicherung Rotation (BAK-02)
|
||||||
|
After=network.target
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=oneshot
|
||||||
|
User=nexarch
|
||||||
|
EnvironmentFile=/etc/nexarch/archive-objectbackup.env
|
||||||
|
ExecStart=__INSTALL_DIR__/bin/objectbackup-cli rotate
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
[Unit]
|
||||||
|
Description=Taeglicher Zeitplan fuer NEXARCH Archive Objekt-Storage-Rotation (BAK-02)
|
||||||
|
|
||||||
|
[Timer]
|
||||||
|
OnCalendar=*-*-* 03:30:00
|
||||||
|
Persistent=true
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=timers.target
|
||||||
@@ -1,39 +0,0 @@
|
|||||||
// Command pflichttestgate ist das CI-Gate aus docs/TESTSTRATEGIE-MAIL.md
|
|
||||||
// Abschnitt 4. Aufruf: pflichttestgate < geänderte-dateien.txt
|
|
||||||
package main
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/pflichttestgate"
|
|
||||||
)
|
|
||||||
|
|
||||||
func main() {
|
|
||||||
var changedFiles []string
|
|
||||||
scanner := bufio.NewScanner(os.Stdin)
|
|
||||||
for scanner.Scan() {
|
|
||||||
line := scanner.Text()
|
|
||||||
if line != "" {
|
|
||||||
changedFiles = append(changedFiles, line)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if err := scanner.Err(); err != nil {
|
|
||||||
fmt.Fprintf(os.Stderr, "pflichttestgate: eingabe konnte nicht gelesen werden: %v\n", err)
|
|
||||||
os.Exit(2)
|
|
||||||
}
|
|
||||||
|
|
||||||
violations := pflichttestgate.CheckDiff(changedFiles)
|
|
||||||
if len(violations) == 0 {
|
|
||||||
fmt.Println("pflichttestgate: bestanden — alle sicherheitskritischen Änderungen haben begleitende Tests.")
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
fmt.Fprintln(os.Stderr, "pflichttestgate: FEHLGESCHLAGEN — Pflichttest fehlt für:")
|
|
||||||
for _, v := range violations {
|
|
||||||
fmt.Fprintf(os.Stderr, " - Package %q (Datei %q hat keine begleitende _test.go-Änderung)\n", v.Package, v.ChangedFile)
|
|
||||||
}
|
|
||||||
fmt.Fprintln(os.Stderr, "\nSiehe docs/TESTSTRATEGIE-MAIL.md Abschnitt 4.")
|
|
||||||
os.Exit(1)
|
|
||||||
}
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
# ARC-01 – Prüfprotokoll: Objekt-Speicher-Anbindung für Mails/Anhänge
|
|
||||||
|
|
||||||
Voraussetzung ING-04 – bereits Fertig. ARC-01 ist der Startpunkt der
|
|
||||||
Foundation-Kette (analog DMS FDN-03), nicht nur eine Ergänzung — es
|
|
||||||
entsperrt ARC-02 bis ARC-10 sowie mehrere Ingestion-Tickets.
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
Bewährtes Muster aus DMS FDN-03 (LocalDriver/S3Driver-Abstraktion)
|
|
||||||
übernommen — bewusste Neuimplementierung statt Cross-Modul-Import
|
|
||||||
(Mail ist eigenständiges Go-Modul, kann DMS' `internal/` nicht
|
|
||||||
importieren):
|
|
||||||
|
|
||||||
- `mail/internal/storage.Driver` — `Put`/`Get`/`Delete`, zwei
|
|
||||||
Implementierungen (`LocalDriver`, `S3Driver`).
|
|
||||||
- `ObjectKey(messageID, partIndex)` — festes, dokumentiertes
|
|
||||||
Pfadschema `messages/<id>/parts/<n>` (Akzeptanzkriterium 1).
|
|
||||||
Lesezugriff hängt NUR von `messageID`+`partIndex` ab, nicht vom
|
|
||||||
ursprünglichen Importpfad (Akzeptanzkriterium 3).
|
|
||||||
- **Erweiterung gegenüber FDN-03** — Prüfsummenverifikation AN DIESER
|
|
||||||
SCHICHT (Akzeptanzkriterium 2, von ARC-01 explizit gefordert, anders
|
|
||||||
als FDN-03): `Service.Put` schreibt Inhalt + SHA-256-Sidecar-Objekt,
|
|
||||||
liest SOFORT zurück und verifiziert — ein fehlgeschlagener
|
|
||||||
Rücklese-Vergleich lässt `Put` selbst fehlschlagen, keine unbemerkt
|
|
||||||
fehlerhafte Ablage. `Service.GetVerified` wiederholt die Prüfung bei
|
|
||||||
jedem späteren Lesezugriff.
|
|
||||||
- `HTTPUsageReporter` — identisches Muster wie DMS FDN-03, meldet über
|
|
||||||
Core API-11 (`resync-api`, `internal/resync.Handler.UsageHandler`,
|
|
||||||
Service-Credential wie API-02) an LIC-05 (Akzeptanzkriterium 4).
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: geschriebenes Objekt liefert beim Lesen byteidentischen Inhalt | **bestanden** – `TestPut_ReadBackIsByteIdentical`: `GetVerified` liefert exakt den geschriebenen Inhalt |
|
|
||||||
| 2 | Test: absichtlich beschädigtes Objekt wird bei Prüfsummenvergleich erkannt | **bestanden** – `TestGetVerified_DetectsTamperedObject`: Objekt direkt am Dateisystem manipuliert (umgeht `Service` vollständig), `GetVerified` liefert real `ErrChecksumMismatch` |
|
|
||||||
| 3 | Lasttest mit vielen kleinen Objekten bestätigt akzeptable Latenz | **bestanden** – `TestPut_ManySmallObjectsAcceptableLatency`: 500 reale `Put`-Aufrufe (inkl. Schreiben+Sidecar+Rücklese-Verifikation) in 52,9 ms — **105,8 µs/Objekt**, weit unter der 10-ms-Grenze |
|
|
||||||
| 4 | Melde-Aufruf an Core LIC-05 bei Schreib- und Löschvorgang nachweislich ausgelöst, mit korrekter Größenangabe | **bestanden** – `TestPut_ReportsUsageOnWriteAndDelete` (Fake-Reporter, exakte Delta-Werte); ZUSÄTZLICH real auf 131 gegen den laufenden `nexarch-resync-api.service` (API-11) bewiesen: echtes Service-Credential provisioniert, `Put`→`GetVerified`→`Delete` komplett durchlaufen, `usage_counters` zeigt reales Delta `+29` dann `-29` (Nettosumme 0 — beide Meldungen real angewendet, nicht nur eine) |
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
go test ./... -p 1 -> alle Mail-Pakete bestanden (storage, mimeparse, example, pflichttestgate)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle vier Akzeptanzkriterien und alle vier
|
|
||||||
Pflichtprüfungen real erfüllt, inklusive eines echten End-zu-Ende-Laufs
|
|
||||||
gegen den live laufenden Core-API-11-Dienst (nicht nur einen Fake).
|
|
||||||
Entsperrt ARC-02–ARC-10 sowie mehrere Ingestion-Tickets.
|
|
||||||
@@ -1,71 +0,0 @@
|
|||||||
# ARC-02 – Prüfprotokoll: Verschlüsselung at rest
|
|
||||||
|
|
||||||
Voraussetzung ARC-01 (Mail, Fertig), Core API-10 (Fertig) + API-12
|
|
||||||
(neu angelegt und fertig — API-10 war nicht als Dienst erreichbar,
|
|
||||||
siehe API-12-Prüfprotokoll).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
Bewährtes Muster aus DMS FDN-09 übernommen (bewusste
|
|
||||||
Neuimplementierung, Mail kann DMS nicht importieren):
|
|
||||||
|
|
||||||
- `mail/internal/crypto` — `GenerateDEK`/`WrapDEK`/`UnwrapDEK`
|
|
||||||
(AES-256-GCM), `HTTPKEKProvider` (bezieht den Tenant-KEK über Core
|
|
||||||
API-12, `X-Nexarch-Client-Id/Secret`), `Service.Seal`/`Open`
|
|
||||||
(Envelope-Verfahren, KEK wird bei JEDEM Aufruf frisch bezogen, nie
|
|
||||||
zwischengespeichert).
|
|
||||||
- `mail/internal/encstorage` — verbindet ARC-01 (`storage.Service`) mit
|
|
||||||
ARC-02 (`crypto.Service`) OHNE eines der beiden Pakete zu ändern
|
|
||||||
(`git diff --stat mail/internal/storage/` bleibt leer): `Put`
|
|
||||||
verschlüsselt VOR dem Schreiben, legt Chiffretext + verpackten DEK
|
|
||||||
als zwei Objekte über `storage.Service` ab (Prüfsumme,
|
|
||||||
Nutzungsmeldung — ARC-01 unverändert mitgenutzt).
|
|
||||||
- **Reihenfolge beachtet** (Ticket "Bekannte Fehler vermeiden"):
|
|
||||||
`encstorage.Put` nimmt bereits fertigen Klartext entgegen — die
|
|
||||||
SHA-256-Dublettenerkennung (ARC-03) muss VOM AUFRUFER auf dem
|
|
||||||
Klartext berechnet werden, BEVOR er an `Put` übergeben wird; dieses
|
|
||||||
Paket verschlüsselt sofort und hält den Klartext nicht länger als
|
|
||||||
nötig im Speicher.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Zugriff auf Rohspeicher ohne Schlüssel liefert keine lesbaren Inhalte | **bestanden** – `TestPut_RawStorageAccessWithoutKeyYieldsNoReadableContent`: Objekt über `encstorage.Put` geschrieben, DANACH die Datei DIREKT am Dateisystem gelesen (umgeht Service/Entschlüsselung vollständig) — Klartext UND erkennbare Fragmente sind real NICHT im Rohspeicher auffindbar |
|
|
||||||
| 2 | Test: falscher Mandantenschlüssel verweigert Entschlüsselung | **bestanden** – `TestGetDecrypted_WrongTenantKeyDeniesDecryption`: korrekter Tenant entschlüsselt erfolgreich, ein ANDERER Tenant-Slug (anderer KEK) liefert real `ErrDecryptFailed` (GCM-Auth-Tag-Prüfung schlägt fehl); ZUSÄTZLICH real gegen den laufenden `kek-api` (API-12) bewiesen: nicht-existenter Tenant wird bereits beim KEK-Bezug abgelehnt (404), Entschlüsselung damit strukturell unmöglich |
|
|
||||||
| 3 | Performance-Test bestätigt akzeptablen Overhead durch Verschlüsselung | **bestanden** – `TestPut_AcceptableEncryptionOverhead`: 50 Objekte à 64 KiB (realistische Anhanggröße) in 45,5 ms — **910 µs/Objekt** (inkl. AES-256-GCM, Prüfsumme, Sidecar-Schreiben, Rücklese-Verifikation aus ARC-01), weit unter der 50-ms-Grenze |
|
|
||||||
|
|
||||||
## Echter End-zu-Ende-Beweis auf 192.168.1.131
|
|
||||||
|
|
||||||
Vollständiger Roundtrip gegen den ECHT laufenden `nexarch-kek-api.service`
|
|
||||||
(API-12, kein Fake): echtes Modul registriert+provisioniert, echter
|
|
||||||
Tenant + Tenant-KEK real angelegt, `encstorage.Put` → `GetDecrypted`
|
|
||||||
über HTTP gegen API-12 — Inhalt kommt byteidentisch zurück. Zusätzlich:
|
|
||||||
Entschlüsselungsversuch mit nicht-existentem Tenant-Slug real
|
|
||||||
abgelehnt (Core liefert 404, kein KEK verfügbar). Testdaten
|
|
||||||
anschließend entfernt.
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
go test ./... -p 1 -> alle Mail-Pakete bestanden (encstorage, crypto indirekt getestet, storage, mimeparse, example, pflichttestgate)
|
|
||||||
```
|
|
||||||
|
|
||||||
**Hinweis (offener Punkt, ehrlich vermerkt):** `mail/internal/crypto`
|
|
||||||
selbst hat keine eigenen `_test.go`-Dateien — es wird vollständig
|
|
||||||
indirekt über `mail/internal/encstorage`s Tests abgedeckt. Zusätzlich:
|
|
||||||
`mail/internal/pflichttestgate`s Pfadmuster (`docs/TESTSTRATEGIE-MAIL.md`)
|
|
||||||
erfassen `internal/crypto/`/`internal/encstorage/` NICHT explizit als
|
|
||||||
"Compliance-kritisch" (nur `internal/arc/`) — sollte in einem
|
|
||||||
Folgeticket nachgezogen werden, da Verschlüsselungscode mindestens so
|
|
||||||
kritisch ist wie die dort bereits gelisteten Bereiche.
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
|
||||||
Pflichtprüfungen real erfüllt, inklusive eines vollständigen
|
|
||||||
End-zu-Ende-Laufs gegen den live laufenden Core-API-12-Dienst.
|
|
||||||
Entsperrt ARC-08 (Schlüsselrotation).
|
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
# ARC-03 – Prüfprotokoll: Dublettenerkennung E-Mail
|
|
||||||
|
|
||||||
Voraussetzung ARC-01 (Mail, Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/dedup/hash.go` — `HashAndBuffer(plaintext io.Reader)`:
|
|
||||||
SHA-256-Inhalts-Hash, gebildet auf dem KLARTEXT (Bekannter Fehler
|
|
||||||
vermeiden: muss VOR mail/internal/crypto passieren, siehe ARC-02 —
|
|
||||||
ein Hash auf dem Chiffretext wäre wegen des zufälligen DEK je Objekt
|
|
||||||
bei jedem Import anders). Liefert zusätzlich einen erneut lesbaren
|
|
||||||
Reader zurück, da der Original-Reader beim Hashen verbraucht wird.
|
|
||||||
- `mail/internal/dedup/store.go` — `Store.Register(ctx, contentHash, objectKey)`:
|
|
||||||
Postgres-Tabelle `mail_content_hashes`, Primärschlüssel
|
|
||||||
`(tenant_slug, content_hash)` — `tenant_slug` fest im Store gebunden
|
|
||||||
(`NewStore(pool, tenantSlug)`, gleiches Muster wie
|
|
||||||
`storage.Service`/`encstorage.Service`), nicht nur Konvention.
|
|
||||||
`ON CONFLICT DO NOTHING` + Rücklese entscheidet, ob der gefundene
|
|
||||||
Eintrag der gerade übergebene ist (kein Duplikat) oder ein älterer
|
|
||||||
(Duplikat, Original-`object_key` wird zurückgegeben statt erneut
|
|
||||||
gespeichert — Akzeptanzkriterium 2).
|
|
||||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/crypto`/
|
|
||||||
`mail/internal/encstorage` unverändert (`git diff --stat` bleibt für
|
|
||||||
alle drei leer). `dedup` kennt keines der drei Pakete — der Aufrufer
|
|
||||||
(spätere Ingest-Tickets) ruft `HashAndBuffer` VOR `encstorage.Put`
|
|
||||||
auf.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: dieselbe Nachricht aus zwei Quellen wird als Duplikat erkannt | **bestanden** – `TestRegister_SameMessageFromTwoSourcesIsDuplicate`: gleicher Hash, zwei verschiedene `object_key` ("quelle-1/objekt", "quelle-2/objekt") — zweite Registrierung liefert real `isDuplicate=true` und referenziert das Original `quelle-1/objekt` |
|
|
||||||
| 2 | Test: zwei Mandanten mit identischem Mailinhalt werden nicht fälschlich verknüpft | **bestanden** – `TestRegister_SameContentTwoTenantsNotLinked`: zwei `Store`-Instanzen mit unterschiedlichem `tenantSlug`, IDENTISCHER Hash — beide Registrierungen liefern real `isDuplicate=false`, keine Verknüpfung über die Mandantengrenze |
|
|
||||||
| 3 | Test mit knapp unterschiedlichen Nachrichten bestätigt korrekte Nicht-Erkennung | **bestanden** – `TestHashAndBuffer_SlightlyDifferentContentDifferentHash`: zwei Nachrichten, die sich nur im letzten Zeichen unterscheiden (`.` vs `,`) — real unterschiedlicher SHA-256-Hash |
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
TEST_TENANT_DSN=postgresql://nexarch_test:***@localhost:5432/tenant_acme?sslmode=disable \
|
|
||||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/dedup (5 Tests)
|
|
||||||
```
|
|
||||||
|
|
||||||
Testdaten (`mail_content_hashes`, Zeilen mit `tenant_slug` beginnend
|
|
||||||
`mandant-arc03-`) werden von den Tests selbst über `t.Cleanup`
|
|
||||||
entfernt.
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
|
||||||
Pflichtprüfungen real erfüllt. Entsperrt SRC-01, SRC-02, SRC-07.
|
|
||||||
@@ -1,65 +0,0 @@
|
|||||||
# ING-04 – Prüfprotokoll: MIME- & Anhang-Parsing
|
|
||||||
|
|
||||||
Keine Vorbedingungen (Wave 1, sofort startbar). ING-04 ist die
|
|
||||||
Voraussetzung für ARC-01 (Objekt-Speicher) — nicht nur eine
|
|
||||||
Ergänzung, sondern der direkte Blocker (`ARC-01.dependsOn = ["ING-04"]`).
|
|
||||||
|
|
||||||
## Bekannten Fehler vermieden
|
|
||||||
|
|
||||||
archivmail (`known-issues-archivmail.md` Punkt 3): Anhänge wurden über
|
|
||||||
`io.ReadAll` ohne Größenlimit gelesen — Speicherbombe durch große/
|
|
||||||
böswillige Anhänge. Hier läuft JEDER Anhang-Lesevorgang über
|
|
||||||
`io.LimitReader(r, maxSize+1)` — eine Überschreitung führt zu
|
|
||||||
`ErrAttachmentTooLarge`, nicht zu stillem Abschneiden oder
|
|
||||||
unbegrenztem Speicherwachstum.
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/mimeparse.Parse` — zerlegt eine MIME-Nachricht
|
|
||||||
vollständig, rekursiv über verschachtelte `multipart/*`-Container.
|
|
||||||
- Zeichensatz-Reparatur: `mime.WordDecoder` mit eigenem
|
|
||||||
`CharsetReader` (via `golang.org/x/text/encoding/htmlindex`) — ein
|
|
||||||
unbekannter/kaputter Zeichensatz reicht den Rohtext unverändert
|
|
||||||
durch statt abzubrechen.
|
|
||||||
- Content-Transfer-Encoding: `quoted-printable`/`base64` werden
|
|
||||||
dekodiert, unbekannte Encodings unverändert durchgereicht (defensiv).
|
|
||||||
- **Nur Parsing, keine Speicherung** — Objekt-Speicher ist explizit
|
|
||||||
ARC-01s Aufgabe (Ticket-"Nicht Bestandteil"), dieses Paket schreibt
|
|
||||||
nirgends in einen Objektspeicher.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test mit sehr großem simuliertem Anhang bestätigt harte Ablehnung statt Speicheranstieg | **bestanden** – `TestParse_OversizedAttachmentRejectedNotMemoryExhausted`: ein UNBEGRENZTER `io.Reader` (liefert endlos Bytes) als Anhang-Body — `Parse` bricht real mit `ErrAttachmentTooLarge` ab, statt (wie ein `io.ReadAll`-basierter Parser) den Prozess durch unbegrenztes Speicherwachstum zum Absturz zu bringen. Test läuft in Millisekunden durch, kein Speicheranstieg |
|
|
||||||
| 2 | Testkorpus mit realitätsnahen Multipart-/Encoding-Varianten läuft fehlerfrei durch | **bestanden** – `TestParse_RealisticCorpusRunsCleanly`: 4 realitätsnahe Varianten (einfacher Text, quoted-printable, multipart/alternative, leere Multipart-Hülle mit Präambel/Epilog) laufen alle fehlerfrei durch |
|
|
||||||
| 3 | Fuzz-/Grenzwerttest mit kaputten MIME-Strukturen bricht kontrolliert ab, kein Absturz | **bestanden** – `FuzzParse`: ECHTES Go-Fuzzing (`go test -fuzz=FuzzParse -fuzztime=45s`), **728.164 reale Testläufe** mit mutierten/kaputten Byte-Sequenzen, 146 "interessante" (coverage-erweiternde) Eingaben gefunden, KEIN einziger Absturz (jeder `panic` hätte den Test sofort fehlschlagen lassen) |
|
|
||||||
|
|
||||||
**Zusätzliche Tests (je Akzeptanzkriterium mindestens ein Test):**
|
|
||||||
- `TestParse_NestedMultipartFullyDecomposed` (AC1: verschachtelte
|
|
||||||
Multipart-Teile vollständig zerlegt — `multipart/mixed` enthält
|
|
||||||
`multipart/alternative` UND einen Anhang, alle 3 Blatt-Teile
|
|
||||||
gefunden).
|
|
||||||
- `TestParse_AttachmentMetadataExtracted` (AC2: Dateiname,
|
|
||||||
Content-Type, Größe korrekt extrahiert).
|
|
||||||
- `TestParse_BrokenCharsetIsRepairedNotAborted`,
|
|
||||||
`TestParse_ISO88591FilenameDecoded` (AC3: kaputter/unbekannter
|
|
||||||
Zeichensatz repariert statt Abbruch; RFC-2047-kodierter,
|
|
||||||
ISO-8859-1-Dateiname real korrekt zu "Rechnung Ü" dekodiert).
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
go test ./... -p 1 -> alle Mail-Pakete bestanden (inkl. mimeparse, example, pflichttestgate)
|
|
||||||
go test ./internal/mimeparse/... -fuzz=FuzzParse -fuzztime=45s -> PASS, 728.164 Ausführungen, 0 Abstürze
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei
|
|
||||||
Pflichtprüfungen real erfüllt, inklusive eines echten, nicht nur
|
|
||||||
simulierten Fuzz-Laufs mit über 700.000 Testfällen. Entsperrt ARC-01
|
|
||||||
(Objekt-Speicher-Anbindung), IMP-02, ING-10, ARC-10.
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
# NEXARCH Mail – Teststrategie
|
|
||||||
|
|
||||||
Stand: 2026-08-30. Ticket: QA-01. Vorbild: Core `QA-01` (`docs/TESTSTRATEGIE-CORE.md`,
|
|
||||||
Fertig) — dieselbe Struktur, für das Mail-Modul übernommen, wo sinnvoll um
|
|
||||||
protokollspezifische Aspekte (IMAP/SMTP/MIME) ergänzt.
|
|
||||||
|
|
||||||
## 1. Warum dieses Dokument existiert
|
|
||||||
|
|
||||||
archivmail (Vorgängerprojekt) testete 2 von 18 Modulen trotz hoher Kritikalität
|
|
||||||
(Compliance-/Protokoll-Logik). Kein zentrales Issue-Tracking — Bugs wurden nur als
|
|
||||||
`BUG-N`-Kommentare im Code festgehalten (`known-issues-archivmail.md`). NEXARCH Mail
|
|
||||||
übernimmt denselben Grundsatz wie Core: **Testpflicht für Auth, Tenant-Scoping und
|
|
||||||
Protokoll-/Compliance-kritische Logik ist ein Merge-Gate, keine Nachrüstung.**
|
|
||||||
|
|
||||||
## 2. Testpyramide
|
|
||||||
|
|
||||||
| Ebene | Werkzeug | Umfang |
|
|
||||||
|---|---|---|
|
|
||||||
| Unit | `go test` (Standardbibliothek) | Einzelne Funktionen/Typen, keine externe Abhängigkeit (DB, Netzwerk, IMAP/SMTP-Socket) |
|
|
||||||
| Integration | `go test` gegen echte PostgreSQL-Instanz (`nexarch_test`-Rolle) | Repository-/Handler-Schicht, Tenant-Scoping, Objekt-Speicher |
|
|
||||||
| Protokoll-Zustandsmaschinen | `go test` gegen echten IMAP-/SMTP-Client-Roundtrip (kein reiner Parser-Unit-Test) | ING-01/ING-02/ING-03: Login-Zustände, Befehlssequenzen, Fehlerpfade |
|
|
||||||
| E2E | Echter HTTP-Roundtrip (`httptest.Server`) bis zum ersten Mail-Frontend-Ticket, danach Playwright/Jest gegen die echte UI | Vollständiger Request-Response-Zyklus, kein reiner Funktionsaufruf |
|
|
||||||
| Vertragstests | Analog Core `QA-07`/DMS-Äquivalent, sobald Mail öffentliche Modul-Adapter-Schnittstellen (RET-05-Konsument, siehe `ARC-11`) hat | Wire-Contract-Stabilität |
|
|
||||||
|
|
||||||
**E2E-Zwischenlösung begründet:** Mail hat aktuell kein Frontend-Ticket (0/66 Board).
|
|
||||||
Playwright/Jest bräuchte eine echte Browser-UI zum Testen — bis zum ersten
|
|
||||||
Mail-Frontend-Ticket ist ein echter HTTP-Roundtrip (kein reiner In-Process-Funktionsaufruf)
|
|
||||||
die ehrliche, tatsächlich verfügbare Untergrenze für "E2E". Siehe Beispiel in
|
|
||||||
Abschnitt 3.
|
|
||||||
|
|
||||||
## 3. Beispieltests je Testart (Akzeptanzkriterium/Pflichtprüfung 2)
|
|
||||||
|
|
||||||
`mail/internal/example` — kein Wegwerf-Demo, sondern eine kleine, tatsächlich nützliche
|
|
||||||
Funktion (E-Mail-Adress-Normalisierung), die spätere Ticket ohnehin brauchen:
|
|
||||||
|
|
||||||
- **Unit:** `normalize_test.go` — `TestNormalizeAddress_*`, keine externe Abhängigkeit.
|
|
||||||
- **Integration:** `store_integration_test.go` — `TestAddressStore_SaveAndCheckExists`,
|
|
||||||
echte Postgres-Instanz, `TEST_TENANT_DSN`, `t.Cleanup`.
|
|
||||||
- **E2E:** `handler_e2e_test.go` — `TestNormalizeHandler_RealHTTPRoundTrip`, echter
|
|
||||||
`httptest.Server`-Roundtrip (TCP, nicht nur Funktionsaufruf).
|
|
||||||
|
|
||||||
Alle sechs Tests real ausgeführt (siehe Prüfungen, Abschnitt 6).
|
|
||||||
|
|
||||||
## 4. Pflichttests als Merge-Gate (Akzeptanzkriterium 3/4)
|
|
||||||
|
|
||||||
Verbindlich für jeden Pull Request, der Dateien in einem der folgenden Bereiche ändert:
|
|
||||||
|
|
||||||
- **Auth** (`mail/internal/auth/` — sobald durch ein späteres Ticket angelegt)
|
|
||||||
- **Tenant-Scoping** (`mail/internal/tenant/`, jede Repository-Schicht mit Mandanten-Bezug)
|
|
||||||
- **Protokoll-kritisch** (`mail/internal/ingest/`, `mail/internal/imap/`,
|
|
||||||
`mail/internal/smtp/` — Zustandsmaschinen, Auth-Handshakes der Protokolle selbst)
|
|
||||||
- **Compliance-kritisch** (`mail/internal/arc/` oder gleichwertig — RET-05-Konsument,
|
|
||||||
Löschung/Archivierung, siehe `ARC-11`)
|
|
||||||
|
|
||||||
Regel (identisch zu Core `QA-01`): **jede geänderte `.go`-Datei in einem dieser
|
|
||||||
Bereiche muss von einer geänderten oder neuen `_test.go`-Datei im selben Package
|
|
||||||
begleitet sein.**
|
|
||||||
|
|
||||||
`mail/internal/pflichttestgate` implementiert das Gate (Code-Kopie des Musters aus
|
|
||||||
Core `internal/pflichttestgate`, mit mail-spezifischen Pfadmustern statt Core-Pfaden
|
|
||||||
— bewusst keine Cross-Modul-Abhängigkeit, da Mail als eigenständiges Go-Modul Core
|
|
||||||
nicht importieren kann). `.gitea/workflows/mail-pflichttest-gate.yml` führt es gegen
|
|
||||||
jeden PR-Diff aus.
|
|
||||||
|
|
||||||
Negativtest des Gates selbst (Prüfung 1 dieses Tickets):
|
|
||||||
`mail/internal/pflichttestgate/gate_test.go` simuliert einen Diff mit geänderter
|
|
||||||
`mail/internal/auth/login.go` ohne begleitende Testdatei und erwartet, dass das Gate
|
|
||||||
das als Verstoß erkennt.
|
|
||||||
|
|
||||||
## 5. Bug-Tracking (Akzeptanzkriterium 3)
|
|
||||||
|
|
||||||
**Konvention: Gitea-Issues** auf `gitea.perlbach24.de/scripte/nexarch`, Label `mail`
|
|
||||||
plus Schweregrad-Label (`bug-kritisch`/`bug-normal`/`bug-kosmetisch`). Durchsuchbar
|
|
||||||
über Gitea-Suche/Label-Filter — explizit KEIN Code-Kommentar-Tracking (`BUG-N` wie in
|
|
||||||
archivmail), das laut `known-issues-archivmail.md` genau diese Sichtbarkeitslücke
|
|
||||||
verursacht hat.
|
|
||||||
|
|
||||||
**Realer Durchspiel-Nachweis (Prüfung 3):** Diese Session (nicht Mail-spezifisch, aber
|
|
||||||
derselbe reale Vorgang) fand mehrere echte Bugs, dokumentiert nach exakt diesem
|
|
||||||
Muster in den jeweiligen `*-PRUEFPROTOKOLL.md`-Dateien statt als Code-Kommentar, z. B.
|
|
||||||
`archive/docs/RET-10-PRUEFPROTOKOLL.md`: fehlende CORS-Header bei RET-06-API,
|
|
||||||
gefunden bei einer Sichtprüfung, Symptom (Browser hätte Fetch blockiert), Ursache
|
|
||||||
(kein `Access-Control-Allow-Origin`), Fix (RET-10-Ticket), Nachweis (curl-Test vorher/
|
|
||||||
nachher) — alles durchsuchbar in der Protokolldatei, nicht im Quelltext verstreut.
|
|
||||||
|
|
||||||
**Ehrlich vermerkt:** Ein ECHTER Gitea-Issue konnte in dieser Session nicht angelegt
|
|
||||||
werden (kein Gitea-API-Token verfügbar, nur Git-SSH/HTTPS-Push-Zugriff). Das oben
|
|
||||||
verlinkte Beispiel demonstriert das Vorgehen strukturell (Symptom → Ursache → Fix →
|
|
||||||
Nachweis, durchsuchbar abgelegt), aber NICHT über die Gitea-Issue-Oberfläche selbst.
|
|
||||||
Sobald ein Gitea-Zugriffstoken verfügbar ist, sollte mindestens ein Test-Issue real
|
|
||||||
angelegt werden, um die Konvention vollständig nachzuweisen — offener Punkt, siehe
|
|
||||||
Abschnitt 7.
|
|
||||||
|
|
||||||
## 6. Prüfungen (real durchgeführt)
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Dokument liegt vor und wurde von zweiter Person gegengelesen | **bestanden** — Dokument von der Nutzerin/dem Nutzer (zweite Person) gegengelesen und freigegeben (2026-08-30) |
|
|
||||||
| 2 | Stichprobe: mindestens ein Beispieltest je benannter Testart ist umgesetzt | **bestanden** — 6 Tests real ausgeführt auf 131: `go test ./mail/internal/example/... -v -p 1`, alle grün (3 Unit, 1 Integration, 2 E2E) |
|
|
||||||
| 3 | Bug-Tracking-Vorgehen wurde einmal exemplarisch für einen realen Befund durchgespielt | **teilweise bestanden** — Vorgehen strukturell durchgespielt anhand eines realen, bereits dokumentierten Befunds (RET-10), aber NICHT über die echte Gitea-Issue-Oberfläche (kein API-Token verfügbar). Siehe Abschnitt 5, offener Punkt in Abschnitt 7 |
|
|
||||||
|
|
||||||
## 7. Offene Punkte
|
|
||||||
|
|
||||||
- Echter Gitea-Issue als Nachweis der Bug-Tracking-Konvention noch nicht angelegt
|
|
||||||
(fehlendes API-Token in dieser Session). Sollte nachgeholt werden, sobald Zugriff
|
|
||||||
besteht.
|
|
||||||
- `mail/internal/auth/`, `mail/internal/tenant/`, `mail/internal/ingest/` etc. existieren
|
|
||||||
noch nicht — die Pflichttest-Gate-Pfadmuster sind auf Basis der geplanten
|
|
||||||
Modulstruktur vordefiniert, nicht an echtem Code verifiziert. Erste Nagelprobe: das
|
|
||||||
erste Ticket, das einen dieser Pfade tatsächlich anlegt (voraussichtlich `ING-01`).
|
|
||||||
-36
@@ -1,36 +0,0 @@
|
|||||||
module gitea.perlbach24.de/scripte/nexarch/mail
|
|
||||||
|
|
||||||
go 1.24
|
|
||||||
|
|
||||||
toolchain go1.24.4
|
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/aws/aws-sdk-go-v2 v1.45.1
|
|
||||||
github.com/aws/aws-sdk-go-v2/config v1.33.1
|
|
||||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.1
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1
|
|
||||||
github.com/aws/smithy-go v1.28.1
|
|
||||||
github.com/jackc/pgx/v5 v5.6.0
|
|
||||||
golang.org/x/text v0.14.0
|
|
||||||
)
|
|
||||||
|
|
||||||
require (
|
|
||||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.20 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.11.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.20.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/signin v1.7.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/sso v1.35.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.40.1 // indirect
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/sts v1.47.1 // indirect
|
|
||||||
github.com/jackc/pgpassfile v1.0.0 // indirect
|
|
||||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a // indirect
|
|
||||||
github.com/jackc/puddle/v2 v2.2.1 // indirect
|
|
||||||
golang.org/x/crypto v0.17.0 // indirect
|
|
||||||
golang.org/x/sync v0.1.0 // indirect
|
|
||||||
)
|
|
||||||
-64
@@ -1,64 +0,0 @@
|
|||||||
github.com/aws/aws-sdk-go-v2 v1.45.1 h1:iIoG3NaLhV6UZpPXyPXlDj2I9oS8tV/nMcMnITCC6Ks=
|
|
||||||
github.com/aws/aws-sdk-go-v2 v1.45.1/go.mod h1:bttEH6JqnUL8LepvDVfdrds/fZ5bCIxzpe3abyUrhDU=
|
|
||||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.20 h1:GPRlPwz40I2B2VrBEASOA3Bi77NyeqejNLkifosX0rs=
|
|
||||||
github.com/aws/aws-sdk-go-v2/aws/protocol/eventstream v1.7.20/go.mod h1:g7PNzKcsOKWb4fkSRBA7BZVAS6Y8IcxzN+nRohhQ1Q8=
|
|
||||||
github.com/aws/aws-sdk-go-v2/config v1.33.1 h1:bq9jze1hQ5YTCLoVxNnbp0T7rglrlOE7N9YsHqjGkEw=
|
|
||||||
github.com/aws/aws-sdk-go-v2/config v1.33.1/go.mod h1:2A3HQwG4zaL5Tm80rc6RZj8LmWWv4WYT5v8raSz/L7A=
|
|
||||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.1 h1:Z8GRNEx0u9sDkZOq4PUnN8mjGwbUQGRzMSXpvt3d8xQ=
|
|
||||||
github.com/aws/aws-sdk-go-v2/credentials v1.20.1/go.mod h1:uBIK00kFo95dnemqfFMTWx0X8YRqsh6ecIoCjjOkZqM=
|
|
||||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1 h1:YIEBqcqRnpi4Pfv0YHImtgi6czGCwKHANC7SwmUAVD0=
|
|
||||||
github.com/aws/aws-sdk-go-v2/feature/ec2/imds v1.19.1/go.mod h1:imEf0oufgAo8KAkCHhrOdqGEC0YWx1PPBQH82shSxGw=
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.1 h1:pc138gM1CW+XPc60rEwUlwwuwWFQK16CI1T7v1F9Oec=
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/configsources v1.5.1/go.mod h1:1+koxpPIbfBdfzP6vojm5/zTpTQ/micYwlxIiNB3TxI=
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.1 h1:K0JsbZQj+1h208Ro1zHeA4l7bMp0NvRffHQ91q8Ol1s=
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/endpoints/v2 v2.8.1/go.mod h1:W3/vL6EtCIatICGy9ab29QhMuae+cOKPWcMxv02CO+Q=
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1 h1:yhw5KD1phVyP9vijxOUzDfEtJx+bt+L63k+VfuiYFAA=
|
|
||||||
github.com/aws/aws-sdk-go-v2/internal/v4a v1.5.1/go.mod h1:ZW2e0d7DYlRxlS9hEiMXE47gTdX5KRN4byUiNbUpG+Q=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19 h1:bAdDl/HkGCcGPoe25ToSHEw23VIxt6CT5fLcg111BKg=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/accept-encoding v1.13.19/go.mod h1:KaUzbLxv4CeSxh6ZCl9B4m7CuFenS8kUEaDs+f/DQr4=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.11.1 h1:s67hBfG5t9rn1NCvDuB4E3QIep3UFhHPtaIqFDjV3N8=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/checksum v1.11.1/go.mod h1:FpvjBMXtSNMLPmDJsWwcY5cRnqJlpS2y1R6n4pvzs4k=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1 h1:RmmWQPREQdk9U+PfqeHW3MqZaBaNK7TpV9W3RY+b+7g=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/presigned-url v1.14.1/go.mod h1:0A3W4F+68ZnNk5XcNL/e9HFMwnP8RlEicFfy6eOEDyw=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.20.1 h1:ZMbtPZZQRca+3+XYQne9PBvRiYpHZlNJJOZfE9WNfT0=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/internal/s3shared v1.20.1/go.mod h1:YAGWQdCYlVCoqrzvfv3RLxO6zKwti7gsAULOGWPLYv4=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1 h1:kVpzaDBzOdRtOftmiSpTdQbWVqRg0kONLXijktiwXnk=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/s3 v1.109.1/go.mod h1:CUr46sCpGAg/rHaclRyhJX0LJAmH73uWSJPPSaMUrSk=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/signin v1.7.1 h1:mdMtSVKdQ3+mzBh+l0ogrFYZVQUCg6pJZOirA2ARsYE=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/signin v1.7.1/go.mod h1:9IqUlsJDbUPcg6cgx3WEzXdjrbWzLDQrak0aaSqlTcI=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/sso v1.35.1 h1:B6WFn91tobD6gG4724ONHaqrpKsoETGnv98LHe/yIGM=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/sso v1.35.1/go.mod h1:tWuiVBUtPBr8/rgRiYS8Uf85sHcAN+G7XS3D3CEoUh8=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.40.1 h1:6yeYCWFvgbI2TI3K6jr9LtBNhXgJ7g4xqD+DEiaDDmM=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/ssooidc v1.40.1/go.mod h1:naFe83jSMuYkH+QjQPX8n1MLhBkeCFM5Lsnh5m5wz3c=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/sts v1.47.1 h1:Sv2xPnRHlThSUtVujYuUBPI/Il8si6UPHXL8DMiB/F0=
|
|
||||||
github.com/aws/aws-sdk-go-v2/service/sts v1.47.1/go.mod h1:mKo/CzaCz8qytGW70NG4vIIGAx1HXTlb5lHNkC5k3lk=
|
|
||||||
github.com/aws/smithy-go v1.28.1 h1:R/nXH00c8qcfCzQVELtRw+eLQWtzv+VAIEFJ1/xxXlQ=
|
|
||||||
github.com/aws/smithy-go v1.28.1/go.mod h1:YE2RhdIuDbA5E5bTdciG9KrW3+TiEONeUWCqxX9i1Fc=
|
|
||||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
|
||||||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
|
|
||||||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
|
||||||
github.com/jackc/pgpassfile v1.0.0 h1:/6Hmqy13Ss2zCq62VdNG8tM1wchn8zjSGOBJ6icpsIM=
|
|
||||||
github.com/jackc/pgpassfile v1.0.0/go.mod h1:CEx0iS5ambNFdcRtxPj5JhEz+xB6uRky5eyVu/W2HEg=
|
|
||||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a h1:bbPeKD0xmW/Y25WS6cokEszi5g+S0QxI/d45PkRi7Nk=
|
|
||||||
github.com/jackc/pgservicefile v0.0.0-20221227161230-091c0ba34f0a/go.mod h1:5TJZWKEWniPve33vlWYSoGYefn3gLQRzjfDlhSJ9ZKM=
|
|
||||||
github.com/jackc/pgx/v5 v5.6.0 h1:SWJzexBzPL5jb0GEsrPMLIsi/3jOo7RHlzTjcAeDrPY=
|
|
||||||
github.com/jackc/pgx/v5 v5.6.0/go.mod h1:DNZ/vlrUnhWCoFGxHAG8U2ljioxukquj7utPDgtQdTw=
|
|
||||||
github.com/jackc/puddle/v2 v2.2.1 h1:RhxXJtFG022u4ibrCSMSiu5aOq1i77R3OHKNJj77OAk=
|
|
||||||
github.com/jackc/puddle/v2 v2.2.1/go.mod h1:vriiEXHvEE654aYKXXjOvZM39qJ0q+azkZFrfEOc3H4=
|
|
||||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
|
||||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
|
||||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
|
||||||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
|
|
||||||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
|
|
||||||
github.com/stretchr/testify v1.8.1 h1:w7B6lhMri9wdJUVmEZPGGhZzrYTPvgJArz7wNPgYKsk=
|
|
||||||
github.com/stretchr/testify v1.8.1/go.mod h1:w2LPCIKwWwSfY2zedu0+kehJoqGctiVI29o6fzry7u4=
|
|
||||||
golang.org/x/crypto v0.17.0 h1:r8bRNjWL3GshPW3gkd+RpvzWrZAwPS49OmTGZ/uhM4k=
|
|
||||||
golang.org/x/crypto v0.17.0/go.mod h1:gCAAfMLgwOJRpTjQ2zCCt2OcSfYMTeZVSRtQlPC7Nq4=
|
|
||||||
golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o=
|
|
||||||
golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
|
|
||||||
golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
|
|
||||||
golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
|
|
||||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
|
||||||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
|
||||||
gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
|
|
||||||
gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
|
|
||||||
@@ -1,118 +0,0 @@
|
|||||||
// Package crypto implementiert ARC-02: Envelope-Encryption für Objekte
|
|
||||||
// at rest. Jedes Objekt bekommt einen eigenen, zufälligen
|
|
||||||
// Datenverschlüsselungsschlüssel (DEK, Akzeptanzkriterium 1), der mit
|
|
||||||
// dem Tenant-Hauptschlüssel (KEK) verpackt wird — der KEK selbst kommt
|
|
||||||
// AUSSCHLIESSLICH von Core API-10/API-12 (Akzeptanzkriterium 2), wird
|
|
||||||
// hier nie persistiert, nur flüchtig für eine Wrap-/Unwrap-Operation
|
|
||||||
// gehalten. Bewusste Neuimplementierung des bewährten DMS-FDN-09-
|
|
||||||
// Musters (Mail kann DMS' internal/ nicht importieren, eigenständiges
|
|
||||||
// Go-Modul).
|
|
||||||
package crypto
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/aes"
|
|
||||||
"crypto/cipher"
|
|
||||||
"crypto/rand"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
DEKSize = 32
|
|
||||||
KEKSize = 32
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrDecryptFailed wird geliefert, wenn ein Chiffretext nicht
|
|
||||||
// entschlüsselt werden kann — falscher Schlüssel ODER manipulierte
|
|
||||||
// Daten (Pflichtprüfung 2: GCM-Auth-Tag erkennt Manipulation
|
|
||||||
// zuverlässig, AEAD unterscheidet die beiden Ursachen bewusst nicht).
|
|
||||||
var ErrDecryptFailed = errors.New("crypto: entschlüsselung fehlgeschlagen (falscher schlüssel oder manipulierte daten)")
|
|
||||||
|
|
||||||
func GenerateDEK() ([]byte, error) {
|
|
||||||
dek := make([]byte, DEKSize)
|
|
||||||
if _, err := rand.Read(dek); err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: dek erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
return dek, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func seal(key, plaintext []byte) ([]byte, error) {
|
|
||||||
block, err := aes.NewCipher(key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: aes-cipher erstellen: %w", err)
|
|
||||||
}
|
|
||||||
gcm, err := cipher.NewGCM(block)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: gcm erstellen: %w", err)
|
|
||||||
}
|
|
||||||
nonce := make([]byte, gcm.NonceSize())
|
|
||||||
if _, err := rand.Read(nonce); err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: nonce erzeugen: %w", err)
|
|
||||||
}
|
|
||||||
return gcm.Seal(nonce, nonce, plaintext, nil), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func open(key, sealed []byte) ([]byte, error) {
|
|
||||||
block, err := aes.NewCipher(key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: aes-cipher erstellen: %w", err)
|
|
||||||
}
|
|
||||||
gcm, err := cipher.NewGCM(block)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: gcm erstellen: %w", err)
|
|
||||||
}
|
|
||||||
if len(sealed) < gcm.NonceSize() {
|
|
||||||
return nil, ErrDecryptFailed
|
|
||||||
}
|
|
||||||
nonce, ciphertext := sealed[:gcm.NonceSize()], sealed[gcm.NonceSize():]
|
|
||||||
plaintext, err := gcm.Open(nil, nonce, ciphertext, nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, ErrDecryptFailed
|
|
||||||
}
|
|
||||||
return plaintext, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func WrapDEK(kek, dek []byte) ([]byte, error) {
|
|
||||||
wrapped, err := seal(kek, dek)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: dek verpacken: %w", err)
|
|
||||||
}
|
|
||||||
return wrapped, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func UnwrapDEK(kek, wrappedDEK []byte) ([]byte, error) {
|
|
||||||
return open(kek, wrappedDEK)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EncryptStream verschlüsselt den gesamten Inhalt von r mit dek
|
|
||||||
// (AES-256-GCM). Liest r vollständig in den Speicher — dasselbe Muster
|
|
||||||
// wie mail/internal/storage.S3Driver.Put (ARC-01), das S3-PutObject
|
|
||||||
// ebenfalls vollständig puffert; ein segmentiertes AEAD-Verfahren für
|
|
||||||
// sehr große Anhänge ist bewusst nicht Teil der "kleinsten Lösung".
|
|
||||||
func EncryptStream(dek []byte, r io.Reader) (io.Reader, error) {
|
|
||||||
plaintext, err := io.ReadAll(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: klartext lesen: %w", err)
|
|
||||||
}
|
|
||||||
ciphertext, err := seal(dek, plaintext)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: verschlüsseln: %w", err)
|
|
||||||
}
|
|
||||||
return bytes.NewReader(ciphertext), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// DecryptStream entschlüsselt einen zuvor mit EncryptStream erzeugten
|
|
||||||
// Chiffretext-Stream.
|
|
||||||
func DecryptStream(dek []byte, r io.Reader) (io.Reader, error) {
|
|
||||||
ciphertext, err := io.ReadAll(r)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: chiffretext lesen: %w", err)
|
|
||||||
}
|
|
||||||
plaintext, err := open(dek, ciphertext)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return bytes.NewReader(plaintext), nil
|
|
||||||
}
|
|
||||||
@@ -1,80 +0,0 @@
|
|||||||
package crypto
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/base64"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
"net/url"
|
|
||||||
)
|
|
||||||
|
|
||||||
// KEKProvider liefert den aktuellen, entschlüsselten Tenant-KEK
|
|
||||||
// (Akzeptanzkriterium 2: KEK kommt ausschließlich von Core API-10/
|
|
||||||
// API-12). Schmale Schnittstelle, damit Tests einen Fake statt eines
|
|
||||||
// echten HTTP-Aufrufs einsetzen können.
|
|
||||||
type KEKProvider interface {
|
|
||||||
TenantKEK(ctx context.Context, tenantSlug string) ([]byte, error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// tenantKEKResponse entspricht Core internal/kek.tenantKEKResponse
|
|
||||||
// (JSON-Vertrag: tenant_kek_base64) — dieselbe Struktur, hier
|
|
||||||
// gespiegelt, da Mail Cores internal/-Pakete nicht importieren kann.
|
|
||||||
type tenantKEKResponse struct {
|
|
||||||
TenantKEKBase64 string `json:"tenant_kek_base64"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// HTTPKEKProvider bezieht den Tenant-KEK über Core API-12
|
|
||||||
// (internal/kek.Handler.TenantKEKHandler, echt laufender Dienst),
|
|
||||||
// authentifiziert über dasselbe Service-Credential-Verfahren wie jeder
|
|
||||||
// andere Modul-Core-Aufruf (API-02) — identisches Muster wie DMS
|
|
||||||
// FDN-09/internal/storage.HTTPUsageReporter aus ARC-01.
|
|
||||||
type HTTPKEKProvider struct {
|
|
||||||
endpointURL string
|
|
||||||
clientID string
|
|
||||||
clientSecret string
|
|
||||||
httpClient *http.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewHTTPKEKProvider(endpointURL, clientID, clientSecret string, httpClient *http.Client) *HTTPKEKProvider {
|
|
||||||
if httpClient == nil {
|
|
||||||
httpClient = http.DefaultClient
|
|
||||||
}
|
|
||||||
return &HTTPKEKProvider{endpointURL: endpointURL, clientID: clientID, clientSecret: clientSecret, httpClient: httpClient}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *HTTPKEKProvider) TenantKEK(ctx context.Context, tenantSlug string) ([]byte, error) {
|
|
||||||
u, err := url.Parse(p.endpointURL)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: kek-endpunkt-url ungültig: %w", err)
|
|
||||||
}
|
|
||||||
q := u.Query()
|
|
||||||
q.Set("tenant", tenantSlug)
|
|
||||||
u.RawQuery = q.Encode()
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodGet, u.String(), nil)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: kek-anfrage aufbauen: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("X-Nexarch-Client-Id", p.clientID)
|
|
||||||
req.Header.Set("X-Nexarch-Client-Secret", p.clientSecret)
|
|
||||||
|
|
||||||
resp, err := p.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: kek-anfrage senden: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = resp.Body.Close() }()
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
|
||||||
return nil, fmt.Errorf("crypto: kek-bezug von core abgelehnt: status %d", resp.StatusCode)
|
|
||||||
}
|
|
||||||
|
|
||||||
var body tenantKEKResponse
|
|
||||||
if err := json.NewDecoder(resp.Body).Decode(&body); err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: kek-antwort dekodieren: %w", err)
|
|
||||||
}
|
|
||||||
kek, err := base64.StdEncoding.DecodeString(body.TenantKEKBase64)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: kek base64-dekodieren: %w", err)
|
|
||||||
}
|
|
||||||
return kek, nil
|
|
||||||
}
|
|
||||||
@@ -1,67 +0,0 @@
|
|||||||
package crypto
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Envelope ist das Ergebnis einer Seal-Operation: der Chiffretext-
|
|
||||||
// Stream plus der mit dem Tenant-KEK verpackte DEK, der zusammen mit
|
|
||||||
// dem Objekt persistiert werden muss (siehe mail/internal/encstorage).
|
|
||||||
type Envelope struct {
|
|
||||||
Ciphertext io.Reader
|
|
||||||
WrappedDEK []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service verbindet KEKProvider mit den Envelope-Operationen — Aufrufer
|
|
||||||
// (mail/internal/encstorage) rufen ausschließlich Service auf, nie die
|
|
||||||
// Einzelfunktionen aus envelope.go direkt.
|
|
||||||
type Service struct {
|
|
||||||
kek KEKProvider
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(kek KEKProvider) *Service {
|
|
||||||
return &Service{kek: kek}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Seal erzeugt einen neuen DEK (Akzeptanzkriterium 1), verschlüsselt
|
|
||||||
// plaintext damit und verpackt den DEK mit dem aktuellen Tenant-KEK
|
|
||||||
// (Akzeptanzkriterium 2 — der KEK wird bei JEDEM Aufruf frisch von Core
|
|
||||||
// bezogen, nie zwischengespeichert).
|
|
||||||
func (s *Service) Seal(ctx context.Context, tenantSlug string, plaintext io.Reader) (*Envelope, error) {
|
|
||||||
dek, err := GenerateDEK()
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
ciphertext, err := EncryptStream(dek, plaintext)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
kek, err := s.kek.TenantKEK(ctx, tenantSlug)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: tenant-kek beziehen: %w", err)
|
|
||||||
}
|
|
||||||
wrappedDEK, err := WrapDEK(kek, dek)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return &Envelope{Ciphertext: ciphertext, WrappedDEK: wrappedDEK}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Open entpackt den DEK mit dem aktuellen Tenant-KEK (Akzeptanzkriterium
|
|
||||||
// 3: nur mit gültigem, mandantenbezogenem Schlüssel möglich — ein
|
|
||||||
// falscher Tenant-Slug liefert entweder einen falschen KEK von Core
|
|
||||||
// [dann schlägt UnwrapDEK fehl] oder Core verweigert den Zugriff direkt)
|
|
||||||
// und entschlüsselt ciphertext damit.
|
|
||||||
func (s *Service) Open(ctx context.Context, tenantSlug string, wrappedDEK []byte, ciphertext io.Reader) (io.Reader, error) {
|
|
||||||
kek, err := s.kek.TenantKEK(ctx, tenantSlug)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: tenant-kek beziehen: %w", err)
|
|
||||||
}
|
|
||||||
dek, err := UnwrapDEK(kek, wrappedDEK)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return DecryptStream(dek, ciphertext)
|
|
||||||
}
|
|
||||||
@@ -1,35 +0,0 @@
|
|||||||
// Package dedup implementiert ARC-03: Dublettenerkennung für
|
|
||||||
// archivierte E-Mails über einen Inhalts-Hash. Kombiniert bewusst NICHT
|
|
||||||
// mit mail/internal/storage oder mail/internal/crypto — dieses Paket
|
|
||||||
// kennt beide nicht, der Aufrufer (spätere Ingest-Tickets) ruft es VOR
|
|
||||||
// mail/internal/crypto auf.
|
|
||||||
package dedup
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// HashAndBuffer berechnet den SHA-256-Inhalts-Hash von plaintext.
|
|
||||||
//
|
|
||||||
// Bekannter Fehler vermeiden (siehe ARC-03-Ticket): der Hash MUSS auf
|
|
||||||
// dem Klartext berechnet werden, BEVOR mail/internal/crypto verschlüsselt
|
|
||||||
// — ein Hash auf dem Chiffretext wäre bei jedem Import anders (neuer
|
|
||||||
// DEK je Objekt, siehe ARC-02) und Dublettenerkennung würde vollständig
|
|
||||||
// versagen. Reihenfolge: Mail/Anhang empfangen -> HashAndBuffer (dieses
|
|
||||||
// Paket) -> verschlüsseln (ARC-02) -> ablegen.
|
|
||||||
//
|
|
||||||
// plaintext wird beim Hashen vollständig verbraucht — HashAndBuffer
|
|
||||||
// liefert deshalb einen erneut lesbaren Reader mit demselben Inhalt für
|
|
||||||
// den nachfolgenden Verschlüsselungsschritt zurück.
|
|
||||||
func HashAndBuffer(plaintext io.Reader) (contentHash string, buffered io.Reader, err error) {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
hasher := sha256.New()
|
|
||||||
if _, err := io.Copy(hasher, io.TeeReader(plaintext, &buf)); err != nil {
|
|
||||||
return "", nil, fmt.Errorf("dedup: klartext hashen: %w", err)
|
|
||||||
}
|
|
||||||
return hex.EncodeToString(hasher.Sum(nil)), &buf, nil
|
|
||||||
}
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
package dedup
|
|
||||||
|
|
||||||
import (
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestHashAndBuffer_SameContentSameHash(t *testing.T) {
|
|
||||||
h1, buf1, err := HashAndBuffer(strings.NewReader("identischer inhalt"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
h2, buf2, err := HashAndBuffer(strings.NewReader("identischer inhalt"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if h1 != h2 {
|
|
||||||
t.Fatalf("erwartet identischen hash für identischen inhalt, habe %q vs %q", h1, h2)
|
|
||||||
}
|
|
||||||
|
|
||||||
got1, _ := io.ReadAll(buf1)
|
|
||||||
got2, _ := io.ReadAll(buf2)
|
|
||||||
if string(got1) != "identischer inhalt" || string(got2) != "identischer inhalt" {
|
|
||||||
t.Fatal("buffered reader liefert nicht denselben inhalt zurück wie der ursprüngliche klartext")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestHashAndBuffer_DifferentContentDifferentHash(t *testing.T) {
|
|
||||||
h1, _, err := HashAndBuffer(strings.NewReader("nachricht a"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
h2, _, err := HashAndBuffer(strings.NewReader("nachricht b"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if h1 == h2 {
|
|
||||||
t.Fatal("unterschiedlicher inhalt hätte unterschiedlichen hash liefern müssen")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestHashAndBuffer_SlightlyDifferentContentDifferentHash ist die
|
|
||||||
// geforderte Pflichtprüfung 3: knapp unterschiedliche Nachrichten
|
|
||||||
// werden korrekt NICHT als Duplikat erkannt.
|
|
||||||
func TestHashAndBuffer_SlightlyDifferentContentDifferentHash(t *testing.T) {
|
|
||||||
h1, _, err := HashAndBuffer(strings.NewReader("Betreff: Test\r\n\r\nInhalt der Nachricht."))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
h2, _, err := HashAndBuffer(strings.NewReader("Betreff: Test\r\n\r\nInhalt der Nachricht,"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if h1 == h2 {
|
|
||||||
t.Fatal("ein einziges abweichendes zeichen hätte den hash ändern müssen")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
package dedup
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Store verwaltet bekannte Inhalts-Hashes je Mandant. tenant_slug ist
|
|
||||||
// fester Bestandteil des Primärschlüssels (Akzeptanzkriterium 3:
|
|
||||||
// mandantenübergreifend korrekt getrennt) — auch wenn Store einen mit
|
|
||||||
// anderen Mandanten geteilten Pool erhält, kann ein Hash-Treffer nie
|
|
||||||
// über Mandantengrenzen hinweg entstehen.
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
tenantSlug string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool, tenantSlug string) *Store {
|
|
||||||
return &Store{pool: pool, tenantSlug: tenantSlug}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
|
||||||
// gleiches Muster wie mail/internal/example (kein zentraler
|
|
||||||
// Migrationsläufer für Mandanten-Datenbanken im Mail-Modul vorhanden).
|
|
||||||
func (s *Store) EnsureSchema(ctx context.Context) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS mail_content_hashes (
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
content_hash TEXT NOT NULL,
|
|
||||||
object_key TEXT NOT NULL,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (tenant_slug, content_hash)
|
|
||||||
)
|
|
||||||
`); err != nil {
|
|
||||||
return fmt.Errorf("dedup: schema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Register trägt contentHash für den Mandanten als neu bekannt ein
|
|
||||||
// (Akzeptanzkriterium 1) und referenziert das Original, statt es
|
|
||||||
// redundant zu speichern (Akzeptanzkriterium 2): existiert derselbe
|
|
||||||
// Hash für DIESEN Mandanten bereits mit einem ANDEREN object_key,
|
|
||||||
// liefert Register isDuplicate=true und den object_key des Originals —
|
|
||||||
// der Aufrufer legt den neuen Inhalt dann NICHT ab.
|
|
||||||
func (s *Store) Register(ctx context.Context, contentHash, objectKey string) (isDuplicate bool, existingKey string, err error) {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO mail_content_hashes (tenant_slug, content_hash, object_key)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
ON CONFLICT (tenant_slug, content_hash) DO NOTHING
|
|
||||||
`, s.tenantSlug, contentHash, objectKey); err != nil {
|
|
||||||
return false, "", fmt.Errorf("dedup: hash eintragen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var storedKey string
|
|
||||||
err = s.pool.QueryRow(ctx, `
|
|
||||||
SELECT object_key FROM mail_content_hashes
|
|
||||||
WHERE tenant_slug = $1 AND content_hash = $2
|
|
||||||
`, s.tenantSlug, contentHash).Scan(&storedKey)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return false, "", fmt.Errorf("dedup: gerade eingetragenen hash nicht wiedergefunden")
|
|
||||||
}
|
|
||||||
return false, "", fmt.Errorf("dedup: eintrag lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if storedKey != objectKey {
|
|
||||||
return true, storedKey, nil
|
|
||||||
}
|
|
||||||
return false, "", nil
|
|
||||||
}
|
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
// Integrationstest (ARC-03): echte Postgres-Instanz, folgt derselben
|
|
||||||
// Testhost-Konvention wie mail/internal/example (QA-01) — TEST_TENANT_DSN.
|
|
||||||
package dedup
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStore(t *testing.T, tenantSlug string) *Store {
|
|
||||||
t.Helper()
|
|
||||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
|
||||||
if dsn == "" {
|
|
||||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
pool, err := pgxpool.New(ctx, dsn)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() { pool.Close() })
|
|
||||||
|
|
||||||
store := NewStore(pool, tenantSlug)
|
|
||||||
if err := store.EnsureSchema(ctx); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_content_hashes WHERE tenant_slug = $1`, tenantSlug)
|
|
||||||
})
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRegister_SameMessageFromTwoSourcesIsDuplicate ist die geforderte
|
|
||||||
// Pflichtprüfung 1: dieselbe Nachricht aus zwei Quellen wird als
|
|
||||||
// Duplikat erkannt.
|
|
||||||
func TestRegister_SameMessageFromTwoSourcesIsDuplicate(t *testing.T) {
|
|
||||||
store := setupStore(t, "mandant-arc03-a")
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
hash := "fixierter-inhalts-hash-fuer-test-1"
|
|
||||||
|
|
||||||
isDup, _, err := store.Register(ctx, hash, "quelle-1/objekt")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erste registrierung: %v", err)
|
|
||||||
}
|
|
||||||
if isDup {
|
|
||||||
t.Fatal("erste registrierung eines hashes darf kein duplikat sein")
|
|
||||||
}
|
|
||||||
|
|
||||||
isDup, existing, err := store.Register(ctx, hash, "quelle-2/objekt")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zweite registrierung: %v", err)
|
|
||||||
}
|
|
||||||
if !isDup {
|
|
||||||
t.Fatal("erwartet: dieselbe nachricht aus zweiter quelle wird als duplikat erkannt")
|
|
||||||
}
|
|
||||||
if existing != "quelle-1/objekt" {
|
|
||||||
t.Fatalf("erwartet referenz auf das original quelle-1/objekt, habe %q", existing)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRegister_SameContentTwoTenantsNotLinked ist die geforderte
|
|
||||||
// Pflichtprüfung 2: zwei Mandanten mit identischem Mailinhalt werden
|
|
||||||
// nicht fälschlich verknüpft.
|
|
||||||
func TestRegister_SameContentTwoTenantsNotLinked(t *testing.T) {
|
|
||||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
|
||||||
if dsn == "" {
|
|
||||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
|
|
||||||
}
|
|
||||||
storeA := setupStore(t, "mandant-arc03-x")
|
|
||||||
storeB := setupStore(t, "mandant-arc03-y")
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
hash := "identischer-inhalt-ueber-zwei-mandanten-hinweg"
|
|
||||||
|
|
||||||
isDupA, _, err := storeA.Register(ctx, hash, "mandant-x/objekt")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("mandant a: %v", err)
|
|
||||||
}
|
|
||||||
if isDupA {
|
|
||||||
t.Fatal("erste registrierung bei mandant a darf kein duplikat sein")
|
|
||||||
}
|
|
||||||
|
|
||||||
isDupB, existingB, err := storeB.Register(ctx, hash, "mandant-y/objekt")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("mandant b: %v", err)
|
|
||||||
}
|
|
||||||
if isDupB {
|
|
||||||
t.Fatalf("mandant b wurde fälschlich mit mandant a verknüpft, existing=%q", existingB)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,93 +0,0 @@
|
|||||||
// Package encstorage implementiert ARC-02s Anbindung an ARC-01: jedes
|
|
||||||
// archivierte Objekt wird VOR dem Schreiben über
|
|
||||||
// mail/internal/storage.Service verschlüsselt (Akzeptanzkriterium 1).
|
|
||||||
// Kombiniert bewusst zwei bereits fertige, unveränderte Pakete
|
|
||||||
// (mail/internal/storage aus ARC-01, mail/internal/crypto aus ARC-02)
|
|
||||||
// statt eines davon zu erweitern — kein Umbau angrenzender Bereiche.
|
|
||||||
//
|
|
||||||
// Reihenfolge beachtet (Ticket "Bekannte Fehler vermeiden"): ein
|
|
||||||
// SHA-256-Hash für Dublettenerkennung (ARC-03) muss auf dem KLARTEXT
|
|
||||||
// berechnet werden, BEVOR diese Verschlüsselung angewendet wird — das
|
|
||||||
// ist Sache des Aufrufers (ARC-03, außerhalb dieses Pakets), dieses
|
|
||||||
// Paket nimmt bereits fertigen Klartext entgegen und verschlüsselt ihn
|
|
||||||
// sofort, hält ihn nicht länger als nötig im Speicher.
|
|
||||||
package encstorage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/crypto"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
// wrappedDEKKey ist der Sidecar-Objektschlüssel für den mit dem
|
|
||||||
// Tenant-KEK verpackten DEK — liegt im selben Storage-Backend wie der
|
|
||||||
// Chiffretext, analog zum Prüfsummen-Sidecar aus ARC-01.
|
|
||||||
func wrappedDEKKey(key string) string {
|
|
||||||
return key + ".dek"
|
|
||||||
}
|
|
||||||
|
|
||||||
// Service verbindet Storage (ARC-01) und Crypto (ARC-02): der Rest von
|
|
||||||
// Mail ruft AUSSCHLIESSLICH diesen Service auf, nie storage.Service
|
|
||||||
// direkt mit Klartext — das verhindert einen Schreibpfad, der die
|
|
||||||
// Verschlüsselung vergisst (Akzeptanzkriterium 1).
|
|
||||||
type Service struct {
|
|
||||||
storage *storage.Service
|
|
||||||
crypto *crypto.Service
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(storageSvc *storage.Service, cryptoSvc *crypto.Service) *Service {
|
|
||||||
return &Service{storage: storageSvc, crypto: cryptoSvc}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Put verschlüsselt plaintext (Akzeptanzkriterium 1/2: neuer DEK je
|
|
||||||
// Objekt, mit dem per API-12 bezogenen Tenant-KEK verpackt) und legt
|
|
||||||
// Chiffretext + verpackten DEK über storage.Service ab (Prüfsumme,
|
|
||||||
// Nutzungsmeldung — ARC-01 unverändert wiederverwendet).
|
|
||||||
func (s *Service) Put(ctx context.Context, tenantSlug, key string, plaintext io.Reader, contentType string) error {
|
|
||||||
env, err := s.crypto.Seal(ctx, tenantSlug, plaintext)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("encstorage: verschlüsseln: %w", err)
|
|
||||||
}
|
|
||||||
ciphertext, err := io.ReadAll(env.Ciphertext)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("encstorage: chiffretext lesen: %w", err)
|
|
||||||
}
|
|
||||||
if _, err := s.storage.Put(ctx, key, bytes.NewReader(ciphertext), int64(len(ciphertext)), contentType); err != nil {
|
|
||||||
return fmt.Errorf("encstorage: chiffretext speichern: %w", err)
|
|
||||||
}
|
|
||||||
if _, err := s.storage.Put(ctx, wrappedDEKKey(key), bytes.NewReader(env.WrappedDEK), int64(len(env.WrappedDEK)), "application/octet-stream"); err != nil {
|
|
||||||
return fmt.Errorf("encstorage: verpackten dek speichern: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetDecrypted liest Chiffretext (über storage.GetVerified — ARC-01s
|
|
||||||
// Prüfsummenverifikation wird dabei mitgenutzt) und verpackten DEK,
|
|
||||||
// entpackt den DEK mit dem AKTUELLEN Tenant-KEK und entschlüsselt den
|
|
||||||
// Inhalt (Akzeptanzkriterium 3: nur mit gültigem, mandantenbezogenem
|
|
||||||
// Schlüssel möglich).
|
|
||||||
func (s *Service) GetDecrypted(ctx context.Context, tenantSlug, key string) ([]byte, error) {
|
|
||||||
ciphertext, err := s.storage.GetVerified(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("encstorage: chiffretext lesen: %w", err)
|
|
||||||
}
|
|
||||||
dekReader, err := s.storage.Get(ctx, wrappedDEKKey(key))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("encstorage: verpackten dek lesen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = dekReader.Close() }()
|
|
||||||
wrappedDEK, err := io.ReadAll(dekReader)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("encstorage: verpackten dek lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
plaintextReader, err := s.crypto.Open(ctx, tenantSlug, wrappedDEK, bytes.NewReader(ciphertext))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return io.ReadAll(plaintextReader)
|
|
||||||
}
|
|
||||||
@@ -1,138 +0,0 @@
|
|||||||
package encstorage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/crypto"
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/storage"
|
|
||||||
)
|
|
||||||
|
|
||||||
type fakeUsageReporter struct{}
|
|
||||||
|
|
||||||
func (fakeUsageReporter) Report(_ context.Context, _, _ string, _ int64) error { return nil }
|
|
||||||
|
|
||||||
// fakeKEKProvider liefert einen festen, mandantenspezifischen KEK —
|
|
||||||
// simuliert Core API-12, ohne den echten Dienst für Unit-Tests zu
|
|
||||||
// brauchen. "richtiger-tenant" hat einen bekannten KEK, jeder andere
|
|
||||||
// Tenant-Slug liefert einen ANDEREN (falschen) KEK — genau der Fall,
|
|
||||||
// den Pflichtprüfung 2 testet.
|
|
||||||
type fakeKEKProvider struct {
|
|
||||||
keksByTenant map[string][]byte
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fakeKEKProvider) TenantKEK(_ context.Context, tenantSlug string) ([]byte, error) {
|
|
||||||
if kek, ok := f.keksByTenant[tenantSlug]; ok {
|
|
||||||
return kek, nil
|
|
||||||
}
|
|
||||||
// Unbekannter Tenant bekommt einen ANDEREN zufälligen KEK (nicht
|
|
||||||
// abgelehnt auf Core-Seite in diesem Fake, aber garantiert falsch —
|
|
||||||
// entspricht dem realen Fall, dass ein falscher Tenant-Slug einen
|
|
||||||
// anderen KEK liefert und die Entschlüsselung deshalb scheitert).
|
|
||||||
return bytes.Repeat([]byte{0xFF}, crypto.KEKSize), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTestServiceWithDir(t *testing.T) (*Service, string) {
|
|
||||||
t.Helper()
|
|
||||||
dir := t.TempDir()
|
|
||||||
storageSvc := storage.NewService(storage.NewLocalDriver(dir), fakeUsageReporter{}, "acme")
|
|
||||||
kekProvider := fakeKEKProvider{keksByTenant: map[string][]byte{
|
|
||||||
"richtiger-tenant": bytes.Repeat([]byte{0x42}, crypto.KEKSize),
|
|
||||||
}}
|
|
||||||
cryptoSvc := crypto.NewService(kekProvider)
|
|
||||||
return NewService(storageSvc, cryptoSvc), dir
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_RawStorageAccessWithoutKeyYieldsNoReadableContent ist die
|
|
||||||
// geforderte Pflichtprüfung 1: Zugriff auf Rohspeicher ohne Schlüssel
|
|
||||||
// liefert keine lesbaren Inhalte.
|
|
||||||
func TestPut_RawStorageAccessWithoutKeyYieldsNoReadableContent(t *testing.T) {
|
|
||||||
svc, dir := newTestServiceWithDir(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
key := storage.ObjectKey("msg-enc-1", 0)
|
|
||||||
plaintext := "STRENG GEHEIMER E-MAIL-INHALT, NICHT IM KLARTEXT AUF DER PLATTE"
|
|
||||||
|
|
||||||
if err := svc.Put(ctx, "richtiger-tenant", key, strings.NewReader(plaintext), "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Direkter Dateisystemzugriff, UMGEHT den Service/die Entschlüsselung
|
|
||||||
// vollständig — simuliert "Rohspeicher ohne Schlüssel".
|
|
||||||
raw, err := os.ReadFile(filepath.Join(dir, filepath.FromSlash(key)))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("rohdatei lesen: %v", err)
|
|
||||||
}
|
|
||||||
if bytes.Contains(raw, []byte(plaintext)) {
|
|
||||||
t.Fatalf("klartext ist unverschlüsselt im rohspeicher auffindbar: %q enthält %q", raw, plaintext)
|
|
||||||
}
|
|
||||||
if bytes.Contains(raw, []byte("STRENG GEHEIMER")) || bytes.Contains(raw, []byte("GEHEIM")) {
|
|
||||||
t.Fatal("erkennbare klartext-fragmente im rohspeicher gefunden")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestGetDecrypted_WrongTenantKeyDeniesDecryption ist die geforderte
|
|
||||||
// Pflichtprüfung 2: falscher Mandantenschlüssel verweigert
|
|
||||||
// Entschlüsselung.
|
|
||||||
func TestGetDecrypted_WrongTenantKeyDeniesDecryption(t *testing.T) {
|
|
||||||
svc, _ := newTestServiceWithDir(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
key := storage.ObjectKey("msg-enc-2", 0)
|
|
||||||
plaintext := "inhalt fuer richtiger-tenant"
|
|
||||||
|
|
||||||
if err := svc.Put(ctx, "richtiger-tenant", key, strings.NewReader(plaintext), "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Korrekter Tenant kann entschlüsseln.
|
|
||||||
got, err := svc.GetDecrypted(ctx, "richtiger-tenant", key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("getdecrypted (richtiger tenant): %v", err)
|
|
||||||
}
|
|
||||||
if string(got) != plaintext {
|
|
||||||
t.Fatalf("falscher inhalt: %q", got)
|
|
||||||
}
|
|
||||||
|
|
||||||
// FALSCHER Mandant (anderer Tenant-Slug -> anderer KEK) muss
|
|
||||||
// abgelehnt werden.
|
|
||||||
_, err = svc.GetDecrypted(ctx, "falscher-tenant", key)
|
|
||||||
if !errors.Is(err, crypto.ErrDecryptFailed) {
|
|
||||||
t.Fatalf("erwartet ErrDecryptFailed bei falschem mandantenschlüssel, habe: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_AcceptableEncryptionOverhead ist die geforderte
|
|
||||||
// Pflichtprüfung 3: Performance-Test bestätigt akzeptablen Overhead
|
|
||||||
// durch Verschlüsselung.
|
|
||||||
func TestPut_AcceptableEncryptionOverhead(t *testing.T) {
|
|
||||||
svc, _ := newTestServiceWithDir(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
// ~64 KiB Nutzlast, realistische Anhanggröße.
|
|
||||||
payload := strings.Repeat("x", 64*1024)
|
|
||||||
|
|
||||||
const count = 50
|
|
||||||
start := time.Now()
|
|
||||||
for i := 0; i < count; i++ {
|
|
||||||
key := storage.ObjectKey("msg-perf", i)
|
|
||||||
if err := svc.Put(ctx, "richtiger-tenant", key, strings.NewReader(payload), "application/octet-stream"); err != nil {
|
|
||||||
t.Fatalf("put #%d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
elapsed := time.Since(start)
|
|
||||||
avgPerObject := elapsed / count
|
|
||||||
|
|
||||||
// Großzügige Grenze (50ms je 64-KiB-Objekt inkl. AES-GCM,
|
|
||||||
// Prüfsumme, Sidecar-Schreiben, Rücklese-Verifikation aus ARC-01) —
|
|
||||||
// Ziel: Nachweis, dass Verschlüsselung keinen unverhältnismäßigen
|
|
||||||
// Overhead verursacht, nicht ein knallhartes SLA.
|
|
||||||
if avgPerObject > 50*time.Millisecond {
|
|
||||||
t.Fatalf("erwartet akzeptablen verschlüsselungs-overhead (<50ms/64KiB-objekt), habe %v/objekt (gesamt %v für %d objekte)", avgPerObject, elapsed, count)
|
|
||||||
}
|
|
||||||
t.Logf("Verschlüsselungs-Performance: %d×64KiB-Objekte in %v (%v/Objekt)", count, elapsed, avgPerObject)
|
|
||||||
}
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
package example
|
|
||||||
|
|
||||||
import (
|
|
||||||
"encoding/json"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
// NormalizeHandler ist das E2E-Test-Beispiel (QA-01): ein echter
|
|
||||||
// HTTP-Endpunkt, gegen den ein Test einen vollständigen Request-Response-
|
|
||||||
// Zyklus fährt (httptest.Server, echter TCP-Roundtrip, kein reiner
|
|
||||||
// Funktionsaufruf). Sobald das erste Mail-Frontend-Ticket eine echte
|
|
||||||
// Browser-UI mitbringt, wird die E2E-Ebene um Playwright/Jest ergänzt
|
|
||||||
// (siehe QA-01-Teststrategiedokument, Abschnitt 2) — bis dahin ist ein
|
|
||||||
// echter HTTP-Roundtrip die ehrliche, verfügbare Untergrenze für "E2E".
|
|
||||||
type normalizeRequest struct {
|
|
||||||
Address string `json:"address"`
|
|
||||||
}
|
|
||||||
|
|
||||||
type normalizeResponse struct {
|
|
||||||
Normalized string `json:"normalized"`
|
|
||||||
}
|
|
||||||
|
|
||||||
func NormalizeHandler(w http.ResponseWriter, r *http.Request) {
|
|
||||||
var req normalizeRequest
|
|
||||||
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
|
||||||
http.Error(w, "ungültiger request-body", http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
normalized, err := NormalizeAddress(req.Address)
|
|
||||||
if err != nil {
|
|
||||||
http.Error(w, err.Error(), http.StatusBadRequest)
|
|
||||||
return
|
|
||||||
}
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
_ = json.NewEncoder(w).Encode(normalizeResponse{Normalized: normalized})
|
|
||||||
}
|
|
||||||
@@ -1,51 +0,0 @@
|
|||||||
// E2E-Test-Beispiel (QA-01 Akzeptanzkriterium 1/Prüfung 2): echter
|
|
||||||
// HTTP-Request über einen laufenden httptest.Server (TCP-Roundtrip),
|
|
||||||
// nicht nur ein Funktionsaufruf im selben Prozess.
|
|
||||||
package example
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/json"
|
|
||||||
"net/http"
|
|
||||||
"net/http/httptest"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestNormalizeHandler_RealHTTPRoundTrip(t *testing.T) {
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(NormalizeHandler))
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
body, _ := json.Marshal(normalizeRequest{Address: "Kunde@Beispiel.DE"})
|
|
||||||
resp, err := http.Post(server.URL, "application/json", bytes.NewReader(body))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("post: %v", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = resp.Body.Close() }()
|
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
|
||||||
t.Fatalf("status = %d, want 200", resp.StatusCode)
|
|
||||||
}
|
|
||||||
var out normalizeResponse
|
|
||||||
if err := json.NewDecoder(resp.Body).Decode(&out); err != nil {
|
|
||||||
t.Fatalf("antwort dekodieren: %v", err)
|
|
||||||
}
|
|
||||||
if out.Normalized != "Kunde@beispiel.de" {
|
|
||||||
t.Fatalf("got %q", out.Normalized)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNormalizeHandler_InvalidAddressReturns400(t *testing.T) {
|
|
||||||
server := httptest.NewServer(http.HandlerFunc(NormalizeHandler))
|
|
||||||
defer server.Close()
|
|
||||||
|
|
||||||
body, _ := json.Marshal(normalizeRequest{Address: "keine-gueltige-adresse"})
|
|
||||||
resp, err := http.Post(server.URL, "application/json", bytes.NewReader(body))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("post: %v", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = resp.Body.Close() }()
|
|
||||||
|
|
||||||
if resp.StatusCode != http.StatusBadRequest {
|
|
||||||
t.Fatalf("status = %d, want 400", resp.StatusCode)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,26 +0,0 @@
|
|||||||
// Package example dient QA-01 (Mail): liefert je Testart (Unit,
|
|
||||||
// Integration, E2E) genau EIN reales, lauffähiges Beispiel, an dem sich
|
|
||||||
// spätere Mail-Tickets orientieren können — keine Wegwerf-Demo, sondern
|
|
||||||
// eine tatsächlich nützliche, kleine Funktion (Adress-Normalisierung),
|
|
||||||
// die spätere Ticket (z. B. ING-01/ING-04) ohnehin brauchen werden.
|
|
||||||
package example
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
var ErrInvalidAddress = errors.New("example: keine gültige e-mail-adresse")
|
|
||||||
|
|
||||||
// NormalizeAddress normalisiert eine E-Mail-Adresse für den
|
|
||||||
// tenant-scoped Vergleich: Kleinschreibung der Domain-Hälfte
|
|
||||||
// (lokaler Teil bleibt case-sensitive, RFC 5321), Leerraum entfernt.
|
|
||||||
func NormalizeAddress(addr string) (string, error) {
|
|
||||||
addr = strings.TrimSpace(addr)
|
|
||||||
at := strings.LastIndex(addr, "@")
|
|
||||||
if at <= 0 || at == len(addr)-1 {
|
|
||||||
return "", ErrInvalidAddress
|
|
||||||
}
|
|
||||||
local, domain := addr[:at], addr[at+1:]
|
|
||||||
return local + "@" + strings.ToLower(domain), nil
|
|
||||||
}
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
// Unit-Test-Beispiel (QA-01 Akzeptanzkriterium 1/Prüfung 2): keine
|
|
||||||
// externe Abhängigkeit (DB, Netzwerk), reine Funktionsprüfung.
|
|
||||||
package example
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func TestNormalizeAddress_LowercasesDomainOnly(t *testing.T) {
|
|
||||||
got, err := NormalizeAddress("User.Name@Example.COM")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unerwarteter fehler: %v", err)
|
|
||||||
}
|
|
||||||
want := "User.Name@example.com"
|
|
||||||
if got != want {
|
|
||||||
t.Fatalf("got %q, want %q", got, want)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNormalizeAddress_TrimsWhitespace(t *testing.T) {
|
|
||||||
got, err := NormalizeAddress(" user@example.com ")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("unerwarteter fehler: %v", err)
|
|
||||||
}
|
|
||||||
if got != "user@example.com" {
|
|
||||||
t.Fatalf("got %q", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestNormalizeAddress_RejectsInvalidInput(t *testing.T) {
|
|
||||||
cases := []string{"", "no-at-sign", "@nolocalpart.com", "trailing@"}
|
|
||||||
for _, c := range cases {
|
|
||||||
if _, err := NormalizeAddress(c); !errors.Is(err, ErrInvalidAddress) {
|
|
||||||
t.Fatalf("input %q: erwartet ErrInvalidAddress, habe: %v", c, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
package example
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// AddressStore ist das Integrationstest-Beispiel (QA-01): eine
|
|
||||||
// minimale, aber echte DB-gestützte Komponente — nutzt dieselbe
|
|
||||||
// Tenant-DB-Isolationskonvention wie DMS/Archive (t.Cleanup, geteilte
|
|
||||||
// physische Postgres-Instanz auf dem Testhost).
|
|
||||||
type AddressStore struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewAddressStore(pool *pgxpool.Pool) *AddressStore {
|
|
||||||
return &AddressStore{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *AddressStore) SaveNormalized(ctx context.Context, addr string) (string, error) {
|
|
||||||
normalized, err := NormalizeAddress(addr)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO example_addresses (address) VALUES ($1)
|
|
||||||
ON CONFLICT (address) DO NOTHING
|
|
||||||
`, normalized); err != nil {
|
|
||||||
return "", fmt.Errorf("example: adresse speichern: %w", err)
|
|
||||||
}
|
|
||||||
return normalized, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *AddressStore) Exists(ctx context.Context, addr string) (bool, error) {
|
|
||||||
var exists bool
|
|
||||||
if err := s.pool.QueryRow(ctx, `SELECT EXISTS(SELECT 1 FROM example_addresses WHERE address = $1)`, addr).Scan(&exists); err != nil {
|
|
||||||
return false, fmt.Errorf("example: existenz prüfen: %w", err)
|
|
||||||
}
|
|
||||||
return exists, nil
|
|
||||||
}
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
// Integrations-Test-Beispiel (QA-01 Akzeptanzkriterium 1/Prüfung 2):
|
|
||||||
// echte Postgres-Instanz, folgt derselben Testhost-Konvention wie
|
|
||||||
// DMS/Archive/Core (TEST_TENANT_DSN, t.Cleanup, geteilte physische
|
|
||||||
// Instanz auf 192.168.1.131 — siehe project-nexarch-test-infra).
|
|
||||||
package example
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupTest(t *testing.T) *pgxpool.Pool {
|
|
||||||
t.Helper()
|
|
||||||
dsn := os.Getenv("TEST_TENANT_DSN")
|
|
||||||
if dsn == "" {
|
|
||||||
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest übersprungen")
|
|
||||||
}
|
|
||||||
ctx := context.Background()
|
|
||||||
pool, err := pgxpool.New(ctx, dsn)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("pool: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() { pool.Close() })
|
|
||||||
|
|
||||||
if _, err := pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS example_addresses (
|
|
||||||
address TEXT PRIMARY KEY
|
|
||||||
);
|
|
||||||
`); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = pool.Exec(context.Background(), `TRUNCATE example_addresses`)
|
|
||||||
})
|
|
||||||
return pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestAddressStore_SaveAndCheckExists(t *testing.T) {
|
|
||||||
pool := setupTest(t)
|
|
||||||
store := NewAddressStore(pool)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
normalized, err := store.SaveNormalized(ctx, "Kunde@Beispiel.DE")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("savenormalized: %v", err)
|
|
||||||
}
|
|
||||||
if normalized != "Kunde@beispiel.de" {
|
|
||||||
t.Fatalf("erwartet normalisierte adresse, habe %q", normalized)
|
|
||||||
}
|
|
||||||
|
|
||||||
exists, err := store.Exists(ctx, normalized)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if !exists {
|
|
||||||
t.Fatal("erwartet real gespeicherte adresse")
|
|
||||||
}
|
|
||||||
|
|
||||||
notExists, err := store.Exists(ctx, "unbekannt@beispiel.de")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatal(err)
|
|
||||||
}
|
|
||||||
if notExists {
|
|
||||||
t.Fatal("nie gespeicherte adresse haette nicht existieren duerfen")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,206 +0,0 @@
|
|||||||
// Package mimeparse implementiert ING-04: MIME-/Anhang-Parsing für
|
|
||||||
// ein- und ausgehende Nachrichten (Multipart, verschachtelt,
|
|
||||||
// Content-Transfer-Encoding, defensive Zeichensatz-Reparatur).
|
|
||||||
//
|
|
||||||
// NUR Parsing — Speicherung ist ARC-01s Aufgabe (siehe "Nicht
|
|
||||||
// Bestandteil dieser Kachel"), dieses Paket schreibt nirgends in einen
|
|
||||||
// Objekt-Speicher, sondern liefert nur strukturierte Go-Werte zurück.
|
|
||||||
//
|
|
||||||
// Bekannten Fehler vermieden (archivmail known-issues #3): Anhänge
|
|
||||||
// wurden früher über io.ReadAll ohne Größenlimit gelesen — eine
|
|
||||||
// Speicherbombe durch große/böswillige Anhänge. Hier läuft JEDER
|
|
||||||
// Anhang-Lesevorgang über io.LimitReader mit konfigurierter Max-Size;
|
|
||||||
// eine Überschreitung führt zu einer harten, sauberen Ablehnung
|
|
||||||
// (ErrAttachmentTooLarge), kein stilles Abschneiden.
|
|
||||||
package mimeparse
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"encoding/base64"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"mime"
|
|
||||||
"mime/multipart"
|
|
||||||
"mime/quotedprintable"
|
|
||||||
"net/mail"
|
|
||||||
"strings"
|
|
||||||
|
|
||||||
"golang.org/x/text/encoding/htmlindex"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrAttachmentTooLarge wird geliefert, wenn ein Anhang die
|
|
||||||
// konfigurierte Maximalgröße überschreitet (Akzeptanzkriterium/
|
|
||||||
// Pflichtprüfung 1).
|
|
||||||
var ErrAttachmentTooLarge = errors.New("mimeparse: anhang überschreitet die maximal erlaubte größe")
|
|
||||||
|
|
||||||
// Part ist EIN zerlegter MIME-Teil — sowohl Textteile (IsAttachment
|
|
||||||
// == false) als auch Anhänge (Akzeptanzkriterium 1/2).
|
|
||||||
type Part struct {
|
|
||||||
ContentType string
|
|
||||||
Filename string
|
|
||||||
Size int64
|
|
||||||
Content []byte
|
|
||||||
IsAttachment bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// Message ist das Ergebnis eines vollständig zerlegten Multipart-
|
|
||||||
// Baums — verschachtelte multipart/*-Teile sind bereits rekursiv
|
|
||||||
// aufgelöst, der Aufrufer sieht nur die "Blatt"-Teile (Akzeptanz-
|
|
||||||
// kriterium 1).
|
|
||||||
type Message struct {
|
|
||||||
Parts []Part
|
|
||||||
}
|
|
||||||
|
|
||||||
// wordDecoder dekodiert RFC-2047-kodierte Header-Werte (z. B.
|
|
||||||
// Anhang-Dateinamen) defensiv: ein unbekannter/fehlerhafter
|
|
||||||
// Zeichensatz bricht die Verarbeitung NICHT ab (Akzeptanzkriterium 3),
|
|
||||||
// sondern liefert den Rohwert unverändert zurück.
|
|
||||||
var wordDecoder = &mime.WordDecoder{CharsetReader: charsetReader}
|
|
||||||
|
|
||||||
func charsetReader(charsetLabel string, input io.Reader) (io.Reader, error) {
|
|
||||||
enc, err := htmlindex.Get(charsetLabel)
|
|
||||||
if err != nil {
|
|
||||||
// Unbekannter/fehlerhafter Zeichensatz: defensiv als
|
|
||||||
// UTF-8-verträglichen Rohtext weiterreichen statt
|
|
||||||
// abzubrechen (Akzeptanzkriterium 3).
|
|
||||||
return input, nil
|
|
||||||
}
|
|
||||||
return enc.NewDecoder().Reader(input), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func decodeHeaderValue(raw string) string {
|
|
||||||
decoded, err := wordDecoder.DecodeHeader(raw)
|
|
||||||
if err != nil {
|
|
||||||
// Defensiv: Rohwert statt Abbruch (Akzeptanzkriterium 3).
|
|
||||||
return raw
|
|
||||||
}
|
|
||||||
return decoded
|
|
||||||
}
|
|
||||||
|
|
||||||
// Parse zerlegt eine MIME-Nachricht vollständig, inklusive
|
|
||||||
// verschachtelter Multipart-Teile (Akzeptanzkriterium 1). maxAttachmentSize
|
|
||||||
// begrenzt JEDEN einzelnen Anhang (Akzeptanzkriterium/Pflichtprüfung 1).
|
|
||||||
func Parse(r io.Reader, maxAttachmentSize int64) (Message, error) {
|
|
||||||
msg, err := mail.ReadMessage(r)
|
|
||||||
if err != nil {
|
|
||||||
return Message{}, fmt.Errorf("mimeparse: nachricht lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
mediaType, params, err := mime.ParseMediaType(msg.Header.Get("Content-Type"))
|
|
||||||
if err != nil {
|
|
||||||
// Kein/kaputtes Content-Type: als einzelnen Textteil behandeln
|
|
||||||
// statt abzubrechen (Akzeptanzkriterium 3: defensiv reparieren).
|
|
||||||
body, readErr := readLimited(msg.Body, maxAttachmentSize)
|
|
||||||
if readErr != nil {
|
|
||||||
return Message{}, readErr
|
|
||||||
}
|
|
||||||
return Message{Parts: []Part{{ContentType: "text/plain", Content: body, Size: int64(len(body))}}}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
var result Message
|
|
||||||
if strings.HasPrefix(mediaType, "multipart/") {
|
|
||||||
if err := parseMultipart(msg.Body, params["boundary"], maxAttachmentSize, &result); err != nil {
|
|
||||||
return Message{}, err
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Einzelner Teil (keine Multipart-Hülle).
|
|
||||||
part, err := readSinglePart(msg.Header.Get("Content-Transfer-Encoding"), mediaType, "", msg.Body, maxAttachmentSize)
|
|
||||||
if err != nil {
|
|
||||||
return Message{}, err
|
|
||||||
}
|
|
||||||
result.Parts = append(result.Parts, part)
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseMultipart löst EINEN Multipart-Container rekursiv auf —
|
|
||||||
// verschachtelte multipart/*-Teile (z. B. multipart/mixed, das
|
|
||||||
// multipart/alternative enthält) werden vollständig zerlegt
|
|
||||||
// (Akzeptanzkriterium 1), keine Rekursionstiefe hartkodiert begrenzt
|
|
||||||
// außer durch die natürliche Nachrichtengröße selbst.
|
|
||||||
func parseMultipart(r io.Reader, boundary string, maxAttachmentSize int64, result *Message) error {
|
|
||||||
if boundary == "" {
|
|
||||||
return errors.New("mimeparse: multipart ohne boundary")
|
|
||||||
}
|
|
||||||
mr := multipart.NewReader(r, boundary)
|
|
||||||
for {
|
|
||||||
p, err := mr.NextPart()
|
|
||||||
if err == io.EOF {
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
if err != nil {
|
|
||||||
// Kaputte Multipart-Struktur: kontrolliert abbrechen
|
|
||||||
// (Pflichtprüfung 3), nicht abstürzen.
|
|
||||||
return fmt.Errorf("mimeparse: multipart-teil lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
contentType := p.Header.Get("Content-Type")
|
|
||||||
mediaType, subParams, err := mime.ParseMediaType(contentType)
|
|
||||||
if err != nil {
|
|
||||||
mediaType = "text/plain"
|
|
||||||
}
|
|
||||||
|
|
||||||
if strings.HasPrefix(mediaType, "multipart/") {
|
|
||||||
if err := parseMultipart(p, subParams["boundary"], maxAttachmentSize, result); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
part, err := readSinglePart(p.Header.Get("Content-Transfer-Encoding"), mediaType, decodeHeaderValue(p.FileName()), p, maxAttachmentSize)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
result.Parts = append(result.Parts, part)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func readSinglePart(transferEncoding, mediaType, filename string, r io.Reader, maxAttachmentSize int64) (Part, error) {
|
|
||||||
decoded := decodeTransferEncoding(transferEncoding, r)
|
|
||||||
|
|
||||||
content, err := readLimited(decoded, maxAttachmentSize)
|
|
||||||
if err != nil {
|
|
||||||
return Part{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
return Part{
|
|
||||||
ContentType: mediaType,
|
|
||||||
Filename: filename,
|
|
||||||
Size: int64(len(content)),
|
|
||||||
Content: content,
|
|
||||||
IsAttachment: filename != "",
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// decodeTransferEncoding dekodiert Content-Transfer-Encoding
|
|
||||||
// (quoted-printable/base64) — defensiv: ein unbekanntes Encoding wird
|
|
||||||
// unverändert durchgereicht statt die Verarbeitung abzubrechen
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
func decodeTransferEncoding(encoding string, r io.Reader) io.Reader {
|
|
||||||
switch strings.ToLower(strings.TrimSpace(encoding)) {
|
|
||||||
case "quoted-printable":
|
|
||||||
return quotedprintable.NewReader(r)
|
|
||||||
case "base64":
|
|
||||||
return base64.NewDecoder(base64.StdEncoding, r)
|
|
||||||
default:
|
|
||||||
return r
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// readLimited liest höchstens maxSize+1 Bytes — wird die Grenze
|
|
||||||
// überschritten, wird ErrAttachmentTooLarge geliefert, statt beliebig
|
|
||||||
// viel Speicher zu allozieren (Akzeptanzkriterium/Pflichtprüfung 1,
|
|
||||||
// archivmail known-issues #3).
|
|
||||||
func readLimited(r io.Reader, maxSize int64) ([]byte, error) {
|
|
||||||
limited := io.LimitReader(r, maxSize+1)
|
|
||||||
var buf bytes.Buffer
|
|
||||||
if _, err := io.Copy(&buf, limited); err != nil {
|
|
||||||
return nil, fmt.Errorf("mimeparse: teil lesen: %w", err)
|
|
||||||
}
|
|
||||||
if int64(buf.Len()) > maxSize {
|
|
||||||
return nil, ErrAttachmentTooLarge
|
|
||||||
}
|
|
||||||
return buf.Bytes(), nil
|
|
||||||
}
|
|
||||||
@@ -1,219 +0,0 @@
|
|||||||
package mimeparse
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
const defaultMaxSize = 10 * 1024 * 1024 // 10 MiB
|
|
||||||
|
|
||||||
// TestParse_NestedMultipartFullyDecomposed ist Akzeptanzkriterium 1:
|
|
||||||
// Multipart-Nachrichten mit verschachtelten Teilen werden vollständig
|
|
||||||
// zerlegt (multipart/mixed enthält multipart/alternative UND einen
|
|
||||||
// Anhang).
|
|
||||||
func TestParse_NestedMultipartFullyDecomposed(t *testing.T) {
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"To: b@example.com\r\n" +
|
|
||||||
"Subject: Test\r\n" +
|
|
||||||
"MIME-Version: 1.0\r\n" +
|
|
||||||
"Content-Type: multipart/mixed; boundary=\"outer\"\r\n\r\n" +
|
|
||||||
"--outer\r\n" +
|
|
||||||
"Content-Type: multipart/alternative; boundary=\"inner\"\r\n\r\n" +
|
|
||||||
"--inner\r\n" +
|
|
||||||
"Content-Type: text/plain; charset=utf-8\r\n\r\n" +
|
|
||||||
"Hallo als Text\r\n" +
|
|
||||||
"--inner\r\n" +
|
|
||||||
"Content-Type: text/html; charset=utf-8\r\n\r\n" +
|
|
||||||
"<p>Hallo als HTML</p>\r\n" +
|
|
||||||
"--inner--\r\n" +
|
|
||||||
"--outer\r\n" +
|
|
||||||
"Content-Type: application/pdf\r\n" +
|
|
||||||
"Content-Disposition: attachment; filename=\"rechnung.pdf\"\r\n" +
|
|
||||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
|
||||||
"JVBERi0xLjQK\r\n" +
|
|
||||||
"--outer--\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
if len(msg.Parts) != 3 {
|
|
||||||
t.Fatalf("erwartet 3 zerlegte teile (text, html, anhang), habe %d: %+v", len(msg.Parts), msg.Parts)
|
|
||||||
}
|
|
||||||
|
|
||||||
var sawText, sawHTML, sawAttachment bool
|
|
||||||
for _, p := range msg.Parts {
|
|
||||||
switch {
|
|
||||||
case p.ContentType == "text/plain":
|
|
||||||
sawText = true
|
|
||||||
if string(p.Content) != "Hallo als Text" {
|
|
||||||
t.Fatalf("unerwarteter text-inhalt: %q", p.Content)
|
|
||||||
}
|
|
||||||
case p.ContentType == "text/html":
|
|
||||||
sawHTML = true
|
|
||||||
case p.IsAttachment:
|
|
||||||
sawAttachment = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !sawText || !sawHTML || !sawAttachment {
|
|
||||||
t.Fatalf("nicht alle erwarteten teile gefunden: text=%v html=%v attachment=%v", sawText, sawHTML, sawAttachment)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_AttachmentMetadataExtracted ist Akzeptanzkriterium 2:
|
|
||||||
// Anhänge werden mit korrektem Dateinamen, Größe und Content-Type
|
|
||||||
// extrahiert.
|
|
||||||
func TestParse_AttachmentMetadataExtracted(t *testing.T) {
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: multipart/mixed; boundary=\"b\"\r\n\r\n" +
|
|
||||||
"--b\r\n" +
|
|
||||||
"Content-Type: text/plain\r\n\r\n" +
|
|
||||||
"Text\r\n" +
|
|
||||||
"--b\r\n" +
|
|
||||||
"Content-Type: image/png\r\n" +
|
|
||||||
"Content-Disposition: attachment; filename=\"bild.png\"\r\n" +
|
|
||||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
|
||||||
"iVBORw0KGgo=\r\n" +
|
|
||||||
"--b--\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
var attachment *Part
|
|
||||||
for i := range msg.Parts {
|
|
||||||
if msg.Parts[i].IsAttachment {
|
|
||||||
attachment = &msg.Parts[i]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if attachment == nil {
|
|
||||||
t.Fatal("kein anhang gefunden")
|
|
||||||
}
|
|
||||||
if attachment.Filename != "bild.png" {
|
|
||||||
t.Fatalf("falscher dateiname: %q", attachment.Filename)
|
|
||||||
}
|
|
||||||
if attachment.ContentType != "image/png" {
|
|
||||||
t.Fatalf("falscher content-type: %q", attachment.ContentType)
|
|
||||||
}
|
|
||||||
if attachment.Size != int64(len(attachment.Content)) || attachment.Size == 0 {
|
|
||||||
t.Fatalf("unplausible größe: %d (content-len %d)", attachment.Size, len(attachment.Content))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_BrokenCharsetIsRepairedNotAborted ist Akzeptanzkriterium 3:
|
|
||||||
// fehlerhafte/inkonsistente Zeichensatzangaben werden defensiv repariert
|
|
||||||
// statt die Verarbeitung abzubrechen.
|
|
||||||
func TestParse_BrokenCharsetIsRepairedNotAborted(t *testing.T) {
|
|
||||||
// "unbekannt-xyz" ist KEIN gültiger IANA-Zeichensatzname.
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: text/plain; charset=\"unbekannt-xyz\"\r\n\r\n" +
|
|
||||||
"Rohtext trotz kaputtem Charset\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erwartet KEINEN abbruch bei kaputtem charset, habe: %v", err)
|
|
||||||
}
|
|
||||||
if len(msg.Parts) != 1 {
|
|
||||||
t.Fatalf("erwartet 1 teil, habe %d", len(msg.Parts))
|
|
||||||
}
|
|
||||||
if !strings.Contains(string(msg.Parts[0].Content), "Rohtext") {
|
|
||||||
t.Fatalf("inhalt fehlt/verstümmelt: %q", msg.Parts[0].Content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_ISO88591BodyDecodedWithoutAbort ist Akzeptanzkriterium 3
|
|
||||||
// zusätzlich: ein bekannter Nicht-UTF-8-Zeichensatz wird via
|
|
||||||
// Header-Dekodierung real repariert (RFC-2047-kodierter Dateiname).
|
|
||||||
func TestParse_ISO88591FilenameDecoded(t *testing.T) {
|
|
||||||
// "=?ISO-8859-1?Q?Rechnung_=DC?=" kodiert "Rechnung Ü" (0xDC = 'Ü' in Latin-1).
|
|
||||||
raw := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: multipart/mixed; boundary=\"b\"\r\n\r\n" +
|
|
||||||
"--b\r\n" +
|
|
||||||
"Content-Type: application/octet-stream\r\n" +
|
|
||||||
"Content-Disposition: attachment; filename=\"=?ISO-8859-1?Q?Rechnung_=DC?=\"\r\n" +
|
|
||||||
"Content-Transfer-Encoding: base64\r\n\r\n" +
|
|
||||||
"AAA=\r\n" +
|
|
||||||
"--b--\r\n"
|
|
||||||
|
|
||||||
msg, err := Parse(strings.NewReader(raw), defaultMaxSize)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("parse: %v", err)
|
|
||||||
}
|
|
||||||
if len(msg.Parts) != 1 {
|
|
||||||
t.Fatalf("erwartet 1 teil, habe %d", len(msg.Parts))
|
|
||||||
}
|
|
||||||
if msg.Parts[0].Filename != "Rechnung Ü" {
|
|
||||||
t.Fatalf("erwartet dekodierten dateinamen 'Rechnung Ü', habe %q", msg.Parts[0].Filename)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// infiniteReader liefert unbegrenzt viele Bytes — simuliert einen sehr
|
|
||||||
// großen/böswilligen Anhang. Ohne io.LimitReader (siehe archivmail
|
|
||||||
// known-issues #3) würde ein io.ReadAll hierauf den Prozessspeicher
|
|
||||||
// erschöpfen; mit readLimited bricht Parse kontrolliert und schnell ab.
|
|
||||||
type infiniteReader struct{}
|
|
||||||
|
|
||||||
func (infiniteReader) Read(p []byte) (int, error) {
|
|
||||||
for i := range p {
|
|
||||||
p[i] = 'A'
|
|
||||||
}
|
|
||||||
return len(p), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_OversizedAttachmentRejectedNotMemoryExhausted ist die
|
|
||||||
// geforderte Pflichtprüfung 1.
|
|
||||||
func TestParse_OversizedAttachmentRejectedNotMemoryExhausted(t *testing.T) {
|
|
||||||
const tinyLimit = 1024 // 1 KiB — winzig, damit der Test schnell bleibt
|
|
||||||
|
|
||||||
header := "From: a@example.com\r\n" +
|
|
||||||
"Content-Type: application/octet-stream\r\n" +
|
|
||||||
"Content-Transfer-Encoding: identity\r\n\r\n"
|
|
||||||
|
|
||||||
r := io.MultiReader(strings.NewReader(header), infiniteReader{})
|
|
||||||
_, err := Parse(r, tinyLimit)
|
|
||||||
if !errors.Is(err, ErrAttachmentTooLarge) {
|
|
||||||
t.Fatalf("erwartet ErrAttachmentTooLarge bei unbegrenzt großem anhang, habe: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestParse_RealisticCorpusRunsCleanly ist die geforderte
|
|
||||||
// Pflichtprüfung 2: realitätsnahe Multipart-/Encoding-Varianten laufen
|
|
||||||
// fehlerfrei durch.
|
|
||||||
func TestParse_RealisticCorpusRunsCleanly(t *testing.T) {
|
|
||||||
corpus := []string{
|
|
||||||
// Einfache Textnachricht ohne Multipart.
|
|
||||||
"From: a@example.com\r\nContent-Type: text/plain; charset=utf-8\r\n\r\nEinfacher Text\r\n",
|
|
||||||
// Quoted-Printable.
|
|
||||||
"From: a@example.com\r\nContent-Type: text/plain; charset=utf-8\r\nContent-Transfer-Encoding: quoted-printable\r\n\r\nUmlaut: =C3=9C\r\n",
|
|
||||||
// Multipart/alternative ohne Anhang.
|
|
||||||
"From: a@example.com\r\nContent-Type: multipart/alternative; boundary=\"x\"\r\n\r\n--x\r\nContent-Type: text/plain\r\n\r\nText\r\n--x\r\nContent-Type: text/html\r\n\r\n<p>Text</p>\r\n--x--\r\n",
|
|
||||||
// Leere Multipart-Nachricht (kein Teil, nur Präambel/Epilog).
|
|
||||||
"From: a@example.com\r\nContent-Type: multipart/mixed; boundary=\"y\"\r\n\r\nPräambel wird ignoriert\r\n--y--\r\nEpilog wird ignoriert\r\n",
|
|
||||||
}
|
|
||||||
for i, raw := range corpus {
|
|
||||||
if _, err := Parse(strings.NewReader(raw), defaultMaxSize); err != nil {
|
|
||||||
t.Fatalf("corpus[%d] fehlgeschlagen: %v\nraw=%q", i, err, raw)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// FuzzParse ist die geforderte Pflichtprüfung 3: kaputte MIME-Strukturen
|
|
||||||
// dürfen Parse nicht zum Absturz bringen, nur zu einem kontrollierten
|
|
||||||
// Fehler.
|
|
||||||
func FuzzParse(f *testing.F) {
|
|
||||||
f.Add([]byte("From: a@example.com\r\nContent-Type: multipart/mixed; boundary=\"b\"\r\n\r\n--b\r\nContent-Type: text/plain\r\n\r\nHallo\r\n--b--\r\n"))
|
|
||||||
f.Add([]byte("Content-Type: multipart/mixed; boundary=\r\n\r\nkaputt"))
|
|
||||||
f.Add([]byte(""))
|
|
||||||
f.Add([]byte("From: a@example.com\r\n\r\n"))
|
|
||||||
|
|
||||||
f.Fuzz(func(t *testing.T, data []byte) {
|
|
||||||
defer func() {
|
|
||||||
if r := recover(); r != nil {
|
|
||||||
t.Fatalf("Parse ist abgestürzt (panic) statt kontrolliert einen Fehler zu liefern: %v", r)
|
|
||||||
}
|
|
||||||
}()
|
|
||||||
_, _ = Parse(strings.NewReader(string(data)), defaultMaxSize)
|
|
||||||
})
|
|
||||||
}
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
// Package pflichttestgate erzwingt die in docs/TESTSTRATEGIE-MAIL.md
|
|
||||||
// Abschnitt 4 festgelegte Regel: jede geänderte Go-Datei in einem
|
|
||||||
// sicherheitskritischen Bereich (Auth, Tenant-Scoping, Protokoll-/
|
|
||||||
// Compliance-kritisch) muss von einer geänderten oder neuen _test.go-
|
|
||||||
// Datei im selben Package begleitet sein. Bewusste Code-Kopie des
|
|
||||||
// Musters aus Core internal/pflichttestgate — Mail ist ein eigenständiges
|
|
||||||
// Go-Modul und kann Core nicht importieren.
|
|
||||||
package pflichttestgate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"path"
|
|
||||||
"regexp"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// sensitivePathPatterns beschreibt die Bereiche aus
|
|
||||||
// TESTSTRATEGIE-MAIL.md Abschnitt 4.
|
|
||||||
var sensitivePathPatterns = []*regexp.Regexp{
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/auth/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/tenant/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/ingest/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/imap/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/smtp/`),
|
|
||||||
regexp.MustCompile(`(^|/)mail/internal/arc/`),
|
|
||||||
}
|
|
||||||
|
|
||||||
// Violation beschreibt ein Package mit sicherheitskritischer Änderung
|
|
||||||
// ohne begleitende Testdatei.
|
|
||||||
type Violation struct {
|
|
||||||
Package string
|
|
||||||
ChangedFile string
|
|
||||||
}
|
|
||||||
|
|
||||||
func isSensitive(file string) bool {
|
|
||||||
if !strings.HasSuffix(file, ".go") || strings.HasSuffix(file, "_test.go") {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
for _, re := range sensitivePathPatterns {
|
|
||||||
if re.MatchString(file) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// CheckDiff prüft eine Liste geänderter Dateipfade gegen die
|
|
||||||
// Pflichttest-Regel — ein leeres Ergebnis bedeutet: Gate besteht.
|
|
||||||
func CheckDiff(changedFiles []string) []Violation {
|
|
||||||
sensitiveByPkg := map[string]string{}
|
|
||||||
testTouchedPkgs := map[string]bool{}
|
|
||||||
|
|
||||||
for _, f := range changedFiles {
|
|
||||||
pkg := path.Dir(f)
|
|
||||||
if strings.HasSuffix(f, "_test.go") {
|
|
||||||
testTouchedPkgs[pkg] = true
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if isSensitive(f) {
|
|
||||||
if _, seen := sensitiveByPkg[pkg]; !seen {
|
|
||||||
sensitiveByPkg[pkg] = f
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
var violations []Violation
|
|
||||||
for pkg, file := range sensitiveByPkg {
|
|
||||||
if !testTouchedPkgs[pkg] {
|
|
||||||
violations = append(violations, Violation{Package: pkg, ChangedFile: file})
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return violations
|
|
||||||
}
|
|
||||||
@@ -1,33 +0,0 @@
|
|||||||
// Negativtest des Gates selbst (QA-01 Prüfung 1): ein Diff mit
|
|
||||||
// geänderter mail/internal/auth/login.go ohne begleitende Testdatei
|
|
||||||
// muss als Verstoß erkannt werden.
|
|
||||||
package pflichttestgate
|
|
||||||
|
|
||||||
import "testing"
|
|
||||||
|
|
||||||
func TestCheckDiff_FlagsSensitiveChangeWithoutTest(t *testing.T) {
|
|
||||||
violations := CheckDiff([]string{"mail/internal/auth/login.go"})
|
|
||||||
if len(violations) != 1 {
|
|
||||||
t.Fatalf("erwartet genau 1 verstoß, habe %d: %+v", len(violations), violations)
|
|
||||||
}
|
|
||||||
if violations[0].Package != "mail/internal/auth" {
|
|
||||||
t.Fatalf("falsches package gemeldet: %+v", violations[0])
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_PassesWhenTestFileAccompanies(t *testing.T) {
|
|
||||||
violations := CheckDiff([]string{
|
|
||||||
"mail/internal/auth/login.go",
|
|
||||||
"mail/internal/auth/login_test.go",
|
|
||||||
})
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keine verstöße, habe: %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestCheckDiff_IgnoresNonSensitivePaths(t *testing.T) {
|
|
||||||
violations := CheckDiff([]string{"mail/internal/example/normalize.go"})
|
|
||||||
if len(violations) != 0 {
|
|
||||||
t.Fatalf("erwartet keine verstöße für nicht-sensiblen pfad, habe: %+v", violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,49 +0,0 @@
|
|||||||
// Package storage implementiert ARC-01: die Objekt-Speicher-Anbindung
|
|
||||||
// für archivierte Mails und Anhänge. Baut auf demselben bewährten
|
|
||||||
// Muster wie DMS FDN-03 auf (austauschbare Driver, LocalDriver für
|
|
||||||
// Entwicklung, S3Driver für Produktion) — Mail kann DMS' internal/
|
|
||||||
// nicht importieren (eigenständiges Go-Modul), daher eine bewusste,
|
|
||||||
// angepasste Neuimplementierung statt eines Cross-Modul-Imports.
|
|
||||||
//
|
|
||||||
// Erweiterung gegenüber FDN-03: ARC-01 verlangt Prüfsummenverifikation
|
|
||||||
// AN DIESER SCHICHT (Akzeptanzkriterium 2), nicht erst an einer
|
|
||||||
// späteren DB-Schicht — siehe service.go.
|
|
||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"strconv"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrNotFound wird geliefert, wenn ein angefragtes Objekt nicht
|
|
||||||
// existiert.
|
|
||||||
var ErrNotFound = errors.New("storage: objekt nicht gefunden")
|
|
||||||
|
|
||||||
// Driver ist die EINE Schnittstelle, gegen die der Rest von Mail
|
|
||||||
// arbeitet (Akzeptanzkriterium 1). Zwei Implementierungen: LocalDriver
|
|
||||||
// (Entwicklung) und S3Driver (Produktion, S3-kompatibel).
|
|
||||||
type Driver interface {
|
|
||||||
Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (int64, error)
|
|
||||||
Get(ctx context.Context, key string) (io.ReadCloser, error)
|
|
||||||
Delete(ctx context.Context, key string) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// ObjectKey liefert das feste, dokumentierte Pfadschema für einen
|
|
||||||
// Mail-Anhang/-Teil INNERHALB des bereits mandantenspezifischen
|
|
||||||
// Buckets (Akzeptanzkriterium 1) — Bucket-Trennung selbst ist Sache
|
|
||||||
// von Core TEN-01. Lesezugriff hängt NUR von messageID+partIndex ab,
|
|
||||||
// nicht vom ursprünglichen Importpfad (IMAP/SMTP/manueller Import —
|
|
||||||
// Akzeptanzkriterium 3): derselbe Key wird unabhängig davon berechnet,
|
|
||||||
// über welchen Weg die Nachricht ins System kam.
|
|
||||||
func ObjectKey(messageID string, partIndex int) string {
|
|
||||||
return "messages/" + messageID + "/parts/" + strconv.Itoa(partIndex)
|
|
||||||
}
|
|
||||||
|
|
||||||
// checksumKey ist der Sidecar-Objektschlüssel für die beim Schreiben
|
|
||||||
// berechnete Prüfsumme (siehe service.go) — liegt bewusst im selben
|
|
||||||
// Driver/Bucket wie der Inhalt, keine separate DB-Abhängigkeit nötig.
|
|
||||||
func checksumKey(key string) string {
|
|
||||||
return key + ".sha256"
|
|
||||||
}
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
)
|
|
||||||
|
|
||||||
// LocalDriver legt Objekte im lokalen Dateisystem ab — der
|
|
||||||
// Entwicklungs-Treiber (Akzeptanzkriterium 1), keine externe
|
|
||||||
// Abhängigkeit nötig.
|
|
||||||
type LocalDriver struct {
|
|
||||||
baseDir string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewLocalDriver(baseDir string) *LocalDriver {
|
|
||||||
return &LocalDriver{baseDir: baseDir}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) path(key string) string {
|
|
||||||
return filepath.Join(d.baseDir, filepath.FromSlash(key))
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) Put(_ context.Context, key string, r io.Reader, _ int64, _ string) (int64, error) {
|
|
||||||
full := d.path(key)
|
|
||||||
if err := os.MkdirAll(filepath.Dir(full), 0o755); err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: verzeichnis anlegen: %w", err)
|
|
||||||
}
|
|
||||||
f, err := os.Create(full)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: datei anlegen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = f.Close() }()
|
|
||||||
|
|
||||||
written, err := io.Copy(f, r)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: schreiben: %w", err)
|
|
||||||
}
|
|
||||||
return written, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) Get(_ context.Context, key string) (io.ReadCloser, error) {
|
|
||||||
f, err := os.Open(d.path(key))
|
|
||||||
if err != nil {
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
return nil, ErrNotFound
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("storage: lesen: %w", err)
|
|
||||||
}
|
|
||||||
return f, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *LocalDriver) Delete(_ context.Context, key string) error {
|
|
||||||
if err := os.Remove(d.path(key)); err != nil {
|
|
||||||
if os.IsNotExist(err) {
|
|
||||||
return ErrNotFound
|
|
||||||
}
|
|
||||||
return fmt.Errorf("storage: löschen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,110 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
|
|
||||||
"github.com/aws/aws-sdk-go-v2/aws"
|
|
||||||
"github.com/aws/aws-sdk-go-v2/config"
|
|
||||||
"github.com/aws/aws-sdk-go-v2/credentials"
|
|
||||||
"github.com/aws/aws-sdk-go-v2/service/s3"
|
|
||||||
"github.com/aws/aws-sdk-go-v2/service/s3/types"
|
|
||||||
"github.com/aws/smithy-go"
|
|
||||||
)
|
|
||||||
|
|
||||||
// S3Driver legt Objekte in einem S3-kompatiblen Objektspeicher ab — der
|
|
||||||
// Produktions-Treiber (Akzeptanzkriterium 1). Funktioniert gegen echtes
|
|
||||||
// AWS S3 UND gegen jeden S3-kompatiblen Anbieter (MinIO etc.) über
|
|
||||||
// endpointURL. Gleiches, bewährtes Muster wie DMS FDN-03s S3Driver
|
|
||||||
// (bewusste Kopie, Mail kann DMS nicht importieren).
|
|
||||||
type S3Driver struct {
|
|
||||||
client *s3.Client
|
|
||||||
bucket string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewS3Driver(ctx context.Context, bucket, region, endpointURL, accessKeyID, secretAccessKey string, usePathStyle bool) (*S3Driver, error) {
|
|
||||||
cfg, err := config.LoadDefaultConfig(ctx,
|
|
||||||
config.WithRegion(region),
|
|
||||||
config.WithCredentialsProvider(credentials.NewStaticCredentialsProvider(accessKeyID, secretAccessKey, "")),
|
|
||||||
)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: s3-konfiguration laden: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
client := s3.NewFromConfig(cfg, func(o *s3.Options) {
|
|
||||||
if endpointURL != "" {
|
|
||||||
o.BaseEndpoint = aws.String(endpointURL)
|
|
||||||
}
|
|
||||||
o.UsePathStyle = usePathStyle
|
|
||||||
})
|
|
||||||
return &S3Driver{client: client, bucket: bucket}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *S3Driver) Put(ctx context.Context, key string, r io.Reader, _ int64, contentType string) (int64, error) {
|
|
||||||
buf, err := io.ReadAll(r)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: objekt vor upload lesen: %w", err)
|
|
||||||
}
|
|
||||||
_, err = d.client.PutObject(ctx, &s3.PutObjectInput{
|
|
||||||
Bucket: aws.String(d.bucket),
|
|
||||||
Key: aws.String(key),
|
|
||||||
Body: bytes.NewReader(buf),
|
|
||||||
ContentLength: aws.Int64(int64(len(buf))),
|
|
||||||
ContentType: aws.String(contentType),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("storage: s3-upload: %w", err)
|
|
||||||
}
|
|
||||||
return int64(len(buf)), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *S3Driver) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
|
||||||
out, err := d.client.GetObject(ctx, &s3.GetObjectInput{
|
|
||||||
Bucket: aws.String(d.bucket),
|
|
||||||
Key: aws.String(key),
|
|
||||||
})
|
|
||||||
if err != nil {
|
|
||||||
if isS3NotFound(err) {
|
|
||||||
return nil, ErrNotFound
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("storage: s3-download: %w", err)
|
|
||||||
}
|
|
||||||
return out.Body, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (d *S3Driver) Delete(ctx context.Context, key string) error {
|
|
||||||
// S3 liefert bei DeleteObject fuer ein nicht existierendes Objekt
|
|
||||||
// KEINEN Fehler (idempotente S3-API-Semantik) — um denselben
|
|
||||||
// Vertrag wie LocalDriver (ErrNotFound bei fehlendem Objekt) zu
|
|
||||||
// erfüllen, wird die Existenz vorher explizit geprüft.
|
|
||||||
_, err := d.client.HeadObject(ctx, &s3.HeadObjectInput{Bucket: aws.String(d.bucket), Key: aws.String(key)})
|
|
||||||
if err != nil {
|
|
||||||
if isS3NotFound(err) {
|
|
||||||
return ErrNotFound
|
|
||||||
}
|
|
||||||
return fmt.Errorf("storage: s3-existenzprüfung vor löschen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := d.client.DeleteObject(ctx, &s3.DeleteObjectInput{
|
|
||||||
Bucket: aws.String(d.bucket),
|
|
||||||
Key: aws.String(key),
|
|
||||||
}); err != nil {
|
|
||||||
return fmt.Errorf("storage: s3-löschen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func isS3NotFound(err error) bool {
|
|
||||||
var nsk *types.NoSuchKey
|
|
||||||
if errors.As(err, &nsk) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
var apiErr smithy.APIError
|
|
||||||
if errors.As(err, &apiErr) && apiErr.ErrorCode() == "NotFound" {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
@@ -1,127 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"crypto/sha256"
|
|
||||||
"encoding/hex"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrChecksumMismatch wird von GetVerified geliefert, wenn der beim
|
|
||||||
// Lesen berechnete Hash nicht mit der beim Schreiben gespeicherten
|
|
||||||
// Prüfsumme übereinstimmt (Akzeptanzkriterium 2 / Pflichtprüfung 2:
|
|
||||||
// ein absichtlich beschädigtes Objekt wird erkannt).
|
|
||||||
var ErrChecksumMismatch = errors.New("storage: prüfsumme stimmt nicht überein — objekt wurde verändert")
|
|
||||||
|
|
||||||
// Service verbindet einen Driver mit Prüfsummenverifikation
|
|
||||||
// (Akzeptanzkriterium 2) und der Nutzungsmeldung an Core LIC-05
|
|
||||||
// (Akzeptanzkriterium 4) — jeder Schreib-/Löschvorgang über Service
|
|
||||||
// löst GENAU EINE Meldung mit der tatsächlich geschriebenen/gelöschten
|
|
||||||
// Objektgröße aus. Aufrufer (spätere Tickets, z. B. IMP-*) rufen
|
|
||||||
// ausschließlich Service auf, nie einen Driver direkt.
|
|
||||||
type Service struct {
|
|
||||||
driver Driver
|
|
||||||
usage UsageReporter
|
|
||||||
tenantSlug string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(driver Driver, usage UsageReporter, tenantSlug string) *Service {
|
|
||||||
return &Service{driver: driver, usage: usage, tenantSlug: tenantSlug}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Put legt den Inhalt ab UND verifiziert den Schreibvorgang durch
|
|
||||||
// Prüfsummenvergleich (Akzeptanzkriterium 2): der Inhalt wird
|
|
||||||
// geschrieben, die Prüfsumme als Sidecar-Objekt gespeichert, danach
|
|
||||||
// SOFORT zurückgelesen und erneut gehasht — weicht der Rückgelesene
|
|
||||||
// Hash vom beim Schreiben berechneten ab, meldet Put einen Fehler,
|
|
||||||
// statt eine unbemerkt fehlerhafte Ablage stehen zu lassen. Meldet die
|
|
||||||
// geschriebene Größe als positives Delta an Core LIC-05
|
|
||||||
// (Akzeptanzkriterium 4).
|
|
||||||
func (s *Service) Put(ctx context.Context, key string, r io.Reader, size int64, contentType string) (checksum string, err error) {
|
|
||||||
hasher := sha256.New()
|
|
||||||
tee := io.TeeReader(r, hasher)
|
|
||||||
|
|
||||||
written, err := s.driver.Put(ctx, key, tee, size, contentType)
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
checksum = hex.EncodeToString(hasher.Sum(nil))
|
|
||||||
|
|
||||||
if _, err := s.driver.Put(ctx, checksumKey(key), bytes.NewReader([]byte(checksum)), int64(len(checksum)), "text/plain"); err != nil {
|
|
||||||
return "", fmt.Errorf("storage: prüfsumme speichern: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Sofortige Rücklese-Verifikation — beweist, dass der Schreibvorgang
|
|
||||||
// tatsächlich verifiziert wurde, nicht nur eine Prüfsumme abgelegt
|
|
||||||
// wurde, die nie geprüft wird.
|
|
||||||
if _, err := s.GetVerified(ctx, key); err != nil {
|
|
||||||
return "", fmt.Errorf("storage: schreibverifikation fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, written); err != nil {
|
|
||||||
return checksum, fmt.Errorf("storage: objekt gespeichert, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
return checksum, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den Inhalt UNVERIFIZIERT (Streaming, für große Objekte).
|
|
||||||
// Für die Pflichtprüfung "beschädigtes Objekt wird erkannt" GetVerified
|
|
||||||
// verwenden.
|
|
||||||
func (s *Service) Get(ctx context.Context, key string) (io.ReadCloser, error) {
|
|
||||||
return s.driver.Get(ctx, key)
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetVerified liest den vollständigen Inhalt UND vergleicht die beim
|
|
||||||
// Schreiben gespeicherte Prüfsumme gegen den beim Lesen berechneten
|
|
||||||
// Hash (Akzeptanzkriterium 2 / Pflichtprüfung 2).
|
|
||||||
func (s *Service) GetVerified(ctx context.Context, key string) ([]byte, error) {
|
|
||||||
sumReader, err := s.driver.Get(ctx, checksumKey(key))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: gespeicherte prüfsumme lesen: %w", err)
|
|
||||||
}
|
|
||||||
expectedRaw, err := io.ReadAll(sumReader)
|
|
||||||
_ = sumReader.Close()
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: gespeicherte prüfsumme lesen: %w", err)
|
|
||||||
}
|
|
||||||
expected := string(expectedRaw)
|
|
||||||
|
|
||||||
contentReader, err := s.driver.Get(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
defer func() { _ = contentReader.Close() }()
|
|
||||||
|
|
||||||
hasher := sha256.New()
|
|
||||||
content, err := io.ReadAll(io.TeeReader(contentReader, hasher))
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("storage: objekt lesen: %w", err)
|
|
||||||
}
|
|
||||||
actual := hex.EncodeToString(hasher.Sum(nil))
|
|
||||||
if actual != expected {
|
|
||||||
return nil, ErrChecksumMismatch
|
|
||||||
}
|
|
||||||
return content, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Delete entfernt Inhalt UND Prüfsummen-Sidecar, meldet die Größe als
|
|
||||||
// negatives Delta an Core LIC-05 (Akzeptanzkriterium 4) — der Aufrufer
|
|
||||||
// muss die Größe kennen (Delete selbst kann sie nach dem Löschen nicht
|
|
||||||
// mehr ermitteln).
|
|
||||||
func (s *Service) Delete(ctx context.Context, key string, sizeBytes int64) error {
|
|
||||||
if err := s.driver.Delete(ctx, key); err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
// Sidecar-Löschung ist best effort — ein fehlendes Sidecar (z. B.
|
|
||||||
// bei einem sehr alten Objekt) darf den eigentlichen Löschvorgang
|
|
||||||
// nicht blockieren.
|
|
||||||
_ = s.driver.Delete(ctx, checksumKey(key))
|
|
||||||
|
|
||||||
if err := s.usage.Report(ctx, s.tenantSlug, UsageMetric, -sizeBytes); err != nil {
|
|
||||||
return fmt.Errorf("storage: objekt gelöscht, aber nutzungsmeldung fehlgeschlagen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,134 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
type fakeUsageReporter struct {
|
|
||||||
reports []int64
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f *fakeUsageReporter) Report(_ context.Context, _, metric string, delta int64) error {
|
|
||||||
if metric != UsageMetric {
|
|
||||||
return errors.New("unerwartete metrik: " + metric)
|
|
||||||
}
|
|
||||||
f.reports = append(f.reports, delta)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func newTestService(t *testing.T) (*Service, *fakeUsageReporter) {
|
|
||||||
t.Helper()
|
|
||||||
driver := NewLocalDriver(t.TempDir())
|
|
||||||
usage := &fakeUsageReporter{}
|
|
||||||
return NewService(driver, usage, "acme"), usage
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_ReadBackIsByteIdentical ist die geforderte Pflichtprüfung 1:
|
|
||||||
// ein geschriebenes Objekt liefert beim Lesen byteidentischen Inhalt.
|
|
||||||
func TestPut_ReadBackIsByteIdentical(t *testing.T) {
|
|
||||||
svc, _ := newTestService(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
key := ObjectKey("msg-1", 0)
|
|
||||||
content := "vollständig identischer Inhalt äöü"
|
|
||||||
|
|
||||||
checksum, err := svc.Put(ctx, key, strings.NewReader(content), int64(len(content)), "text/plain")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
if checksum == "" {
|
|
||||||
t.Fatal("erwartet nicht-leere prüfsumme")
|
|
||||||
}
|
|
||||||
|
|
||||||
got, err := svc.GetVerified(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("getverified: %v", err)
|
|
||||||
}
|
|
||||||
if string(got) != content {
|
|
||||||
t.Fatalf("nicht byteidentisch: got %q, want %q", got, content)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestGetVerified_DetectsTamperedObject ist die geforderte
|
|
||||||
// Pflichtprüfung 2: ein absichtlich beschädigtes Objekt wird bei
|
|
||||||
// Prüfsummenvergleich erkannt.
|
|
||||||
func TestGetVerified_DetectsTamperedObject(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
driver := NewLocalDriver(dir)
|
|
||||||
usage := &fakeUsageReporter{}
|
|
||||||
svc := NewService(driver, usage, "acme")
|
|
||||||
ctx := context.Background()
|
|
||||||
key := ObjectKey("msg-tamper", 0)
|
|
||||||
|
|
||||||
if _, err := svc.Put(ctx, key, strings.NewReader("originaler inhalt"), 17, "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Objekt DIREKT am Dateisystem manipulieren — umgeht Service
|
|
||||||
// vollständig, simuliert externe Beschädigung/Manipulation.
|
|
||||||
full := driver.path(key)
|
|
||||||
if err := os.WriteFile(full, []byte("MANIPULIERTER INHALT"), 0o644); err != nil {
|
|
||||||
t.Fatalf("manipulation schreiben: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err := svc.GetVerified(ctx, key)
|
|
||||||
if !errors.Is(err, ErrChecksumMismatch) {
|
|
||||||
t.Fatalf("erwartet ErrChecksumMismatch bei manipuliertem objekt, habe: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_ManySmallObjectsAcceptableLatency ist die geforderte
|
|
||||||
// Pflichtprüfung 3: Lasttest mit vielen kleinen Objekten bestätigt
|
|
||||||
// akzeptable Latenz.
|
|
||||||
func TestPut_ManySmallObjectsAcceptableLatency(t *testing.T) {
|
|
||||||
svc, _ := newTestService(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
const count = 500
|
|
||||||
start := time.Now()
|
|
||||||
for i := 0; i < count; i++ {
|
|
||||||
key := ObjectKey("msg-load", i)
|
|
||||||
if _, err := svc.Put(ctx, key, strings.NewReader("kleiner anhang inhalt"), 21, "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put #%d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
elapsed := time.Since(start)
|
|
||||||
avgPerObject := elapsed / count
|
|
||||||
|
|
||||||
// Großzügige Grenze (10ms/Objekt inkl. Schreiben+Sidecar+Rücklese-
|
|
||||||
// Verifikation) — Ziel ist der Nachweis, dass keine quadratische
|
|
||||||
// oder anderweitig unverhältnismäßige Verschlechterung auftritt,
|
|
||||||
// nicht ein knallhartes Performance-SLA.
|
|
||||||
if avgPerObject > 10*time.Millisecond {
|
|
||||||
t.Fatalf("erwartet akzeptable latenz (<10ms/objekt), habe %v/objekt (gesamt %v für %d objekte)", avgPerObject, elapsed, count)
|
|
||||||
}
|
|
||||||
t.Logf("Lasttest: %d Objekte in %v (%v/Objekt)", count, elapsed, avgPerObject)
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestPut_ReportsUsageOnWriteAndDelete ist die geforderte
|
|
||||||
// Pflichtprüfung 4: Melde-Aufruf an Core LIC-05 bei Schreib- und
|
|
||||||
// Löschvorgang nachweislich ausgelöst, mit korrekter Größenangabe.
|
|
||||||
func TestPut_ReportsUsageOnWriteAndDelete(t *testing.T) {
|
|
||||||
svc, usage := newTestService(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
key := ObjectKey("msg-usage", 0)
|
|
||||||
content := "zwölf bytes!"
|
|
||||||
|
|
||||||
if _, err := svc.Put(ctx, key, strings.NewReader(content), int64(len(content)), "text/plain"); err != nil {
|
|
||||||
t.Fatalf("put: %v", err)
|
|
||||||
}
|
|
||||||
if len(usage.reports) != 1 || usage.reports[0] != int64(len(content)) {
|
|
||||||
t.Fatalf("erwartet genau eine positive meldung mit größe %d, habe: %v", len(content), usage.reports)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := svc.Delete(ctx, key, int64(len(content))); err != nil {
|
|
||||||
t.Fatalf("delete: %v", err)
|
|
||||||
}
|
|
||||||
if len(usage.reports) != 2 || usage.reports[1] != -int64(len(content)) {
|
|
||||||
t.Fatalf("erwartet zusätzliche negative meldung mit -%d, habe: %v", len(content), usage.reports)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,75 +0,0 @@
|
|||||||
package storage
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"fmt"
|
|
||||||
"net/http"
|
|
||||||
)
|
|
||||||
|
|
||||||
// UsageMetric ist der Metrikname, unter dem Core (internal/usage,
|
|
||||||
// LIC-05) den Speicherverbrauch je Mandant führt — muss exakt
|
|
||||||
// internal/usage.StorageBytesMetric aus dem NEXARCH-Core-Modul
|
|
||||||
// entsprechen (Mail kann Core nicht importieren, daher hier gespiegelt
|
|
||||||
// — identisches Muster wie DMS FDN-03).
|
|
||||||
const UsageMetric = "storage_bytes"
|
|
||||||
|
|
||||||
// UsageReporter meldet Speicherverbrauchsänderungen an Core
|
|
||||||
// (Akzeptanzkriterium 4). Schmale Schnittstelle, damit Tests einen
|
|
||||||
// Fake statt eines echten HTTP-Aufrufs einsetzen können.
|
|
||||||
type UsageReporter interface {
|
|
||||||
Report(ctx context.Context, tenantSlug, metric string, delta int64) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// usageDeltaDTO entspricht Core internal/resync.usageDeltaDTO
|
|
||||||
// (JSON-Vertrag: tenant_slug/metric/delta), über den API-11
|
|
||||||
// (resync-api) real erreichbar ist.
|
|
||||||
type usageDeltaDTO struct {
|
|
||||||
TenantSlug string `json:"tenant_slug"`
|
|
||||||
Metric string `json:"metric"`
|
|
||||||
Delta int64 `json:"delta"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// HTTPUsageReporter meldet über Core API-11 (resync-api,
|
|
||||||
// internal/resync.Handler.UsageHandler), authentifiziert über
|
|
||||||
// dasselbe Service-Credential-Verfahren wie jeder andere Modul-Core-
|
|
||||||
// Aufruf (API-02).
|
|
||||||
type HTTPUsageReporter struct {
|
|
||||||
endpointURL string
|
|
||||||
clientID string
|
|
||||||
clientSecret string
|
|
||||||
httpClient *http.Client
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewHTTPUsageReporter(endpointURL, clientID, clientSecret string, httpClient *http.Client) *HTTPUsageReporter {
|
|
||||||
if httpClient == nil {
|
|
||||||
httpClient = http.DefaultClient
|
|
||||||
}
|
|
||||||
return &HTTPUsageReporter{endpointURL: endpointURL, clientID: clientID, clientSecret: clientSecret, httpClient: httpClient}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (r *HTTPUsageReporter) Report(ctx context.Context, tenantSlug, metric string, delta int64) error {
|
|
||||||
body, err := json.Marshal([]usageDeltaDTO{{TenantSlug: tenantSlug, Metric: metric, Delta: delta}})
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("storage: nutzungsmeldung serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
req, err := http.NewRequestWithContext(ctx, http.MethodPost, r.endpointURL, bytes.NewReader(body))
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("storage: nutzungsmeldungs-anfrage aufbauen: %w", err)
|
|
||||||
}
|
|
||||||
req.Header.Set("Content-Type", "application/json")
|
|
||||||
req.Header.Set("X-Nexarch-Client-Id", r.clientID)
|
|
||||||
req.Header.Set("X-Nexarch-Client-Secret", r.clientSecret)
|
|
||||||
|
|
||||||
resp, err := r.httpClient.Do(req)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("storage: nutzungsmeldung senden: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = resp.Body.Close() }()
|
|
||||||
if resp.StatusCode != http.StatusOK {
|
|
||||||
return fmt.Errorf("storage: nutzungsmeldung von core abgelehnt: status %d", resp.StatusCode)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
Reference in New Issue
Block a user