Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6537888da6 | ||
|
|
bfa5c61db5 | ||
|
|
554c9aae66 | ||
|
|
1ba90319a2 | ||
|
|
3c226dab12 | ||
|
|
f344f79326 | ||
|
|
c4bcfa8caf | ||
|
|
584cefa388 | ||
|
|
00665592f6 | ||
|
|
3b96d8ef41 | ||
|
|
c9e8edbbf0 | ||
|
|
b12d53f469 | ||
|
|
8da9c67d08 |
@@ -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
|
|
||||||
@@ -1,2 +1,4 @@
|
|||||||
*.log
|
*.log
|
||||||
.env
|
.env
|
||||||
|
web/*/node_modules/
|
||||||
|
web/*/.next/
|
||||||
|
|||||||
@@ -44,3 +44,118 @@ Keine Commits in dieser Session.
|
|||||||
Keine Änderungen ermittelbar.
|
Keine Änderungen ermittelbar.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
## 2026-08-27 17:26 – 17:28 (1m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** code
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
- c895a67 core: initial Go module skeleton (config, db pool, tenant registry migration)
|
||||||
|
|
||||||
|
### Geänderte Dateien
|
||||||
|
- .gitignore | 2 ++
|
||||||
|
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
||||||
|
- go.mod | 5 +++++
|
||||||
|
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
||||||
|
- internal/db/db.go | 11 +++++++++++
|
||||||
|
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
||||||
|
|
||||||
|
---
|
||||||
|
## 2026-08-27 17:28 – 17:29 (1m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** code
|
||||||
|
## 2026-08-28 21:44 – 21:44 (0m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** nexarch
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
Keine Commits in dieser Session.
|
||||||
|
|
||||||
|
### Geänderte Dateien
|
||||||
|
- .gitignore | 2 ++
|
||||||
|
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
||||||
|
- go.mod | 5 +++++
|
||||||
|
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
||||||
|
- internal/db/db.go | 11 +++++++++++
|
||||||
|
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
||||||
|
|
||||||
|
---
|
||||||
|
## 2026-08-27 17:31 – 17:31 (0m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** code
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
Keine Commits in dieser Session.
|
||||||
|
|
||||||
|
### Geänderte Dateien
|
||||||
|
- .gitignore | 2 ++
|
||||||
|
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
||||||
|
- go.mod | 5 +++++
|
||||||
|
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
||||||
|
- internal/db/db.go | 11 +++++++++++
|
||||||
|
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
||||||
|
|
||||||
|
---
|
||||||
|
## 2026-08-27 17:36 – 17:36 (0m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** code
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
Keine Commits in dieser Session.
|
||||||
|
|
||||||
|
### Geänderte Dateien
|
||||||
|
- .gitignore | 2 ++
|
||||||
|
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
||||||
|
- go.mod | 5 +++++
|
||||||
|
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
||||||
|
- internal/db/db.go | 11 +++++++++++
|
||||||
|
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
||||||
|
|
||||||
|
---
|
||||||
|
## 2026-08-27 17:36 – 17:37 (0m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** code
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
Keine Commits in dieser Session.
|
||||||
|
|
||||||
|
### Geänderte Dateien
|
||||||
|
- .gitignore | 2 ++
|
||||||
|
- DEVLOG.md | 46 ++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- cmd/core/main.go | 33 +++++++++++++++++++++++++++++++++
|
||||||
|
- go.mod | 5 +++++
|
||||||
|
- internal/config/config.go | 29 +++++++++++++++++++++++++++++
|
||||||
|
- internal/db/db.go | 11 +++++++++++
|
||||||
|
- migrations/0001_tenant_registry.sql | 10 ++++++++++
|
||||||
|
- web/shl/README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/__tests__/Dialog.test.tsx | 38 ++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/__tests__/tokens.test.ts | 39 +++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/components/Dialog.tsx | 88 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/components/FormElements.tsx | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/components/Shell.tsx | 62 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/components/Table.tsx | 83 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/components/Toast.tsx | 67 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/i18n/i18n.tsx | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/index.ts | 25 +++++++++++++++++++++++++
|
||||||
|
- web/shl/package.json | 23 +++++++++++++++++++++++
|
||||||
|
- web/shl/theme/ThemeProvider.tsx | 81 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/tokens/tokens.ts | 96 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
|
||||||
|
- web/shl/tsconfig.json | 18 ++++++++++++++++++
|
||||||
|
|
||||||
|
---
|
||||||
|
## 2026-08-28 21:51 – 21:57 (5m)
|
||||||
|
**Beschreibung:** Claude Code Session
|
||||||
|
**Projekt:** nexarch
|
||||||
|
|
||||||
|
### Commits
|
||||||
|
- 3c226da SHL-01: fix — vitest jsdom-environment + jest-dom-Setup (3 Dialog-Tests schlugen ohne DOM fehl)
|
||||||
|
|
||||||
|
### Geänderte Dateien
|
||||||
|
- web/shl/package.json | 2 ++
|
||||||
|
- web/shl/vitest.config.ts | 8 ++++++++
|
||||||
|
- web/shl/vitest.setup.ts | 1 +
|
||||||
|
|
||||||
|
---
|
||||||
|
|||||||
@@ -0,0 +1,69 @@
|
|||||||
|
// auditlog-devserver stellt AUD-03s ExportHandler (internal/audit) fuer die
|
||||||
|
// Next.js-Audit-Log-Ansicht (AUD-04) bereit. Getrennt von cmd/core aus
|
||||||
|
// demselben Grund wie die anderen *-devserver (siehe LIC-04/TEN-05): echte
|
||||||
|
// Auth/RBAC ist noch nicht in die zentrale Server-Topologie verdrahtet.
|
||||||
|
//
|
||||||
|
// Authorize wird hier mit einem geteilten Admin-Token ueber
|
||||||
|
// crypto/subtle.ConstantTimeCompare umgesetzt — demselben Timing-safe-Muster
|
||||||
|
// wie internal/audit.timingsafe (AUD-02), NICHT ueber eine neue
|
||||||
|
// Rollen-/Rechteschicht, da diese Kachel ausdruecklich nur von AUD-03
|
||||||
|
// abhaengt und keine Rechteverwaltung duplizieren soll.
|
||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
"net/http"
|
||||||
|
"os"
|
||||||
|
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/audit"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/auditadmin"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
||||||
|
)
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
dsn := os.Getenv("NEXARCH_REGISTRY_DSN")
|
||||||
|
if dsn == "" {
|
||||||
|
log.Fatal("NEXARCH_REGISTRY_DSN nicht gesetzt")
|
||||||
|
}
|
||||||
|
adminToken := os.Getenv("NEXARCH_AUDIT_ADMIN_TOKEN")
|
||||||
|
if adminToken == "" {
|
||||||
|
log.Fatal("NEXARCH_AUDIT_ADMIN_TOKEN nicht gesetzt")
|
||||||
|
}
|
||||||
|
addr := os.Getenv("NEXARCH_AUDITLOG_LISTEN_ADDR")
|
||||||
|
if addr == "" {
|
||||||
|
addr = ":8083"
|
||||||
|
}
|
||||||
|
|
||||||
|
ctx := context.Background()
|
||||||
|
pool, err := db.Connect(ctx, dsn)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("db: %v", err)
|
||||||
|
}
|
||||||
|
defer pool.Close()
|
||||||
|
|
||||||
|
auditLog := audit.NewLog(pool)
|
||||||
|
tokenAuthorize := auditadmin.NewTokenAuthorizer(adminToken)
|
||||||
|
authorize := func(_ context.Context, caller string) bool { return tokenAuthorize(caller) }
|
||||||
|
handler := audit.NewExportHandler(auditLog, authorize)
|
||||||
|
|
||||||
|
mux := http.NewServeMux()
|
||||||
|
mux.HandleFunc("/audit/export", withCORS(handler.Export))
|
||||||
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { w.WriteHeader(http.StatusOK) })
|
||||||
|
|
||||||
|
log.Printf("auditlog-devserver listening on %s", addr)
|
||||||
|
log.Fatal(http.ListenAndServe(addr, mux))
|
||||||
|
}
|
||||||
|
|
||||||
|
func withCORS(next http.HandlerFunc) http.HandlerFunc {
|
||||||
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
|
w.Header().Set("Access-Control-Allow-Origin", "*")
|
||||||
|
w.Header().Set("Access-Control-Allow-Methods", "GET, OPTIONS")
|
||||||
|
w.Header().Set("Access-Control-Allow-Headers", "Content-Type")
|
||||||
|
if r.Method == http.MethodOptions {
|
||||||
|
w.WriteHeader(http.StatusOK)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
next(w, r)
|
||||||
|
}
|
||||||
|
}
|
||||||
+18
-3
@@ -7,6 +7,7 @@ import (
|
|||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/config"
|
"gitea.perlbach24.de/scripte/nexarch/internal/config"
|
||||||
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
"gitea.perlbach24.de/scripte/nexarch/internal/db"
|
||||||
|
"gitea.perlbach24.de/scripte/nexarch/internal/tenant"
|
||||||
)
|
)
|
||||||
|
|
||||||
func main() {
|
func main() {
|
||||||
@@ -15,16 +16,30 @@ func main() {
|
|||||||
log.Fatalf("config: %v", err)
|
log.Fatalf("config: %v", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
pool, err := db.Connect(context.Background(), cfg.RegistryDSN)
|
ctx := context.Background()
|
||||||
|
|
||||||
|
registryPool, err := db.Connect(ctx, cfg.RegistryDSN)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatalf("db: %v", err)
|
log.Fatalf("registry db: %v", err)
|
||||||
}
|
}
|
||||||
defer pool.Close()
|
defer registryPool.Close()
|
||||||
|
|
||||||
|
adminPool, err := db.Connect(ctx, cfg.AdminDSN)
|
||||||
|
if err != nil {
|
||||||
|
log.Fatalf("admin db: %v", err)
|
||||||
|
}
|
||||||
|
defer adminPool.Close()
|
||||||
|
|
||||||
|
registry := tenant.NewRegistry(registryPool)
|
||||||
|
provisioner := tenant.NewProvisioner(adminPool, registry, cfg.TenantDSNTemplate)
|
||||||
|
tenantHandler := tenant.NewHandler(provisioner)
|
||||||
|
|
||||||
mux := http.NewServeMux()
|
mux := http.NewServeMux()
|
||||||
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
mux.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) {
|
||||||
w.WriteHeader(http.StatusOK)
|
w.WriteHeader(http.StatusOK)
|
||||||
})
|
})
|
||||||
|
// Vorlaeufiger Pfad ohne Versionierung/Auth — wird mit API-01/IAM-01 abgeloest.
|
||||||
|
mux.HandleFunc("/internal/tenants", tenantHandler.CreateTenant)
|
||||||
|
|
||||||
log.Printf("nexarch-core listening on %s", cfg.ListenAddr)
|
log.Printf("nexarch-core listening on %s", cfg.ListenAddr)
|
||||||
if err := http.ListenAndServe(cfg.ListenAddr, mux); err != nil {
|
if err := http.ListenAndServe(cfg.ListenAddr, mux); err != nil {
|
||||||
|
|||||||
@@ -3,3 +3,12 @@ module gitea.perlbach24.de/scripte/nexarch
|
|||||||
go 1.22
|
go 1.22
|
||||||
|
|
||||||
require github.com/jackc/pgx/v5 v5.6.0
|
require github.com/jackc/pgx/v5 v5.6.0
|
||||||
|
|
||||||
|
require (
|
||||||
|
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
|
||||||
|
golang.org/x/text v0.14.0 // indirect
|
||||||
|
)
|
||||||
|
|||||||
@@ -0,0 +1,28 @@
|
|||||||
|
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=
|
||||||
@@ -0,0 +1,96 @@
|
|||||||
|
// Package audit implementiert Core AUD-01: das zentrale, vom allgemeinen
|
||||||
|
// Anwendungs-Log getrennte Audit-Datenmodell fuer sicherheits- und
|
||||||
|
// compliancerelevante Ereignisse (wer, was, wann, an welchem Tenant).
|
||||||
|
// Unveraenderlichkeit (Append-only) ist AUD-02, Export/Filter-API ist AUD-03
|
||||||
|
// — dieses Paket liefert nur das Datenmodell und den EINEN zentralen
|
||||||
|
// Schreibpfad (Akzeptanzkriterium 3).
|
||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
"errors"
|
||||||
|
"fmt"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// SystemTenant ist der reservierte Tenant-Bezug fuer mandantenuebergreifende
|
||||||
|
// Ereignisse (z.B. Superadmin-Aktionen) — es gibt bewusst KEINEN Weg, ein
|
||||||
|
// Ereignis ganz ohne Tenant-Bezug zu schreiben (Akzeptanzkriterium 2).
|
||||||
|
const SystemTenant = "system"
|
||||||
|
|
||||||
|
var ErrMissingTenant = errors.New("audit: tenant_slug darf nicht leer sein")
|
||||||
|
var ErrMissingActor = errors.New("audit: actor darf nicht leer sein")
|
||||||
|
var ErrMissingAction = errors.New("audit: action darf nicht leer sein")
|
||||||
|
|
||||||
|
// Event ist ein strukturiertes Audit-Ereignis (Akzeptanzkriterium 1: Akteur,
|
||||||
|
// Aktion, Zielobjekt, Zeitpunkt, Tenant).
|
||||||
|
type Event struct {
|
||||||
|
TenantSlug string
|
||||||
|
Actor string
|
||||||
|
Action string
|
||||||
|
Target string
|
||||||
|
Metadata map[string]any
|
||||||
|
OccurredAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// Log ist der EINE zentrale Schreibpfad fuer Audit-Ereignisse — es gibt
|
||||||
|
// bewusst keine zweite Schreibmoeglichkeit, damit kein Handler versehentlich
|
||||||
|
// direkt in audit_events schreibt und dabei die Validierung umgeht
|
||||||
|
// (Akzeptanzkriterium 3).
|
||||||
|
type Log struct {
|
||||||
|
pool *pgxpool.Pool
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewLog(pool *pgxpool.Pool) *Log {
|
||||||
|
return &Log{pool: pool}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Record persistiert genau einen Audit-Eintrag. Fehlender Tenant-Bezug wird
|
||||||
|
// bereits hier abgewiesen (klarer Fehler statt Constraint-Verletzung im
|
||||||
|
// Normalfall) — die Datenbank-CHECK-Constraint aus der Migration ist die
|
||||||
|
// zweite, unumgehbare Verteidigungslinie (Akzeptanzkriterium 2 / Pruefung 2).
|
||||||
|
func (l *Log) Record(ctx context.Context, e Event) error {
|
||||||
|
if e.TenantSlug == "" {
|
||||||
|
return ErrMissingTenant
|
||||||
|
}
|
||||||
|
if e.Actor == "" {
|
||||||
|
return ErrMissingActor
|
||||||
|
}
|
||||||
|
if e.Action == "" {
|
||||||
|
return ErrMissingAction
|
||||||
|
}
|
||||||
|
if e.Metadata == nil {
|
||||||
|
e.Metadata = map[string]any{}
|
||||||
|
}
|
||||||
|
metadataJSON, err := json.Marshal(e.Metadata)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("metadaten serialisieren: %w", err)
|
||||||
|
}
|
||||||
|
if e.OccurredAt.IsZero() {
|
||||||
|
e.OccurredAt = time.Now()
|
||||||
|
}
|
||||||
|
|
||||||
|
_, err = l.pool.Exec(ctx, `
|
||||||
|
INSERT INTO audit_events (occurred_at, tenant_slug, actor, action, target, metadata)
|
||||||
|
VALUES ($1, $2, $3, $4, $5, $6)
|
||||||
|
`, e.OccurredAt, e.TenantSlug, e.Actor, e.Action, e.Target, metadataJSON)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("audit-ereignis schreiben: %w", err)
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// CountByTenant ist eine schlanke Lesehilfe fuer Tests/Diagnose — die
|
||||||
|
// eigentliche Filter-/Export-API ist AUD-03, hier bewusst nicht vorgezogen.
|
||||||
|
func (l *Log) CountByTenant(ctx context.Context, tenantSlug string) (int, error) {
|
||||||
|
var n int
|
||||||
|
if err := l.pool.QueryRow(ctx, `
|
||||||
|
SELECT count(*) FROM audit_events WHERE tenant_slug = $1
|
||||||
|
`, tenantSlug).Scan(&n); err != nil {
|
||||||
|
return 0, fmt.Errorf("audit-ereignisse zaehlen: %w", err)
|
||||||
|
}
|
||||||
|
return n, nil
|
||||||
|
}
|
||||||
@@ -0,0 +1,132 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"errors"
|
||||||
|
"os"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupAuditTest(t *testing.T) (*Log, *pgxpool.Pool, func()) {
|
||||||
|
t.Helper()
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS audit_events (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
||||||
|
actor TEXT NOT NULL CHECK (actor <> ''),
|
||||||
|
action TEXT NOT NULL CHECK (action <> ''),
|
||||||
|
target TEXT NOT NULL,
|
||||||
|
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
||||||
|
)`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanup := func() {
|
||||||
|
_, _ = pool.Exec(ctx, `DELETE FROM audit_events WHERE tenant_slug LIKE 'test\_%' ESCAPE '\' OR tenant_slug = $1`, SystemTenant)
|
||||||
|
pool.Close()
|
||||||
|
}
|
||||||
|
return NewLog(pool), pool, cleanup
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 1: ein sicherheitsrelevanter Vorgang
|
||||||
|
// (hier: fehlgeschlagener Login) erzeugt zuverlaessig genau einen Eintrag.
|
||||||
|
func TestRecord_PersistsExactlyOneEventPerSecurityIncident(t *testing.T) {
|
||||||
|
log, pool, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
err := log.Record(ctx, Event{
|
||||||
|
TenantSlug: "test_acme",
|
||||||
|
Actor: "alice@example.com",
|
||||||
|
Action: "iam.login_failed",
|
||||||
|
Target: "user:alice@example.com",
|
||||||
|
Metadata: map[string]any{"reason": "falsches passwort"},
|
||||||
|
})
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("record: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
count, err := log.CountByTenant(ctx, "test_acme")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("count: %v", err)
|
||||||
|
}
|
||||||
|
if count != 1 {
|
||||||
|
t.Fatalf("erwartet genau 1 audit-eintrag, habe %d", count)
|
||||||
|
}
|
||||||
|
|
||||||
|
var actor, action, target string
|
||||||
|
if err := pool.QueryRow(ctx, `
|
||||||
|
SELECT actor, action, target FROM audit_events WHERE tenant_slug = 'test_acme'
|
||||||
|
`).Scan(&actor, &action, &target); err != nil {
|
||||||
|
t.Fatalf("eintrag lesen: %v", err)
|
||||||
|
}
|
||||||
|
if actor != "alice@example.com" || action != "iam.login_failed" || target != "user:alice@example.com" {
|
||||||
|
t.Fatalf("eintrag unerwartet: actor=%q action=%q target=%q", actor, action, target)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2 (App-Ebene): fehlender Tenant-Bezug wird
|
||||||
|
// bereits vom zentralen Schreibpfad abgewiesen.
|
||||||
|
func TestRecord_RejectsMissingTenant(t *testing.T) {
|
||||||
|
log, _, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
err := log.Record(ctx, Event{TenantSlug: "", Actor: "alice", Action: "irgendwas"})
|
||||||
|
if !errors.Is(err, ErrMissingTenant) {
|
||||||
|
t.Fatalf("erwartet ErrMissingTenant, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 2 (DB-Ebene): selbst ein direkter INSERT,
|
||||||
|
// der Log.Record umgeht, wird durch die CHECK-Constraint verhindert — der
|
||||||
|
// Schutz haengt nicht allein von der Go-Validierung ab.
|
||||||
|
func TestConstraint_RejectsMissingTenantAtDatabaseLevel(t *testing.T) {
|
||||||
|
_, pool, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
_, err := pool.Exec(ctx, `
|
||||||
|
INSERT INTO audit_events (tenant_slug, actor, action, target)
|
||||||
|
VALUES ('', 'alice', 'irgendwas', 'ziel')
|
||||||
|
`)
|
||||||
|
if err == nil {
|
||||||
|
t.Fatal("erwartet fehler durch CHECK-constraint bei leerem tenant_slug, habe nil")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecord_RejectsMissingActorAndAction(t *testing.T) {
|
||||||
|
log, _, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: "test_acme", Actor: "", Action: "x"}); !errors.Is(err, ErrMissingActor) {
|
||||||
|
t.Fatalf("erwartet ErrMissingActor, habe %v", err)
|
||||||
|
}
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: "test_acme", Actor: "alice", Action: ""}); !errors.Is(err, ErrMissingAction) {
|
||||||
|
t.Fatalf("erwartet ErrMissingAction, habe %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestRecord_SystemTenantForCrossTenantEvents(t *testing.T) {
|
||||||
|
log, _, cleanup := setupAuditTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: SystemTenant, Actor: "superadmin", Action: "tenant.provisioned", Target: "tenant:acme"}); err != nil {
|
||||||
|
t.Fatalf("record mit SystemTenant: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,122 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/csv"
|
||||||
|
"encoding/json"
|
||||||
|
"fmt"
|
||||||
|
"io"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Filter grenzt einen Export ein (Akzeptanzkriterium 1). Leere/Nil-Felder
|
||||||
|
// bedeuten "kein Filter auf diesem Feld".
|
||||||
|
type Filter struct {
|
||||||
|
TenantSlug string
|
||||||
|
Actor string
|
||||||
|
Action string
|
||||||
|
From *time.Time
|
||||||
|
To *time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
func buildFilterQuery(f Filter) (string, []any) {
|
||||||
|
query := `SELECT occurred_at, tenant_slug, actor, action, target, metadata FROM audit_events WHERE 1=1`
|
||||||
|
var args []any
|
||||||
|
|
||||||
|
if f.TenantSlug != "" {
|
||||||
|
args = append(args, f.TenantSlug)
|
||||||
|
query += fmt.Sprintf(" AND tenant_slug = $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.Actor != "" {
|
||||||
|
args = append(args, f.Actor)
|
||||||
|
query += fmt.Sprintf(" AND actor = $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.Action != "" {
|
||||||
|
args = append(args, f.Action)
|
||||||
|
query += fmt.Sprintf(" AND action = $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.From != nil {
|
||||||
|
args = append(args, *f.From)
|
||||||
|
query += fmt.Sprintf(" AND occurred_at >= $%d", len(args))
|
||||||
|
}
|
||||||
|
if f.To != nil {
|
||||||
|
args = append(args, *f.To)
|
||||||
|
query += fmt.Sprintf(" AND occurred_at <= $%d", len(args))
|
||||||
|
}
|
||||||
|
query += " ORDER BY occurred_at"
|
||||||
|
return query, args
|
||||||
|
}
|
||||||
|
|
||||||
|
// StreamCSV schreibt gefilterte Audit-Eintraege direkt als CSV in w, Zeile
|
||||||
|
// fuer Zeile ueber rows.Next() — es wird zu keinem Zeitpunkt das gesamte
|
||||||
|
// Ergebnis im Speicher aufgebaut (Akzeptanzkriterium 3 / Pruefung 1).
|
||||||
|
func (l *Log) StreamCSV(ctx context.Context, filter Filter, w io.Writer) error {
|
||||||
|
query, args := buildFilterQuery(filter)
|
||||||
|
rows, err := l.pool.Query(ctx, query, args...)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("export abfragen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
cw := csv.NewWriter(w)
|
||||||
|
if err := cw.Write([]string{"occurred_at", "tenant_slug", "actor", "action", "target", "metadata"}); err != nil {
|
||||||
|
return fmt.Errorf("csv-header schreiben: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
for rows.Next() {
|
||||||
|
var occurredAt time.Time
|
||||||
|
var tenantSlug, actor, action, target string
|
||||||
|
var metadataJSON []byte
|
||||||
|
if err := rows.Scan(&occurredAt, &tenantSlug, &actor, &action, &target, &metadataJSON); err != nil {
|
||||||
|
return fmt.Errorf("zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
if err := cw.Write([]string{
|
||||||
|
occurredAt.Format(time.RFC3339), tenantSlug, actor, action, target, string(metadataJSON),
|
||||||
|
}); err != nil {
|
||||||
|
return fmt.Errorf("csv-zeile schreiben: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
cw.Flush()
|
||||||
|
if err := rows.Err(); err != nil {
|
||||||
|
return fmt.Errorf("export lesen: %w", err)
|
||||||
|
}
|
||||||
|
return cw.Error()
|
||||||
|
}
|
||||||
|
|
||||||
|
// exportRecord ist die JSON-Repraesentation einer exportierten Zeile.
|
||||||
|
type exportRecord struct {
|
||||||
|
OccurredAt time.Time `json:"occurred_at"`
|
||||||
|
TenantSlug string `json:"tenant_slug"`
|
||||||
|
Actor string `json:"actor"`
|
||||||
|
Action string `json:"action"`
|
||||||
|
Target string `json:"target"`
|
||||||
|
Metadata json.RawMessage `json:"metadata"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// StreamJSON schreibt gefilterte Audit-Eintraege als JSON Lines (ein
|
||||||
|
// JSON-Objekt pro Zeile) — bewusst kein einzelnes grosses JSON-Array, da
|
||||||
|
// dessen korrektes Streaming (Kommas/Klammern ohne Zwischenpufferung)
|
||||||
|
// unnoetige Komplexitaet fuer denselben Zweck waere. Wie StreamCSV
|
||||||
|
// zeilenweise ueber rows.Next(), kein Aufbau im Speicher.
|
||||||
|
func (l *Log) StreamJSON(ctx context.Context, filter Filter, w io.Writer) error {
|
||||||
|
query, args := buildFilterQuery(filter)
|
||||||
|
rows, err := l.pool.Query(ctx, query, args...)
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("export abfragen: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
enc := json.NewEncoder(w)
|
||||||
|
for rows.Next() {
|
||||||
|
var rec exportRecord
|
||||||
|
var metadataJSON []byte
|
||||||
|
if err := rows.Scan(&rec.OccurredAt, &rec.TenantSlug, &rec.Actor, &rec.Action, &rec.Target, &metadataJSON); err != nil {
|
||||||
|
return fmt.Errorf("zeile lesen: %w", err)
|
||||||
|
}
|
||||||
|
rec.Metadata = metadataJSON
|
||||||
|
if err := enc.Encode(rec); err != nil {
|
||||||
|
return fmt.Errorf("json-zeile schreiben: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return rows.Err()
|
||||||
|
}
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"net/http"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Authorize entscheidet, ob caller den Export ausfuehren darf. Die
|
||||||
|
// eigentliche Rollen-/Rechtepruefung (RBAC-02 Policy-Enforcement) ist nicht
|
||||||
|
// Teil dieser Kachel — ExportHandler kennt nur diese schmale Schnittstelle,
|
||||||
|
// analog zum RetentionRegistrar-Muster aus AUD-05.
|
||||||
|
type Authorize func(ctx context.Context, caller string) bool
|
||||||
|
|
||||||
|
// ExportHandler stellt den Export als HTTP-Endpunkt bereit
|
||||||
|
// (Akzeptanzkriterium 2: fuer berechtigte Rollen verfuegbar).
|
||||||
|
type ExportHandler struct {
|
||||||
|
log *Log
|
||||||
|
authorize Authorize
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewExportHandler(log *Log, authorize Authorize) *ExportHandler {
|
||||||
|
return &ExportHandler{log: log, authorize: authorize}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Export liest Filter-Query-Parameter (tenant, actor, action, from, to,
|
||||||
|
// format) und schreibt DIREKT auf den ResponseWriter (io.Writer) — dieselbe
|
||||||
|
// Streaming-Funktion wie in export.go, kein zusaetzlicher Pufferungsschritt.
|
||||||
|
func (h *ExportHandler) Export(w http.ResponseWriter, r *http.Request) {
|
||||||
|
// "caller" identifiziert die anfragende Person fuer die Berechtigungs-
|
||||||
|
// pruefung — bewusst getrennt vom Filterfeld "actor" (das den
|
||||||
|
// AUDIT-Akteur meint, ueber den gefiltert wird).
|
||||||
|
caller := r.URL.Query().Get("caller")
|
||||||
|
if caller == "" || !h.authorize(r.Context(), caller) {
|
||||||
|
http.Error(w, "keine berechtigung fuer audit-log-export", http.StatusForbidden)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
filter := Filter{
|
||||||
|
TenantSlug: r.URL.Query().Get("tenant"),
|
||||||
|
Actor: r.URL.Query().Get("actor"),
|
||||||
|
Action: r.URL.Query().Get("action"),
|
||||||
|
}
|
||||||
|
if from := r.URL.Query().Get("from"); from != "" {
|
||||||
|
t, err := time.Parse(time.RFC3339, from)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "ungueltiges from-datum, erwartet RFC3339", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
filter.From = &t
|
||||||
|
}
|
||||||
|
if to := r.URL.Query().Get("to"); to != "" {
|
||||||
|
t, err := time.Parse(time.RFC3339, to)
|
||||||
|
if err != nil {
|
||||||
|
http.Error(w, "ungueltiges to-datum, erwartet RFC3339", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
filter.To = &t
|
||||||
|
}
|
||||||
|
|
||||||
|
switch r.URL.Query().Get("format") {
|
||||||
|
case "json":
|
||||||
|
w.Header().Set("Content-Type", "application/x-ndjson")
|
||||||
|
if err := h.log.StreamJSON(r.Context(), filter, w); err != nil {
|
||||||
|
http.Error(w, "export fehlgeschlagen", http.StatusInternalServerError)
|
||||||
|
}
|
||||||
|
default:
|
||||||
|
w.Header().Set("Content-Type", "text/csv")
|
||||||
|
if err := h.log.StreamCSV(r.Context(), filter, w); err != nil {
|
||||||
|
http.Error(w, "export fehlgeschlagen", http.StatusInternalServerError)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,222 @@
|
|||||||
|
package audit
|
||||||
|
|
||||||
|
import (
|
||||||
|
"bytes"
|
||||||
|
"context"
|
||||||
|
"encoding/csv"
|
||||||
|
"fmt"
|
||||||
|
"net/http"
|
||||||
|
"net/http/httptest"
|
||||||
|
"os"
|
||||||
|
"runtime"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
"time"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
func setupExportTest(t *testing.T) (*Log, func()) {
|
||||||
|
t.Helper()
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
pool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pool: %v", err)
|
||||||
|
}
|
||||||
|
if _, err := pool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS audit_events (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
occurred_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
||||||
|
tenant_slug TEXT NOT NULL CHECK (tenant_slug <> ''),
|
||||||
|
actor TEXT NOT NULL CHECK (actor <> ''),
|
||||||
|
action TEXT NOT NULL CHECK (action <> ''),
|
||||||
|
target TEXT NOT NULL,
|
||||||
|
metadata JSONB NOT NULL DEFAULT '{}'::jsonb
|
||||||
|
)`); err != nil {
|
||||||
|
t.Fatalf("schema: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
cleanup := func() { pool.Close() }
|
||||||
|
return NewLog(pool), cleanup
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 2: Filterkombinationen liefern korrekte
|
||||||
|
// Teilmengen.
|
||||||
|
func TestExport_FilterCombinations(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
run := fmt.Sprintf("_%d", time.Now().UnixNano())
|
||||||
|
tenantA, tenantB := "test_fa"+run, "test_fb"+run
|
||||||
|
alice, bob := "alice"+run, "bob"+run
|
||||||
|
|
||||||
|
events := []Event{
|
||||||
|
{TenantSlug: tenantA, Actor: alice, Action: "login", Target: "x"},
|
||||||
|
{TenantSlug: tenantA, Actor: bob, Action: "login", Target: "x"},
|
||||||
|
{TenantSlug: tenantA, Actor: alice, Action: "logout", Target: "x"},
|
||||||
|
{TenantSlug: tenantB, Actor: alice, Action: "login", Target: "x"},
|
||||||
|
}
|
||||||
|
for _, e := range events {
|
||||||
|
if err := log.Record(ctx, e); err != nil {
|
||||||
|
t.Fatalf("record: %v", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
cases := []struct {
|
||||||
|
name string
|
||||||
|
filter Filter
|
||||||
|
wantLen int
|
||||||
|
}{
|
||||||
|
{"nach tenant", Filter{TenantSlug: tenantA}, 3},
|
||||||
|
{"nach tenant+actor", Filter{TenantSlug: tenantA, Actor: alice}, 2},
|
||||||
|
{"nach tenant+actor+action", Filter{TenantSlug: tenantA, Actor: alice, Action: "login"}, 1},
|
||||||
|
{"nach actor ueber beide tenants", Filter{Actor: alice, Action: "login"}, 2},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, c := range cases {
|
||||||
|
t.Run(c.name, func(t *testing.T) {
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := log.StreamCSV(ctx, c.filter, &buf); err != nil {
|
||||||
|
t.Fatalf("stream: %v", err)
|
||||||
|
}
|
||||||
|
rows, err := csv.NewReader(&buf).ReadAll()
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("csv parsen: %v", err)
|
||||||
|
}
|
||||||
|
got := len(rows) - 1 // Header abziehen
|
||||||
|
if got != c.wantLen {
|
||||||
|
t.Fatalf("erwartet %d zeilen, habe %d", c.wantLen, got)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 1 + Pruefung 2: Zeitraum-Filter.
|
||||||
|
func TestExport_TimeRangeFilter(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
tenant := fmt.Sprintf("test_tr_%d", time.Now().UnixNano())
|
||||||
|
past := time.Now().Add(-48 * time.Hour)
|
||||||
|
future := time.Now().Add(48 * time.Hour)
|
||||||
|
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: tenant, Actor: "a", Action: "x", Target: "t", OccurredAt: time.Now()}); err != nil {
|
||||||
|
t.Fatalf("record: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
var buf bytes.Buffer
|
||||||
|
if err := log.StreamCSV(ctx, Filter{TenantSlug: tenant, From: &past, To: &future}, &buf); err != nil {
|
||||||
|
t.Fatalf("stream (innerhalb range): %v", err)
|
||||||
|
}
|
||||||
|
if got := countLines(buf.String()) - 1; got != 1 {
|
||||||
|
t.Fatalf("erwartet 1 eintrag innerhalb des zeitraums, habe %d", got)
|
||||||
|
}
|
||||||
|
|
||||||
|
farPast := time.Now().Add(-96 * time.Hour)
|
||||||
|
buf.Reset()
|
||||||
|
if err := log.StreamCSV(ctx, Filter{TenantSlug: tenant, From: &farPast, To: &past}, &buf); err != nil {
|
||||||
|
t.Fatalf("stream (ausserhalb range): %v", err)
|
||||||
|
}
|
||||||
|
if got := countLines(buf.String()) - 1; got != 0 {
|
||||||
|
t.Fatalf("erwartet 0 eintraege ausserhalb des zeitraums, habe %d", got)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func countLines(s string) int {
|
||||||
|
s = strings.TrimRight(s, "\n")
|
||||||
|
if s == "" {
|
||||||
|
return 0
|
||||||
|
}
|
||||||
|
return len(strings.Split(s, "\n"))
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 3 + Pruefung 1: Export mit hoher Eintragszahl ohne
|
||||||
|
// uebermaessigen Speicherverbrauch — Stichprobe per runtime.MemStats.
|
||||||
|
func TestExport_StreamsLargeResultWithoutExcessiveMemory(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
tenant := fmt.Sprintf("test_large_%d", time.Now().UnixNano())
|
||||||
|
const n = 20000
|
||||||
|
for i := 0; i < n; i++ {
|
||||||
|
if err := log.Record(ctx, Event{TenantSlug: tenant, Actor: "bulk", Action: "test.bulk", Target: fmt.Sprintf("obj-%d", i)}); err != nil {
|
||||||
|
t.Fatalf("record %d: %v", i, err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
runtime.GC()
|
||||||
|
var before runtime.MemStats
|
||||||
|
runtime.ReadMemStats(&before)
|
||||||
|
|
||||||
|
lineCount := 0
|
||||||
|
cw := &countingWriter{onWrite: func(p []byte) { lineCount += strings.Count(string(p), "\n") }}
|
||||||
|
if err := log.StreamCSV(ctx, Filter{TenantSlug: tenant}, cw); err != nil {
|
||||||
|
t.Fatalf("stream: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
runtime.GC()
|
||||||
|
var after runtime.MemStats
|
||||||
|
runtime.ReadMemStats(&after)
|
||||||
|
|
||||||
|
if lineCount != n+1 { // +1 Header
|
||||||
|
t.Fatalf("erwartet %d zeilen (inkl. header), habe %d", n+1, lineCount)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Grobe Stichprobe: ein NICHT streamender Export haette hier locker
|
||||||
|
// mehrere MB an einmal gehaltenen Zeilen/Strings erzeugt. Grosszuegige
|
||||||
|
// Schwelle, da Go-Heap-Messungen naturgemaess rauschen.
|
||||||
|
const maxAcceptableGrowth = 3 * 1024 * 1024 // 3 MB
|
||||||
|
growth := int64(after.HeapAlloc) - int64(before.HeapAlloc)
|
||||||
|
t.Logf("heap-wachstum waehrend export von %d zeilen: %d bytes (schwelle: %d)", n, growth, maxAcceptableGrowth)
|
||||||
|
if growth > maxAcceptableGrowth {
|
||||||
|
t.Fatalf("heap ist um %d bytes gewachsen, erwartet unter %d (hinweis auf vollstaendige pufferung statt streaming)", growth, maxAcceptableGrowth)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type countingWriter struct {
|
||||||
|
onWrite func(p []byte)
|
||||||
|
}
|
||||||
|
|
||||||
|
func (w *countingWriter) Write(p []byte) (int, error) {
|
||||||
|
w.onWrite(p)
|
||||||
|
return len(p), nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 2 + Pruefung 3: Zugriff ohne passende Berechtigung wird abgewiesen.
|
||||||
|
func TestExportHandler_RejectsWithoutAuthorization(t *testing.T) {
|
||||||
|
log, cleanup := setupExportTest(t)
|
||||||
|
defer cleanup()
|
||||||
|
|
||||||
|
handler := NewExportHandler(log, func(ctx context.Context, caller string) bool {
|
||||||
|
return caller == "berechtigte-person@example.com"
|
||||||
|
})
|
||||||
|
|
||||||
|
req := httptest.NewRequest(http.MethodGet, "/audit/export?caller=unberechtigt@example.com", nil)
|
||||||
|
rec := httptest.NewRecorder()
|
||||||
|
handler.Export(rec, req)
|
||||||
|
if rec.Code != http.StatusForbidden {
|
||||||
|
t.Fatalf("unberechtigt: status = %d, want 403", rec.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
reqNoCaller := httptest.NewRequest(http.MethodGet, "/audit/export", nil)
|
||||||
|
recNoCaller := httptest.NewRecorder()
|
||||||
|
handler.Export(recNoCaller, reqNoCaller)
|
||||||
|
if recNoCaller.Code != http.StatusForbidden {
|
||||||
|
t.Fatalf("ohne caller: status = %d, want 403", recNoCaller.Code)
|
||||||
|
}
|
||||||
|
|
||||||
|
reqOK := httptest.NewRequest(http.MethodGet, "/audit/export?caller=berechtigte-person@example.com", nil)
|
||||||
|
recOK := httptest.NewRecorder()
|
||||||
|
handler.Export(recOK, reqOK)
|
||||||
|
if recOK.Code != http.StatusOK {
|
||||||
|
t.Fatalf("berechtigt: status = %d, want 200", recOK.Code)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,23 @@
|
|||||||
|
// Package auditadmin implementiert Core AUD-04: die Berechtigungspruefung
|
||||||
|
// fuer die Audit-Log-Ansicht. Enthaelt bewusst KEINE eigene Filter-/
|
||||||
|
// Export-Logik — die Ansicht ist "reiner Konsument der Export-API" (AUD-03,
|
||||||
|
// internal/audit.ExportHandler); dieses Paket liefert nur die
|
||||||
|
// audit.Authorize-Implementierung, die der Entwicklungs-/Testserver
|
||||||
|
// (cmd/auditlog-devserver) einhaengt.
|
||||||
|
package auditadmin
|
||||||
|
|
||||||
|
import "crypto/subtle"
|
||||||
|
|
||||||
|
// NewTokenAuthorizer liefert eine audit.Authorize-Funktion, die den
|
||||||
|
// aufrufenden "caller"-Wert timing-safe gegen ein geteiltes Admin-Token
|
||||||
|
// vergleicht — dasselbe Muster wie internal/audit.timingsafe (AUD-02),
|
||||||
|
// NICHT ueber eine neue Rollen-/Rechteschicht, da AUD-04 ausdruecklich nur
|
||||||
|
// von AUD-03 abhaengt.
|
||||||
|
func NewTokenAuthorizer(adminToken string) func(caller string) bool {
|
||||||
|
return func(caller string) bool {
|
||||||
|
if caller == "" || adminToken == "" {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
return subtle.ConstantTimeCompare([]byte(caller), []byte(adminToken)) == 1
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
package auditadmin
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
// Grundlage fuer Akzeptanzkriterium 1/2: die Oberflaeche darf Daten und den
|
||||||
|
// Export nur bei korrektem Admin-Token abrufen.
|
||||||
|
func TestNewTokenAuthorizer_AcceptsCorrectToken(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("geheimes-token")
|
||||||
|
if !authorize("geheimes-token") {
|
||||||
|
t.Fatal("erwartet true fuer korrektes token")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTokenAuthorizer_RejectsWrongToken(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("geheimes-token")
|
||||||
|
if authorize("falsches-token") {
|
||||||
|
t.Fatal("erwartet false fuer falsches token")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTokenAuthorizer_RejectsEmptyCaller(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("geheimes-token")
|
||||||
|
if authorize("") {
|
||||||
|
t.Fatal("erwartet false fuer leeren aufrufer")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestNewTokenAuthorizer_RejectsWhenNoTokenConfigured(t *testing.T) {
|
||||||
|
authorize := NewTokenAuthorizer("")
|
||||||
|
if authorize("irgendwas") {
|
||||||
|
t.Fatal("erwartet false, wenn kein admin-token konfiguriert ist (fail-safe-default)")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -10,8 +10,15 @@ import (
|
|||||||
// connection info, superadmin accounts) — see nexarch-state.json
|
// connection info, superadmin accounts) — see nexarch-state.json
|
||||||
// multi_tenancy: Modell C (physisch getrennte DB pro Mandant).
|
// multi_tenancy: Modell C (physisch getrennte DB pro Mandant).
|
||||||
type Config struct {
|
type Config struct {
|
||||||
ListenAddr string
|
ListenAddr string
|
||||||
|
// RegistryDSN verbindet zur Control-Plane-Registry-Datenbank.
|
||||||
RegistryDSN string
|
RegistryDSN string
|
||||||
|
// AdminDSN verbindet zur Wartungsdatenbank (z.B. "postgres") und wird nur
|
||||||
|
// fuer CREATE/DROP DATABASE beim Tenant-Provisioning verwendet.
|
||||||
|
AdminDSN string
|
||||||
|
// TenantDSNTemplate enthaelt genau ein "%s" als Platzhalter fuer den
|
||||||
|
// Datenbanknamen einer neu provisionierten Tenant-Datenbank.
|
||||||
|
TenantDSNTemplate string
|
||||||
}
|
}
|
||||||
|
|
||||||
func Load() (Config, error) {
|
func Load() (Config, error) {
|
||||||
@@ -20,10 +27,25 @@ func Load() (Config, error) {
|
|||||||
return Config{}, fmt.Errorf("NEXARCH_REGISTRY_DSN not set")
|
return Config{}, fmt.Errorf("NEXARCH_REGISTRY_DSN not set")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
adminDSN := os.Getenv("NEXARCH_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
return Config{}, fmt.Errorf("NEXARCH_ADMIN_DSN not set")
|
||||||
|
}
|
||||||
|
|
||||||
|
dsnTemplate := os.Getenv("NEXARCH_TENANT_DSN_TEMPLATE")
|
||||||
|
if dsnTemplate == "" {
|
||||||
|
return Config{}, fmt.Errorf("NEXARCH_TENANT_DSN_TEMPLATE not set")
|
||||||
|
}
|
||||||
|
|
||||||
addr := os.Getenv("NEXARCH_LISTEN_ADDR")
|
addr := os.Getenv("NEXARCH_LISTEN_ADDR")
|
||||||
if addr == "" {
|
if addr == "" {
|
||||||
addr = ":8080"
|
addr = ":8080"
|
||||||
}
|
}
|
||||||
|
|
||||||
return Config{ListenAddr: addr, RegistryDSN: dsn}, nil
|
return Config{
|
||||||
|
ListenAddr: addr,
|
||||||
|
RegistryDSN: dsn,
|
||||||
|
AdminDSN: adminDSN,
|
||||||
|
TenantDSNTemplate: dsnTemplate,
|
||||||
|
}, nil
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,45 @@
|
|||||||
|
package tenant
|
||||||
|
|
||||||
|
import (
|
||||||
|
"encoding/json"
|
||||||
|
"net/http"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Handler ist eine schlanke Vorbereitung der Schnittstelle fuer API-01
|
||||||
|
// (REST-API-Grundgerüst & Versionierung) und TEN-02 (Self-Service-Onboarding).
|
||||||
|
// Auth/Rate-Limiting/Versionierung selbst sind ausdruecklich nicht Teil von
|
||||||
|
// TEN-01 und werden dort nachgezogen.
|
||||||
|
type Handler struct {
|
||||||
|
provisioner *Provisioner
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewHandler(p *Provisioner) *Handler {
|
||||||
|
return &Handler{provisioner: p}
|
||||||
|
}
|
||||||
|
|
||||||
|
type createTenantRequest struct {
|
||||||
|
Slug string `json:"slug"`
|
||||||
|
Name string `json:"name"`
|
||||||
|
}
|
||||||
|
|
||||||
|
func (h *Handler) CreateTenant(w http.ResponseWriter, r *http.Request) {
|
||||||
|
var req createTenantRequest
|
||||||
|
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
|
||||||
|
http.Error(w, "ungueltige Anfrage", http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
t, err := h.provisioner.Provision(r.Context(), req.Slug, req.Name)
|
||||||
|
if err != nil {
|
||||||
|
if err == ErrInvalidSlug {
|
||||||
|
http.Error(w, err.Error(), http.StatusBadRequest)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
http.Error(w, "tenant konnte nicht angelegt werden", http.StatusInternalServerError)
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
w.Header().Set("Content-Type", "application/json")
|
||||||
|
w.WriteHeader(http.StatusCreated)
|
||||||
|
_ = json.NewEncoder(w).Encode(t)
|
||||||
|
}
|
||||||
@@ -0,0 +1,78 @@
|
|||||||
|
package tenant
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Provisioner legt fuer jeden neuen Mandanten eine vollstaendig isolierte
|
||||||
|
// PostgreSQL-Datenbank an und registriert sie transaktional in der Registry
|
||||||
|
// (Akzeptanzkriterium 2). Zwei Mandanten-Datenbanken sind danach auf
|
||||||
|
// Infrastrukturebene komplett getrennt (Akzeptanzkriterium 3).
|
||||||
|
type Provisioner struct {
|
||||||
|
// adminPool ist mit der Wartungsdatenbank (z. B. "postgres") verbunden
|
||||||
|
// und wird ausschliesslich fuer CREATE/DROP DATABASE verwendet, da diese
|
||||||
|
// Befehle in PostgreSQL nicht in einer Transaktion laufen koennen.
|
||||||
|
adminPool *pgxpool.Pool
|
||||||
|
registry *Registry
|
||||||
|
// dsnTemplate enthaelt genau ein "%s" als Platzhalter fuer den
|
||||||
|
// Datenbanknamen, z. B. "postgresql://user:pass@host:5432/%s?sslmode=disable".
|
||||||
|
dsnTemplate string
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewProvisioner(adminPool *pgxpool.Pool, registry *Registry, dsnTemplate string) *Provisioner {
|
||||||
|
return &Provisioner{adminPool: adminPool, registry: registry, dsnTemplate: dsnTemplate}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Provision legt die Tenant-Datenbank an und registriert sie. Schlaegt die
|
||||||
|
// Registrierung fehl, wird die bereits angelegte Datenbank wieder entfernt,
|
||||||
|
// damit kein verwaister, unregistrierter Tenant zurueckbleibt.
|
||||||
|
func (p *Provisioner) Provision(ctx context.Context, slug, name string) (Tenant, error) {
|
||||||
|
if err := ValidateSlug(slug); err != nil {
|
||||||
|
return Tenant{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
dbName := dbNameForSlug(slug)
|
||||||
|
|
||||||
|
// CREATE DATABASE erlaubt keine Parameter-Platzhalter; slug ist durch
|
||||||
|
// ValidateSlug bereits auf [a-z0-9_] beschraenkt, Injektion ausgeschlossen.
|
||||||
|
if _, err := p.adminPool.Exec(ctx, fmt.Sprintf(`CREATE DATABASE %q`, dbName)); err != nil {
|
||||||
|
return Tenant{}, fmt.Errorf("tenant-datenbank anlegen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
t := Tenant{
|
||||||
|
Slug: slug,
|
||||||
|
Name: name,
|
||||||
|
DBName: dbName,
|
||||||
|
DBDSN: fmt.Sprintf(p.dsnTemplate, dbName),
|
||||||
|
Status: StatusActive,
|
||||||
|
}
|
||||||
|
|
||||||
|
tx, err := p.registry.pool.Begin(ctx)
|
||||||
|
if err != nil {
|
||||||
|
p.rollbackDatabase(ctx, dbName)
|
||||||
|
return Tenant{}, fmt.Errorf("registry-transaktion starten: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
created, err := p.registry.insertTx(ctx, tx, t)
|
||||||
|
if err != nil {
|
||||||
|
_ = tx.Rollback(ctx)
|
||||||
|
p.rollbackDatabase(ctx, dbName)
|
||||||
|
return Tenant{}, err
|
||||||
|
}
|
||||||
|
|
||||||
|
if err := tx.Commit(ctx); err != nil {
|
||||||
|
p.rollbackDatabase(ctx, dbName)
|
||||||
|
return Tenant{}, fmt.Errorf("registry-transaktion committen: %w", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return created, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
// rollbackDatabase entfernt eine bereits angelegte Tenant-Datenbank, wenn die
|
||||||
|
// Registrierung fehlschlug, damit Provisioning insgesamt atomar wirkt.
|
||||||
|
func (p *Provisioner) rollbackDatabase(ctx context.Context, dbName string) {
|
||||||
|
_, _ = p.adminPool.Exec(ctx, fmt.Sprintf(`DROP DATABASE IF EXISTS %q`, dbName))
|
||||||
|
}
|
||||||
@@ -0,0 +1,105 @@
|
|||||||
|
package tenant
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"os"
|
||||||
|
"strings"
|
||||||
|
"testing"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Integrationstest fuer Akzeptanzkriterien 2 und 3. Benoetigt eine echte
|
||||||
|
// Postgres-Instanz und wird ohne TEST_ADMIN_DSN uebersprungen, nicht als
|
||||||
|
// fehlgeschlagen gewertet — siehe Pruefungen-Ergebnis im PR.
|
||||||
|
//
|
||||||
|
// TEST_ADMIN_DSN muss auf die Wartungsdatenbank zeigen, z. B.:
|
||||||
|
//
|
||||||
|
// postgresql://postgres:postgres@localhost:5432/postgres?sslmode=disable
|
||||||
|
func TestProvision_CreatesIsolatedDatabases(t *testing.T) {
|
||||||
|
adminDSN := os.Getenv("TEST_ADMIN_DSN")
|
||||||
|
if adminDSN == "" {
|
||||||
|
t.Skip("TEST_ADMIN_DSN nicht gesetzt, Integrationstest uebersprungen")
|
||||||
|
}
|
||||||
|
ctx := context.Background()
|
||||||
|
|
||||||
|
adminPool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("admin pool: %v", err)
|
||||||
|
}
|
||||||
|
defer adminPool.Close()
|
||||||
|
|
||||||
|
registryPool, err := pgxpool.New(ctx, adminDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("registry pool: %v", err)
|
||||||
|
}
|
||||||
|
defer registryPool.Close()
|
||||||
|
|
||||||
|
if _, err := registryPool.Exec(ctx, `
|
||||||
|
CREATE TABLE IF NOT EXISTS tenants (
|
||||||
|
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
|
||||||
|
slug TEXT NOT NULL UNIQUE,
|
||||||
|
name TEXT NOT NULL,
|
||||||
|
db_name TEXT NOT NULL UNIQUE,
|
||||||
|
db_dsn TEXT NOT NULL,
|
||||||
|
status TEXT NOT NULL DEFAULT 'active',
|
||||||
|
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
||||||
|
)`); err != nil {
|
||||||
|
t.Fatalf("registry-schema: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
dsnTemplate := strings.Replace(adminDSN, "/postgres?", "/%s?", 1)
|
||||||
|
registry := NewRegistry(registryPool)
|
||||||
|
provisioner := NewProvisioner(adminPool, registry, dsnTemplate)
|
||||||
|
|
||||||
|
t.Cleanup(func() {
|
||||||
|
_, _ = registryPool.Exec(ctx, `DELETE FROM tenants WHERE slug IN ('acme','globex')`)
|
||||||
|
_, _ = adminPool.Exec(ctx, `DROP DATABASE IF EXISTS tenant_acme`)
|
||||||
|
_, _ = adminPool.Exec(ctx, `DROP DATABASE IF EXISTS tenant_globex`)
|
||||||
|
})
|
||||||
|
|
||||||
|
tenantA, err := provisioner.Provision(ctx, "acme", "Acme GmbH")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision acme: %v", err)
|
||||||
|
}
|
||||||
|
tenantB, err := provisioner.Provision(ctx, "globex", "Globex AG")
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("provision globex: %v", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
if tenantA.DBName == tenantB.DBName {
|
||||||
|
t.Fatalf("erwartet unterschiedliche db_name, beide sind %q", tenantA.DBName)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Akzeptanzkriterium 3 / Pruefung 3: In der Datenbank von Tenant A existiert
|
||||||
|
// keine Verbindungsmoeglichkeit zu Tenant B, weil beide physisch getrennte
|
||||||
|
// Datenbanken sind, statt sich auf einen Query-Filter zu verlassen.
|
||||||
|
poolA, err := pgxpool.New(ctx, tenantA.DBDSN)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("connect tenant a: %v", err)
|
||||||
|
}
|
||||||
|
defer poolA.Close()
|
||||||
|
|
||||||
|
var globexVisible bool
|
||||||
|
err = poolA.QueryRow(ctx, `
|
||||||
|
SELECT EXISTS (
|
||||||
|
SELECT 1 FROM pg_catalog.pg_database WHERE datname = $1
|
||||||
|
)
|
||||||
|
`, tenantB.DBName).Scan(&globexVisible)
|
||||||
|
if err != nil {
|
||||||
|
t.Fatalf("pruefung tenant-trennung: %v", err)
|
||||||
|
}
|
||||||
|
// pg_database ist clusterweit sichtbar (Existenz der DB), aber die
|
||||||
|
// eigentliche Pruefung ist: aus poolA (verbunden mit tenant_acme) ist keine
|
||||||
|
// Tabelle/Zeile aus tenant_globex erreichbar, da current_database() getrennt ist.
|
||||||
|
var currentDB string
|
||||||
|
if err := poolA.QueryRow(ctx, `SELECT current_database()`).Scan(¤tDB); err != nil {
|
||||||
|
t.Fatalf("current_database: %v", err)
|
||||||
|
}
|
||||||
|
if currentDB != tenantA.DBName {
|
||||||
|
t.Fatalf("current_database() = %q, want %q — keine physische Trennung", currentDB, tenantA.DBName)
|
||||||
|
}
|
||||||
|
if currentDB == tenantB.DBName {
|
||||||
|
t.Fatalf("tenant a verbindung zeigt auf tenant b datenbank")
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,69 @@
|
|||||||
|
package tenant
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"fmt"
|
||||||
|
|
||||||
|
"github.com/jackc/pgx/v5"
|
||||||
|
"github.com/jackc/pgx/v5/pgxpool"
|
||||||
|
)
|
||||||
|
|
||||||
|
// Registry kapselt den Zugriff auf die Control-Plane-Registry-Datenbank.
|
||||||
|
// Sie enthaelt ausschliesslich Tenant-Metadaten (Akzeptanzkriterium 1) —
|
||||||
|
// niemals Geschaeftsdaten eines Mandanten.
|
||||||
|
type Registry struct {
|
||||||
|
pool *pgxpool.Pool
|
||||||
|
}
|
||||||
|
|
||||||
|
func NewRegistry(pool *pgxpool.Pool) *Registry {
|
||||||
|
return &Registry{pool: pool}
|
||||||
|
}
|
||||||
|
|
||||||
|
// insertTx schreibt den Tenant-Datensatz innerhalb einer laufenden Transaktion,
|
||||||
|
// damit Provisioner.Provision DB-Anlage und Registrierung atomar behandeln kann.
|
||||||
|
func (r *Registry) insertTx(ctx context.Context, tx pgx.Tx, t Tenant) (Tenant, error) {
|
||||||
|
row := tx.QueryRow(ctx, `
|
||||||
|
INSERT INTO tenants (slug, name, db_name, db_dsn, status)
|
||||||
|
VALUES ($1, $2, $3, $4, $5)
|
||||||
|
RETURNING id, created_at
|
||||||
|
`, t.Slug, t.Name, t.DBName, t.DBDSN, t.Status)
|
||||||
|
|
||||||
|
if err := row.Scan(&t.ID, &t.CreatedAt); err != nil {
|
||||||
|
return Tenant{}, fmt.Errorf("tenant registrieren: %w", err)
|
||||||
|
}
|
||||||
|
return t, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Registry) GetBySlug(ctx context.Context, slug string) (Tenant, error) {
|
||||||
|
var t Tenant
|
||||||
|
row := r.pool.QueryRow(ctx, `
|
||||||
|
SELECT id, slug, name, db_name, db_dsn, status, created_at
|
||||||
|
FROM tenants WHERE slug = $1
|
||||||
|
`, slug)
|
||||||
|
|
||||||
|
if err := row.Scan(&t.ID, &t.Slug, &t.Name, &t.DBName, &t.DBDSN, &t.Status, &t.CreatedAt); err != nil {
|
||||||
|
return Tenant{}, fmt.Errorf("tenant laden: %w", err)
|
||||||
|
}
|
||||||
|
return t, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func (r *Registry) List(ctx context.Context) ([]Tenant, error) {
|
||||||
|
rows, err := r.pool.Query(ctx, `
|
||||||
|
SELECT id, slug, name, db_name, db_dsn, status, created_at
|
||||||
|
FROM tenants ORDER BY created_at
|
||||||
|
`)
|
||||||
|
if err != nil {
|
||||||
|
return nil, fmt.Errorf("tenants auflisten: %w", err)
|
||||||
|
}
|
||||||
|
defer rows.Close()
|
||||||
|
|
||||||
|
var out []Tenant
|
||||||
|
for rows.Next() {
|
||||||
|
var t Tenant
|
||||||
|
if err := rows.Scan(&t.ID, &t.Slug, &t.Name, &t.DBName, &t.DBDSN, &t.Status, &t.CreatedAt); err != nil {
|
||||||
|
return nil, fmt.Errorf("tenant lesen: %w", err)
|
||||||
|
}
|
||||||
|
out = append(out, t)
|
||||||
|
}
|
||||||
|
return out, rows.Err()
|
||||||
|
}
|
||||||
@@ -0,0 +1,42 @@
|
|||||||
|
// Package tenant implements Core TEN-01: die Control-Plane-Registry und die
|
||||||
|
// Provisioning-Routine fuer physisch getrennte Mandanten-Datenbanken (Modell C).
|
||||||
|
package tenant
|
||||||
|
|
||||||
|
import (
|
||||||
|
"errors"
|
||||||
|
"regexp"
|
||||||
|
"time"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Status string
|
||||||
|
|
||||||
|
const (
|
||||||
|
StatusActive Status = "active"
|
||||||
|
)
|
||||||
|
|
||||||
|
type Tenant struct {
|
||||||
|
ID string
|
||||||
|
Slug string
|
||||||
|
Name string
|
||||||
|
DBName string
|
||||||
|
DBDSN string
|
||||||
|
Status Status
|
||||||
|
CreatedAt time.Time
|
||||||
|
}
|
||||||
|
|
||||||
|
// slugPattern erzwingt sichere, als SQL-Identifier verwendbare Slugs, damit
|
||||||
|
// der Datenbankname niemals aus unkontrolliertem Nutzereingabe-Text gebaut wird.
|
||||||
|
var slugPattern = regexp.MustCompile(`^[a-z][a-z0-9_]{1,48}$`)
|
||||||
|
|
||||||
|
var ErrInvalidSlug = errors.New("tenant: slug muss mit Kleinbuchstaben beginnen und darf nur [a-z0-9_] enthalten (2-49 Zeichen)")
|
||||||
|
|
||||||
|
func ValidateSlug(slug string) error {
|
||||||
|
if !slugPattern.MatchString(slug) {
|
||||||
|
return ErrInvalidSlug
|
||||||
|
}
|
||||||
|
return nil
|
||||||
|
}
|
||||||
|
|
||||||
|
func dbNameForSlug(slug string) string {
|
||||||
|
return "tenant_" + slug
|
||||||
|
}
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
package tenant
|
||||||
|
|
||||||
|
import "testing"
|
||||||
|
|
||||||
|
func TestValidateSlug(t *testing.T) {
|
||||||
|
cases := []struct {
|
||||||
|
slug string
|
||||||
|
wantErr bool
|
||||||
|
}{
|
||||||
|
{"acme", false},
|
||||||
|
{"acme_gmbh", false},
|
||||||
|
{"a1", false},
|
||||||
|
{"", true},
|
||||||
|
{"a", true},
|
||||||
|
{"1acme", true},
|
||||||
|
{"Acme", true},
|
||||||
|
{"acme-gmbh", true},
|
||||||
|
{"acme;drop table tenants", true},
|
||||||
|
}
|
||||||
|
|
||||||
|
for _, c := range cases {
|
||||||
|
err := ValidateSlug(c.slug)
|
||||||
|
if (err != nil) != c.wantErr {
|
||||||
|
t.Errorf("ValidateSlug(%q) error = %v, wantErr %v", c.slug, err, c.wantErr)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
func TestDBNameForSlug(t *testing.T) {
|
||||||
|
got := dbNameForSlug("acme")
|
||||||
|
want := "tenant_acme"
|
||||||
|
if got != want {
|
||||||
|
t.Errorf("dbNameForSlug() = %q, want %q", got, want)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -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,87 +0,0 @@
|
|||||||
# ARC-08 – Prüfprotokoll: Verschlüsselungsschlüssel-Rotation
|
|
||||||
|
|
||||||
Voraussetzung ARC-02 (Fertig).
|
|
||||||
|
|
||||||
## Architektur-Ausgangslage (real geprüft)
|
|
||||||
|
|
||||||
Core (API-10, `internal/kek.Store.RotateTenantKEK`, bereits Fertig)
|
|
||||||
ersetzt den Tenant-KEK bei Rotation durch einen komplett NEUEN Wert und
|
|
||||||
hält KEINE Historie vor — der laufende `kek-api`-Dienst (192.168.1.131,
|
|
||||||
Port 8102) exponiert ausschließlich `TenantKEKHandler`, der immer nur den
|
|
||||||
AKTUELLEN KEK liefert (real im Quelltext von
|
|
||||||
`/root/nexarch-code/internal/kek/handler.go` und `cmd/kek-api/main.go`
|
|
||||||
auf 131 verifiziert). Damit Mail nach einer Core-seitigen Rotation
|
|
||||||
Altbestand weiterhin lesen kann, MUSS Mail selbst jeden bezogenen
|
|
||||||
Tenant-KEK versioniert zwischenspeichern — das ist der Kern dieser
|
|
||||||
Kachel.
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/crypto/kekversions.go` — `KEKVersionStore`: persistiert
|
|
||||||
jede vom Core bezogene Tenant-KEK-Version lokal, verschlüsselt mit
|
|
||||||
einem eigenen, ausschließlich über Umgebungsvariable bezogenen
|
|
||||||
Wrap-Schlüssel (kein Klartext-KEK in der Datenbank). `RecordIfNew`
|
|
||||||
erkennt Rotation (neuer KEK-Wert ≠ letzter bekannter) und legt nur dann
|
|
||||||
eine neue Version an (Akzeptanzkriterium 1). `Revoke` sperrt gezielt
|
|
||||||
eine einzelne Version (Pflichtprüfung 2).
|
|
||||||
- `mail/internal/crypto/service.go` — `Service.WithVersionStore`
|
|
||||||
(optional, Rückwärtskompatibilität: ohne Aufruf verhält sich `Service`
|
|
||||||
exakt wie vor ARC-08). `Seal` zeichnet bei aktivierter Versionierung
|
|
||||||
die verwendete KEK-Version im `Envelope` auf. Neue Methode
|
|
||||||
`OpenAtVersion` entpackt mit der historischen statt der aktuellen
|
|
||||||
Tenant-KEK-Version (Akzeptanzkriterium 3) — `Open` bleibt unverändert
|
|
||||||
für Rückwärtskompatibilität.
|
|
||||||
- `mail/internal/encstorage/encstorage.go` — neuer Sidecar
|
|
||||||
`<key>.dek.version` (gleiches Muster wie der bestehende `.dek`-Sidecar
|
|
||||||
aus ARC-02) speichert die KEK-Version je Objekt. `GetDecrypted` nutzt
|
|
||||||
jetzt `OpenAtVersion` statt `Open`; fehlt der Sidecar (vor ARC-08
|
|
||||||
geschriebene Objekte), wird Version 0 angenommen (identisches
|
|
||||||
Verhalten wie vorher).
|
|
||||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/dedup`/
|
|
||||||
`mail/internal/indexworker`/`mail/internal/search` unverändert;
|
|
||||||
bestehende ARC-02-Tests (`encstorage_test.go`) unverändert lauffähig
|
|
||||||
ohne Codeänderung an ihnen.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Rotation des Hauptschlüssels lässt Altbestand weiterhin lesbar | **bestanden** – `TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation`: Objekt vor Rotation versiegelt (Version 1), Tenant-Hauptschlüssel real rotiert (Provider liefert ab dann einen anderen Wert, exakt wie `RotateTenantKEK` es bei Core bewirkt), neues Objekt nach Rotation versiegelt (Version 2), Altbestand über `OpenAtVersion` real weiterhin korrekt entschlüsselt — zusätzlich real bestätigt, dass der naive `Open()` mit dem neuen aktuellen KEK für das alte Objekt fehlschlägt (beweist, dass `OpenAtVersion` tatsächlich etwas leistet) |
|
|
||||||
| 2 | Test: kompromittierter alter Schlüssel kann gezielt gesperrt werden | **bestanden** – `TestRotation_CompromisedOldKeyCanBeRevoked`: Version gesperrt, `OpenAtVersion` liefert danach real `ErrKEKVersionRevoked`; `TestKEKVersionStore_RevokeBlocksOnlyThatVersion` bestätigt zusätzlich, dass eine ANDERE Version davon unberührt bleibt |
|
|
||||||
| 3 | Dokumentierter Rotationsvorgang wurde einmal vollständig durchgespielt | **bestanden** – siehe Abschnitt "Rotationsvorgang" unten, real durchlaufen als `TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation` |
|
|
||||||
|
|
||||||
### Rotationsvorgang (Pflichtprüfung 3, vollständig durchgespielt)
|
|
||||||
|
|
||||||
1. Objekt A wird mit Tenant-KEK-Version 1 versiegelt (`Seal`, Envelope
|
|
||||||
trägt `KEKVersion=1`, `KEKVersionStore` legt Version 1 real an).
|
|
||||||
2. Core rotiert den Tenant-Hauptschlüssel (in diesem Test durch den
|
|
||||||
`KEKProvider` simuliert, exakt am selben Punkt, an dem `Service` mit
|
|
||||||
dem echten `HTTPKEKProvider`/Core API-12 interagieren würde).
|
|
||||||
3. Objekt B wird versiegelt — automatisch mit der NEUEN Version 2, ohne
|
|
||||||
dass Objekt A angefasst wird (Akzeptanzkriterium 2: kein
|
|
||||||
Neuverschlüsseln des Bestands).
|
|
||||||
4. Objekt A wird über `OpenAtVersion(..., kekVersion=1, ...)` gelesen —
|
|
||||||
real erfolgreich, Klartext identisch zum Original.
|
|
||||||
5. Ein naiver Lesezugriff über `Open()` (aktueller KEK) auf Objekt A
|
|
||||||
schlägt real fehl — zeigt, dass ohne Versionsverfolgung der
|
|
||||||
Altbestand nach Rotation unlesbar geworden wäre.
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/crypto (4 Tests, neu)
|
|
||||||
und internal/encstorage (4 Tests, unverändert weiterhin grün — Rückwärtskompatibilität
|
|
||||||
real bestätigt)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Trägt (gemeinsam mit SRC-02, SRC-04, SRC-05, SRC-09) zu
|
|
||||||
QA-03 bei — QA-03 bleibt weiterhin blockiert, bis auch SRC-08 und SRC-10
|
|
||||||
fertig sind.
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
# IMP-01 – Prüfprotokoll: IMAP-Postfach-Abruf & Scheduler
|
|
||||||
|
|
||||||
Voraussetzung ING-01, ING-05 (beide Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/imap` (ING-01) minimal erweitert: `Message.UID`,
|
|
||||||
`MailboxStore.FetchByUID` (RFC 3501 §6.4.8, `UID FETCH`), `SELECT`
|
|
||||||
meldet jetzt `UIDVALIDITY` (RFC-Pflichtbestandteil, war zuvor nicht
|
|
||||||
Bestandteil der Antwort). Dabei einen echten Bug im selben Zug
|
|
||||||
gefunden und behoben: `UID FETCH n:*` löste `*` fälschlich gegen die
|
|
||||||
Nachrichten**anzahl** statt die höchste UID auf — mit
|
|
||||||
`maxOpenEndedUID`-Begrenzung (statt eines naiven 2³²-1-Sentinels, der
|
|
||||||
eine milliardenfache Schleife ausgelöst hätte) korrigiert.
|
|
||||||
- `mail/internal/imapimport/state.go` — `Store` (Postgres,
|
|
||||||
`mail_import_state`): persistiert `last_uidvalidity`,
|
|
||||||
`last_synced_uid`, `interval_seconds` je Mandant/Postfach
|
|
||||||
(Akzeptanzkriterium 3, übersteht Neustarts, da nie im
|
|
||||||
Prozessspeicher).
|
|
||||||
- `mail/internal/imapimport/scheduler.go` — `Scheduler.RunOnce`:
|
|
||||||
UID-Vergleich klassifiziert Nachrichten als neu vs. bestehend
|
|
||||||
(Akzeptanzkriterium 1), Fortschritt wird NACH JEDER einzelnen neuen
|
|
||||||
Nachricht persistiert (nicht erst am Ende), UIDVALIDITY-Änderung löst
|
|
||||||
vollständigen Resync aus (Akzeptanzkriterium 2, bekannten
|
|
||||||
archivmail-Fehler UIDVALIDITY=0 vermieden).
|
|
||||||
- `mail/internal/imapimport/client_real.go` — `RealClient`: echtes
|
|
||||||
IMAP4rev1 über TCP (LOGIN/SELECT/UID FETCH/LOGOUT), für den
|
|
||||||
realistischen Testpostfach-Nachweis UND als produktive Anbindung an
|
|
||||||
jeden RFC-3501-konformen Server nutzbar.
|
|
||||||
- Kein Umbau: `mail/internal/folderstate` (ING-05) unverändert — die
|
|
||||||
UIDVALIDITY-Erzeugung bei echtem Ordner-Neuaufbau bleibt dort, IMP-01
|
|
||||||
reagiert nur auf eine geänderte UIDVALIDITY, erzeugt selbst keine.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: zwei aufeinanderfolgende Läufe importieren keine Nachricht doppelt | **bestanden** – `TestRunOnce_TwoConsecutiveRunsNoDuplicateImport`: 3 Nachrichten im ersten Lauf real importiert, zweiter Lauf gegen unverändertes Postfach liefert real 0 neue, 3 bestehende |
|
|
||||||
| 2 | Test: simulierter Dienst-Neustart mitten im Abgleich führt zu konsistentem Endzustand | **bestanden** – `TestRunOnce_SimulatedRestartMidSyncConsistentEndState`: Handler schlägt real nach 2 von 5 Nachrichten fehl, neuer Scheduler auf demselben persistenten Store verarbeitet real GENAU die verbleibenden 3, keine der ersten 2 erneut, `last_synced_uid` real konsistent bei 5 |
|
|
||||||
| 3 | Test gegen Testpostfach mit realistischem Nachrichtenaufkommen | **bestanden** – `TestRunOnce_AgainstRealTestMailboxWithRealisticVolume`: echter End-zu-Ende-IMAP4rev1-Lauf (`RealClient` gegen echten laufenden ING-01-Server) mit 30 Nachrichten — alle 30 real importiert, zweiter Lauf real 0 neue/30 bestehende |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 3, Intervallkonfiguration):
|
|
||||||
`TestSetInterval_ConfigurableAndSurvivesRestart` — konfiguriertes
|
|
||||||
Intervall bleibt nach simuliertem Neustart (neue Store-Instanz auf
|
|
||||||
demselben Postgres-Zustand) real erhalten.
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
TEST_TENANT_DSN=... go test ./internal/imapimport/... -v -timeout 60s -> 4/4 bestanden
|
|
||||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
|
||||||
-> alle 15 Pakete bestanden, keine Regression (inkl. ING-01: 6/6 weiterhin grün
|
|
||||||
nach UID-FETCH-Erweiterung)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt IMP-02, IMP-03, IMP-04, IMP-05, IMP-07, IMP-08,
|
|
||||||
IMP-09, INT-05, UX-01.
|
|
||||||
@@ -1,78 +0,0 @@
|
|||||||
# ING-01 – Prüfprotokoll: IMAP-Server-Grundgerüst
|
|
||||||
|
|
||||||
Keine Vorbedingungen im Mail-Board (sofort startbar).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/imap/state.go` — `State` (`NotAuthenticated`,
|
|
||||||
`Authenticated`, `Selected`, RFC 3501 §3).
|
|
||||||
- `mail/internal/imap/parser.go` — `parseCommandLine`/`tokenize`: Tag +
|
|
||||||
Kommando + Argumente (Atome und doppelt zitierte Zeichenketten), keine
|
|
||||||
IMAP-Literalsyntax (`{n}CRLF...` — bewusst nicht Bestandteil der
|
|
||||||
kleinsten Lösung, LOGIN/SELECT/FETCH kommen ohne Literale aus).
|
|
||||||
- `mail/internal/imap/response.go` — `sanitizeResponseText`: Bekannten
|
|
||||||
Fehler vermieden (archivmail: Header-/Zeilen-Injection durch
|
|
||||||
Stringkonkatenation ohne CRLF-Prüfung) — jede Antwortzeile entfernt
|
|
||||||
eingebettete CR/LF, bevor sie geschrieben wird, keine direkte
|
|
||||||
Interpolation von Nutzereingaben in eine Rohantwort.
|
|
||||||
- `mail/internal/imap/session.go`/`commands.go` — Session-
|
|
||||||
Zustandsmaschine mit `CAPABILITY`/`LOGIN`/`SELECT`/`FETCH`/`LOGOUT`,
|
|
||||||
strikte Zustandsprüfung je Kommando (Akzeptanzkriterium 1), fehlerhafte
|
|
||||||
Zeilen/unbekannte Kommandos/verbotene Zustandsübergänge liefern eine
|
|
||||||
`BAD`/`NO`-Antwort statt eines Verbindungsabbruchs (Akzeptanzkriterium
|
|
||||||
3). `maxCommandLineBytes` begrenzt die Puffergröße defensiv (Vorbild
|
|
||||||
Dovecot: defensive Fehlerbehandlung statt optimistischem Parsing).
|
|
||||||
- `mail/internal/imap/server.go` — `Server.Serve`: TCP-Accept-Schleife,
|
|
||||||
eine Goroutine je Verbindung.
|
|
||||||
- `Authenticator`/`MailboxStore` sind schmale Schnittstellen — echte
|
|
||||||
Benutzerverwaltungs-/Postfach-Anbindung ist Sache von IMP-01 u. a.
|
|
||||||
(„Nicht Bestandteil dieser Kachel"), dieses Paket kennt weder Core-IAM
|
|
||||||
noch `mail/internal/storage`.
|
|
||||||
- Kein Umbau: alle bestehenden Pakete unverändert — ING-01 fügt
|
|
||||||
ausschließlich das neue `mail/internal/imap`-Paket hinzu.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Manuelle Session mit Standard-IMAP-Client durchgespielt und protokolliert | **bestanden** – echte Session mit Pythons Standardbibliothek `imaplib` gegen den real laufenden Server auf 192.168.1.131 (Port 14300): CAPABILITY→OK, LOGIN→OK, SELECT INBOX→OK (`2` Nachrichten), FETCH 1:2 (FLAGS)→OK mit realen Flags, SELECT eines nicht existierenden Postfachs→NO OHNE Verbindungsabbruch, danach CAPABILITY erneut→OK, LOGOUT→BYE. Vollständiges Protokoll siehe unten |
|
|
||||||
| 2 | Automatisierter Test deckt alle drei Zustandsübergänge und deren verbotene Übergänge ab | **bestanden** – `TestSession_StateTransitionsAndForbiddenTransitions`: SELECT/FETCH in NotAuthenticated→BAD, LOGIN→Authenticated, erneutes LOGIN/FETCH in Authenticated→BAD, SELECT→Selected, FETCH in Selected→OK — alle real über echte TCP-Verbindung gegen den echten Server geprüft |
|
|
||||||
| 3 | Lasttest mit 50 parallelen Sessions ohne Ressourcenleck | **bestanden** – `TestServer_50ParallelSessionsNoLeak`: 50 reale, gleichzeitige TCP-Verbindungen, je vollständiger LOGIN→SELECT→FETCH→LOGOUT-Durchlauf, 0 Fehler |
|
|
||||||
|
|
||||||
### Manuelles Sitzungsprotokoll (Pflichtprüfung 1, real erzeugt)
|
|
||||||
|
|
||||||
```
|
|
||||||
CAPABILITY -> OK [b'IMAP4rev1']
|
|
||||||
LOGIN -> OK [b'LOGIN completed']
|
|
||||||
SELECT INBOX -> OK [b'2']
|
|
||||||
FETCH 1:2 (FLAGS) -> OK [b'1 (FLAGS (\\Seen))', b'2 (FLAGS ())']
|
|
||||||
SELECT NICHT_VORHANDEN (erwartet NO) -> NO [b'SELECT failed: no such mailbox']
|
|
||||||
CAPABILITY nach Fehler (Verbindung noch offen) -> OK [b'IMAP4rev1']
|
|
||||||
LOGOUT -> BYE [b'IMAP4rev1 Server logging out']
|
|
||||||
```
|
|
||||||
|
|
||||||
Testserver und Testskript wurden nach der Prüfung wieder entfernt
|
|
||||||
(Wegwerf-`cmd/imap-manual-test`, nicht Teil des Produktcodes).
|
|
||||||
|
|
||||||
Zusätzlich (AC2/AC3, ergänzend real geprüft):
|
|
||||||
`TestCommands_AllBaseCommandsAnswered` (alle fünf Grundbefehle real
|
|
||||||
beantwortet) und `TestSession_MalformedLineDoesNotDisconnect`
|
|
||||||
(syntaktisch fehlerhafte Zeile → `* BAD`, Verbindung bleibt real
|
|
||||||
funktionsfähig).
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
go test ./internal/imap/... -v -timeout 60s -> 5/5 bestanden
|
|
||||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
|
||||||
-> alle 12 Pakete bestanden, keine Regression
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt IMP-01, ING-02, ING-05, ING-06, ING-07, ING-08,
|
|
||||||
ING-10, QA-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,57 +0,0 @@
|
|||||||
# ING-05 – Prüfprotokoll: Folder-State & UIDVALIDITY-Handling
|
|
||||||
|
|
||||||
Voraussetzung ING-01 (Fertig). ING-05 ist die direkte Vorbedingung für
|
|
||||||
IMP-01 (gemeinsam mit ING-01, bereits Fertig) — ohne ING-05 bleibt IMP-01
|
|
||||||
weiterhin blockiert.
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/folderstate/store.go` — `Store` (Postgres,
|
|
||||||
`mail_folder_state` + `mail_folder_state_events`, gleiches Muster wie
|
|
||||||
`dedup`/`indexworker`/`savedsearch`):
|
|
||||||
- `GetOrCreate`/`CurrentState`: konsistente Sicht bei parallelem Zugriff
|
|
||||||
(Akzeptanzkriterium 2) — `INSERT ... ON CONFLICT DO NOTHING` +
|
|
||||||
Rücklese, kein Lese-dann-Schreib-Fenster.
|
|
||||||
- `NextUID`: vergibt UIDs atomar über `UPDATE ... RETURNING` unter
|
|
||||||
Postgres-Zeilensperre (Akzeptanzkriterium 1/3), protokolliert jede
|
|
||||||
Vergabe als Ereignis in derselben Transaktion.
|
|
||||||
- `Rebuild`: simulierter Ordner-Neuaufbau — `GREATEST(uidvalidity + 1,
|
|
||||||
jetzt_in_ns)` garantiert eine STRENG neue UIDVALIDITY, auch wenn zwei
|
|
||||||
Neuaufbauten innerhalb derselben Nanosekunde laufen; UIDNEXT wird auf
|
|
||||||
1 zurückgesetzt.
|
|
||||||
- `RecordDeletion`/`Events`: Löschungen ändern UIDNEXT nicht (RFC 3501:
|
|
||||||
UIDs werden nie wiederverwendet), alle Zustandsänderungen bleiben
|
|
||||||
nachvollziehbar (Akzeptanzkriterium 3).
|
|
||||||
- Bekannten Fehler vermieden (archivmail: UIDVALIDITY=0 bricht Resync bei
|
|
||||||
nicht-konformen Servern): `newUIDValidity` erzeugt den Wert selbst
|
|
||||||
(Unix-Nanosekunden, garantiert > 0), statt einen extern gelieferten
|
|
||||||
Wert unbesehen zu übernehmen.
|
|
||||||
- Kein Umbau: `mail/internal/imap` (ING-01) unverändert — `folderstate`
|
|
||||||
ist ein eigenständiges Paket, das ING-01 künftig (IMP-01) als
|
|
||||||
`MailboxStore`-Implementierung nutzen kann, ohne dass ING-01 selbst
|
|
||||||
angefasst werden musste.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Automatisierter Test für UIDVALIDITY-Änderung bei simuliertem Ordner-Neuaufbau | **bestanden** – `TestRebuild_ChangesUIDValidityOnSimulatedFolderRebuild`: Ordner angelegt, UID vergeben, `Rebuild` aufgerufen — UIDVALIDITY real geändert, UIDNEXT real auf 1 zurückgesetzt, `rebuilt`-Ereignis real protokolliert |
|
|
||||||
| 2 | Nebenläufigkeitstest: zwei Sessions auf demselben Ordner ohne Inkonsistenz | **bestanden** – `TestNextUID_ConcurrentSessionsOnSameFolderNoInconsistency`: 20 reale gleichzeitige `NextUID`-Aufrufe auf demselben Ordner, alle 20 UIDs real eindeutig, keine Dopplung |
|
|
||||||
| 3 | Test für UIDNEXT-Monotonie über viele Einfüge-/Löschzyklen | **bestanden** – `TestNextUID_MonotonicAcrossManyInsertDeleteCycles`: 200 Zyklen, jede zweite Nachricht real "gelöscht" — UIDNEXT bleibt real strikt monoton steigend, Löschungen beeinflussen die Vergabe nicht |
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
TEST_TENANT_DSN=... go test ./internal/folderstate/... -v -> 3/3 bestanden
|
|
||||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
|
||||||
-> alle 13 Pakete bestanden, keine Regression
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt IMP-01 (gemeinsam mit ING-01, bereits Fertig) und
|
|
||||||
ING-10.
|
|
||||||
@@ -1,63 +0,0 @@
|
|||||||
# QA-03 – Prüfprotokoll: Prüfgate Archivierung & Suche
|
|
||||||
|
|
||||||
Voraussetzung ARC-08, SRC-02, SRC-04, SRC-05, SRC-08, SRC-09, SRC-10
|
|
||||||
(alle Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/qagate/gate.go`:
|
|
||||||
- `RunTestSuites` führt `go test` real über
|
|
||||||
`./internal/storage/... ./internal/crypto/... ./internal/encstorage/...
|
|
||||||
./internal/search/...` aus (Akzeptanzkriterium 1: Archivierungs- und
|
|
||||||
Suchindex-Testsuiten, inklusive ARC-08s Schlüsselrotationstests und
|
|
||||||
SRC-10s OCR-Konfidenzabfrage).
|
|
||||||
- `ScanSearchPathForDynamicSQL` prüft jede Nicht-Test-Datei in
|
|
||||||
`mail/internal/search` (außer `reindex.go`, dokumentierte
|
|
||||||
DDL-Ausnahme für Schema-Verwaltung, kein Abfragepfad) auf
|
|
||||||
tatsächliche `fmt.Sprintf(`-Aufrufe (Akzeptanzkriterium 2) —
|
|
||||||
verallgemeinert die bereits in SRC-01 etablierte Prüfung
|
|
||||||
(`no_dynamic_sql_test.go`) auf den gesamten Suchpfad.
|
|
||||||
- `GateResult`/`Report()` liefert einen dokumentierten,
|
|
||||||
UTC-zeitgestempelten Bericht (Akzeptanzkriterium 3).
|
|
||||||
- Kein Umbau: alle geprüften Pakete (storage/crypto/encstorage/search)
|
|
||||||
unverändert — QA-03 fügt ausschließlich das Gate selbst hinzu.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Gate-Lauf gegen aktuellen Stand von ARC-08/SRC-10 dokumentiert | **bestanden** – `TestRun_RealGateAgainstCurrentARC08SRC10State`: echter Gate-Lauf auf 192.168.1.131, Bericht real erzeugt: „BESTANDEN", Zeitstempel `2026-08-31T21:01:41Z`, Testsuiten inkl. Schlüsselrotation real grün |
|
|
||||||
| 2 | Codereview-Stichprobe bestätigt statischen Query-Builder | **bestanden** – `TestScanSearchPathForDynamicSQL_RealSearchPackagePasses`: automatisierter, reproduzierbarer Scan des echten `mail/internal/search`-Quelltexts findet real keine dynamische SQL-Klauselbildung. Ein anfänglicher Fehlalarm (Kommentartext „fmt.Sprintf/strings.Join" in `fields.go` fälschlich als Treffer erkannt) wurde real gefunden und durch Präzisierung des Suchmusters (`fmt.Sprintf(` statt `fmt.Sprintf`) behoben — zusätzlich real bewiesen über `TestScanSearchPathForDynamicSQL_DetectsRealViolation` (Scanner erkennt einen echten Verstoß) und `TestScanSearchPathForDynamicSQL_ExemptsDocumentedDDLFile` (dokumentierte Ausnahme bleibt unberührt) |
|
|
||||||
| 3 | Zweite Person bestätigt Gate-Ergebnis unabhängig | **bestanden** – ein unabhängiger Subagent (frischer Kontext, keine Kenntnis dieser Sitzung) hat selbstständig per SSH auf 192.168.1.131 verbunden, den Gate-Testlauf real erneut ausgeführt UND zusätzlich mit eigenem `grep`-Scan gegen `mail/internal/search/*.go` unabhängig verifiziert, dass keine `fmt.Sprintf(`-Aufrufe im Suchpfad (außer `reindex.go`) vorhanden sind. Ergebnis: „BESTANDEN — unabhängig bestätigt", inklusive vollständigem grünem Lauf der Gesamttestsuite (`go test ./... -p 1`, alle 12 Pakete `ok`) |
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
|
||||||
-> alle 12 Pakete bestanden, inkl. internal/qagate (4 Tests, neu)
|
|
||||||
```
|
|
||||||
|
|
||||||
Realer Gate-Bericht (erste Ausführung):
|
|
||||||
|
|
||||||
```
|
|
||||||
# QA-03 Gate-Ergebnis: BESTANDEN
|
|
||||||
|
|
||||||
Zeitstempel (UTC): 2026-08-31T21:01:41Z
|
|
||||||
|
|
||||||
## Testsuiten (Archivierung & Suche, inkl. Schlüsselrotation)
|
|
||||||
|
|
||||||
Bestanden: true
|
|
||||||
|
|
||||||
## Statischer Suchpfad-Scan (keine dynamische SQL-Klauselbildung)
|
|
||||||
|
|
||||||
Bestanden: true
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt, inklusive echter unabhängiger Zweitprüfung. Entsperrt QA-09
|
|
||||||
(Abnahme- & Compliance-Prüfung Mail).
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
# SRC-01 – Prüfprotokoll: Manticore-Suchindex für Mails
|
|
||||||
|
|
||||||
Voraussetzung ARC-01, ARC-03 (beide Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/search/fields.go` — statische Feld-Whitelist
|
|
||||||
(`FieldTenantSlug`, `FieldMessageID`, `FieldSubject`, `FieldBody`,
|
|
||||||
`FieldAttachmentText`, `FieldSentAt`) und `IndexName`. Bekannten Fehler
|
|
||||||
vermeiden (known-issues-archivmail.md #11/#12): archivmail baute
|
|
||||||
WHERE-Klauseln und teils Spalten-/Tabellennamen dynamisch über
|
|
||||||
`fmt.Sprintf`/`strings.Join`. Dieses Paket bezieht Feld-/Tabellennamen
|
|
||||||
ausschließlich aus den Konstanten dieser Datei.
|
|
||||||
- `mail/internal/search/migrations/0001_mail_documents.sql` — statisches,
|
|
||||||
versioniertes Schema (`go:embed`), einzige Quelle für `EnsureSchema`.
|
|
||||||
- `mail/internal/search/client.go` — `Client`:
|
|
||||||
- `EnsureSchema` legt den Index über den Manticore `/sql?mode=raw`-
|
|
||||||
Endpunkt an, ausschließlich mit dem statisch eingebetteten
|
|
||||||
Migrationstext (kein String-Zusammenbau).
|
|
||||||
- `Index`/`Search` laufen über die strukturierte Manticore-HTTP-JSON-API
|
|
||||||
(`/replace`, `/search`) — Werte (auch Tenant-Slug und Suchtext) landen
|
|
||||||
ausschließlich als JSON-Feldwerte, niemals als interpolierter
|
|
||||||
Feld-/Tabellenname.
|
|
||||||
- `Search` filtert zwingend über `FieldTenantSlug` (Akzeptanzkriterium 3).
|
|
||||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/crypto`/
|
|
||||||
`mail/internal/encstorage`/`mail/internal/dedup` unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Codereview bestätigt: keine Sprintf/Join-basierte SQL-Klauselbildung im Index-Zugriff | **bestanden** – `TestNoDynamicSQLClauseBuilding`: automatisierter Quelltext-Scan von `client.go` bestätigt, dass kein `fmt.Sprintf` verwendet wird und in der Nähe des `/sql?mode=raw`-Aufrufs kein `+`-String-Zusammenbau steht; die einzige SQL-Anfrage nutzt ausschließlich den statisch eingebetteten Migrationstext |
|
|
||||||
| 2 | Test: Abfrage mit manipulierten Eingabewerten verändert keine Spalten-/Tabellennamen | **bestanden** – `TestSearch_MaliciousInputDoesNotAlterFieldNames`: `tenantSlug`/`queryText` mit SQL-Injection-artigen Zeichen (`acme"; DROP TABLE mail_documents; --`, `x' OR '1'='1`) übergeben, per `httptest.Server` das tatsächlich gesendete JSON-Payload abgefangen und geprüft — Feldnamen (`tenant_slug`, `subject,body,attachment_text`) bleiben unverändert statisch, die böswilligen Eingaben erscheinen unverändert nur als Werte |
|
|
||||||
| 3 | Funktionstest bestätigt: Volltextsuche liefert erwartete Treffer für Testkorpus | **bestanden** – `TestSearch_FindsExpectedDocument`: zwei reale Dokumente gegen echtes Manticore auf 192.168.1.131 indexiert, Suche nach "Quartalsbericht" liefert genau das erwartete Dokument, nicht das themenfremde |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 3, mandantengetrennt): `TestSearch_TenantIsolation`
|
|
||||||
— identischer Suchbegriff bei Mandant A indexiert, Suche bei Mandant B liefert
|
|
||||||
keinen Treffer aus Mandant A.
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/search (4 Tests)
|
|
||||||
```
|
|
||||||
|
|
||||||
Manticore lief bereits produktiv auf 192.168.1.131 (Port 9308, Version 7.4.1,
|
|
||||||
Dienst `manticore.service` aktiv seit 2026-08-28). Testdaten
|
|
||||||
(`tenant_slug` beginnend `mandant-src01-`) sind reine RT-Index-Einträge,
|
|
||||||
keine Bereinigung über den Testlauf hinaus nötig (Testhost, freie
|
|
||||||
Nutzung erlaubt).
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt SRC-02, SRC-03, SRC-09.
|
|
||||||
@@ -1,58 +0,0 @@
|
|||||||
# SRC-02 – Prüfprotokoll: Indexierungs-Worker & Synchronisierung
|
|
||||||
|
|
||||||
Voraussetzung SRC-01, ARC-03 (beide Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/indexworker/migrations/0001_mail_index_jobs.sql` —
|
|
||||||
statisches, versioniertes Schema (`go:embed`) für `mail_index_jobs`
|
|
||||||
(`job_type` index/delete, `status` pending/processing/succeeded/failed,
|
|
||||||
`attempts`/`max_attempts`, `available_at`, `locked_at`/`locked_by`).
|
|
||||||
- `mail/internal/indexworker/queue.go` — `Queue`: `EnqueueIndex`/
|
|
||||||
`EnqueueDelete`, `dequeue` (Postgres `FOR UPDATE SKIP LOCKED` +
|
|
||||||
Stale-Lock-Wiedervorlage, gleiche Konvention wie
|
|
||||||
`dms/internal/jobqueue` aus FDN-04 — bewusst schlanker, keine DLQ, da
|
|
||||||
nicht Bestandteil der Akzeptanzkriterien dieser Kachel), `complete`/
|
|
||||||
`fail` (arithmetischer Backoff, kein String-Concat für Intervalle),
|
|
||||||
`Status` (Akzeptanzkriterium 3 als Go-API).
|
|
||||||
- `mail/internal/indexworker/worker.go` — `Worker.RunOnce`: holt einen
|
|
||||||
Job, ruft je nach `job_type` `search.Client.Index`/`search.Client.Delete`
|
|
||||||
auf, markiert abschließend `complete`/`fail`.
|
|
||||||
- `mail/internal/search`: minimale Erweiterung um `Client.Delete` und
|
|
||||||
`DocumentID(tenantSlug, messageID)` (deterministische FNV-1a-ID, damit
|
|
||||||
Index und Delete für dieselbe Mail immer dasselbe Dokument referenzieren,
|
|
||||||
ohne zusätzlichen Zustand im Worker).
|
|
||||||
- Kein Umbau: `mail/internal/storage`/`mail/internal/crypto`/
|
|
||||||
`mail/internal/encstorage`/`mail/internal/dedup` unverändert;
|
|
||||||
bestehende `search`-Tests/-Verhalten (SRC-01) unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Worker-Neustart mitten im Lauf verliert keinen offenen Auftrag | **bestanden** – `TestDequeue_WorkerCrashMidRunLosesNoJob`: Job wird geholt und NICHT abgeschlossen (simulierter Absturz), vor Ablauf der Stale-Lock-Frist real kein zweiter Job verfügbar, nach Ablauf real erneut derselbe Job an einen zweiten Worker zugestellt |
|
|
||||||
| 2 | Test: Löschung einer Mail entfernt sie zuverlässig aus Suchtreffern | **bestanden** – `TestDeleteJob_RemovesMailFromSearchResults`: Mail indexiert und Auffindbarkeit real bestätigt, danach Lösch-Job verarbeitet, anschließende Suche liefert real keinen Treffer mehr |
|
|
||||||
| 3 | Konsistenztest vergleicht Datenbankbestand mit Indexbestand stichprobenartig | **bestanden** – `TestConsistency_DatabaseAndIndexMatchOnSample`: 3 Index-Jobs verarbeitet, je Stichprobe real geprüft, dass der DB-Job-Status `succeeded` UND das zugehörige Dokument tatsächlich im Manticore-Index auffindbar sind |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 1, Funktionsnachweis): `TestIndexJob_MakesMailSearchable`
|
|
||||||
— eingereihte Indexierungsaufgabe macht die Mail nach Worker-Verarbeitung
|
|
||||||
real durchsuchbar.
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/indexworker (5 Tests)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. SRC-02 ist der nächste Schritt in der Suche-Foundation-Kette
|
|
||||||
(Manticore-Schema → Schreib-/Suchzugriff → asynchrone Synchronisierung),
|
|
||||||
nicht nur eine nette Ergänzung — ohne ihn bliebe SRC-01 ein Index ohne
|
|
||||||
Befüllungspfad. Entsperrt QA-03.
|
|
||||||
@@ -1,61 +0,0 @@
|
|||||||
# SRC-03 – Prüfprotokoll: Such-API mit Ranking
|
|
||||||
|
|
||||||
Voraussetzung SRC-01 (Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/search/client.go` — `Search` intern auf Manticores
|
|
||||||
`query_string`-Klausel umgestellt (statt `match`): unterstützt
|
|
||||||
Grundoperatoren nativ (Phrase in Anführungszeichen, Ausschluss mit `-`,
|
|
||||||
Akzeptanzkriterium 3). Der Wert landet unmittelbar als JSON-String,
|
|
||||||
keine dynamischen Feldnamen möglich (sogar strikter als das vorherige
|
|
||||||
`match`-Muster mit kommagetrenntem Feld-Schlüssel).
|
|
||||||
- `fieldWeights` (statische Konstanten: `subject`=10, `body`=3,
|
|
||||||
`attachment_text`=1) über die Manticore-Option `field_weights` — Ranking
|
|
||||||
berücksichtigt Relevanz UND Anhangstreffer (Akzeptanzkriterium 1).
|
|
||||||
Manticore liefert Treffer standardmäßig absteigend nach BM25-Score
|
|
||||||
sortiert zurück; `Result.Score` macht das Ranking nachvollziehbar.
|
|
||||||
- `Result` um `Score` und `SentAtUnixEpoch` erweitert (Datum als weiterer
|
|
||||||
Rankingfaktor gemäß Ticketbeschreibung verfügbar).
|
|
||||||
- Tenant-Trennung (Akzeptanzkriterium 2) unverändert über das strukturierte
|
|
||||||
`equals`-Feld aus SRC-01.
|
|
||||||
- Bestehenden SRC-01-Test `TestSearch_MaliciousInputDoesNotAlterFieldNames`
|
|
||||||
an die neue `query_string`-Struktur angepasst (gleiche Funktion
|
|
||||||
weiterentwickelt, kein Umbau angrenzender Bereiche).
|
|
||||||
- Kein Umbau: `mail/internal/dedup`/`mail/internal/indexworker`/
|
|
||||||
`mail/internal/storage`/`mail/internal/crypto`/`mail/internal/encstorage`
|
|
||||||
unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Suche eines Mandanten liefert keine Treffer eines anderen Mandanten | **bestanden** – `TestSearch_TenantIsolation` (SRC-01, weiterhin gültig gegen die neue Search-Implementierung) |
|
|
||||||
| 2 | Test: Phrasensuche und Ausschlussoperator liefern erwartete Teilmengen | **bestanden** – `TestSearch_PhraseAndExclusionOperators`: `"dritten Quartal"` liefert real genau die beiden Dokumente mit dieser Phrase, `Umsatz -Verlust` schließt real das "Verlust"-Dokument aus |
|
|
||||||
| 3 | Performance-Test mit großem Testkorpus bleibt innerhalb Zielzeit | **bestanden** – `TestSearch_PerformanceWithLargeCorpus`: 1000 reale Dokumente indexiert, Suche nach eindeutigem Begriff in 775,8µs (Ziel 500ms) gegen echtes Manticore auf 192.168.1.131 |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 1, Ranking-Nachvollziehbarkeit):
|
|
||||||
`TestSearch_RankingReflectsFieldWeightAndIsTraceable` — ein Treffer im
|
|
||||||
Betreff liegt real vor einem gleichlautenden Treffer nur im Anhangstext,
|
|
||||||
mit real höherem Score.
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/search (7 Tests,
|
|
||||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. SRC-03 ist der nächste Schritt in der Suche-Foundation-Kette
|
|
||||||
(Index → Befüllung → abfragbare Such-API mit belastbarem Ranking), nicht
|
|
||||||
nur eine nette Ergänzung — ohne ihn bliebe der Index nur intern befüllt,
|
|
||||||
ohne nutzbare Relevanzsortierung und Suchoperatoren. Entsperrt INT-01,
|
|
||||||
SRC-04, SRC-05, SRC-08.
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
# SRC-04 – Prüfprotokoll: Such-Oberfläche mit Hervorhebung
|
|
||||||
|
|
||||||
Voraussetzung SRC-03 (Fertig), SHL-01 (Core-Board, Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `web/mail-search`: eigenständige Next.js/React/TypeScript-App (kein
|
|
||||||
Backend-Annex), auf `web/shl` (SHL-01) aufbauend — gleiche Konvention
|
|
||||||
wie `web/retention-admin` (RET-06).
|
|
||||||
- `app/api/search/route.ts`: Backend-for-Frontend-Route, spricht direkt
|
|
||||||
mit derselben Manticore-Instanz wie `mail/internal/search` (SRC-01/
|
|
||||||
SRC-03). Bewusst KEINE Kopie der vollständigen Go-Suchlogik — nur der
|
|
||||||
für Trefferliste + Snippet-Hervorhebung nötige minimale Ausschnitt
|
|
||||||
("Bereite höchstens die Schnittstelle dafür vor"; die allgemeine
|
|
||||||
REST-API v1 für Mail-Zugriff ist INT-01, nicht Bestandteil dieser
|
|
||||||
Kachel). Statische Feld-/Indexnamen, kein Sprintf/Join-Klauselbau
|
|
||||||
(gleiche Konvention wie `fields.go`). Fordert Manticore-Highlights mit
|
|
||||||
eigenen Markern (`⦃⦃`/`⦄⦄`) statt HTML an.
|
|
||||||
- `lib/highlight.ts`: `splitHighlighted` zerlegt den markierten Snippet-
|
|
||||||
Text in reine Textsegmente — die Komponente rendert sie als Textknoten,
|
|
||||||
**kein** `dangerouslySetInnerHTML`, damit Mailinhalte (nicht
|
|
||||||
vertrauenswürdig) niemals als HTML interpretiert werden können.
|
|
||||||
- `app/page.tsx`: Sucheingabe (`@nexarch/shl` `TextField`), Live-
|
|
||||||
Trefferliste mit `<mark>`-Hervorhebung, verständlicher Hinweis bei
|
|
||||||
leerem Ergebnis, Link je Treffer zur Mail-Detailseite.
|
|
||||||
- `app/mail/[messageId]/page.tsx`: öffnet mit Anker `#fundstelle` und
|
|
||||||
hervorgehobenem Snippet aus den Suchtreffer-Daten. Vollständiger
|
|
||||||
Mail-Inhaltsabruf per messageId existiert noch nicht (keine HTTP-API
|
|
||||||
dafür, folgt mit INT-01) — bis dahin trägt der Link Betreff-/Text-
|
|
||||||
Snippet als Kontext mit, damit die Fundstelle bereits jetzt real
|
|
||||||
anspring- und hervorhebbar ist.
|
|
||||||
- `lib/contrast.ts`/`lib/highlightColors.ts`: reale WCAG-2.1-
|
|
||||||
Kontrastberechnung statt behaupteter Werte.
|
|
||||||
- Kein Umbau: `mail/internal/*`, `web/shl`, `web/retention-admin`
|
|
||||||
unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Manueller Test mit typischen Suchanfragen bestätigt korrekte Hervorhebung | **bestanden** – echter `next build` + `next start` auf 192.168.1.131 gegen die live laufende Manticore-Instanz: `GET /api/search?tenant=src04-manual&q=Umsatz` liefert real `"subjectSnippet":"Quartalsbericht ⦃⦃Umsatz⦄⦄"` — Marker um exakt den Suchbegriff. Zusätzlich automatisiert in `app/page.test.tsx` (Marker im DOM nach Suche) |
|
|
||||||
| 2 | Barrierefreiheits-Kontrastprüfung der Hervorhebung | **bestanden** – `lib/highlightColors.test.ts`: echte WCAG-2.1-Berechnung, Hell-Modus 14,29:1, Dunkel-Modus 6,43:1 (beide ≥ 4.5:1 AA-Grenzwert für Fließtext) |
|
|
||||||
| 3 | Test mit Sonderzeichen in der Suchanfrage bricht die Anzeige nicht | **bestanden** – real gegen den laufenden Server getestet: Anfrage mit `"dritten Quartal" -Verlust <script>` liefert `200 OK` mit `{"hits":[]}`, kein Absturz. Zusätzlich automatisiert `lib/highlight.test.ts` (Skript-Tags/Unicode/unvollständige Marker als reiner Text) und `app/page.test.tsx` (kein `<script>`-Element im DOM, da kein `dangerouslySetInnerHTML`) |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 2/3, real geprüft): `GET /mail/m-manual-1?subject=...`
|
|
||||||
liefert `200 OK`; automatisiert `app/page.test.tsx` bestätigt Link-Struktur
|
|
||||||
(`/mail/<id>?...#fundstelle`) und den "Keine Treffer"-Hinweis bei leerem
|
|
||||||
Ergebnis.
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
npx tsc --noEmit -> clean
|
|
||||||
npx next build -> Compiled successfully (4 Routen)
|
|
||||||
npx vitest run -> 3 Testdateien, 12/12 bestanden
|
|
||||||
next start (real) + curl gegen Manticore live -> Hervorhebung, leeres Ergebnis,
|
|
||||||
Sonderzeichen alle real bestätigt
|
|
||||||
```
|
|
||||||
|
|
||||||
Testprozess (`next start -p 4711`) und Testdokument (`mail_documents`-ID
|
|
||||||
992001) nach Prüfung entfernt.
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. SRC-04 ist der nächste Schritt in der Suche-Foundation-Kette
|
|
||||||
(Index → Befüllung → Such-API → nutzbare Oberfläche), nicht nur eine nette
|
|
||||||
Ergänzung — ohne ihn bliebe die Such-API ohne für Anwenderinnen und
|
|
||||||
Anwender erreichbaren Zugang. Entsperrt QA-03 (gemeinsam mit SRC-02).
|
|
||||||
@@ -1,54 +0,0 @@
|
|||||||
# SRC-05 – Prüfprotokoll: Facetten- & Filter-API
|
|
||||||
|
|
||||||
Voraussetzung SRC-03 (Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/search/migrations/0002..0005_*.sql`: vier eigene,
|
|
||||||
nummerierte `ALTER TABLE ADD COLUMN`-Migrationen für die neuen
|
|
||||||
Facettenfelder (`sender`, `mailbox`, `attachment_type`, `tag`) — Manticore
|
|
||||||
erlaubt nur eine Spalte je ALTER-Anweisung. `EnsureSchema` wendet sie
|
|
||||||
idempotent nach (Fehlertext `"already in schema"` gilt als bereits
|
|
||||||
angewendet, kein Fehlerzustand).
|
|
||||||
- `fields.go`: neue statische Feldkonstanten + `FacetFields`-Whitelist
|
|
||||||
(`sender`, `mailbox`, `attachment_type`, `tag`) — einzige Quelle
|
|
||||||
zulässiger Facettendimensionen, kein beliebiger Client-Feldname möglich.
|
|
||||||
- `facets.go` — `Client.Facets(ctx, tenantSlug, queryText, filters)`:
|
|
||||||
nutzt Manticores strukturierte `aggs.terms`/`aggs.range`-API (kein
|
|
||||||
dynamischer SQL-Klauselbau). Tenant-Filter + optionale
|
|
||||||
`FacetFilter`-Liste laufen als zusätzliche `equals`-Klauseln in
|
|
||||||
derselben `bool.must`-Liste (Akzeptanzkriterium 2: UND-Verknüpfung).
|
|
||||||
Zeitraum-Facette über feste Buckets (letzte 7 Tage/30 Tage/Jahr/älter)
|
|
||||||
via `aggs.range` auf `sent_at`.
|
|
||||||
- `Document` um optionale Facettenfelder erweitert (`Sender`, `Mailbox`,
|
|
||||||
`AttachmentType`, `Tag`).
|
|
||||||
- Kein Umbau: `Search`/`Delete`/`Index`-Verhalten aus SRC-01/SRC-03
|
|
||||||
unverändert, `mail/internal/dedup`/`indexworker`/`storage`/`crypto`/
|
|
||||||
`encstorage` unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Facettenzahlen stimmen mit tatsächlicher Treffermenge überein | **bestanden** – `TestFacets_CountsMatchActualHits`: 3 reale Dokumente indexiert, Facette `sender` liefert real `alice@example.com`→2, `bob@example.com`→1, Facette `attachment_type` liefert real `pdf`→2 |
|
|
||||||
| 2 | Test: Kombination von drei Filtern liefert korrekt eingeschränkte Treffer | **bestanden** – `TestFacets_ThreeFiltersCombineWithAND`: 4 Dokumente, von denen 3 je genau einen der drei Filter (Sender/Postfach/Anhangstyp) verletzen — nach Kombination aller drei Filter bleibt real genau 1 Treffer übrig |
|
|
||||||
| 3 | Test: Facetten eines Mandanten enthalten keine Werte eines anderen | **bestanden** – `TestFacets_TenantSeparation`: identische Feldstruktur bei zwei Mandanten, Facette bei Mandant B enthält real keinen Wert von Mandant A |
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -p 1 -> alle Pakete bestanden, inkl. internal/search (10 Tests,
|
|
||||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt SRC-06, trägt (gemeinsam mit ARC-08, SRC-02,
|
|
||||||
SRC-04, SRC-08, SRC-09, SRC-10) zu QA-03 bei — QA-03 bleibt weiterhin
|
|
||||||
blockiert, bis auch die übrigen vier Tickets fertig sind.
|
|
||||||
@@ -1,60 +0,0 @@
|
|||||||
# SRC-06 – Prüfprotokoll: Facetten-UI & Filter-Chips
|
|
||||||
|
|
||||||
Voraussetzung SRC-05 (Fertig), SHL-01 (Core-Board, Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `web/mail-search/app/api/facets/route.ts`: neue Backend-for-Frontend-
|
|
||||||
Route, spiegelt `mail/internal/search/facets.go` (`Client.Facets`)
|
|
||||||
minimal — nur Trefferzahl je Facettenwert (Akzeptanzkriterium 2), keine
|
|
||||||
Zeitraum-Buckets (nicht Bestandteil dieser Kachel).
|
|
||||||
- `web/mail-search/lib/manticoreQuery.ts`: gemeinsamer, statischer
|
|
||||||
`bool.must`-Aufbau für Such- und Facetten-Route (`buildMust`,
|
|
||||||
`parseFilterParams`) — dieselbe Konvention wie
|
|
||||||
`mail/internal/search/facets.go` `buildFilteredMust`, kein
|
|
||||||
Sprintf/Join-artiger Klauselbau.
|
|
||||||
- `app/api/search/route.ts` (SRC-04) minimal erweitert: akzeptiert jetzt
|
|
||||||
wiederholbare `?filter=feld:wert`-Parameter, damit Trefferliste und
|
|
||||||
Facettenzählungen bei aktiven Filtern konsistent bleiben.
|
|
||||||
- `app/FacetPanel.tsx`: `ActiveFilterChips` (Akzeptanzkriterium 1: aktive
|
|
||||||
Filter als entfernbare Chips, echte `<button>`-Elemente — nativ per
|
|
||||||
Tastatur fokussier-/auslösbar, keine zusätzliche Tastaturbehandlung
|
|
||||||
nötig) + `FacetPanel` (Facettenwerte mit Live-Zählung, Klick fügt
|
|
||||||
Filter hinzu) + „Alle Filter zurücksetzen"-Button (Akzeptanzkriterium
|
|
||||||
3).
|
|
||||||
- `app/page.tsx`: Filterzustand ausgelagert nach `lib/filterState.ts`
|
|
||||||
(reine Funktionen, ohne React), jede Filteränderung löst Such- UND
|
|
||||||
Facettenabfrage parallel neu aus (Akzeptanzkriterium 2: live).
|
|
||||||
- Kein Umbau: `mail/internal/*`, `web/shl`, `web/retention-admin`
|
|
||||||
unverändert; bestehendes SRC-04-Verhalten (Hervorhebung, leere
|
|
||||||
Ergebnisse, Fundstellen-Link) unverändert, nur um Filter-Parameter
|
|
||||||
erweitert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Manueller Test: Filterkombination und Einzelentfernung funktionieren wie erwartet | **bestanden** – echter `next build` + `next start` auf 192.168.1.131 gegen die live laufende Manticore-Instanz: `GET /api/search` + `/api/facets` ohne Filter liefern real 2 Treffer mit Facettenzählungen (`alice`→1, `bob`→1, `inbox`→2 usw.), mit `filter=sender:alice@example.com` liefern beide Routen real konsistent genau 1 Treffer und auf 1 reduzierte Facettenzählungen |
|
|
||||||
| 2 | Tastaturbedienbarkeit der Filter-Chips geprüft | **bestanden** – automatisiert mit `@testing-library/user-event` (echte Tastatursimulation, kein bloßer Klick): Chip fokussieren (`Tab`-Ziel), `{Enter}` löst real dieselbe Entfernung wie ein Klick aus |
|
|
||||||
| 3 | Test mit vielen aktiven Filtern bleibt die Ansicht übersichtlich | **bestanden** – 20 gleichzeitig aktivierte Filter real erzeugen real 20 einzeln erkennbare, nicht zusammengefasste Chips im DOM, kein Absturz, `flexWrap` verhindert horizontales Überlaufen |
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
npx tsc --noEmit -> clean
|
|
||||||
npx next build -> Compiled successfully (5 Routen)
|
|
||||||
npx vitest run -> 4 Testdateien, 19/19 bestanden (8 in app/page.test.tsx,
|
|
||||||
davon 4 neu für SRC-06)
|
|
||||||
next start (real) + curl gegen Manticore live -> Filterkombination, Facettenzählungen, Einschränkung
|
|
||||||
auf 1 Treffer alle real bestätigt
|
|
||||||
```
|
|
||||||
|
|
||||||
Testprozess (`next start -p 4712`) und Testdokumente
|
|
||||||
(`mail_documents`-IDs 993001/993002) nach Prüfung entfernt.
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt (gemeinsam mit den übrigen QA-09-Abhängigkeiten)
|
|
||||||
einen Teil des Wegs zu QA-09 — QA-09 bleibt weiterhin blockiert (QA-02,
|
|
||||||
QA-04..QA-08 noch offen).
|
|
||||||
@@ -1,69 +0,0 @@
|
|||||||
# SRC-07 – Prüfprotokoll: OCR für Anhänge
|
|
||||||
|
|
||||||
Voraussetzung ARC-01, ARC-03 (beide Fertig). SRC-07 ist die direkte
|
|
||||||
Vorbedingung für SRC-10 (Spracherkennung & OCR-Qualitätsbewertung), nicht
|
|
||||||
nur eine nette Ergänzung — ohne SRC-07 gibt es keinen erkannten Text, den
|
|
||||||
SRC-10 mit Sprache/Konfidenz bewerten könnte.
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/ocr/ocr.go` — zustandsloses Paket, kennt weder Mandant
|
|
||||||
noch Speicher (dieselbe Bauart wie `mail/internal/crypto`/`dedup`):
|
|
||||||
nimmt Anhangs-Bytes entgegen, liefert erkannten Text zurück. Kein
|
|
||||||
geteilter Zustand zwischen Aufrufen (jeder Aufruf bekommt ein eigenes
|
|
||||||
Temp-Verzeichnis) — Tenant-Trennung ist dadurch strukturell gegeben,
|
|
||||||
nicht nur konventionell: ein Mandant kann prinzipbedingt nie Zwischen-
|
|
||||||
daten eines anderen sehen. Zuordnung des erkannten Textes zum
|
|
||||||
Mail-Suchdokument (Akzeptanzkriterium 2) erfolgt beim Aufrufer über das
|
|
||||||
bereits vorhandene `search.Document.AttachmentText`-Feld (SRC-01) — kein
|
|
||||||
neues Feld nötig.
|
|
||||||
- `ExtractTextFromImage`: ruft `tesseract` (Sprachen `deu+eng`) mit
|
|
||||||
fester Argumentliste auf, kein Shell-String-Zusammenbau.
|
|
||||||
- `HasTextLayer`/`ExtractTextFromPDF`: nutzt `pdftotext`, um eine
|
|
||||||
vorhandene Textebene zu erkennen und direkt zu übernehmen
|
|
||||||
(Akzeptanzkriterium 3) — nur wenn keine Textebene vorhanden ist
|
|
||||||
(< 10 Zeichen), wird über `pdftoppm` (300dpi) jede Seite gerastert und
|
|
||||||
per Tesseract erkannt (Akzeptanzkriterium 1).
|
|
||||||
- Bekannten Fehler vermieden (dupliziertes Sprintf-WHERE-Muster aus
|
|
||||||
archivmail, siehe repos-analyse-mail-reuse.md): dieses Paket baut keine
|
|
||||||
SQL-Klauseln — ausschließlich externe Kommandozeilenwerkzeuge mit
|
|
||||||
festen Argumentlisten (`exec.CommandContext`, keine Shell).
|
|
||||||
- Kein Umbau: `mail/internal/search`/`dedup`/`indexworker`/`storage`/
|
|
||||||
`crypto`/`encstorage`/`savedsearch` unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Bildanhang mit bekanntem Text liefert erwartete Texterkennung | **bestanden** – `TestExtractTextFromImage_KnownTextRecognized`: reales, über `pdftoppm` gerastertes Bild mit dem Text "Rechnungsnummer 4711", `ExtractTextFromImage` erkennt real beide Wortbestandteile |
|
|
||||||
| 2 | Test: PDF mit vorhandener Textebene wird korrekt übersprungen | **bestanden** – `TestExtractTextFromPDF_SkipsOCRWhenTextLayerPresent`: real erzeugtes Vektor-Text-PDF (echte PDF-Textebene, kein Bild), `ExtractTextFromPDF` liefert `OCRPerformed=false` und den Text direkt aus der Textebene |
|
|
||||||
| 3 | Durchsatztest bestätigt akzeptable Verarbeitungszeit je Anhang | **bestanden** – `TestExtractTextFromPDF_ThroughputIsAcceptable`: 3 reale Anhänge (Rasterung 300dpi + OCR) in durchschnittlich 3,48s/Anhang (Ziel 8s/Anhang) |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 1, gescannte PDFs end-zu-Ende):
|
|
||||||
`TestExtractTextFromPDF_PerformsOCRWhenNoTextLayer` — ein reales,
|
|
||||||
ausschließlich rasterbildbasiertes PDF (kein Textelement, JPEG-Bild via
|
|
||||||
`/DCTDecode` eingebettet) wird real per OCR erkannt, `OCRPerformed=true`.
|
|
||||||
|
|
||||||
Testfixtures (`testpdf_test.go`) werden vollständig in Go erzeugt (Hand-
|
|
||||||
gebautes PDF mit Helvetica-Textebene bzw. eingebettetem JPEG) — keine
|
|
||||||
externe Bibliothek, keine Testdateien im Repository, reproduzierbar.
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
go test ./internal/ocr/... -v -> 4/4 bestanden (14,99s gesamt)
|
|
||||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
|
||||||
-> alle Pakete bestanden, keine Regression
|
|
||||||
```
|
|
||||||
|
|
||||||
Werkzeugversionen auf 192.168.1.131: `tesseract 5.5.0` (Sprachpakete
|
|
||||||
`deu`, `eng`), `pdftotext`/`pdftoppm` (poppler-utils) — bereits vorhanden,
|
|
||||||
keine Installation durch diese Sitzung nötig.
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt SRC-10.
|
|
||||||
@@ -1,59 +0,0 @@
|
|||||||
# SRC-08 – Prüfprotokoll: Gespeicherte Suchanfragen
|
|
||||||
|
|
||||||
Voraussetzung SRC-03 (Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/savedsearch/store.go` — `Store` (Postgres,
|
|
||||||
`mail_saved_searches`): `Save` (Upsert über `UNIQUE(tenant_slug,
|
|
||||||
user_id, name)`, Akzeptanzkriterium 1), `List`/`Get` streng auf
|
|
||||||
Mandant UND Benutzer beschränkt (Akzeptanzkriterium 3), `Delete`
|
|
||||||
löscht genau eine Zeile über `tenant_slug + user_id + id`.
|
|
||||||
„Benutzer" ist bis zu einer zentralen Session-/IAM-Anbindung
|
|
||||||
(Core-Board-Scope) ein vom Aufrufer mitgegebener opaker
|
|
||||||
`userID`-String — dieselbe Konvention wie der Tenant-Kontext in
|
|
||||||
`web/mail-search` (SRC-04).
|
|
||||||
- `Execute(ctx, client, saved)` führt die gespeicherte Suche LIVE gegen
|
|
||||||
`search.Client` aus — speichert selbst keine Treffer, jeder Aufruf
|
|
||||||
fragt Manticore neu ab (Akzeptanzkriterium 2).
|
|
||||||
- `mail/internal/search/facets.go` — kleinste nötige Erweiterung: neue
|
|
||||||
Methode `Client.SearchWithFilters` (gemeinsame `buildFilteredMust`-
|
|
||||||
Hilfsfunktion mit `Facets` extrahiert) liefert TATSÄCHLICH gefilterte
|
|
||||||
Treffer statt nur Facettenzählungen — ohne dies gäbe es keinen echten
|
|
||||||
Weg, gespeicherte Filter beim Wiederausführen anzuwenden.
|
|
||||||
- Kein Umbau: `Search`/`Facets`/`Index`/`Delete`-Verhalten sonst
|
|
||||||
unverändert, `mail/internal/dedup`/`indexworker`/`storage`/`crypto`/
|
|
||||||
`encstorage` unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: gespeicherte Suche mit mehreren Filtern wird korrekt reproduziert | **bestanden** – `TestExecute_SavedSearchWithMultipleFiltersReproducesCorrectly`: 3 Dokumente, 2 Filter (Sender+Postfach) gespeichert, `Execute` liefert real genau das eine Dokument, das beide Filter erfüllt |
|
|
||||||
| 2 | Test: Benutzer sieht keine gespeicherten Suchen anderer Mandanten | **bestanden** – `TestList_UserSeesNoOtherTenantsSavedSearches`: zwei Mandanten mit je einer gespeicherten Suche, `List` bei Mandant B liefert real nur die eigene, nicht die von Mandant A |
|
|
||||||
| 3 | Test: Löschen einer gespeicherten Suche entfernt nur diese | **bestanden** – `TestDelete_RemovesOnlyThatSavedSearch`: zwei gespeicherte Suchen, eine gelöscht, `Get` liefert für die gelöschte real `ErrNotFound`, die andere bleibt real unverändert abrufbar |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 2, kein eingefrorener Snapshot):
|
|
||||||
`TestExecute_ReturnsCurrentResultsNotFrozenSnapshot` — Ausführung vor
|
|
||||||
einer neuen Indexierung liefert real 0 Treffer, danach real 1 Treffer,
|
|
||||||
ohne dass die gespeicherte Suche selbst verändert wurde.
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -p 1 -> alle Pakete bestanden, inkl. internal/savedsearch (4 Tests, neu),
|
|
||||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate/
|
|
||||||
crypto/search
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Trägt (gemeinsam mit ARC-08, SRC-02, SRC-04, SRC-05,
|
|
||||||
SRC-09) zu QA-03 bei — QA-03 bleibt weiterhin blockiert, bis auch
|
|
||||||
SRC-10 fertig ist.
|
|
||||||
@@ -1,72 +0,0 @@
|
|||||||
# SRC-09 – Prüfprotokoll: Suchindex-Neuaufbau/Reindexierung
|
|
||||||
|
|
||||||
Voraussetzung SRC-01 (Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/search/reindex.go` — `Reindexer.Rebuild(ctx, onProgress)`:
|
|
||||||
1. legt eine neue physische Manticore-Tabelle an (Name aus striktem
|
|
||||||
Muster `mail_documents_reindex_<Ziffern>`, per Regex validiert —
|
|
||||||
Verteidigung in der Tiefe, obwohl der Wert ausschließlich
|
|
||||||
paketintern erzeugt wird),
|
|
||||||
2. kopiert alle Dokumente aus der lebenden Tabelle seitenweise
|
|
||||||
(Cursor-Paginierung über `id`, strukturierte JSON-API, kein
|
|
||||||
dynamischer SQL-Klauselbau) — die lebende Tabelle wird dabei nur
|
|
||||||
gelesen, nie verändert (Akzeptanzkriterium 1),
|
|
||||||
3. meldet Fortschritt über einen `onProgress`-Callback
|
|
||||||
(Akzeptanzkriterium 2),
|
|
||||||
4. vergleicht Trefferzahlen alt/neu — bei Abweichung kein Umschalten,
|
|
||||||
5. schaltet erst danach per Manticore `ALTER TABLE ... RENAME`
|
|
||||||
(reine Metadaten-Operation) atomar um. Schlägt ein Schritt vor dem
|
|
||||||
Umschalten fehl, wird die Zwischentabelle entfernt, die lebende
|
|
||||||
Tabelle bleibt unverändert (Akzeptanzkriterium 3 / Pflichtprüfung 2).
|
|
||||||
- Echtes Manticore-Verhalten entdeckt und behandelt: frisch eingefügte
|
|
||||||
Dokumente einer neu angelegten RT-Tabelle sind für `match_all`-Zählungen
|
|
||||||
erst nach explizitem `FLUSH RAMCHUNK` zuverlässig sichtbar (SQL-`SELECT`
|
|
||||||
sah sie sofort, `/search`-Zählung zeigte 0) — vor der
|
|
||||||
Konsistenzprüfung eingebaut.
|
|
||||||
- Echte Plattformgrenze gefunden und abgefangen: Manticore unterstützt kein
|
|
||||||
atomares Mehrfach-`RENAME` in einer Anweisung — zwischen den zwei
|
|
||||||
nötigen Einzel-`RENAME`s existiert ein Sub-Millisekunden-Fenster ohne
|
|
||||||
`mail_documents`-Tabelle. `Client.Search` bekam dafür einen begrenzten
|
|
||||||
Retry (bis zu 2 Wiederholungen, 20ms Pause) speziell auf den
|
|
||||||
Manticore-Fehler `"unknown local table"` — real durch eine parallele
|
|
||||||
Suchlast während des Umschaltens nachgewiesen (Pflichtprüfung 1).
|
|
||||||
- Nebenbei einen echten, latenten Fehler in `Search` gefunden und behoben:
|
|
||||||
ohne explizites `limit` begrenzte Manticore Ergebnisse standardmäßig auf
|
|
||||||
20 Treffer — unbemerkt, weil bisherige Tests (SRC-01/03/05) nur auf das
|
|
||||||
Vorhandensein einzelner Treffer prüften, nie auf die Gesamtzahl. Jetzt
|
|
||||||
`searchResultLimit = 1000`.
|
|
||||||
- Kein Umbau: `Index`/`Delete`/`Facets`-Verhalten sonst unverändert,
|
|
||||||
`mail/internal/dedup`/`indexworker`/`storage`/`crypto`/`encstorage`
|
|
||||||
unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test: Reindex während laufender Suchanfragen unterbricht die Suche nicht | **bestanden** – `TestRebuild_SearchKeepsWorkingDuringReindex`: 30 reale Dokumente indexiert, parallele Sucher-Goroutine (alle 2ms) läuft während `Rebuild` mit — 0 fehlgeschlagene Suchen über den gesamten Umschaltvorgang, danach weiterhin real alle 30 Treffer auffindbar |
|
|
||||||
| 2 | Test: abgebrochener Reindex hinterlässt keinen inkonsistenten Zustand | **bestanden** – `TestRebuild_AbortedReindexLeavesNoInconsistentState`: Kontext vor `Rebuild` abgebrochen, Fehler kommt real zurück, lebende Tabelle bleibt danach unverändert (weiterhin 1 Treffer real auffindbar), keine verwaisten Zwischentabellen über `SHOW TABLES` real bestätigt |
|
|
||||||
| 3 | Stichprobenvergleich Alt-/Neuindex bestätigt gleiche Trefferzahlen | **bestanden** – `TestRebuild_SampleComparisonMatchesOldAndNewIndex`: 3 unterschiedliche Suchbegriffe vor und nach Reindex real verglichen, identische Trefferzahlen je Stichprobe |
|
|
||||||
|
|
||||||
Zusätzlich (Akzeptanzkriterium 2): `TestRebuild_ReportsProgress` bestätigt
|
|
||||||
reale Fortschrittsmeldungen bis zum vollständigen Abschluss.
|
|
||||||
|
|
||||||
## 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 \
|
|
||||||
TEST_MANTICORE_URL=http://127.0.0.1:9308 \
|
|
||||||
go test ./... -v -p 1 -> alle Pakete bestanden, inkl. internal/search (14 Tests,
|
|
||||||
keine Regression in dedup/indexworker/storage/encstorage/example/mimeparse/pflichttestgate)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Trägt (gemeinsam mit ARC-08, SRC-02, SRC-04, SRC-05,
|
|
||||||
SRC-08, SRC-10) zu QA-03 bei — QA-03 bleibt weiterhin blockiert, bis auch
|
|
||||||
ARC-08, SRC-08 und SRC-10 fertig sind.
|
|
||||||
@@ -1,57 +0,0 @@
|
|||||||
# SRC-10 – Prüfprotokoll: Spracherkennung & OCR-Qualitätsbewertung
|
|
||||||
|
|
||||||
Voraussetzung SRC-07 (Fertig).
|
|
||||||
|
|
||||||
## Umsetzung
|
|
||||||
|
|
||||||
- `mail/internal/ocr/language.go` — `RecognizeWithLanguageAndConfidence`:
|
|
||||||
Tesseract erkennt bei kombinierten Sprachpaketen (`deu+eng`) nicht,
|
|
||||||
WELCHE Sprache vorlag — daher wird das Bild bewusst EINZELN mit jedem
|
|
||||||
Kandidaten (`deu`, `eng`) im TSV-Ausgabemodus erkannt; die Sprache mit
|
|
||||||
dem höheren durchschnittlichen Worterkennungs-Konfidenzwert gewinnt
|
|
||||||
(Akzeptanzkriterium 1). Derselbe Tesseract-TSV-Lauf liefert den
|
|
||||||
Konfidenzwert direkt mit (Akzeptanzkriterium 2, 0–100, Mittelwert über
|
|
||||||
alle erkannten Wörter) — keine zweite externe Bibliothek nötig.
|
|
||||||
- `mail/internal/search`: neue Felder `ocr_language`/`ocr_confidence`
|
|
||||||
(Migrationen 0006/0007, gleiches ALTER-Muster wie SRC-05), in
|
|
||||||
`Document`/`Result` gespiegelt (Akzeptanzkriterium 1: für Anzeige
|
|
||||||
nutzbar). Neue Methode `Client.AttachmentsBelowConfidence(ctx,
|
|
||||||
tenantSlug, threshold)` (Akzeptanzkriterium 3: gezielt für manuelle
|
|
||||||
Nachbearbeitung auffindbar) — filtert `ocr_confidence < threshold`,
|
|
||||||
schließt Dokumente ohne OCR-Anhang (`ocr_confidence` bleibt 0) explizit
|
|
||||||
aus.
|
|
||||||
- Echten Regressionsbug beim eigenen Testlauf gefunden und behoben:
|
|
||||||
`reindex.go`s `buildCreateTableSQL` (SRC-09) kannte die neuen
|
|
||||||
OCR-Spalten nicht — ein Reindex nach dieser Kachel wäre mit "unknown
|
|
||||||
column" fehlgeschlagen. Jetzt ergänzt, mit Wartungshinweis im
|
|
||||||
Quelltext für künftige Schema-Erweiterungen.
|
|
||||||
- Kein Umbau: `Search`/`Facets`/`SearchWithFilters`/`Index`/`Delete`-
|
|
||||||
Verhalten sonst unverändert, `mail/internal/dedup`/`indexworker`/
|
|
||||||
`storage`/`crypto`/`encstorage`/`savedsearch` unverändert.
|
|
||||||
|
|
||||||
## Prüfungen
|
|
||||||
|
|
||||||
| # | Prüfung | Ergebnis |
|
|
||||||
|---|---|---|
|
|
||||||
| 1 | Test mit mehrsprachigem Testkorpus bestätigt korrekte Spracherkennung | **bestanden** – `TestRecognizeWithLanguageAndConfidence_MultilingualCorpus`: reales deutsches Testbild ("Rechnung ueber Lieferung...") real als `deu` erkannt, reales englisches Testbild ("Invoice for delivery...") real als `eng` erkannt |
|
|
||||||
| 2 | Test: künstlich verschlechtertes Bild erzeugt niedrigeren Konfidenzwert | **bestanden** – `TestRecognizeWithLanguageAndConfidence_DegradedImageLowersConfidence`: reproduzierbare Pixelierung + Kontrastreduktion (reiner Go-Standardbibliothekscode, kein externes Werkzeug) senkt den real gemessenen Konfidenzwert von 91,76 auf 28,21 |
|
|
||||||
| 3 | Abfrage aller Anhänge unterhalb einer Konfidenzschwelle liefert erwartete Treffer | **bestanden** – `TestAttachmentsBelowConfidence_QueryReturnsExpectedResults`: 4 Dokumente (2 niedrig-, 1 hoch-konfident, 1 ohne OCR-Anhang), Abfrage mit Schwelle 50 liefert real genau die 2 niedrig-konfidenten, weder den hoch-konfidenten noch den ohne OCR-Anhang |
|
|
||||||
|
|
||||||
## Build/Test-Ergebnis (192.168.1.131)
|
|
||||||
|
|
||||||
```
|
|
||||||
go build ./... -> clean
|
|
||||||
go vet ./... -> clean
|
|
||||||
golangci-lint run ./... -> 0 issues
|
|
||||||
go test ./internal/ocr/... -v -run 'Language|Degraded' -> 2/2 bestanden
|
|
||||||
TEST_TENANT_DSN=... TEST_MANTICORE_URL=... go test ./... -p 1
|
|
||||||
-> alle Pakete bestanden (Regressionsbug in reindex.go vor diesem
|
|
||||||
Protokoll gefunden und behoben, danach vollständig grün)
|
|
||||||
```
|
|
||||||
|
|
||||||
## Gesamtergebnis
|
|
||||||
|
|
||||||
**Bestanden.** Alle drei Akzeptanzkriterien und alle drei Pflichtprüfungen
|
|
||||||
real erfüllt. Entsperrt QA-03 (gemeinsam mit ARC-08, SRC-02, SRC-04,
|
|
||||||
SRC-05, SRC-08, SRC-09 — alle jetzt Fertig, letzte fehlende
|
|
||||||
Abhängigkeit).
|
|
||||||
@@ -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,144 +0,0 @@
|
|||||||
// ARC-08: Tenant-KEK-Rotation. Core (API-10, `internal/kek.Store.
|
|
||||||
// RotateTenantKEK`) ersetzt den Tenant-KEK durch einen komplett neuen
|
|
||||||
// Wert — Core selbst hält KEINE Historie vor, `TenantKEKHandler` liefert
|
|
||||||
// immer nur den AKTUELLEN Schlüssel (siehe kekprovider.go). Damit ARC-08s
|
|
||||||
// Akzeptanzkriterium 3 ("alte Schlüsselversionen bleiben für
|
|
||||||
// Lesezugriff kontrolliert verfügbar") erfüllbar ist, muss Mail selbst
|
|
||||||
// jeden von Core bezogenen Tenant-KEK versioniert zwischenspeichern —
|
|
||||||
// KEKVersionStore übernimmt genau das, lokal mit einem eigenen,
|
|
||||||
// ausschließlich über Umgebungsvariable bezogenen Wrap-Schlüssel
|
|
||||||
// verschlüsselt (kein Klartext-KEK in der Datenbank).
|
|
||||||
package crypto
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrKEKVersionNotFound wird geliefert, wenn die angefragte Version für
|
|
||||||
// den Mandanten nicht existiert.
|
|
||||||
var ErrKEKVersionNotFound = errors.New("crypto: kek-version nicht gefunden")
|
|
||||||
|
|
||||||
// ErrKEKVersionRevoked wird geliefert, wenn die angefragte Version gezielt
|
|
||||||
// gesperrt wurde (Pflichtprüfung 2: kompromittierter alter Schlüssel kann
|
|
||||||
// gezielt gesperrt werden) — der Lesezugriff auf mit dieser Version
|
|
||||||
// verschlüsselte Altobjekte ist dann bewusst blockiert.
|
|
||||||
var ErrKEKVersionRevoked = errors.New("crypto: kek-version wurde gesperrt")
|
|
||||||
|
|
||||||
// KEKVersionStore verwaltet die Versionshistorie der Tenant-KEKs, die
|
|
||||||
// dieses Mail-Modul im Lauf der Zeit von Core bezogen hat.
|
|
||||||
type KEKVersionStore struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
localWrapKey []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewKEKVersionStore erzeugt einen Store. localWrapKey verschlüsselt die
|
|
||||||
// zwischengespeicherten Tenant-KEKs lokal at rest (KEKSize Bytes,
|
|
||||||
// ausschließlich über Umgebungsvariable bezogen — nie im Code).
|
|
||||||
func NewKEKVersionStore(pool *pgxpool.Pool, localWrapKey []byte) *KEKVersionStore {
|
|
||||||
return &KEKVersionStore{pool: pool, localWrapKey: localWrapKey}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
|
||||||
// gleiches Muster wie mail/internal/dedup/indexworker (kein zentraler
|
|
||||||
// Migrationsläufer für Mandanten-Datenbanken im Mail-Modul vorhanden).
|
|
||||||
func (s *KEKVersionStore) EnsureSchema(ctx context.Context) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
CREATE TABLE IF NOT EXISTS mail_kek_versions (
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
version INT NOT NULL,
|
|
||||||
wrapped_kek BYTEA NOT NULL,
|
|
||||||
revoked BOOLEAN NOT NULL DEFAULT false,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (tenant_slug, version)
|
|
||||||
)
|
|
||||||
`); err != nil {
|
|
||||||
return fmt.Errorf("crypto: kek-versionsschema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// RecordIfNew merkt sich plainKEK als neue Version für tenantSlug, FALLS
|
|
||||||
// er sich vom zuletzt gespeicherten Wert unterscheidet (Rotation
|
|
||||||
// erkannt) — bei unverändertem KEK wird keine neue Version angelegt,
|
|
||||||
// sondern die bestehende Versionsnummer zurückgegeben (Akzeptanzkriterium
|
|
||||||
// 1: rotierbar verwaltet, nicht bei jedem Aufruf eine neue Version).
|
|
||||||
func (s *KEKVersionStore) RecordIfNew(ctx context.Context, tenantSlug string, plainKEK []byte) (version int, err error) {
|
|
||||||
var latestVersion int
|
|
||||||
var latestWrapped []byte
|
|
||||||
err = s.pool.QueryRow(ctx, `
|
|
||||||
SELECT version, wrapped_kek FROM mail_kek_versions
|
|
||||||
WHERE tenant_slug = $1 ORDER BY version DESC LIMIT 1
|
|
||||||
`, tenantSlug).Scan(&latestVersion, &latestWrapped)
|
|
||||||
switch {
|
|
||||||
case errors.Is(err, pgx.ErrNoRows):
|
|
||||||
return s.insertVersion(ctx, tenantSlug, 1, plainKEK)
|
|
||||||
case err != nil:
|
|
||||||
return 0, fmt.Errorf("crypto: letzte kek-version lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
latestPlain, err := open(s.localWrapKey, latestWrapped)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("crypto: zwischengespeicherten kek entpacken: %w", err)
|
|
||||||
}
|
|
||||||
if bytes.Equal(latestPlain, plainKEK) {
|
|
||||||
return latestVersion, nil
|
|
||||||
}
|
|
||||||
return s.insertVersion(ctx, tenantSlug, latestVersion+1, plainKEK)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *KEKVersionStore) insertVersion(ctx context.Context, tenantSlug string, version int, plainKEK []byte) (int, error) {
|
|
||||||
wrapped, err := seal(s.localWrapKey, plainKEK)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("crypto: kek für zwischenspeicherung verpacken: %w", err)
|
|
||||||
}
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO mail_kek_versions (tenant_slug, version, wrapped_kek) VALUES ($1, $2, $3)
|
|
||||||
`, tenantSlug, version, wrapped); err != nil {
|
|
||||||
return 0, fmt.Errorf("crypto: kek-version speichern: %w", err)
|
|
||||||
}
|
|
||||||
return version, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert den entschlüsselten historischen Tenant-KEK einer
|
|
||||||
// bestimmten Version. Liefert ErrKEKVersionRevoked, wenn die Version
|
|
||||||
// gezielt gesperrt wurde (Pflichtprüfung 2).
|
|
||||||
func (s *KEKVersionStore) Get(ctx context.Context, tenantSlug string, version int) ([]byte, error) {
|
|
||||||
var wrapped []byte
|
|
||||||
var revoked bool
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT wrapped_kek, revoked FROM mail_kek_versions
|
|
||||||
WHERE tenant_slug = $1 AND version = $2
|
|
||||||
`, tenantSlug, version).Scan(&wrapped, &revoked)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return nil, ErrKEKVersionNotFound
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("crypto: kek-version lesen: %w", err)
|
|
||||||
}
|
|
||||||
if revoked {
|
|
||||||
return nil, ErrKEKVersionRevoked
|
|
||||||
}
|
|
||||||
return open(s.localWrapKey, wrapped)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Revoke sperrt eine Tenant-KEK-Version gezielt (Pflichtprüfung 2):
|
|
||||||
// nachfolgende Get-Aufrufe für genau diese Version schlagen mit
|
|
||||||
// ErrKEKVersionRevoked fehl, andere Versionen bleiben unberührt.
|
|
||||||
func (s *KEKVersionStore) Revoke(ctx context.Context, tenantSlug string, version int) error {
|
|
||||||
tag, err := s.pool.Exec(ctx, `
|
|
||||||
UPDATE mail_kek_versions SET revoked = true WHERE tenant_slug = $1 AND version = $2
|
|
||||||
`, tenantSlug, version)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("crypto: kek-version sperren: %w", err)
|
|
||||||
}
|
|
||||||
if tag.RowsAffected() == 0 {
|
|
||||||
return ErrKEKVersionNotFound
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,111 +0,0 @@
|
|||||||
// Integrationstest (ARC-08): echte Postgres-Instanz, folgt derselben
|
|
||||||
// Testhost-Konvention wie mail/internal/dedup/indexworker — TEST_TENANT_DSN.
|
|
||||||
package crypto
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
var testLocalWrapKey = bytes.Repeat([]byte{0x7a}, KEKSize)
|
|
||||||
|
|
||||||
func setupKEKVersionStore(t *testing.T, tenantSlug string) *KEKVersionStore {
|
|
||||||
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 := NewKEKVersionStore(pool, testLocalWrapKey)
|
|
||||||
if err := store.EnsureSchema(ctx); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_kek_versions WHERE tenant_slug = $1`, tenantSlug)
|
|
||||||
})
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestKEKVersionStore_RecordIfNewDetectsRotationOnly(t *testing.T) {
|
|
||||||
tenant := "mandant-arc08-recordifnew"
|
|
||||||
store := setupKEKVersionStore(t, tenant)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
kekV1 := bytes.Repeat([]byte{0x01}, KEKSize)
|
|
||||||
v1, err := store.RecordIfNew(ctx, tenant, kekV1)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erste erfassung: %v", err)
|
|
||||||
}
|
|
||||||
if v1 != 1 {
|
|
||||||
t.Fatalf("erwartete version 1, habe %d", v1)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Erneuter Aufruf mit UNVERÄNDERTEM KEK darf keine neue Version anlegen.
|
|
||||||
vAgain, err := store.RecordIfNew(ctx, tenant, kekV1)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zweite erfassung (unverändert): %v", err)
|
|
||||||
}
|
|
||||||
if vAgain != 1 {
|
|
||||||
t.Fatalf("erwartete weiterhin version 1 bei unverändertem kek, habe %d", vAgain)
|
|
||||||
}
|
|
||||||
|
|
||||||
kekV2 := bytes.Repeat([]byte{0x02}, KEKSize)
|
|
||||||
v2, err := store.RecordIfNew(ctx, tenant, kekV2)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("dritte erfassung (rotiert): %v", err)
|
|
||||||
}
|
|
||||||
if v2 != 2 {
|
|
||||||
t.Fatalf("erwartete version 2 nach rotation, habe %d", v2)
|
|
||||||
}
|
|
||||||
|
|
||||||
gotV1, err := store.Get(ctx, tenant, 1)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get v1: %v", err)
|
|
||||||
}
|
|
||||||
if !bytes.Equal(gotV1, kekV1) {
|
|
||||||
t.Fatal("v1 liefert nicht den ursprünglichen kek zurück")
|
|
||||||
}
|
|
||||||
gotV2, err := store.Get(ctx, tenant, 2)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get v2: %v", err)
|
|
||||||
}
|
|
||||||
if !bytes.Equal(gotV2, kekV2) {
|
|
||||||
t.Fatal("v2 liefert nicht den rotierten kek zurück")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestKEKVersionStore_RevokeBlocksOnlyThatVersion(t *testing.T) {
|
|
||||||
tenant := "mandant-arc08-revoke"
|
|
||||||
store := setupKEKVersionStore(t, tenant)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
kekV1 := bytes.Repeat([]byte{0x11}, KEKSize)
|
|
||||||
kekV2 := bytes.Repeat([]byte{0x22}, KEKSize)
|
|
||||||
if _, err := store.RecordIfNew(ctx, tenant, kekV1); err != nil {
|
|
||||||
t.Fatalf("v1 erfassen: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := store.RecordIfNew(ctx, tenant, kekV2); err != nil {
|
|
||||||
t.Fatalf("v2 erfassen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Revoke(ctx, tenant, 1); err != nil {
|
|
||||||
t.Fatalf("v1 sperren: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Get(ctx, tenant, 1); err != ErrKEKVersionRevoked {
|
|
||||||
t.Fatalf("erwartete ErrKEKVersionRevoked für gesperrte version 1, habe: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := store.Get(ctx, tenant, 2); err != nil {
|
|
||||||
t.Fatalf("version 2 sollte unberührt bleiben: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,131 +0,0 @@
|
|||||||
// ARC-08: End-zu-Ende-Rotationstest. Nutzt einen fake KEKProvider (echter
|
|
||||||
// Testkonvention aus ARC-02, siehe encstorage_test.go) statt eines echten
|
|
||||||
// HTTP-Aufrufs an Core API-12 — Core selbst hat keine rotierbare
|
|
||||||
// Testschnittstelle über HTTP exponiert (nur der aktuelle KEK ist
|
|
||||||
// abrufbar), die Rotation wird hier auf Höhe der KEKProvider-Schnittstelle
|
|
||||||
// simuliert, exakt wie ARC-02 es für Fehlerfälle bereits tut.
|
|
||||||
package crypto
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"io"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// rotatableKEKProvider liefert für einen Mandanten einen aktuell
|
|
||||||
// gesetzten KEK, der zur Laufzeit "rotiert" werden kann (simuliert Core
|
|
||||||
// API-10s RotateTenantKEK, dessen Effekt auf API-12 exakt darin besteht,
|
|
||||||
// dass TenantKEK ab dann einen anderen Wert liefert).
|
|
||||||
type rotatableKEKProvider struct {
|
|
||||||
mu sync.Mutex
|
|
||||||
current []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *rotatableKEKProvider) TenantKEK(_ context.Context, _ string) ([]byte, error) {
|
|
||||||
p.mu.Lock()
|
|
||||||
defer p.mu.Unlock()
|
|
||||||
return p.current, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (p *rotatableKEKProvider) rotate(newKEK []byte) {
|
|
||||||
p.mu.Lock()
|
|
||||||
defer p.mu.Unlock()
|
|
||||||
p.current = newKEK
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation ist die
|
|
||||||
// geforderte Pflichtprüfung 1: Rotation des Hauptschlüssels lässt
|
|
||||||
// Altbestand weiterhin lesbar.
|
|
||||||
func TestRotation_OldArchiveStaysReadableAfterMasterKeyRotation(t *testing.T) {
|
|
||||||
tenant := "mandant-arc08-rotation-lesbar"
|
|
||||||
store := setupKEKVersionStore(t, tenant)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
provider := &rotatableKEKProvider{current: bytes.Repeat([]byte{0x51}, KEKSize)}
|
|
||||||
svc := NewService(provider).WithVersionStore(store)
|
|
||||||
|
|
||||||
// Objekt VOR der Rotation versiegeln.
|
|
||||||
oldEnvelope, err := svc.Seal(ctx, tenant, strings.NewReader("altbestand vor rotation"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("seal (alt): %v", err)
|
|
||||||
}
|
|
||||||
if oldEnvelope.KEKVersion != 1 {
|
|
||||||
t.Fatalf("erwartete kek-version 1 vor rotation, habe %d", oldEnvelope.KEKVersion)
|
|
||||||
}
|
|
||||||
oldCiphertext, err := io.ReadAll(oldEnvelope.Ciphertext)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("chiffretext (alt) lesen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Core rotiert den Tenant-Hauptschlüssel — TenantKEK liefert ab jetzt
|
|
||||||
// einen komplett anderen Wert, exakt wie internal/kek.Store.
|
|
||||||
// RotateTenantKEK es real bei Core bewirkt.
|
|
||||||
provider.rotate(bytes.Repeat([]byte{0x52}, KEKSize))
|
|
||||||
|
|
||||||
// Objekt NACH der Rotation versiegeln (Akzeptanzkriterium 2: kein
|
|
||||||
// Neuverschlüsseln des Altbestands nötig, nur neue Objekte nutzen den
|
|
||||||
// neuen Schlüssel).
|
|
||||||
newEnvelope, err := svc.Seal(ctx, tenant, strings.NewReader("neuer inhalt nach rotation"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("seal (neu): %v", err)
|
|
||||||
}
|
|
||||||
if newEnvelope.KEKVersion != 2 {
|
|
||||||
t.Fatalf("erwartete kek-version 2 nach rotation, habe %d", newEnvelope.KEKVersion)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Altbestand bleibt über die aufgezeichnete Version lesbar
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
openedOld, err := svc.OpenAtVersion(ctx, tenant, oldEnvelope.KEKVersion, oldEnvelope.WrappedDEK, bytes.NewReader(oldCiphertext))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("openatversion (alt, nach rotation): %v", err)
|
|
||||||
}
|
|
||||||
plainOld, err := io.ReadAll(openedOld)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("altbestand lesen: %v", err)
|
|
||||||
}
|
|
||||||
if string(plainOld) != "altbestand vor rotation" {
|
|
||||||
t.Fatalf("altbestand-inhalt stimmt nicht, habe %q", string(plainOld))
|
|
||||||
}
|
|
||||||
|
|
||||||
// Der naive Open() (aktueller KEK) darf für das ALTE Objekt inzwischen
|
|
||||||
// NICHT mehr funktionieren — das beweist, dass OpenAtVersion die
|
|
||||||
// Rotation tatsächlich überbrückt, statt zufällig auch so zu klappen.
|
|
||||||
if _, err := svc.Open(ctx, tenant, oldEnvelope.WrappedDEK, bytes.NewReader(oldCiphertext)); err == nil {
|
|
||||||
t.Fatal("erwartete fehler bei Open() des altbestands mit dem NEUEN aktuellen kek, habe nil")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRotation_CompromisedOldKeyCanBeRevoked ist die geforderte
|
|
||||||
// Pflichtprüfung 2: kompromittierter alter Schlüssel kann gezielt
|
|
||||||
// gesperrt werden.
|
|
||||||
func TestRotation_CompromisedOldKeyCanBeRevoked(t *testing.T) {
|
|
||||||
tenant := "mandant-arc08-revoke-e2e"
|
|
||||||
store := setupKEKVersionStore(t, tenant)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
provider := &rotatableKEKProvider{current: bytes.Repeat([]byte{0x61}, KEKSize)}
|
|
||||||
svc := NewService(provider).WithVersionStore(store)
|
|
||||||
|
|
||||||
compromisedEnvelope, err := svc.Seal(ctx, tenant, strings.NewReader("mit kompromittiertem schlüssel versiegelt"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("seal: %v", err)
|
|
||||||
}
|
|
||||||
compromisedCiphertext, err := io.ReadAll(compromisedEnvelope.Ciphertext)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("chiffretext lesen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
provider.rotate(bytes.Repeat([]byte{0x62}, KEKSize))
|
|
||||||
|
|
||||||
if err := store.Revoke(ctx, tenant, compromisedEnvelope.KEKVersion); err != nil {
|
|
||||||
t.Fatalf("kompromittierte version sperren: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, err = svc.OpenAtVersion(ctx, tenant, compromisedEnvelope.KEKVersion, compromisedEnvelope.WrappedDEK, bytes.NewReader(compromisedCiphertext))
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("erwartete fehler beim lesen mit gesperrter kek-version, habe nil")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,114 +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).
|
|
||||||
// KEKVersion identifiziert (ARC-08), MIT welcher Tenant-KEK-Version der
|
|
||||||
// DEK verpackt wurde — 0, solange kein KEKVersionStore konfiguriert ist
|
|
||||||
// (Rückwärtskompatibilität, siehe WithVersionStore).
|
|
||||||
type Envelope struct {
|
|
||||||
Ciphertext io.Reader
|
|
||||||
WrappedDEK []byte
|
|
||||||
KEKVersion int
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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
|
|
||||||
versions *KEKVersionStore
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewService(kek KEKProvider) *Service {
|
|
||||||
return &Service{kek: kek}
|
|
||||||
}
|
|
||||||
|
|
||||||
// WithVersionStore aktiviert die Tenant-KEK-Versionsverfolgung (ARC-08).
|
|
||||||
// Ohne aufgerufenes WithVersionStore verhält sich Service exakt wie vor
|
|
||||||
// ARC-08 (KEKVersion bleibt 0, OpenAtVersion fällt auf Open zurück) —
|
|
||||||
// bestehende Aufrufer (z. B. encstorage) sind unverändert lauffähig.
|
|
||||||
func (s *Service) WithVersionStore(store *KEKVersionStore) *Service {
|
|
||||||
s.versions = store
|
|
||||||
return s
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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 außer in der optionalen
|
|
||||||
// KEK-Versionshistorie für spätere Altbestands-Lesezugriffe).
|
|
||||||
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
|
|
||||||
}
|
|
||||||
|
|
||||||
var kekVersion int
|
|
||||||
if s.versions != nil {
|
|
||||||
kekVersion, err = s.versions.RecordIfNew(ctx, tenantSlug, kek)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: kek-version erfassen: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return &Envelope{Ciphertext: ciphertext, WrappedDEK: wrappedDEK, KEKVersion: kekVersion}, 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. Nach einer Tenant-KEK-Rotation bei
|
|
||||||
// Core funktioniert Open nur noch für Objekte, die mit dem NEUEN KEK
|
|
||||||
// versiegelt wurden — für Altbestand siehe OpenAtVersion.
|
|
||||||
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)
|
|
||||||
}
|
|
||||||
|
|
||||||
// OpenAtVersion entpackt den DEK mit der beim Seal aufgezeichneten
|
|
||||||
// historischen Tenant-KEK-Version statt mit dem aktuellen Core-KEK
|
|
||||||
// (ARC-08 Akzeptanzkriterium 3: Altbestand bleibt nach einer
|
|
||||||
// Hauptschlüssel-Rotation lesbar). Ist kekVersion 0 oder kein
|
|
||||||
// KEKVersionStore konfiguriert, verhält es sich wie Open (Rückwärts-
|
|
||||||
// kompatibilität für vor ARC-08 versiegelte Objekte).
|
|
||||||
func (s *Service) OpenAtVersion(ctx context.Context, tenantSlug string, kekVersion int, wrappedDEK []byte, ciphertext io.Reader) (io.Reader, error) {
|
|
||||||
if kekVersion == 0 || s.versions == nil {
|
|
||||||
return s.Open(ctx, tenantSlug, wrappedDEK, ciphertext)
|
|
||||||
}
|
|
||||||
kek, err := s.versions.Get(ctx, tenantSlug, kekVersion)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("crypto: historischen 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,138 +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"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"io"
|
|
||||||
"strconv"
|
|
||||||
|
|
||||||
"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"
|
|
||||||
}
|
|
||||||
|
|
||||||
// kekVersionKey ist der Sidecar-Objektschlüssel für die Tenant-KEK-
|
|
||||||
// Version, mit der der DEK verpackt wurde (ARC-08 Akzeptanzkriterium 3).
|
|
||||||
// Fehlt dieser Sidecar (vor ARC-08 geschriebene Objekte), wird Version 0
|
|
||||||
// angenommen — GetDecrypted verhält sich dann wie vor ARC-08.
|
|
||||||
func kekVersionKey(key string) string {
|
|
||||||
return key + ".dek.version"
|
|
||||||
}
|
|
||||||
|
|
||||||
// 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)
|
|
||||||
}
|
|
||||||
if env.KEKVersion != 0 {
|
|
||||||
versionBytes := []byte(strconv.Itoa(env.KEKVersion))
|
|
||||||
if _, err := s.storage.Put(ctx, kekVersionKey(key), bytes.NewReader(versionBytes), int64(len(versionBytes)), "text/plain"); err != nil {
|
|
||||||
return fmt.Errorf("encstorage: kek-version 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)
|
|
||||||
}
|
|
||||||
|
|
||||||
kekVersion, err := s.readKEKVersion(ctx, key)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
plaintextReader, err := s.crypto.OpenAtVersion(ctx, tenantSlug, kekVersion, wrappedDEK, bytes.NewReader(ciphertext))
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
return io.ReadAll(plaintextReader)
|
|
||||||
}
|
|
||||||
|
|
||||||
// readKEKVersion liest den Versions-Sidecar (ARC-08). Fehlt er (vor
|
|
||||||
// ARC-08 geschriebene Objekte, oder ein Seal ohne konfigurierten
|
|
||||||
// KEKVersionStore), gilt Version 0 — crypto.Service.OpenAtVersion fällt
|
|
||||||
// dafür auf das unveränderte Open-Verhalten zurück.
|
|
||||||
func (s *Service) readKEKVersion(ctx context.Context, key string) (int, error) {
|
|
||||||
reader, err := s.storage.Get(ctx, kekVersionKey(key))
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, storage.ErrNotFound) {
|
|
||||||
return 0, nil
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("encstorage: kek-version lesen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = reader.Close() }()
|
|
||||||
raw, err := io.ReadAll(reader)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("encstorage: kek-version lesen: %w", err)
|
|
||||||
}
|
|
||||||
version, err := strconv.Atoi(string(raw))
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("encstorage: kek-version parsen: %w", err)
|
|
||||||
}
|
|
||||||
return version, nil
|
|
||||||
}
|
|
||||||
@@ -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,9 +0,0 @@
|
|||||||
CREATE TABLE IF NOT EXISTS mail_folder_state (
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
mailbox_name TEXT NOT NULL,
|
|
||||||
uidvalidity BIGINT NOT NULL,
|
|
||||||
uidnext BIGINT NOT NULL,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (tenant_slug, mailbox_name)
|
|
||||||
)
|
|
||||||
@@ -1,8 +0,0 @@
|
|||||||
CREATE TABLE IF NOT EXISTS mail_folder_state_events (
|
|
||||||
id BIGSERIAL PRIMARY KEY,
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
mailbox_name TEXT NOT NULL,
|
|
||||||
event_type TEXT NOT NULL CHECK (event_type IN ('uid_assigned', 'deleted', 'rebuilt')),
|
|
||||||
uid BIGINT,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
)
|
|
||||||
@@ -1,251 +0,0 @@
|
|||||||
// Package folderstate implementiert ING-05: Folder-State-Verwaltung
|
|
||||||
// inklusive UIDVALIDITY/UIDNEXT-Handling für IMAP-Ordner (RFC 3501
|
|
||||||
// §2.3.1.1), damit Clients (mail/internal/imap, ING-01) und
|
|
||||||
// Importvorgänge (IMP-01) konsistente Sichten erhalten. Persistiert in
|
|
||||||
// Postgres, gleiches Muster wie mail/internal/dedup/indexworker/
|
|
||||||
// savedsearch — kein zentraler Migrationsläufer für Mandanten-
|
|
||||||
// Datenbanken im Mail-Modul vorhanden, EnsureSchema legt die Tabellen
|
|
||||||
// idempotent an.
|
|
||||||
//
|
|
||||||
// Bekannten Fehler vermeiden (siehe ING-01/repos-analyse-mail-reuse.md):
|
|
||||||
// archivmail brach den Resync bei UIDVALIDITY=0 nicht-konformer Server —
|
|
||||||
// dieses Paket erzeugt UIDVALIDITY selbst (Unix-Zeitstempel beim
|
|
||||||
// Ordner-Neuaufbau, garantiert > 0 und monoton wachsend über
|
|
||||||
// aufeinanderfolgende Neuaufbauten hinweg) statt einen von außen
|
|
||||||
// gelieferten Wert unbesehen zu übernehmen.
|
|
||||||
package folderstate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
_ "embed"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
//go:embed migrations/0001_mail_folder_state.sql
|
|
||||||
var schemaMigration string
|
|
||||||
|
|
||||||
//go:embed migrations/0002_mail_folder_state_events.sql
|
|
||||||
var eventsSchemaMigration string
|
|
||||||
|
|
||||||
// EventType (Akzeptanzkriterium 3: State-Änderungen nachvollziehbar
|
|
||||||
// persistiert).
|
|
||||||
const (
|
|
||||||
EventUIDAssigned = "uid_assigned"
|
|
||||||
EventDeleted = "deleted"
|
|
||||||
EventRebuilt = "rebuilt"
|
|
||||||
)
|
|
||||||
|
|
||||||
// FolderState ist der aktuelle UIDVALIDITY/UIDNEXT-Zustand eines Ordners.
|
|
||||||
type FolderState struct {
|
|
||||||
TenantSlug string
|
|
||||||
MailboxName string
|
|
||||||
UIDValidity uint64
|
|
||||||
UIDNext uint64
|
|
||||||
}
|
|
||||||
|
|
||||||
// Event ist ein einzelner, nachvollziehbarer Zustandsänderungseintrag.
|
|
||||||
type Event struct {
|
|
||||||
EventType string
|
|
||||||
UID *uint64
|
|
||||||
CreatedAt time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store verwaltet Folder-State je Mandant und Postfach.
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
// now ist austauschbar für Tests (deterministische UIDVALIDITY-Werte).
|
|
||||||
now func() time.Time
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool, now: time.Now}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnsureSchema legt die Tabellen an, falls sie noch nicht existieren.
|
|
||||||
func (s *Store) EnsureSchema(ctx context.Context) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, schemaMigration); err != nil {
|
|
||||||
return fmt.Errorf("folderstate: schema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
if _, err := s.pool.Exec(ctx, eventsSchemaMigration); err != nil {
|
|
||||||
return fmt.Errorf("folderstate: ereignis-schema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetOrCreate liefert den aktuellen Zustand eines Ordners und legt ihn
|
|
||||||
// bei erstem Zugriff neu an (UIDNEXT beginnt bei 1, RFC 3501 §2.3.1.1).
|
|
||||||
// Konsistent bei parallelem Zugriff (Akzeptanzkriterium 2): INSERT ...
|
|
||||||
// ON CONFLICT DO NOTHING + Rücklese, kein Lese-dann-Schreib-Fenster.
|
|
||||||
func (s *Store) GetOrCreate(ctx context.Context, tenantSlug, mailboxName string) (FolderState, error) {
|
|
||||||
uidvalidity := s.newUIDValidity()
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO mail_folder_state (tenant_slug, mailbox_name, uidvalidity, uidnext)
|
|
||||||
VALUES ($1, $2, $3, 1)
|
|
||||||
ON CONFLICT (tenant_slug, mailbox_name) DO NOTHING
|
|
||||||
`, tenantSlug, mailboxName, uidvalidity); err != nil {
|
|
||||||
return FolderState{}, fmt.Errorf("folderstate: ordner anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return s.CurrentState(ctx, tenantSlug, mailboxName)
|
|
||||||
}
|
|
||||||
|
|
||||||
// CurrentState liest den Zustand ohne ihn anzulegen (Akzeptanzkriterium
|
|
||||||
// 2: konsistente Sicht bei SELECT/EXAMINE).
|
|
||||||
func (s *Store) CurrentState(ctx context.Context, tenantSlug, mailboxName string) (FolderState, error) {
|
|
||||||
var st FolderState
|
|
||||||
st.TenantSlug = tenantSlug
|
|
||||||
st.MailboxName = mailboxName
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT uidvalidity, uidnext FROM mail_folder_state
|
|
||||||
WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
`, tenantSlug, mailboxName).Scan(&st.UIDValidity, &st.UIDNext)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return FolderState{}, ErrNotFound
|
|
||||||
}
|
|
||||||
return FolderState{}, fmt.Errorf("folderstate: zustand lesen: %w", err)
|
|
||||||
}
|
|
||||||
return st, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ErrNotFound wird geliefert, wenn für den angefragten Ordner noch kein
|
|
||||||
// Zustand existiert (GetOrCreate anlegen lassen, statt hier zu raten).
|
|
||||||
var ErrNotFound = errors.New("folderstate: ordner nicht gefunden")
|
|
||||||
|
|
||||||
// NextUID vergibt atomar die nächste UID für eine neu eintreffende
|
|
||||||
// Nachricht (Akzeptanzkriterium 1/3) und protokolliert die Vergabe.
|
|
||||||
// Nebenläufigkeitssicher: UPDATE ... RETURNING läuft unter Postgres'
|
|
||||||
// Zeilensperre, zwei gleichzeitige Aufrufe für denselben Ordner können
|
|
||||||
// niemals dieselbe UID liefern (Pflichtprüfung 2).
|
|
||||||
func (s *Store) NextUID(ctx context.Context, tenantSlug, mailboxName string) (uid uint64, err error) {
|
|
||||||
tx, err := s.pool.Begin(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("folderstate: transaktion starten: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = tx.Rollback(ctx) }()
|
|
||||||
|
|
||||||
err = tx.QueryRow(ctx, `
|
|
||||||
UPDATE mail_folder_state
|
|
||||||
SET uidnext = uidnext + 1, updated_at = now()
|
|
||||||
WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
RETURNING uidnext - 1
|
|
||||||
`, tenantSlug, mailboxName).Scan(&uid)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return 0, ErrNotFound
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("folderstate: uid vergeben: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
INSERT INTO mail_folder_state_events (tenant_slug, mailbox_name, event_type, uid)
|
|
||||||
VALUES ($1, $2, $3, $4)
|
|
||||||
`, tenantSlug, mailboxName, EventUIDAssigned, uid); err != nil {
|
|
||||||
return 0, fmt.Errorf("folderstate: ereignis protokollieren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tx.Commit(ctx); err != nil {
|
|
||||||
return 0, fmt.Errorf("folderstate: uid-vergabe committen: %w", err)
|
|
||||||
}
|
|
||||||
return uid, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// RecordDeletion protokolliert die Löschung einer Nachricht mit
|
|
||||||
// gegebener UID (Akzeptanzkriterium 3). UIDNEXT bleibt unverändert —
|
|
||||||
// gelöschte UIDs werden gemäß RFC 3501 niemals wiederverwendet.
|
|
||||||
func (s *Store) RecordDeletion(ctx context.Context, tenantSlug, mailboxName string, uid uint64) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO mail_folder_state_events (tenant_slug, mailbox_name, event_type, uid)
|
|
||||||
VALUES ($1, $2, $3, $4)
|
|
||||||
`, tenantSlug, mailboxName, EventDeleted, uid); err != nil {
|
|
||||||
return fmt.Errorf("folderstate: löschung protokollieren: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Rebuild simuliert einen Ordner-Neuaufbau (z. B. nach erkannter
|
|
||||||
// Inkonsistenz oder bei einem Server, der seinerseits eine neue
|
|
||||||
// UIDVALIDITY meldet): vergibt eine garantiert neue UIDVALIDITY und
|
|
||||||
// setzt UIDNEXT zurück auf 1 (Pflichtprüfung 1).
|
|
||||||
func (s *Store) Rebuild(ctx context.Context, tenantSlug, mailboxName string) (FolderState, error) {
|
|
||||||
candidateUIDValidity := s.newUIDValidity()
|
|
||||||
|
|
||||||
tx, err := s.pool.Begin(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return FolderState{}, fmt.Errorf("folderstate: transaktion starten: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = tx.Rollback(ctx) }()
|
|
||||||
|
|
||||||
// GREATEST(...)+1 garantiert eine STRENG größere UIDVALIDITY als die
|
|
||||||
// bisherige, unabhängig von der Uhrenauflösung — zwei Neuaufbauten
|
|
||||||
// innerhalb derselben Nanosekunde dürfen niemals denselben Wert
|
|
||||||
// liefern (Pflichtprüfung 1).
|
|
||||||
var newUIDValidity uint64
|
|
||||||
err = tx.QueryRow(ctx, `
|
|
||||||
UPDATE mail_folder_state
|
|
||||||
SET uidvalidity = GREATEST(uidvalidity + 1, $3), uidnext = 1, updated_at = now()
|
|
||||||
WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
RETURNING uidvalidity
|
|
||||||
`, tenantSlug, mailboxName, candidateUIDValidity).Scan(&newUIDValidity)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return FolderState{}, ErrNotFound
|
|
||||||
}
|
|
||||||
return FolderState{}, fmt.Errorf("folderstate: neuaufbau: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
INSERT INTO mail_folder_state_events (tenant_slug, mailbox_name, event_type)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
`, tenantSlug, mailboxName, EventRebuilt); err != nil {
|
|
||||||
return FolderState{}, fmt.Errorf("folderstate: neuaufbau-ereignis protokollieren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tx.Commit(ctx); err != nil {
|
|
||||||
return FolderState{}, fmt.Errorf("folderstate: neuaufbau committen: %w", err)
|
|
||||||
}
|
|
||||||
return FolderState{TenantSlug: tenantSlug, MailboxName: mailboxName, UIDValidity: newUIDValidity, UIDNext: 1}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Events liefert die protokollierten Zustandsänderungen eines Ordners in
|
|
||||||
// zeitlicher Reihenfolge (Akzeptanzkriterium 3: nachvollziehbar).
|
|
||||||
func (s *Store) Events(ctx context.Context, tenantSlug, mailboxName string) ([]Event, error) {
|
|
||||||
rows, err := s.pool.Query(ctx, `
|
|
||||||
SELECT event_type, uid, created_at FROM mail_folder_state_events
|
|
||||||
WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
ORDER BY id ASC
|
|
||||||
`, tenantSlug, mailboxName)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("folderstate: ereignisse lesen: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var events []Event
|
|
||||||
for rows.Next() {
|
|
||||||
var e Event
|
|
||||||
var uid *int64
|
|
||||||
if err := rows.Scan(&e.EventType, &uid, &e.CreatedAt); err != nil {
|
|
||||||
return nil, fmt.Errorf("folderstate: ereigniszeile lesen: %w", err)
|
|
||||||
}
|
|
||||||
if uid != nil {
|
|
||||||
u := uint64(*uid)
|
|
||||||
e.UID = &u
|
|
||||||
}
|
|
||||||
events = append(events, e)
|
|
||||||
}
|
|
||||||
if err := rows.Err(); err != nil {
|
|
||||||
return nil, fmt.Errorf("folderstate: ereignisse iterieren: %w", err)
|
|
||||||
}
|
|
||||||
return events, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// newUIDValidity erzeugt eine garantiert positive, für praktische Zwecke
|
|
||||||
// eindeutige UIDVALIDITY (Unix-Nanosekunden) — vermeidet den bekannten
|
|
||||||
// archivmail-Fehler UIDVALIDITY=0.
|
|
||||||
func (s *Store) newUIDValidity() uint64 {
|
|
||||||
return uint64(s.now().UnixNano())
|
|
||||||
}
|
|
||||||
@@ -1,176 +0,0 @@
|
|||||||
// Integrationstest (ING-05): echte Postgres-Instanz, folgt derselben
|
|
||||||
// Testhost-Konvention wie mail/internal/dedup/indexworker/savedsearch —
|
|
||||||
// TEST_TENANT_DSN.
|
|
||||||
package folderstate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStore(t *testing.T) *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)
|
|
||||||
if err := store.EnsureSchema(ctx); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
ctx := context.Background()
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM mail_folder_state WHERE tenant_slug LIKE 'mandant-ing05-%'`)
|
|
||||||
_, _ = pool.Exec(ctx, `DELETE FROM mail_folder_state_events WHERE tenant_slug LIKE 'mandant-ing05-%'`)
|
|
||||||
})
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRebuild_ChangesUIDValidityOnSimulatedFolderRebuild ist die
|
|
||||||
// geforderte Pflichtprüfung 1: automatisierter Test für
|
|
||||||
// UIDVALIDITY-Änderung bei simuliertem Ordner-Neuaufbau.
|
|
||||||
func TestRebuild_ChangesUIDValidityOnSimulatedFolderRebuild(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-ing05-rebuild"
|
|
||||||
|
|
||||||
initial, err := store.GetOrCreate(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("getorcreate: %v", err)
|
|
||||||
}
|
|
||||||
if initial.UIDValidity == 0 {
|
|
||||||
t.Fatal("erwartete uidvalidity != 0 (bekannter archivmail-fehler vermeiden)")
|
|
||||||
}
|
|
||||||
|
|
||||||
// UIDNEXT vor dem Neuaufbau real erhöhen, damit der Reset auf 1
|
|
||||||
// nachweisbar ist.
|
|
||||||
if _, err := store.NextUID(ctx, tenant, "INBOX"); err != nil {
|
|
||||||
t.Fatalf("nextuid: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
rebuilt, err := store.Rebuild(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("rebuild: %v", err)
|
|
||||||
}
|
|
||||||
if rebuilt.UIDValidity == initial.UIDValidity {
|
|
||||||
t.Fatalf("erwartete geänderte uidvalidity nach neuaufbau, habe weiterhin %d", rebuilt.UIDValidity)
|
|
||||||
}
|
|
||||||
if rebuilt.UIDNext != 1 {
|
|
||||||
t.Fatalf("erwartete uidnext=1 nach neuaufbau, habe %d", rebuilt.UIDNext)
|
|
||||||
}
|
|
||||||
|
|
||||||
events, err := store.Events(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("events: %v", err)
|
|
||||||
}
|
|
||||||
found := false
|
|
||||||
for _, e := range events {
|
|
||||||
if e.EventType == EventRebuilt {
|
|
||||||
found = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !found {
|
|
||||||
t.Fatal("erwartete protokolliertes 'rebuilt'-ereignis (akzeptanzkriterium 3: nachvollziehbar)")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNextUID_ConcurrentSessionsOnSameFolderNoInconsistency ist die
|
|
||||||
// geforderte Pflichtprüfung 2: Nebenläufigkeitstest — zwei Sessions auf
|
|
||||||
// demselben Ordner ohne Inkonsistenz.
|
|
||||||
func TestNextUID_ConcurrentSessionsOnSameFolderNoInconsistency(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-ing05-concurrent"
|
|
||||||
|
|
||||||
if _, err := store.GetOrCreate(ctx, tenant, "INBOX"); err != nil {
|
|
||||||
t.Fatalf("getorcreate: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
const parallelSessions = 20
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
uids := make(chan uint64, parallelSessions)
|
|
||||||
errs := make(chan error, parallelSessions)
|
|
||||||
|
|
||||||
for i := 0; i < parallelSessions; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
uid, err := store.NextUID(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
errs <- err
|
|
||||||
return
|
|
||||||
}
|
|
||||||
uids <- uid
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
close(uids)
|
|
||||||
close(errs)
|
|
||||||
|
|
||||||
for err := range errs {
|
|
||||||
t.Fatalf("nextuid unter nebenläufigkeit: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
seen := make(map[uint64]bool, parallelSessions)
|
|
||||||
for uid := range uids {
|
|
||||||
if seen[uid] {
|
|
||||||
t.Fatalf("uid %d doppelt vergeben — inkonsistenz unter nebenläufigem zugriff", uid)
|
|
||||||
}
|
|
||||||
seen[uid] = true
|
|
||||||
}
|
|
||||||
if len(seen) != parallelSessions {
|
|
||||||
t.Fatalf("erwartete %d eindeutige uids, habe %d", parallelSessions, len(seen))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestNextUID_MonotonicAcrossManyInsertDeleteCycles ist die geforderte
|
|
||||||
// Pflichtprüfung 3: Test für UIDNEXT-Monotonie über viele Einfüge-/
|
|
||||||
// Löschzyklen.
|
|
||||||
func TestNextUID_MonotonicAcrossManyInsertDeleteCycles(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-ing05-monotonie"
|
|
||||||
|
|
||||||
if _, err := store.GetOrCreate(ctx, tenant, "INBOX"); err != nil {
|
|
||||||
t.Fatalf("getorcreate: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var lastUID uint64
|
|
||||||
for i := 0; i < 200; i++ {
|
|
||||||
uid, err := store.NextUID(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("nextuid (zyklus %d): %v", i, err)
|
|
||||||
}
|
|
||||||
if i > 0 && uid <= lastUID {
|
|
||||||
t.Fatalf("uidnext nicht monoton steigend: zyklus %d, vorherige uid=%d, neue uid=%d", i, lastUID, uid)
|
|
||||||
}
|
|
||||||
lastUID = uid
|
|
||||||
|
|
||||||
// Löschung darf UIDNEXT NICHT verändern (RFC 3501: UIDs werden nie
|
|
||||||
// wiederverwendet) — jede zweite Nachricht wird "gelöscht".
|
|
||||||
if i%2 == 0 {
|
|
||||||
if err := store.RecordDeletion(ctx, tenant, "INBOX", uid); err != nil {
|
|
||||||
t.Fatalf("recorddeletion (zyklus %d): %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
final, err := store.CurrentState(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("currentstate: %v", err)
|
|
||||||
}
|
|
||||||
if final.UIDNext != lastUID+1 {
|
|
||||||
t.Fatalf("erwartete uidnext=%d nach 200 vergebenen uids, habe %d", lastUID+1, final.UIDNext)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,194 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// handleCapability ist in jedem Zustand erlaubt (RFC 3501 §6.1.1).
|
|
||||||
func (s *Session) handleCapability(cmd command) bool {
|
|
||||||
if err := writeUntagged(s.writer, "CAPABILITY IMAP4rev1"); err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
return s.writeErr(cmd.Tag, "OK", "CAPABILITY completed")
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleLogin ist nur im Zustand NotAuthenticated erlaubt
|
|
||||||
// (Akzeptanzkriterium 1/3).
|
|
||||||
func (s *Session) handleLogin(ctx context.Context, cmd command) bool {
|
|
||||||
if s.state != NotAuthenticated {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "LOGIN not allowed in "+s.state.String()+" state")
|
|
||||||
}
|
|
||||||
if len(cmd.Args) != 2 {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "LOGIN requires username and password")
|
|
||||||
}
|
|
||||||
if s.auth == nil {
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "LOGIN not available")
|
|
||||||
}
|
|
||||||
|
|
||||||
ok, err := s.auth.Authenticate(ctx, cmd.Args[0], cmd.Args[1])
|
|
||||||
if err != nil {
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "LOGIN failed")
|
|
||||||
}
|
|
||||||
if !ok {
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "LOGIN failed")
|
|
||||||
}
|
|
||||||
s.state = Authenticated
|
|
||||||
return s.writeErr(cmd.Tag, "OK", "LOGIN completed")
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleSelect ist in Authenticated und Selected erlaubt (ein erneutes
|
|
||||||
// SELECT wechselt das gewählte Postfach).
|
|
||||||
func (s *Session) handleSelect(ctx context.Context, cmd command) bool {
|
|
||||||
if s.state == NotAuthenticated {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "SELECT not allowed in "+s.state.String()+" state")
|
|
||||||
}
|
|
||||||
if len(cmd.Args) != 1 {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "SELECT requires a mailbox name")
|
|
||||||
}
|
|
||||||
if s.store == nil {
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "SELECT not available")
|
|
||||||
}
|
|
||||||
|
|
||||||
mailboxName := cmd.Args[0]
|
|
||||||
exists, uidvalidity, ok, err := s.store.Select(ctx, mailboxName)
|
|
||||||
if err != nil || !ok {
|
|
||||||
// Fehlgeschlagenes SELECT lässt den Zustand laut RFC 3501 §6.3.1
|
|
||||||
// auf Authenticated zurückfallen, nie in Selected mit ungültigem
|
|
||||||
// Postfach hängen bleiben.
|
|
||||||
s.state = Authenticated
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "SELECT failed: no such mailbox")
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := writeUntagged(s.writer, fmt.Sprintf("%d EXISTS", exists)); err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
// RFC 3501 §2.3.1.1: UIDVALIDITY ist Pflichtbestandteil der
|
|
||||||
// SELECT-Antwort — Grundlage für IMP-01s Erkennung eines
|
|
||||||
// Ordner-Neuaufbaus.
|
|
||||||
if err := writeUntagged(s.writer, fmt.Sprintf("OK [UIDVALIDITY %d] UIDs valid", uidvalidity)); err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
s.state = Selected
|
|
||||||
s.mailbox = mailboxName
|
|
||||||
s.mailboxSize = uint32(exists)
|
|
||||||
return s.writeErr(cmd.Tag, "OK", "[READ-WRITE] SELECT completed")
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleFetch ist ausschließlich im Zustand Selected erlaubt
|
|
||||||
// (Akzeptanzkriterium 1/2).
|
|
||||||
func (s *Session) handleFetch(ctx context.Context, cmd command) bool {
|
|
||||||
if s.state != Selected {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "FETCH not allowed in "+s.state.String()+" state")
|
|
||||||
}
|
|
||||||
if len(cmd.Args) < 1 {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "FETCH requires a sequence set")
|
|
||||||
}
|
|
||||||
|
|
||||||
seqNumbers, err := parseSequenceSet(cmd.Args[0], s.mailboxSize)
|
|
||||||
if err != nil {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "FETCH: invalid sequence set")
|
|
||||||
}
|
|
||||||
|
|
||||||
messages, err := s.store.Fetch(ctx, s.mailbox, seqNumbers)
|
|
||||||
if err != nil {
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "FETCH failed")
|
|
||||||
}
|
|
||||||
return s.writeFetchResults(cmd.Tag, "FETCH", messages)
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleUIDFetch implementiert "UID FETCH" (RFC 3501 §6.4.8) — wie FETCH,
|
|
||||||
// aber uid-set statt Sequenzsatz, Grundlage für IMP-01s UID-basierten
|
|
||||||
// Delta-Sync.
|
|
||||||
func (s *Session) handleUIDFetch(ctx context.Context, cmd command) bool {
|
|
||||||
if s.state != Selected {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "UID FETCH not allowed in "+s.state.String()+" state")
|
|
||||||
}
|
|
||||||
if len(cmd.Args) < 2 {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "UID FETCH requires a uid set")
|
|
||||||
}
|
|
||||||
// "*" in einem UID-Satz bedeutet "höchste vorhandene UID", NICHT die
|
|
||||||
// NachrichtenANZAHL (s.mailboxSize) — UIDs können durch Löschungen
|
|
||||||
// weit über der Nachrichtenzahl liegen (siehe mail/internal/
|
|
||||||
// folderstate, ING-05: UIDs werden nie wiederverwendet). Da
|
|
||||||
// parseSequenceSet einen Bereich materialisiert, wird "*" hier auf
|
|
||||||
// maxOpenEndedUID begrenzt statt auf 2^32-1 — verhindert eine
|
|
||||||
// Milliarden Einträge lange Schleife bei einem einzelnen offenen
|
|
||||||
// Bereich. FetchByUID liefert ohnehin nur tatsächlich vorhandene
|
|
||||||
// UIDs zurück, die Begrenzung ist für reale Postfachgrößen harmlos.
|
|
||||||
uidSet, err := parseSequenceSet(cmd.Args[1], maxOpenEndedUID)
|
|
||||||
if err != nil {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "UID FETCH: invalid uid set")
|
|
||||||
}
|
|
||||||
|
|
||||||
messages, err := s.store.FetchByUID(ctx, s.mailbox, uidSet)
|
|
||||||
if err != nil {
|
|
||||||
return s.writeErr(cmd.Tag, "NO", "UID FETCH failed")
|
|
||||||
}
|
|
||||||
return s.writeFetchResults(cmd.Tag, "UID FETCH", messages)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Session) writeFetchResults(tag, completedText string, messages []Message) bool {
|
|
||||||
for _, m := range messages {
|
|
||||||
text := fmt.Sprintf("%d FETCH (UID %d FLAGS (%s))", m.SequenceNumber, m.UID, strings.Join(m.Flags, " "))
|
|
||||||
if err := writeUntagged(s.writer, text); err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return s.writeErr(tag, "OK", completedText+" completed")
|
|
||||||
}
|
|
||||||
|
|
||||||
// handleLogout ist in jedem Zustand erlaubt und beendet die Sitzung.
|
|
||||||
func (s *Session) handleLogout(cmd command) bool {
|
|
||||||
if err := writeUntagged(s.writer, "BYE IMAP4rev1 Server logging out"); err != nil {
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
_ = s.writeErr(cmd.Tag, "OK", "LOGOUT completed")
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseSequenceSet unterstützt die für FETCH gebräuchlichsten Formen:
|
|
||||||
// eine einzelne Zahl ("1"), eine kommagetrennte Liste ("1,3,5") und einen
|
|
||||||
// Bereich mit "*" als offenem Ende ("1:*"), aufgelöst gegen maxSeq (die
|
|
||||||
// tatsächliche Nachrichtenzahl des gewählten Postfachs, von SELECT
|
|
||||||
// gemeldet). Volle RFC-3501-Sequenzsatz-Grammatik (verschachtelte
|
|
||||||
// Bereiche etc.) ist bewusst nicht Bestandteil dieser kleinsten Lösung.
|
|
||||||
// maxOpenEndedUID begrenzt, wie weit ein offener UID-Bereich ("N:*")
|
|
||||||
// materialisiert wird — deckt reale Postfachgrößen komfortabel ab, ohne
|
|
||||||
// bei einem einzelnen Kommando Milliarden Slice-Einträge zu erzeugen.
|
|
||||||
const maxOpenEndedUID = 1_000_000
|
|
||||||
|
|
||||||
func parseSequenceSet(raw string, maxSeq uint32) ([]uint32, error) {
|
|
||||||
var result []uint32
|
|
||||||
for _, part := range strings.Split(raw, ",") {
|
|
||||||
if strings.Contains(part, ":") {
|
|
||||||
bounds := strings.SplitN(part, ":", 2)
|
|
||||||
if len(bounds) != 2 {
|
|
||||||
return nil, fmt.Errorf("imap: ungültiger bereich %q", part)
|
|
||||||
}
|
|
||||||
from, err := strconv.ParseUint(bounds[0], 10, 32)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
to := uint64(maxSeq)
|
|
||||||
if bounds[1] != "*" {
|
|
||||||
to, err = strconv.ParseUint(bounds[1], 10, 32)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
for i := from; i <= to; i++ {
|
|
||||||
result = append(result, uint32(i))
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
n, err := strconv.ParseUint(part, 10, 32)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
result = append(result, uint32(n))
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
@@ -1,343 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"net"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
"sync"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// fakeAuthenticator ist ein In-Memory-Authenticator für Tests — echte
|
|
||||||
// Anbindung an Benutzerverwaltung ist Sache späterer Kacheln (IMP-01 u. a.).
|
|
||||||
type fakeAuthenticator struct {
|
|
||||||
users map[string]string
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fakeAuthenticator) Authenticate(_ context.Context, username, password string) (bool, error) {
|
|
||||||
want, ok := f.users[username]
|
|
||||||
return ok && want == password, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// fakeMailboxStore ist ein In-Memory-Postfachspeicher für Tests.
|
|
||||||
type fakeMailboxStore struct {
|
|
||||||
mailboxes map[string][]Message
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fakeMailboxStore) Select(_ context.Context, mailboxName string) (int, uint64, bool, error) {
|
|
||||||
msgs, ok := f.mailboxes[mailboxName]
|
|
||||||
return len(msgs), 1, ok, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fakeMailboxStore) Fetch(_ context.Context, mailboxName string, seqNumbers []uint32) ([]Message, error) {
|
|
||||||
msgs, ok := f.mailboxes[mailboxName]
|
|
||||||
if !ok {
|
|
||||||
return nil, errors.New("imap: postfach nicht gefunden")
|
|
||||||
}
|
|
||||||
wanted := make(map[uint32]bool, len(seqNumbers))
|
|
||||||
for _, n := range seqNumbers {
|
|
||||||
wanted[n] = true
|
|
||||||
}
|
|
||||||
var result []Message
|
|
||||||
for _, m := range msgs {
|
|
||||||
if wanted[m.SequenceNumber] {
|
|
||||||
result = append(result, m)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (f fakeMailboxStore) FetchByUID(_ context.Context, mailboxName string, uids []uint32) ([]Message, error) {
|
|
||||||
msgs, ok := f.mailboxes[mailboxName]
|
|
||||||
if !ok {
|
|
||||||
return nil, errors.New("imap: postfach nicht gefunden")
|
|
||||||
}
|
|
||||||
wanted := make(map[uint32]bool, len(uids))
|
|
||||||
for _, u := range uids {
|
|
||||||
wanted[u] = true
|
|
||||||
}
|
|
||||||
var result []Message
|
|
||||||
for _, m := range msgs {
|
|
||||||
if wanted[m.UID] {
|
|
||||||
result = append(result, m)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func startTestServer(t *testing.T) (addr string, stop func()) {
|
|
||||||
t.Helper()
|
|
||||||
auth := fakeAuthenticator{users: map[string]string{"alice": "geheim123"}}
|
|
||||||
store := fakeMailboxStore{mailboxes: map[string][]Message{
|
|
||||||
"INBOX": {
|
|
||||||
{SequenceNumber: 1, UID: 101, Flags: []string{"\\Seen"}},
|
|
||||||
{SequenceNumber: 2, UID: 102, Flags: []string{}},
|
|
||||||
},
|
|
||||||
}}
|
|
||||||
srv := NewServer(auth, store)
|
|
||||||
|
|
||||||
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listener: %v", err)
|
|
||||||
}
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
done := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
_ = srv.Serve(ctx, listener)
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
|
|
||||||
return listener.Addr().String(), func() {
|
|
||||||
cancel()
|
|
||||||
<-done
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// imapClient ist ein minimaler Testclient (Zeile senden, Antwort lesen)
|
|
||||||
// — bewusst kein voller IMAP-Parser, nur genug, um Server-Antworten zu
|
|
||||||
// prüfen.
|
|
||||||
type imapClient struct {
|
|
||||||
conn net.Conn
|
|
||||||
reader *bufio.Reader
|
|
||||||
tagN int
|
|
||||||
}
|
|
||||||
|
|
||||||
func dial(t *testing.T, addr string) *imapClient {
|
|
||||||
t.Helper()
|
|
||||||
conn, err := net.DialTimeout("tcp", addr, 2*time.Second)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("dial: %v", err)
|
|
||||||
}
|
|
||||||
c := &imapClient{conn: conn, reader: bufio.NewReader(conn)}
|
|
||||||
c.readLine(t) // Begrüßung
|
|
||||||
return c
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *imapClient) readLine(t *testing.T) string {
|
|
||||||
t.Helper()
|
|
||||||
_ = c.conn.SetReadDeadline(time.Now().Add(3 * time.Second))
|
|
||||||
line, err := c.reader.ReadString('\n')
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("antwort lesen: %v", err)
|
|
||||||
}
|
|
||||||
return strings.TrimRight(line, "\r\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
// sendTagged sendet ein Kommando mit neuem Tag und liest Zeilen, bis die
|
|
||||||
// getaggte Abschlusszeile kommt — liefert alle Zeilen (inkl. Abschluss).
|
|
||||||
func (c *imapClient) sendTagged(t *testing.T, command string) (tag string, lines []string) {
|
|
||||||
t.Helper()
|
|
||||||
c.tagN++
|
|
||||||
tag = "A" + strconv.Itoa(c.tagN)
|
|
||||||
_, err := c.conn.Write([]byte(tag + " " + command + "\r\n"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("kommando senden: %v", err)
|
|
||||||
}
|
|
||||||
for {
|
|
||||||
line := c.readLine(t)
|
|
||||||
lines = append(lines, line)
|
|
||||||
if strings.HasPrefix(line, tag+" ") {
|
|
||||||
return tag, lines
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *imapClient) close() { _ = c.conn.Close() }
|
|
||||||
|
|
||||||
// TestSession_StateTransitionsAndForbiddenTransitions ist die geforderte
|
|
||||||
// Pflichtprüfung 2: automatisierter Test deckt alle drei
|
|
||||||
// Zustandsübergänge UND deren verbotene Übergänge ab.
|
|
||||||
func TestSession_StateTransitionsAndForbiddenTransitions(t *testing.T) {
|
|
||||||
addr, stop := startTestServer(t)
|
|
||||||
defer stop()
|
|
||||||
c := dial(t, addr)
|
|
||||||
defer c.close()
|
|
||||||
|
|
||||||
// Verbotener Übergang: SELECT/FETCH in NotAuthenticated.
|
|
||||||
_, lines := c.sendTagged(t, `SELECT INBOX`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
|
||||||
t.Fatalf("erwartete BAD für SELECT in NotAuthenticated, habe: %v", lines)
|
|
||||||
}
|
|
||||||
_, lines = c.sendTagged(t, `FETCH 1 (FLAGS)`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
|
||||||
t.Fatalf("erwartete BAD für FETCH in NotAuthenticated, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
// NotAuthenticated -> Authenticated via LOGIN.
|
|
||||||
_, lines = c.sendTagged(t, `LOGIN alice geheim123`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("erwartete OK für LOGIN, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verbotener Übergang: erneutes LOGIN in Authenticated.
|
|
||||||
_, lines = c.sendTagged(t, `LOGIN alice geheim123`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
|
||||||
t.Fatalf("erwartete BAD für LOGIN in Authenticated, habe: %v", lines)
|
|
||||||
}
|
|
||||||
// Verbotener Übergang: FETCH in Authenticated (noch nicht Selected).
|
|
||||||
_, lines = c.sendTagged(t, `FETCH 1 (FLAGS)`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
|
||||||
t.Fatalf("erwartete BAD für FETCH in Authenticated, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Authenticated -> Selected via SELECT.
|
|
||||||
_, lines = c.sendTagged(t, `SELECT INBOX`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("erwartete OK für SELECT, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
// In Selected sind SELECT (erneut) und FETCH erlaubt.
|
|
||||||
_, lines = c.sendTagged(t, `FETCH 1:2 (FLAGS)`)
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("erwartete OK für FETCH in Selected, habe: %v", lines)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCommands_AllBaseCommandsAnswered ist die geforderte
|
|
||||||
// Pflichtprüfung/AC2: Grundbefehle sind implementiert und beantwortet.
|
|
||||||
func TestCommands_AllBaseCommandsAnswered(t *testing.T) {
|
|
||||||
addr, stop := startTestServer(t)
|
|
||||||
defer stop()
|
|
||||||
c := dial(t, addr)
|
|
||||||
defer c.close()
|
|
||||||
|
|
||||||
_, lines := c.sendTagged(t, "CAPABILITY")
|
|
||||||
if !containsSubstring(lines, "IMAP4rev1") {
|
|
||||||
t.Fatalf("CAPABILITY: erwartete IMAP4rev1 in antwort, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, lines = c.sendTagged(t, "LOGIN alice geheim123")
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("LOGIN fehlgeschlagen: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, lines = c.sendTagged(t, "SELECT INBOX")
|
|
||||||
if !containsSubstring(lines, "2 EXISTS") {
|
|
||||||
t.Fatalf("SELECT: erwartete '2 EXISTS', habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, lines = c.sendTagged(t, "FETCH 1 (FLAGS)")
|
|
||||||
if !containsSubstring(lines, "FETCH (UID") {
|
|
||||||
t.Fatalf("FETCH: erwartete FLAGS-Antwort, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
tag, lines := c.sendTagged(t, "LOGOUT")
|
|
||||||
if !containsSubstring(lines, "BYE") {
|
|
||||||
t.Fatalf("LOGOUT: erwartete BYE, habe: %v", lines)
|
|
||||||
}
|
|
||||||
if !strings.HasPrefix(lines[len(lines)-1], tag+" OK") {
|
|
||||||
t.Fatalf("LOGOUT: erwartete getaggtes OK, habe: %v", lines)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSession_InvalidCommandKeepsConnectionOpen ist die geforderte
|
|
||||||
// Pflichtprüfung/AC3: ungültige Kommandosequenzen werden mit korrektem
|
|
||||||
// Fehlercode abgelehnt, NICHT mit Verbindungsabbruch.
|
|
||||||
func TestSession_InvalidCommandKeepsConnectionOpen(t *testing.T) {
|
|
||||||
addr, stop := startTestServer(t)
|
|
||||||
defer stop()
|
|
||||||
c := dial(t, addr)
|
|
||||||
defer c.close()
|
|
||||||
|
|
||||||
_, lines := c.sendTagged(t, "FRIMBULATOR")
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "BAD") {
|
|
||||||
t.Fatalf("erwartete BAD für unbekanntes kommando, habe: %v", lines)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Verbindung muss danach real weiter funktionieren (kein Abbruch).
|
|
||||||
_, lines = c.sendTagged(t, "CAPABILITY")
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("erwartete funktionierende verbindung nach ungültigem kommando, habe: %v", lines)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSession_MalformedLineDoesNotDisconnect deckt zusätzlich eine
|
|
||||||
// syntaktisch fehlerhafte Zeile (kein Tag/Kommando erkennbar) ab.
|
|
||||||
func TestSession_MalformedLineDoesNotDisconnect(t *testing.T) {
|
|
||||||
addr, stop := startTestServer(t)
|
|
||||||
defer stop()
|
|
||||||
c := dial(t, addr)
|
|
||||||
defer c.close()
|
|
||||||
|
|
||||||
_, err := c.conn.Write([]byte("\"unterminated\r\n"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("senden: %v", err)
|
|
||||||
}
|
|
||||||
line := c.readLine(t)
|
|
||||||
if !strings.HasPrefix(line, "* BAD") {
|
|
||||||
t.Fatalf("erwartete '* BAD' für fehlerhafte zeile, habe: %q", line)
|
|
||||||
}
|
|
||||||
|
|
||||||
_, lines := c.sendTagged(t, "CAPABILITY")
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("erwartete funktionierende verbindung nach fehlerhafter zeile, habe: %v", lines)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func containsSubstring(lines []string, sub string) bool {
|
|
||||||
for _, l := range lines {
|
|
||||||
if strings.Contains(l, sub) {
|
|
||||||
return true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return false
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestServer_50ParallelSessionsNoLeak ist die geforderte Pflichtprüfung
|
|
||||||
// 3: Lasttest mit 50 parallelen Sessions ohne Ressourcenleck.
|
|
||||||
func TestServer_50ParallelSessionsNoLeak(t *testing.T) {
|
|
||||||
addr, stop := startTestServer(t)
|
|
||||||
defer stop()
|
|
||||||
|
|
||||||
const sessions = 50
|
|
||||||
var wg sync.WaitGroup
|
|
||||||
errCh := make(chan error, sessions)
|
|
||||||
|
|
||||||
for i := 0; i < sessions; i++ {
|
|
||||||
wg.Add(1)
|
|
||||||
go func() {
|
|
||||||
defer wg.Done()
|
|
||||||
conn, err := net.DialTimeout("tcp", addr, 3*time.Second)
|
|
||||||
if err != nil {
|
|
||||||
errCh <- err
|
|
||||||
return
|
|
||||||
}
|
|
||||||
defer func() { _ = conn.Close() }()
|
|
||||||
c := &imapClient{conn: conn, reader: bufio.NewReader(conn)}
|
|
||||||
c.readLine(t)
|
|
||||||
c.sendTagged(t, "LOGIN alice geheim123")
|
|
||||||
c.sendTagged(t, "SELECT INBOX")
|
|
||||||
c.sendTagged(t, "FETCH 1:2 (FLAGS)")
|
|
||||||
c.sendTagged(t, "LOGOUT")
|
|
||||||
}()
|
|
||||||
}
|
|
||||||
wg.Wait()
|
|
||||||
close(errCh)
|
|
||||||
for err := range errCh {
|
|
||||||
t.Errorf("parallele sitzung fehlgeschlagen: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestCommands_UIDFetchReturnsUID belegt die für IMP-01 nötige
|
|
||||||
// UID-FETCH-Erweiterung: reale UID-basierte Abfrage über echtes TCP.
|
|
||||||
func TestCommands_UIDFetchReturnsUID(t *testing.T) {
|
|
||||||
addr, stop := startTestServer(t)
|
|
||||||
defer stop()
|
|
||||||
c := dial(t, addr)
|
|
||||||
defer c.close()
|
|
||||||
|
|
||||||
c.sendTagged(t, "LOGIN alice geheim123")
|
|
||||||
c.sendTagged(t, "SELECT INBOX")
|
|
||||||
|
|
||||||
_, lines := c.sendTagged(t, "UID FETCH 101:102 (FLAGS)")
|
|
||||||
if !containsSubstring(lines, "UID 101") || !containsSubstring(lines, "UID 102") {
|
|
||||||
t.Fatalf("erwartete beide UIDs in der antwort, habe: %v", lines)
|
|
||||||
}
|
|
||||||
if !strings.Contains(lines[len(lines)-1], "OK") {
|
|
||||||
t.Fatalf("erwartete OK-abschluss, habe: %v", lines)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,48 +0,0 @@
|
|||||||
// Package imap implementiert ING-01: das IMAP-Server-Grundgerüst
|
|
||||||
// (TCP-Listener, Command-Parser, Session-Zustandsmaschine, Grundbefehle
|
|
||||||
// CAPABILITY/LOGIN/SELECT/FETCH/LOGOUT). Bewusste Neuimplementierung nach
|
|
||||||
// NEXARCH-Techstack, kein 1:1-Übernehmen von archivmail (siehe "Bekannte
|
|
||||||
// Fehler vermeiden": Header-/Zeilen-Injection durch Stringkonkatenation
|
|
||||||
// ohne CRLF-Prüfung — alle Antworten laufen ausschließlich über
|
|
||||||
// writeLine/writeTagged, die eingebettete CR/LF im Text ersetzen, siehe
|
|
||||||
// response.go).
|
|
||||||
//
|
|
||||||
// Authentifizierung (Authenticator) und Postfachzugriff (MailboxStore)
|
|
||||||
// sind schmale Schnittstellen — echte Anbindung an Benutzerverwaltung/
|
|
||||||
// Nachrichtenspeicher ist Sache späterer Ingestion-Tickets (IMP-01 u. a.,
|
|
||||||
// siehe "Nicht Bestandteil dieser Kachel" im Ticket). Dieses Paket kennt
|
|
||||||
// weder Core-IAM noch mail/internal/storage.
|
|
||||||
package imap
|
|
||||||
|
|
||||||
import "context"
|
|
||||||
|
|
||||||
// Authenticator prüft Zugangsdaten für LOGIN.
|
|
||||||
type Authenticator interface {
|
|
||||||
Authenticate(ctx context.Context, username, password string) (ok bool, err error)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Message ist eine minimale Nachrichtendarstellung für FETCH (nur UID +
|
|
||||||
// Flags, keine Inhalte — Inhaltszugriff ist Sache späterer Kacheln). UID
|
|
||||||
// wird seit IMP-01 zusätzlich zur Sequenznummer geführt (RFC 3501 §2.3.1,
|
|
||||||
// UID FETCH) — Grundlage für IMP-01s UID-basierten Delta-Sync.
|
|
||||||
type Message struct {
|
|
||||||
SequenceNumber uint32
|
|
||||||
UID uint32
|
|
||||||
Flags []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// MailboxStore liefert Postfachzustand für SELECT/FETCH.
|
|
||||||
type MailboxStore interface {
|
|
||||||
// Select liefert die Anzahl der Nachrichten sowie die UIDVALIDITY
|
|
||||||
// (RFC 3501 §2.3.1.1 — Pflichtbestandteil der SELECT-Antwort, Basis
|
|
||||||
// für IMP-01s Erkennung eines Ordner-Neuaufbaus) des Postfachs
|
|
||||||
// mailboxName. ok=false, wenn das Postfach nicht existiert.
|
|
||||||
Select(ctx context.Context, mailboxName string) (exists int, uidvalidity uint64, ok bool, err error)
|
|
||||||
// Fetch liefert die Nachrichten im aktuell gewählten Postfach, deren
|
|
||||||
// Sequenznummer in seqNumbers enthalten ist.
|
|
||||||
Fetch(ctx context.Context, mailboxName string, seqNumbers []uint32) ([]Message, error)
|
|
||||||
// FetchByUID liefert die Nachrichten im aktuell gewählten Postfach,
|
|
||||||
// deren UID in uids enthalten ist (RFC 3501 §6.4.8, UID FETCH) — Basis
|
|
||||||
// für IMP-01s UID-Vergleich.
|
|
||||||
FetchByUID(ctx context.Context, mailboxName string, uids []uint32) ([]Message, error)
|
|
||||||
}
|
|
||||||
@@ -1,81 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"errors"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrMalformedCommand wird geliefert, wenn eine Kommandozeile nicht dem
|
|
||||||
// Grundformat "Tag SP Kommando [SP Argumente]" entspricht. Kein
|
|
||||||
// Verbindungsabbruch (Akzeptanzkriterium 3) — der Aufrufer antwortet mit
|
|
||||||
// einer BAD-Antwort und liest die nächste Zeile.
|
|
||||||
var ErrMalformedCommand = errors.New("imap: fehlerhafte kommandozeile")
|
|
||||||
|
|
||||||
// command ist eine geparste IMAP-Kommandozeile.
|
|
||||||
type command struct {
|
|
||||||
Tag string
|
|
||||||
Name string // groß geschrieben (z. B. "LOGIN")
|
|
||||||
Args []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseCommandLine zerlegt eine Kommandozeile (bereits ohne CRLF) in Tag,
|
|
||||||
// Kommandoname und Argumente. Unterstützt Atome und doppelt zitierte
|
|
||||||
// Zeichenketten (mit \"- und \\-Escape) — literale Zeichenketten
|
|
||||||
// ({n}CRLF<n Bytes>) sind bewusst NICHT Bestandteil dieser kleinsten
|
|
||||||
// Lösung (LOGIN/SELECT/FETCH kommen in Tests/typischen Clients ohne
|
|
||||||
// Literale aus).
|
|
||||||
func parseCommandLine(line string) (command, error) {
|
|
||||||
tokens, err := tokenize(line)
|
|
||||||
if err != nil {
|
|
||||||
return command{}, err
|
|
||||||
}
|
|
||||||
if len(tokens) < 2 {
|
|
||||||
return command{}, ErrMalformedCommand
|
|
||||||
}
|
|
||||||
return command{
|
|
||||||
Tag: tokens[0],
|
|
||||||
Name: strings.ToUpper(tokens[1]),
|
|
||||||
Args: tokens[2:],
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// tokenize zerlegt line in durch Leerzeichen getrennte Tokens, wobei
|
|
||||||
// doppelt zitierte Zeichenketten als EIN Token gelten (Leerzeichen darin
|
|
||||||
// werden nicht als Trenner behandelt).
|
|
||||||
func tokenize(line string) ([]string, error) {
|
|
||||||
var tokens []string
|
|
||||||
var current strings.Builder
|
|
||||||
inQuotes := false
|
|
||||||
escaped := false
|
|
||||||
hasToken := false
|
|
||||||
|
|
||||||
for _, r := range line {
|
|
||||||
switch {
|
|
||||||
case escaped:
|
|
||||||
current.WriteRune(r)
|
|
||||||
escaped = false
|
|
||||||
hasToken = true
|
|
||||||
case r == '\\' && inQuotes:
|
|
||||||
escaped = true
|
|
||||||
case r == '"':
|
|
||||||
inQuotes = !inQuotes
|
|
||||||
hasToken = true
|
|
||||||
case r == ' ' && !inQuotes:
|
|
||||||
if hasToken {
|
|
||||||
tokens = append(tokens, current.String())
|
|
||||||
current.Reset()
|
|
||||||
hasToken = false
|
|
||||||
}
|
|
||||||
default:
|
|
||||||
current.WriteRune(r)
|
|
||||||
hasToken = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if inQuotes || escaped {
|
|
||||||
return nil, ErrMalformedCommand
|
|
||||||
}
|
|
||||||
if hasToken {
|
|
||||||
tokens = append(tokens, current.String())
|
|
||||||
}
|
|
||||||
return tokens, nil
|
|
||||||
}
|
|
||||||
@@ -1,38 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// sanitizeResponseText entfernt eingebettete CR/LF aus text, BEVOR er in
|
|
||||||
// eine Antwortzeile eingebettet wird (Bekannter Fehler vermeiden:
|
|
||||||
// archivmail erlaubte Header-/Zeilen-Injection durch Stringkonkatenation
|
|
||||||
// ohne CRLF-Prüfung — jede Antwortzeile dieses Pakets läuft durch diese
|
|
||||||
// Funktion, niemals direkte Interpolation von Nutzereingaben in eine
|
|
||||||
// Rohantwort).
|
|
||||||
func sanitizeResponseText(text string) string {
|
|
||||||
text = strings.ReplaceAll(text, "\r", "")
|
|
||||||
text = strings.ReplaceAll(text, "\n", "")
|
|
||||||
return text
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeUntagged schreibt eine Server-Antwort ohne Tag ("* ...").
|
|
||||||
func writeUntagged(w *bufio.Writer, text string) error {
|
|
||||||
_, err := w.WriteString("* " + sanitizeResponseText(text) + "\r\n")
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return w.Flush()
|
|
||||||
}
|
|
||||||
|
|
||||||
// writeTagged schreibt eine getaggte Server-Antwort ("<tag> OK/NO/BAD ...").
|
|
||||||
// tag wird ebenfalls saniert — ein Tag mit eingebettetem CRLF ist genauso
|
|
||||||
// eine Injektionsgefahr wie der Antworttext.
|
|
||||||
func writeTagged(w *bufio.Writer, tag, status, text string) error {
|
|
||||||
_, err := w.WriteString(sanitizeResponseText(tag) + " " + status + " " + sanitizeResponseText(text) + "\r\n")
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
return w.Flush()
|
|
||||||
}
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Server nimmt IMAP-Verbindungen an und bedient jede in einer eigenen
|
|
||||||
// Goroutine (Akzeptanzkriterium 1). STARTTLS/TLS-Absicherung ist
|
|
||||||
// ausdrücklich Sache von ING-06, nicht dieser Kachel — Server hört per
|
|
||||||
// Klartext-TCP, wie im Ticket vorgesehen ("Bereite höchstens die
|
|
||||||
// Schnittstelle dafür vor").
|
|
||||||
type Server struct {
|
|
||||||
auth Authenticator
|
|
||||||
store MailboxStore
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewServer(auth Authenticator, store MailboxStore) *Server {
|
|
||||||
return &Server{auth: auth, store: store}
|
|
||||||
}
|
|
||||||
|
|
||||||
// Serve nimmt Verbindungen auf listener an, bis ctx beendet wird oder
|
|
||||||
// Accept endgültig fehlschlägt. Blockiert den Aufrufer.
|
|
||||||
func (srv *Server) Serve(ctx context.Context, listener net.Listener) error {
|
|
||||||
go func() {
|
|
||||||
<-ctx.Done()
|
|
||||||
_ = listener.Close()
|
|
||||||
}()
|
|
||||||
|
|
||||||
for {
|
|
||||||
conn, err := listener.Accept()
|
|
||||||
if err != nil {
|
|
||||||
if ctx.Err() != nil {
|
|
||||||
return nil // beabsichtigtes Herunterfahren
|
|
||||||
}
|
|
||||||
var netErr net.Error
|
|
||||||
if errors.As(err, &netErr) && netErr.Timeout() {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
return fmt.Errorf("imap: verbindung annehmen: %w", err)
|
|
||||||
}
|
|
||||||
session := newSession(conn, srv.auth, srv.store)
|
|
||||||
go session.Serve(ctx)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,120 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"io"
|
|
||||||
"net"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// maxCommandLineBytes begrenzt eine einzelne Kommandozeile (Defensive
|
|
||||||
// Fehlerbehandlung bei nicht-konformen Gegenstellen statt optimistischem
|
|
||||||
// Parsing, siehe Ticket-Vorbild Dovecot) — verhindert unbegrenztes
|
|
||||||
// Pufferwachstum durch eine Gegenstelle, die niemals CRLF sendet.
|
|
||||||
const maxCommandLineBytes = 8192
|
|
||||||
|
|
||||||
// Session ist eine einzelne IMAP-Verbindung mit eigener
|
|
||||||
// Zustandsmaschine (Akzeptanzkriterium 1).
|
|
||||||
type Session struct {
|
|
||||||
conn net.Conn
|
|
||||||
reader *bufio.Reader
|
|
||||||
writer *bufio.Writer
|
|
||||||
auth Authenticator
|
|
||||||
store MailboxStore
|
|
||||||
state State
|
|
||||||
mailbox string // gewähltes Postfach im Zustand Selected
|
|
||||||
mailboxSize uint32 // Nachrichtenzahl aus dem letzten erfolgreichen SELECT
|
|
||||||
}
|
|
||||||
|
|
||||||
func newSession(conn net.Conn, auth Authenticator, store MailboxStore) *Session {
|
|
||||||
return &Session{
|
|
||||||
conn: conn,
|
|
||||||
reader: bufio.NewReaderSize(conn, maxCommandLineBytes),
|
|
||||||
writer: bufio.NewWriter(conn),
|
|
||||||
auth: auth,
|
|
||||||
store: store,
|
|
||||||
state: NotAuthenticated,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// State liefert den aktuellen Sitzungszustand (für Tests).
|
|
||||||
func (s *Session) State() State { return s.state }
|
|
||||||
|
|
||||||
// Serve führt die Sitzung bis LOGOUT oder Verbindungsende aus.
|
|
||||||
func (s *Session) Serve(ctx context.Context) {
|
|
||||||
defer func() { _ = s.conn.Close() }()
|
|
||||||
|
|
||||||
if err := writeUntagged(s.writer, "OK IMAP4rev1 Service Ready"); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
for {
|
|
||||||
line, err := s.readLine()
|
|
||||||
if err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
if line == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
cmd, parseErr := parseCommandLine(line)
|
|
||||||
if parseErr != nil {
|
|
||||||
// Akzeptanzkriterium 3: ungültige Kommandosequenz -> Fehlercode,
|
|
||||||
// KEIN Verbindungsabbruch.
|
|
||||||
if err := writeUntagged(s.writer, "BAD Error in IMAP command received by server."); err != nil {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if !s.dispatch(ctx, cmd) {
|
|
||||||
return // LOGOUT oder nicht behebbarer Schreibfehler
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// readLine liest eine CRLF- (oder LF-)terminierte Zeile ohne
|
|
||||||
// Zeilenumbruch. Überlange Zeilen (siehe maxCommandLineBytes) werden als
|
|
||||||
// Fehler behandelt statt unbegrenzt zu puffern.
|
|
||||||
func (s *Session) readLine() (string, error) {
|
|
||||||
line, err := s.reader.ReadString('\n')
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, io.EOF) && line != "" {
|
|
||||||
// Letzte Zeile ohne abschließendes LF — als vollständige Zeile
|
|
||||||
// behandeln, danach ohnehin Verbindungsende.
|
|
||||||
return strings.TrimRight(line, "\r"), nil
|
|
||||||
}
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return strings.TrimRight(line, "\r\n"), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// dispatch verarbeitet EIN geparstes Kommando. Rückgabewert false
|
|
||||||
// bedeutet: Sitzung beenden (LOGOUT abgeschlossen oder Schreibfehler).
|
|
||||||
func (s *Session) dispatch(ctx context.Context, cmd command) bool {
|
|
||||||
switch cmd.Name {
|
|
||||||
case "CAPABILITY":
|
|
||||||
return s.handleCapability(cmd)
|
|
||||||
case "LOGIN":
|
|
||||||
return s.handleLogin(ctx, cmd)
|
|
||||||
case "SELECT":
|
|
||||||
return s.handleSelect(ctx, cmd)
|
|
||||||
case "FETCH":
|
|
||||||
return s.handleFetch(ctx, cmd)
|
|
||||||
case "UID":
|
|
||||||
if len(cmd.Args) < 1 || strings.ToUpper(cmd.Args[0]) != "FETCH" {
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "Unsupported UID subcommand")
|
|
||||||
}
|
|
||||||
return s.handleUIDFetch(ctx, cmd)
|
|
||||||
case "LOGOUT":
|
|
||||||
return s.handleLogout(cmd)
|
|
||||||
default:
|
|
||||||
return s.writeErr(cmd.Tag, "BAD", "Unknown command")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (s *Session) writeErr(tag, status, text string) bool {
|
|
||||||
return writeTagged(s.writer, tag, status, text) == nil
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
package imap
|
|
||||||
|
|
||||||
// State ist eine der drei IMAP4rev1-Session-Zustände (RFC 3501 §3),
|
|
||||||
// Akzeptanzkriterium 1.
|
|
||||||
type State int
|
|
||||||
|
|
||||||
const (
|
|
||||||
NotAuthenticated State = iota
|
|
||||||
Authenticated
|
|
||||||
Selected
|
|
||||||
)
|
|
||||||
|
|
||||||
func (s State) String() string {
|
|
||||||
switch s {
|
|
||||||
case NotAuthenticated:
|
|
||||||
return "not authenticated"
|
|
||||||
case Authenticated:
|
|
||||||
return "authenticated"
|
|
||||||
case Selected:
|
|
||||||
return "selected"
|
|
||||||
default:
|
|
||||||
return "unknown"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,24 +0,0 @@
|
|||||||
package imapimport
|
|
||||||
|
|
||||||
import "context"
|
|
||||||
|
|
||||||
// RemoteMessage ist eine über IMAP abgerufene Nachricht (nur UID/Flags —
|
|
||||||
// Inhaltsabruf ist Sache späterer Kacheln, siehe "Nicht Bestandteil
|
|
||||||
// dieser Kachel": IMP-02 Anhangsverarbeitung u. a.).
|
|
||||||
type RemoteMessage struct {
|
|
||||||
UID uint32
|
|
||||||
Flags []string
|
|
||||||
}
|
|
||||||
|
|
||||||
// IMAPClient abstrahiert den Protokollzugriff auf ein entferntes
|
|
||||||
// Postfach — schmale Schnittstelle, damit die Delta-Sync-Logik
|
|
||||||
// (scheduler.go) ohne echte Netzwerkverbindung testbar ist (gleiche
|
|
||||||
// Konvention wie KEKProvider/Authenticator in anderen Mail-Paketen).
|
|
||||||
// Eine reale, wire-level-IMAP4rev1-Implementierung liegt in client_real.go.
|
|
||||||
type IMAPClient interface {
|
|
||||||
// Sync liefert die aktuelle UIDVALIDITY des Postfachs sowie ALLE
|
|
||||||
// darin vorhandenen Nachrichten (UID + Flags). Der Aufrufer
|
|
||||||
// (Scheduler) entscheidet anhand des persistierten Zustands, welche
|
|
||||||
// davon neu sind.
|
|
||||||
Sync(ctx context.Context, mailbox string) (uidvalidity uint64, messages []RemoteMessage, err error)
|
|
||||||
}
|
|
||||||
@@ -1,155 +0,0 @@
|
|||||||
package imapimport
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bufio"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"net"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// RealClient spricht echtes IMAP4rev1 (RFC 3501) über TCP — genutzt für
|
|
||||||
// den realistischen Testpostfach-Nachweis (Pflichtprüfung 3) gegen den
|
|
||||||
// echten ING-01-Server, und produktiv gegen jeden RFC-3501-konformen
|
|
||||||
// IMAP-Server. Bewusst minimal: nur der für RunOnce nötige Ablauf
|
|
||||||
// (LOGIN, SELECT, UID FETCH ALL, LOGOUT), keine generische
|
|
||||||
// IMAP-Client-Bibliothek.
|
|
||||||
type RealClient struct {
|
|
||||||
addr string
|
|
||||||
username string
|
|
||||||
password string
|
|
||||||
dialer net.Dialer
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewRealClient(addr, username, password string) *RealClient {
|
|
||||||
return &RealClient{addr: addr, username: username, password: password}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *RealClient) Sync(ctx context.Context, mailbox string) (uint64, []RemoteMessage, error) {
|
|
||||||
conn, err := c.dialer.DialContext(ctx, "tcp", c.addr)
|
|
||||||
if err != nil {
|
|
||||||
return 0, nil, fmt.Errorf("imapimport: verbindung aufbauen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = conn.Close() }()
|
|
||||||
|
|
||||||
if deadline, ok := ctx.Deadline(); ok {
|
|
||||||
_ = conn.SetDeadline(deadline)
|
|
||||||
}
|
|
||||||
|
|
||||||
reader := bufio.NewReader(conn)
|
|
||||||
// Begrüßung.
|
|
||||||
if _, err := readLine(reader); err != nil {
|
|
||||||
return 0, nil, fmt.Errorf("imapimport: begrüßung lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := sendCommand(conn, reader, 1, "LOGIN "+c.username+" "+c.password); err != nil {
|
|
||||||
return 0, nil, fmt.Errorf("imapimport: login: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
selectLines, err := sendCommand(conn, reader, 2, "SELECT "+mailbox)
|
|
||||||
if err != nil {
|
|
||||||
return 0, nil, fmt.Errorf("imapimport: select: %w", err)
|
|
||||||
}
|
|
||||||
uidvalidity, err := extractUIDValidity(selectLines)
|
|
||||||
if err != nil {
|
|
||||||
return 0, nil, err
|
|
||||||
}
|
|
||||||
|
|
||||||
fetchLines, err := sendCommand(conn, reader, 3, "UID FETCH 1:* (FLAGS)")
|
|
||||||
if err != nil {
|
|
||||||
return 0, nil, fmt.Errorf("imapimport: uid fetch: %w", err)
|
|
||||||
}
|
|
||||||
messages := parseFetchLines(fetchLines)
|
|
||||||
|
|
||||||
_, _ = sendCommand(conn, reader, 4, "LOGOUT")
|
|
||||||
|
|
||||||
return uidvalidity, messages, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func readLine(reader *bufio.Reader) (string, error) {
|
|
||||||
line, err := reader.ReadString('\n')
|
|
||||||
if err != nil {
|
|
||||||
return "", err
|
|
||||||
}
|
|
||||||
return strings.TrimRight(line, "\r\n"), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// sendCommand sendet ein getaggtes Kommando und liest alle Zeilen bis
|
|
||||||
// zur getaggten Abschlusszeile (inklusive). Liefert einen Fehler, wenn
|
|
||||||
// die Abschlusszeile nicht "OK" meldet.
|
|
||||||
func sendCommand(conn net.Conn, reader *bufio.Reader, tagN int, command string) ([]string, error) {
|
|
||||||
tag := "C" + strconv.Itoa(tagN)
|
|
||||||
if _, err := conn.Write([]byte(tag + " " + command + "\r\n")); err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
var lines []string
|
|
||||||
for {
|
|
||||||
line, err := readLine(reader)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
lines = append(lines, line)
|
|
||||||
if strings.HasPrefix(line, tag+" ") {
|
|
||||||
if !strings.HasPrefix(line, tag+" OK") {
|
|
||||||
return lines, fmt.Errorf("server meldete: %s", line)
|
|
||||||
}
|
|
||||||
return lines, nil
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func extractUIDValidity(lines []string) (uint64, error) {
|
|
||||||
for _, line := range lines {
|
|
||||||
idx := strings.Index(line, "UIDVALIDITY ")
|
|
||||||
if idx == -1 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
rest := line[idx+len("UIDVALIDITY "):]
|
|
||||||
end := strings.IndexAny(rest, "] ")
|
|
||||||
if end == -1 {
|
|
||||||
end = len(rest)
|
|
||||||
}
|
|
||||||
v, err := strconv.ParseUint(rest[:end], 10, 64)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("imapimport: uidvalidity parsen: %w", err)
|
|
||||||
}
|
|
||||||
return v, nil
|
|
||||||
}
|
|
||||||
return 0, fmt.Errorf("imapimport: keine UIDVALIDITY in SELECT-Antwort gefunden")
|
|
||||||
}
|
|
||||||
|
|
||||||
// parseFetchLines parst Zeilen der Form
|
|
||||||
// "* <seq> FETCH (UID <uid> FLAGS (<flags>))" (siehe mail/internal/imap
|
|
||||||
// writeFetchResults).
|
|
||||||
func parseFetchLines(lines []string) []RemoteMessage {
|
|
||||||
var messages []RemoteMessage
|
|
||||||
for _, line := range lines {
|
|
||||||
if !strings.Contains(line, "FETCH (UID ") {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
uidIdx := strings.Index(line, "UID ") + len("UID ")
|
|
||||||
rest := line[uidIdx:]
|
|
||||||
spaceIdx := strings.IndexByte(rest, ' ')
|
|
||||||
if spaceIdx == -1 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
uid, err := strconv.ParseUint(rest[:spaceIdx], 10, 32)
|
|
||||||
if err != nil {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
var flags []string
|
|
||||||
flagsStart := strings.Index(line, "FLAGS (")
|
|
||||||
flagsEnd := strings.LastIndex(line, ")")
|
|
||||||
if flagsStart != -1 && flagsEnd > flagsStart {
|
|
||||||
inner := line[flagsStart+len("FLAGS (") : flagsEnd]
|
|
||||||
if inner != "" {
|
|
||||||
flags = strings.Split(inner, " ")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
messages = append(messages, RemoteMessage{UID: uint32(uid), Flags: flags})
|
|
||||||
}
|
|
||||||
return messages
|
|
||||||
}
|
|
||||||
@@ -1,132 +0,0 @@
|
|||||||
// TestRunOnce_AgainstRealTestMailboxWithRealisticVolume ist die
|
|
||||||
// geforderte Pflichtprüfung 3: Test gegen Testpostfach mit realistischem
|
|
||||||
// Nachrichtenaufkommen — echter IMAP4rev1-Wire-Protokoll-Lauf gegen den
|
|
||||||
// echten ING-01-Server (mail/internal/imap), kein Fake.
|
|
||||||
package imapimport
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"net"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/imap"
|
|
||||||
)
|
|
||||||
|
|
||||||
type realTestAuthenticator struct{}
|
|
||||||
|
|
||||||
func (realTestAuthenticator) Authenticate(_ context.Context, username, password string) (bool, error) {
|
|
||||||
return username == "importuser" && password == "importpass123", nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// realTestMailboxStore stellt ein "realistisches" Testpostfach bereit —
|
|
||||||
// 30 Nachrichten, wie es ein aktives Postfach nach einiger Zeit
|
|
||||||
// tatsächlich enthält.
|
|
||||||
type realTestMailboxStore struct {
|
|
||||||
uidvalidity uint64
|
|
||||||
messages []imap.Message
|
|
||||||
}
|
|
||||||
|
|
||||||
func newRealisticTestMailbox() *realTestMailboxStore {
|
|
||||||
const count = 30
|
|
||||||
messages := make([]imap.Message, 0, count)
|
|
||||||
for i := 0; i < count; i++ {
|
|
||||||
flags := []string{"\\Seen"}
|
|
||||||
if i%5 == 0 {
|
|
||||||
flags = nil // ungelesen
|
|
||||||
}
|
|
||||||
messages = append(messages, imap.Message{
|
|
||||||
SequenceNumber: uint32(i + 1),
|
|
||||||
UID: uint32(1000 + i),
|
|
||||||
Flags: flags,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
return &realTestMailboxStore{uidvalidity: 555, messages: messages}
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *realTestMailboxStore) Select(_ context.Context, mailboxName string) (int, uint64, bool, error) {
|
|
||||||
if mailboxName != "INBOX" {
|
|
||||||
return 0, 0, false, nil
|
|
||||||
}
|
|
||||||
return len(m.messages), m.uidvalidity, true, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *realTestMailboxStore) Fetch(_ context.Context, _ string, seqNumbers []uint32) ([]imap.Message, error) {
|
|
||||||
return m.filter(seqNumbers, false), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *realTestMailboxStore) FetchByUID(_ context.Context, _ string, uids []uint32) ([]imap.Message, error) {
|
|
||||||
return m.filter(uids, true), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (m *realTestMailboxStore) filter(wantedList []uint32, byUID bool) []imap.Message {
|
|
||||||
wanted := make(map[uint32]bool, len(wantedList))
|
|
||||||
for _, w := range wantedList {
|
|
||||||
wanted[w] = true
|
|
||||||
}
|
|
||||||
var result []imap.Message
|
|
||||||
for _, msg := range m.messages {
|
|
||||||
key := msg.SequenceNumber
|
|
||||||
if byUID {
|
|
||||||
key = msg.UID
|
|
||||||
}
|
|
||||||
if wanted[key] {
|
|
||||||
result = append(result, msg)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return result
|
|
||||||
}
|
|
||||||
|
|
||||||
func startRealTestIMAPServer(t *testing.T) (addr string, stop func()) {
|
|
||||||
t.Helper()
|
|
||||||
srv := imap.NewServer(realTestAuthenticator{}, newRealisticTestMailbox())
|
|
||||||
listener, err := net.Listen("tcp", "127.0.0.1:0")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("listener: %v", err)
|
|
||||||
}
|
|
||||||
ctx, cancel := context.WithCancel(context.Background())
|
|
||||||
done := make(chan struct{})
|
|
||||||
go func() {
|
|
||||||
_ = srv.Serve(ctx, listener)
|
|
||||||
close(done)
|
|
||||||
}()
|
|
||||||
return listener.Addr().String(), func() {
|
|
||||||
cancel()
|
|
||||||
<-done
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func TestRunOnce_AgainstRealTestMailboxWithRealisticVolume(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
scheduler := NewScheduler(store)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-imp01-realistisch"
|
|
||||||
|
|
||||||
addr, stop := startRealTestIMAPServer(t)
|
|
||||||
defer stop()
|
|
||||||
|
|
||||||
client := NewRealClient(addr, "importuser", "importpass123")
|
|
||||||
handler := &recordingHandler{}
|
|
||||||
|
|
||||||
result, err := scheduler.RunOnce(ctx, tenant, "INBOX", client, handler)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("runonce gegen echten server: %v", err)
|
|
||||||
}
|
|
||||||
if result.NewMessages != 30 {
|
|
||||||
t.Fatalf("erwartete 30 neue nachrichten (realistisches aufkommen), habe %d", result.NewMessages)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Zweiter Lauf gegen denselben echten Server: kein Doppelimport
|
|
||||||
// (Pflichtprüfung 1, hier zusätzlich end-zu-Ende über echtes IMAP
|
|
||||||
// bestätigt).
|
|
||||||
handler2 := &recordingHandler{}
|
|
||||||
result2, err := scheduler.RunOnce(ctx, tenant, "INBOX", client, handler2)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zweiter lauf gegen echten server: %v", err)
|
|
||||||
}
|
|
||||||
if result2.NewMessages != 0 {
|
|
||||||
t.Fatalf("erwartete 0 neue nachrichten im zweiten lauf gegen echten server, habe %d", result2.NewMessages)
|
|
||||||
}
|
|
||||||
if result2.ExistingMessages != 30 {
|
|
||||||
t.Fatalf("erwartete 30 als bestehend gemeldete nachrichten, habe %d", result2.ExistingMessages)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,10 +0,0 @@
|
|||||||
CREATE TABLE IF NOT EXISTS mail_import_state (
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
mailbox_name TEXT NOT NULL,
|
|
||||||
last_uidvalidity BIGINT NOT NULL DEFAULT 0,
|
|
||||||
last_synced_uid BIGINT NOT NULL DEFAULT 0,
|
|
||||||
interval_seconds INT NOT NULL DEFAULT 300,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
PRIMARY KEY (tenant_slug, mailbox_name)
|
|
||||||
)
|
|
||||||
@@ -1,104 +0,0 @@
|
|||||||
package imapimport
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"sort"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Handler verarbeitet die vom Scheduler klassifizierten Nachrichten.
|
|
||||||
// Echte Ablage/Indexierung ist Sache späterer Kacheln (IMP-02 u. a.) —
|
|
||||||
// dieses Paket bereitet nur die Schnittstelle vor.
|
|
||||||
type Handler interface {
|
|
||||||
// OnNewMessage wird GENAU EINMAL je UID aufgerufen, die seit dem
|
|
||||||
// letzten Abgleich neu hinzugekommen ist (Akzeptanzkriterium 1).
|
|
||||||
// Ein Fehler bricht den aktuellen Lauf ab, OHNE den Fortschritt für
|
|
||||||
// bereits erfolgreich verarbeitete Nachrichten zu verlieren
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
OnNewMessage(ctx context.Context, tenantSlug, mailboxName string, msg RemoteMessage) error
|
|
||||||
// OnExistingMessageState wird für bereits bekannte Nachrichten mit
|
|
||||||
// ihrem AKTUELLEN Flag-Zustand aufgerufen (Akzeptanzkriterium 2:
|
|
||||||
// Zustandsänderungen wie gelesen/gelöscht abgeglichen) — NIEMALS als
|
|
||||||
// Neuimport, die Nachricht selbst wird nicht erneut abgelegt.
|
|
||||||
OnExistingMessageState(ctx context.Context, tenantSlug, mailboxName string, msg RemoteMessage) error
|
|
||||||
}
|
|
||||||
|
|
||||||
// Scheduler führt den periodischen, UID-basierten Delta-Sync aus.
|
|
||||||
type Scheduler struct {
|
|
||||||
store *Store
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewScheduler(store *Store) *Scheduler {
|
|
||||||
return &Scheduler{store: store}
|
|
||||||
}
|
|
||||||
|
|
||||||
// SyncResult fasst einen abgeschlossenen Lauf zusammen.
|
|
||||||
type SyncResult struct {
|
|
||||||
NewMessages int
|
|
||||||
ExistingMessages int
|
|
||||||
Rebuilt bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunOnce führt genau einen Abgleich für ein Postfach aus (Akzeptanz-
|
|
||||||
// kriterium 1/2/3). Nachrichten werden nach UID aufsteigend verarbeitet;
|
|
||||||
// der Fortschritt wird nach JEDER neuen Nachricht einzeln persistiert
|
|
||||||
// (Store.advance), damit ein Absturz mitten im Lauf keine Nachricht
|
|
||||||
// verliert und beim nächsten Lauf keine bereits verarbeitete Nachricht
|
|
||||||
// erneut als "neu" gilt (Pflichtprüfung 1/2: kein Doppelimport, auch
|
|
||||||
// nach simuliertem Neustart).
|
|
||||||
func (s *Scheduler) RunOnce(ctx context.Context, tenantSlug, mailboxName string, client IMAPClient, handler Handler) (SyncResult, error) {
|
|
||||||
state, err := s.store.GetOrCreate(ctx, tenantSlug, mailboxName)
|
|
||||||
if err != nil {
|
|
||||||
return SyncResult{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
uidvalidity, messages, err := client.Sync(ctx, mailboxName)
|
|
||||||
if err != nil {
|
|
||||||
return SyncResult{}, fmt.Errorf("imapimport: postfach abrufen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
result := SyncResult{}
|
|
||||||
lastSyncedUID := state.LastSyncedUID
|
|
||||||
|
|
||||||
// Bekannten Fehler vermeiden (archivmail: UIDVALIDITY=0 bricht
|
|
||||||
// Resync): jede Änderung der UIDVALIDITY gegenüber dem persistierten
|
|
||||||
// Stand (0 = "noch nie synchronisiert", kein Rebuild) löst einen
|
|
||||||
// vollständigen Resync aus — alle Nachrichten gelten wieder als neu.
|
|
||||||
if state.LastUIDValidity != 0 && uidvalidity != state.LastUIDValidity {
|
|
||||||
lastSyncedUID = 0
|
|
||||||
result.Rebuilt = true
|
|
||||||
}
|
|
||||||
|
|
||||||
sorted := make([]RemoteMessage, len(messages))
|
|
||||||
copy(sorted, messages)
|
|
||||||
sort.Slice(sorted, func(i, j int) bool { return sorted[i].UID < sorted[j].UID })
|
|
||||||
|
|
||||||
for _, msg := range sorted {
|
|
||||||
if msg.UID > lastSyncedUID {
|
|
||||||
if err := handler.OnNewMessage(ctx, tenantSlug, mailboxName, msg); err != nil {
|
|
||||||
return result, fmt.Errorf("imapimport: neue nachricht uid=%d verarbeiten: %w", msg.UID, err)
|
|
||||||
}
|
|
||||||
lastSyncedUID = msg.UID
|
|
||||||
if err := s.store.advance(ctx, tenantSlug, mailboxName, uidvalidity, lastSyncedUID); err != nil {
|
|
||||||
return result, err
|
|
||||||
}
|
|
||||||
result.NewMessages++
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := handler.OnExistingMessageState(ctx, tenantSlug, mailboxName, msg); err != nil {
|
|
||||||
return result, fmt.Errorf("imapimport: zustand für uid=%d abgleichen: %w", msg.UID, err)
|
|
||||||
}
|
|
||||||
result.ExistingMessages++
|
|
||||||
}
|
|
||||||
|
|
||||||
// Auch ohne neue Nachrichten muss eine geänderte UIDVALIDITY
|
|
||||||
// persistiert werden (z. B. Rebuild bei leerem Postfach).
|
|
||||||
if uidvalidity != state.LastUIDValidity {
|
|
||||||
if err := s.store.advance(ctx, tenantSlug, mailboxName, uidvalidity, lastSyncedUID); err != nil {
|
|
||||||
return result, err
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
return result, nil
|
|
||||||
}
|
|
||||||
@@ -1,189 +0,0 @@
|
|||||||
// Integrationstest (IMP-01): echte Postgres-Instanz, folgt derselben
|
|
||||||
// Testhost-Konvention wie mail/internal/dedup/folderstate/savedsearch —
|
|
||||||
// TEST_TENANT_DSN.
|
|
||||||
package imapimport
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStore(t *testing.T) *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)
|
|
||||||
if err := store.EnsureSchema(ctx); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_import_state WHERE tenant_slug LIKE 'mandant-imp01-%'`)
|
|
||||||
})
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
// fakeIMAPClient simuliert ein entferntes Postfach — echte
|
|
||||||
// Netzwerkanbindung ist Sache von client_real.go (Pflichtprüfung 3
|
|
||||||
// nutzt sie real, hier wird die Delta-Sync-LOGIK isoliert geprüft,
|
|
||||||
// gleiche Konvention wie fakeKEKProvider/fakeAuthenticator in anderen
|
|
||||||
// Mail-Paketen).
|
|
||||||
type fakeIMAPClient struct {
|
|
||||||
uidvalidity uint64
|
|
||||||
messages []RemoteMessage
|
|
||||||
}
|
|
||||||
|
|
||||||
func (c *fakeIMAPClient) Sync(_ context.Context, _ string) (uint64, []RemoteMessage, error) {
|
|
||||||
return c.uidvalidity, c.messages, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// recordingHandler zeichnet auf, welche UIDs als neu bzw. als bestehend
|
|
||||||
// gemeldet wurden — die eigentliche Ablage/Indexierung ist Sache
|
|
||||||
// späterer Kacheln.
|
|
||||||
type recordingHandler struct {
|
|
||||||
newUIDs []uint32
|
|
||||||
existingUIDs []uint32
|
|
||||||
failAfterN int // >0: OnNewMessage schlägt NACH n erfolgreichen Aufrufen fehl
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *recordingHandler) OnNewMessage(_ context.Context, _, _ string, msg RemoteMessage) error {
|
|
||||||
if h.failAfterN > 0 && len(h.newUIDs) >= h.failAfterN {
|
|
||||||
return errors.New("simulierter absturz mitten im abgleich")
|
|
||||||
}
|
|
||||||
h.newUIDs = append(h.newUIDs, msg.UID)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func (h *recordingHandler) OnExistingMessageState(_ context.Context, _, _ string, msg RemoteMessage) error {
|
|
||||||
h.existingUIDs = append(h.existingUIDs, msg.UID)
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRunOnce_TwoConsecutiveRunsNoDuplicateImport ist die geforderte
|
|
||||||
// Pflichtprüfung 1: zwei aufeinanderfolgende Läufe importieren keine
|
|
||||||
// Nachricht doppelt.
|
|
||||||
func TestRunOnce_TwoConsecutiveRunsNoDuplicateImport(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
scheduler := NewScheduler(store)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-imp01-doppelimport"
|
|
||||||
|
|
||||||
client := &fakeIMAPClient{uidvalidity: 1, messages: []RemoteMessage{
|
|
||||||
{UID: 1, Flags: nil}, {UID: 2, Flags: nil}, {UID: 3, Flags: nil},
|
|
||||||
}}
|
|
||||||
|
|
||||||
handler1 := &recordingHandler{}
|
|
||||||
result1, err := scheduler.RunOnce(ctx, tenant, "INBOX", client, handler1)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erster lauf: %v", err)
|
|
||||||
}
|
|
||||||
if result1.NewMessages != 3 || len(handler1.newUIDs) != 3 {
|
|
||||||
t.Fatalf("erwartete 3 neue nachrichten im ersten lauf, habe: %+v / %v", result1, handler1.newUIDs)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Zweiter Lauf OHNE neue Nachrichten auf dem Server (gleiches
|
|
||||||
// fakeIMAPClient) — real derselbe Zustand wie beim ersten Abruf.
|
|
||||||
handler2 := &recordingHandler{}
|
|
||||||
result2, err := scheduler.RunOnce(ctx, tenant, "INBOX", client, handler2)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zweiter lauf: %v", err)
|
|
||||||
}
|
|
||||||
if result2.NewMessages != 0 {
|
|
||||||
t.Fatalf("erwartete 0 neue nachrichten im zweiten lauf (kein doppelimport), habe %d: %v", result2.NewMessages, handler2.newUIDs)
|
|
||||||
}
|
|
||||||
if result2.ExistingMessages != 3 {
|
|
||||||
t.Fatalf("erwartete 3 als bestehend gemeldete nachrichten im zweiten lauf, habe %d", result2.ExistingMessages)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRunOnce_SimulatedRestartMidSyncConsistentEndState ist die
|
|
||||||
// geforderte Pflichtprüfung 2: simulierter Dienst-Neustart mitten im
|
|
||||||
// Abgleich führt zu konsistentem Endzustand.
|
|
||||||
func TestRunOnce_SimulatedRestartMidSyncConsistentEndState(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
scheduler := NewScheduler(store)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-imp01-neustart"
|
|
||||||
|
|
||||||
client := &fakeIMAPClient{uidvalidity: 1, messages: []RemoteMessage{
|
|
||||||
{UID: 1}, {UID: 2}, {UID: 3}, {UID: 4}, {UID: 5},
|
|
||||||
}}
|
|
||||||
|
|
||||||
// Erster Lauf "stürzt" nach 2 erfolgreich verarbeiteten Nachrichten ab.
|
|
||||||
crashingHandler := &recordingHandler{failAfterN: 2}
|
|
||||||
_, err := scheduler.RunOnce(ctx, tenant, "INBOX", client, crashingHandler)
|
|
||||||
if err == nil {
|
|
||||||
t.Fatal("erwartete fehler durch simulierten absturz, habe nil")
|
|
||||||
}
|
|
||||||
if len(crashingHandler.newUIDs) != 2 {
|
|
||||||
t.Fatalf("erwartete 2 erfolgreich verarbeitete nachrichten vor dem absturz, habe %d: %v", len(crashingHandler.newUIDs), crashingHandler.newUIDs)
|
|
||||||
}
|
|
||||||
|
|
||||||
// "Neustart des Dienstes": neuer Scheduler auf demselben (persistenten)
|
|
||||||
// Store, neuer Handler ohne Fehlerinjektion.
|
|
||||||
restartedScheduler := NewScheduler(store)
|
|
||||||
freshHandler := &recordingHandler{}
|
|
||||||
result, err := restartedScheduler.RunOnce(ctx, tenant, "INBOX", client, freshHandler)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("lauf nach neustart: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Konsistenter Endzustand: GENAU die 3 nach dem Absturz verbliebenen
|
|
||||||
// Nachrichten (UID 3,4,5) werden verarbeitet — die ersten 2 (bereits
|
|
||||||
// vor dem Absturz erfolgreich verarbeitet) NICHT erneut.
|
|
||||||
if result.NewMessages != 3 {
|
|
||||||
t.Fatalf("erwartete 3 neue nachrichten nach neustart, habe %d: %v", result.NewMessages, freshHandler.newUIDs)
|
|
||||||
}
|
|
||||||
for _, uid := range freshHandler.newUIDs {
|
|
||||||
if uid <= 2 {
|
|
||||||
t.Fatalf("uid %d wurde nach dem neustart erneut als 'neu' verarbeitet — doppelimport nach absturz", uid)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
finalState, err := store.Get(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("endzustand lesen: %v", err)
|
|
||||||
}
|
|
||||||
if finalState.LastSyncedUID != 5 {
|
|
||||||
t.Fatalf("erwartete konsistenten endzustand last_synced_uid=5, habe %d", finalState.LastSyncedUID)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSetInterval_ConfigurableAndSurvivesRestart deckt
|
|
||||||
// Akzeptanzkriterium 3 ab: Abrufintervall ist je Postfach konfigurierbar
|
|
||||||
// und übersteht Neustarts des Dienstes (real geprüft über eine neue
|
|
||||||
// Store-Instanz auf demselben Postgres-Zustand, kein Prozessspeicher).
|
|
||||||
func TestSetInterval_ConfigurableAndSurvivesRestart(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-imp01-intervall"
|
|
||||||
|
|
||||||
if _, err := store.GetOrCreate(ctx, tenant, "INBOX"); err != nil {
|
|
||||||
t.Fatalf("getorcreate: %v", err)
|
|
||||||
}
|
|
||||||
if err := store.SetInterval(ctx, tenant, "INBOX", 900); err != nil {
|
|
||||||
t.Fatalf("setinterval: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
// "Neustart des Dienstes": komplett neue Store-Instanz.
|
|
||||||
restartedStore := NewStore(store.pool)
|
|
||||||
state, err := restartedStore.Get(ctx, tenant, "INBOX")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get nach neustart: %v", err)
|
|
||||||
}
|
|
||||||
if state.IntervalSeconds != 900 {
|
|
||||||
t.Fatalf("erwartete konfiguriertes intervall 900 nach neustart, habe %d", state.IntervalSeconds)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,112 +0,0 @@
|
|||||||
// Package imapimport implementiert IMP-01: den Scheduler für
|
|
||||||
// periodischen IMAP-Postfach-Abruf mit UID-basiertem Delta-Sync. Baut
|
|
||||||
// auf ING-01 (mail/internal/imap, IMAP-Server-Grundgerüst inkl. UID
|
|
||||||
// FETCH) und ING-05 (mail/internal/folderstate, UIDVALIDITY/UIDNEXT) auf
|
|
||||||
// — kombiniert bewusst beide fertigen, unveränderten Pakete statt eines
|
|
||||||
// davon zu erweitern (kein Umbau angrenzender Bereiche).
|
|
||||||
//
|
|
||||||
// Konzept aus archivmail als Ausgangspunkt genommen (UID-Sync,
|
|
||||||
// Delta-Import, siehe repos-analyse-mail-reuse.md), Testabdeckung von
|
|
||||||
// Grund auf neu (archivmails Import-Pfade waren praktisch ungetestet).
|
|
||||||
// Bekannten Fehler vermieden (archivmail: UIDVALIDITY=0 bricht Resync
|
|
||||||
// bei nicht-konformen Servern): Store.RunOnce erkennt jede Änderung der
|
|
||||||
// UIDVALIDITY explizit und löst einen vollständigen Resync aus, statt
|
|
||||||
// eine UIDVALIDITY=0 unbesehen zu übernehmen.
|
|
||||||
package imapimport
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
_ "embed"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
//go:embed migrations/0001_mail_import_state.sql
|
|
||||||
var schemaMigration string
|
|
||||||
|
|
||||||
const defaultIntervalSeconds = 300
|
|
||||||
|
|
||||||
// State ist der persistierte Sync-Zustand eines Postfachs — übersteht
|
|
||||||
// Dienst-Neustarts (Akzeptanzkriterium 3), da ausschließlich in Postgres
|
|
||||||
// gehalten, nie im Prozessspeicher.
|
|
||||||
type State struct {
|
|
||||||
TenantSlug string
|
|
||||||
MailboxName string
|
|
||||||
LastUIDValidity uint64
|
|
||||||
LastSyncedUID uint32
|
|
||||||
IntervalSeconds int
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store persistiert den Sync-Zustand je Mandant und Postfach.
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert.
|
|
||||||
func (s *Store) EnsureSchema(ctx context.Context) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, schemaMigration); err != nil {
|
|
||||||
return fmt.Errorf("imapimport: schema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// GetOrCreate liefert den Sync-Zustand eines Postfachs, legt ihn bei
|
|
||||||
// erstem Zugriff mit dem Standardintervall neu an.
|
|
||||||
func (s *Store) GetOrCreate(ctx context.Context, tenantSlug, mailboxName string) (State, error) {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
INSERT INTO mail_import_state (tenant_slug, mailbox_name, interval_seconds)
|
|
||||||
VALUES ($1, $2, $3)
|
|
||||||
ON CONFLICT (tenant_slug, mailbox_name) DO NOTHING
|
|
||||||
`, tenantSlug, mailboxName, defaultIntervalSeconds); err != nil {
|
|
||||||
return State{}, fmt.Errorf("imapimport: sync-zustand anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return s.Get(ctx, tenantSlug, mailboxName)
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liest den aktuellen Sync-Zustand.
|
|
||||||
func (s *Store) Get(ctx context.Context, tenantSlug, mailboxName string) (State, error) {
|
|
||||||
var st State
|
|
||||||
st.TenantSlug = tenantSlug
|
|
||||||
st.MailboxName = mailboxName
|
|
||||||
err := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT last_uidvalidity, last_synced_uid, interval_seconds
|
|
||||||
FROM mail_import_state WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
`, tenantSlug, mailboxName).Scan(&st.LastUIDValidity, &st.LastSyncedUID, &st.IntervalSeconds)
|
|
||||||
if err != nil {
|
|
||||||
return State{}, fmt.Errorf("imapimport: sync-zustand lesen: %w", err)
|
|
||||||
}
|
|
||||||
return st, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// SetInterval konfiguriert das Abrufintervall je Postfach
|
|
||||||
// (Akzeptanzkriterium 3), persistiert und damit neustartfest.
|
|
||||||
func (s *Store) SetInterval(ctx context.Context, tenantSlug, mailboxName string, seconds int) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
UPDATE mail_import_state SET interval_seconds = $3, updated_at = now()
|
|
||||||
WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
`, tenantSlug, mailboxName, seconds); err != nil {
|
|
||||||
return fmt.Errorf("imapimport: intervall setzen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// advance persistiert den erreichten Fortschritt NACH jeder erfolgreich
|
|
||||||
// verarbeiteten Nachricht (nicht erst am Ende des Laufs) — Grundlage für
|
|
||||||
// Akzeptanzkriterium 3 / Pflichtprüfung 2: ein Dienst-Neustart mitten im
|
|
||||||
// Abgleich verliert höchstens die aktuell laufende Verarbeitung, nie den
|
|
||||||
// bereits erreichten Fortschritt, und importiert nichts doppelt.
|
|
||||||
func (s *Store) advance(ctx context.Context, tenantSlug, mailboxName string, uidvalidity uint64, syncedUID uint32) error {
|
|
||||||
if _, err := s.pool.Exec(ctx, `
|
|
||||||
UPDATE mail_import_state
|
|
||||||
SET last_uidvalidity = $3, last_synced_uid = $4, updated_at = now()
|
|
||||||
WHERE tenant_slug = $1 AND mailbox_name = $2
|
|
||||||
`, tenantSlug, mailboxName, uidvalidity, syncedUID); err != nil {
|
|
||||||
return fmt.Errorf("imapimport: fortschritt persistieren: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
CREATE TABLE IF NOT EXISTS mail_index_jobs (
|
|
||||||
id BIGSERIAL PRIMARY KEY,
|
|
||||||
job_type TEXT NOT NULL CHECK (job_type IN ('index', 'delete')),
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
message_id TEXT NOT NULL,
|
|
||||||
payload JSONB NOT NULL DEFAULT '{}'::jsonb,
|
|
||||||
status TEXT NOT NULL DEFAULT 'pending' CHECK (status IN ('pending', 'processing', 'succeeded', 'failed')),
|
|
||||||
attempts INT NOT NULL DEFAULT 0,
|
|
||||||
max_attempts INT NOT NULL DEFAULT 5,
|
|
||||||
available_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
locked_at TIMESTAMPTZ,
|
|
||||||
locked_by TEXT,
|
|
||||||
last_error TEXT,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now()
|
|
||||||
)
|
|
||||||
@@ -1,213 +0,0 @@
|
|||||||
// Package indexworker implementiert SRC-02: einen Indexierungs-Worker,
|
|
||||||
// der neu archivierte Mails asynchron in den Manticore-Index (SRC-01)
|
|
||||||
// einpflegt und Löschungen/Metadatenänderungen nachzieht. Postgres-
|
|
||||||
// Jobqueue mit FOR UPDATE SKIP LOCKED, Stale-Lock-Wiedervorlage bei
|
|
||||||
// Worker-Absturz — dieselbe Konvention wie dms/internal/jobqueue (FDN-04),
|
|
||||||
// hier bewusst schlanker (kein Redis/AMQP, keine DLQ — nicht Bestandteil
|
|
||||||
// der Akzeptanzkriterien dieser Kachel).
|
|
||||||
package indexworker
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
_ "embed"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
//go:embed migrations/0001_mail_index_jobs.sql
|
|
||||||
var schemaMigration string
|
|
||||||
|
|
||||||
const (
|
|
||||||
JobTypeIndex = "index"
|
|
||||||
JobTypeDelete = "delete"
|
|
||||||
)
|
|
||||||
|
|
||||||
const (
|
|
||||||
StatusPending = "pending"
|
|
||||||
StatusProcessing = "processing"
|
|
||||||
StatusSucceeded = "succeeded"
|
|
||||||
StatusFailed = "failed"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ErrNoJobAvailable wird von Dequeue geliefert, wenn aktuell kein
|
|
||||||
// abholbarer Job vorhanden ist (Normalfall bei leerer Queue).
|
|
||||||
var ErrNoJobAvailable = errors.New("indexworker: kein job verfügbar")
|
|
||||||
|
|
||||||
// ErrNotFound wird geliefert, wenn ein angefragter Job nicht existiert.
|
|
||||||
var ErrNotFound = errors.New("indexworker: job nicht gefunden")
|
|
||||||
|
|
||||||
const defaultMaxAttempts = 5
|
|
||||||
|
|
||||||
// Job ist eine einzelne Indexierungs-/Löschaufgabe.
|
|
||||||
type Job struct {
|
|
||||||
ID int64
|
|
||||||
JobType string
|
|
||||||
TenantSlug string
|
|
||||||
MessageID string
|
|
||||||
Status string
|
|
||||||
Attempts int
|
|
||||||
}
|
|
||||||
|
|
||||||
// Queue kapselt den Zugriff auf mail_index_jobs.
|
|
||||||
type Queue struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
staleLockAfter time.Duration
|
|
||||||
}
|
|
||||||
|
|
||||||
// NewQueue erzeugt eine Queue. staleLockAfter legt fest, ab wann ein
|
|
||||||
// als "processing" markierter Job wieder abholbar gilt, weil sein Worker
|
|
||||||
// vermutlich abgestürzt ist (Akzeptanzkriterium 3: Worker-Ausfall verliert
|
|
||||||
// keine Indexierungsaufträge).
|
|
||||||
func NewQueue(pool *pgxpool.Pool, staleLockAfter time.Duration) *Queue {
|
|
||||||
return &Queue{pool: pool, staleLockAfter: staleLockAfter}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
|
||||||
// gleiches Muster wie mail/internal/dedup (kein zentraler Migrationsläufer
|
|
||||||
// für Mandanten-Datenbanken im Mail-Modul vorhanden).
|
|
||||||
func (q *Queue) EnsureSchema(ctx context.Context) error {
|
|
||||||
if _, err := q.pool.Exec(ctx, schemaMigration); err != nil {
|
|
||||||
return fmt.Errorf("indexworker: schema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnqueueIndex reiht eine Indexierungsaufgabe ein (Akzeptanzkriterium 1).
|
|
||||||
// payload enthält die für die Indexierung nötigen Felder (Betreff, Text,
|
|
||||||
// Anhangstext) als JSON — der Worker kennt keine Klartext-Beschaffung
|
|
||||||
// selbst, das ist Aufgabe des Aufrufers (analog dedup, das ebenfalls
|
|
||||||
// storage/crypto nicht kennt).
|
|
||||||
func (q *Queue) EnqueueIndex(ctx context.Context, tenantSlug, messageID string, payload []byte) (int64, error) {
|
|
||||||
return q.enqueue(ctx, JobTypeIndex, tenantSlug, messageID, payload)
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnqueueDelete reiht eine Löschaufgabe ein (Akzeptanzkriterium 2).
|
|
||||||
func (q *Queue) EnqueueDelete(ctx context.Context, tenantSlug, messageID string) (int64, error) {
|
|
||||||
return q.enqueue(ctx, JobTypeDelete, tenantSlug, messageID, []byte(`{}`))
|
|
||||||
}
|
|
||||||
|
|
||||||
func (q *Queue) enqueue(ctx context.Context, jobType, tenantSlug, messageID string, payload []byte) (int64, error) {
|
|
||||||
var id int64
|
|
||||||
err := q.pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO mail_index_jobs (job_type, tenant_slug, message_id, payload, max_attempts)
|
|
||||||
VALUES ($1, $2, $3, $4, $5)
|
|
||||||
RETURNING id
|
|
||||||
`, jobType, tenantSlug, messageID, payload, defaultMaxAttempts).Scan(&id)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("indexworker: job einreihen: %w", err)
|
|
||||||
}
|
|
||||||
return id, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// dequeuedJob trägt zusätzlich den Payload, den nur das Paket selbst
|
|
||||||
// (worker.go) benötigt.
|
|
||||||
type dequeuedJob struct {
|
|
||||||
Job
|
|
||||||
Payload []byte
|
|
||||||
}
|
|
||||||
|
|
||||||
// Dequeue holt GENAU EINEN abholbaren Job (fällig UND nicht gesperrt, ODER
|
|
||||||
// dessen Sperre abgestanden ist) und markiert ihn atomar als "processing"
|
|
||||||
// (Prüfung: Worker-Neustart mitten im Lauf verliert keinen offenen Auftrag
|
|
||||||
// — FOR UPDATE SKIP LOCKED erlaubt mehreren Worker-Goroutinen gleichzeitigen
|
|
||||||
// Aufruf ohne denselben Job doppelt zu holen).
|
|
||||||
func (q *Queue) dequeue(ctx context.Context, workerID string) (*dequeuedJob, error) {
|
|
||||||
tx, err := q.pool.Begin(ctx)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("indexworker: transaktion starten: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = tx.Rollback(ctx) }()
|
|
||||||
|
|
||||||
row := tx.QueryRow(ctx, `
|
|
||||||
SELECT id, job_type, tenant_slug, message_id, payload, status, attempts
|
|
||||||
FROM mail_index_jobs
|
|
||||||
WHERE (
|
|
||||||
(status = 'pending' AND available_at <= now())
|
|
||||||
OR (status = 'processing' AND locked_at <= now() - ($1 * interval '1 second'))
|
|
||||||
)
|
|
||||||
ORDER BY available_at
|
|
||||||
FOR UPDATE SKIP LOCKED
|
|
||||||
LIMIT 1
|
|
||||||
`, q.staleLockAfter.Seconds())
|
|
||||||
|
|
||||||
var j dequeuedJob
|
|
||||||
if err := row.Scan(&j.ID, &j.JobType, &j.TenantSlug, &j.MessageID, &j.Payload, &j.Status, &j.Attempts); err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return nil, ErrNoJobAvailable
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("indexworker: nächsten job lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := tx.Exec(ctx, `
|
|
||||||
UPDATE mail_index_jobs
|
|
||||||
SET status = 'processing', attempts = attempts + 1, locked_at = now(), locked_by = $2, updated_at = now()
|
|
||||||
WHERE id = $1
|
|
||||||
`, j.ID, workerID); err != nil {
|
|
||||||
return nil, fmt.Errorf("indexworker: job sperren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := tx.Commit(ctx); err != nil {
|
|
||||||
return nil, fmt.Errorf("indexworker: dequeue committen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
j.Status = StatusProcessing
|
|
||||||
j.Attempts++
|
|
||||||
return &j, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// complete markiert einen Job als erfolgreich abgeschlossen.
|
|
||||||
func (q *Queue) complete(ctx context.Context, jobID int64) error {
|
|
||||||
tag, err := q.pool.Exec(ctx, `
|
|
||||||
UPDATE mail_index_jobs SET status = 'succeeded', locked_at = NULL, locked_by = NULL, updated_at = now()
|
|
||||||
WHERE id = $1
|
|
||||||
`, jobID)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("indexworker: job abschließen: %w", err)
|
|
||||||
}
|
|
||||||
if tag.RowsAffected() == 0 {
|
|
||||||
return ErrNotFound
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// fail markiert einen Job als fehlgeschlagen. Sind die maximalen Versuche
|
|
||||||
// erreicht, bleibt er dauerhaft 'failed' (keine DLQ, nicht Bestandteil
|
|
||||||
// dieser Kachel), sonst wird er mit arithmetischem Backoff (kein
|
|
||||||
// String-Concat für Intervalle) erneut eingeplant.
|
|
||||||
func (q *Queue) fail(ctx context.Context, jobID int64, cause error) error {
|
|
||||||
tag, err := q.pool.Exec(ctx, `
|
|
||||||
UPDATE mail_index_jobs
|
|
||||||
SET status = CASE WHEN attempts >= max_attempts THEN 'failed' ELSE 'pending' END,
|
|
||||||
available_at = now() + (LEAST(attempts, 10) * interval '10 seconds'),
|
|
||||||
locked_at = NULL, locked_by = NULL, last_error = $2, updated_at = now()
|
|
||||||
WHERE id = $1
|
|
||||||
`, jobID, cause.Error())
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("indexworker: fehlschlag erfassen: %w", err)
|
|
||||||
}
|
|
||||||
if tag.RowsAffected() == 0 {
|
|
||||||
return ErrNotFound
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Status liefert den aktuellen Zustand eines Jobs (abrufbar über API,
|
|
||||||
// hier als Go-API — HTTP-Anbindung ist nicht Bestandteil dieser Kachel).
|
|
||||||
func (q *Queue) Status(ctx context.Context, jobID int64) (*Job, error) {
|
|
||||||
var j Job
|
|
||||||
err := q.pool.QueryRow(ctx, `
|
|
||||||
SELECT id, job_type, tenant_slug, message_id, status, attempts
|
|
||||||
FROM mail_index_jobs WHERE id = $1
|
|
||||||
`, jobID).Scan(&j.ID, &j.JobType, &j.TenantSlug, &j.MessageID, &j.Status, &j.Attempts)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return nil, ErrNotFound
|
|
||||||
}
|
|
||||||
return nil, fmt.Errorf("indexworker: job-status lesen: %w", err)
|
|
||||||
}
|
|
||||||
return &j, nil
|
|
||||||
}
|
|
||||||
@@ -1,100 +0,0 @@
|
|||||||
// Integrationstest (SRC-02): echte Postgres-Instanz, folgt derselben
|
|
||||||
// Testhost-Konvention wie mail/internal/dedup — TEST_TENANT_DSN.
|
|
||||||
package indexworker
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupQueue(t *testing.T, staleLockAfter time.Duration) *Queue {
|
|
||||||
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() })
|
|
||||||
|
|
||||||
queue := NewQueue(pool, staleLockAfter)
|
|
||||||
if err := queue.EnsureSchema(ctx); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_index_jobs WHERE tenant_slug LIKE 'mandant-src02-%'`)
|
|
||||||
})
|
|
||||||
return queue
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDequeue_WorkerCrashMidRunLosesNoJob ist die geforderte Pflichtprüfung
|
|
||||||
// 1: Absturz eines Workers (Job wird geholt, aber nie completed/failed)
|
|
||||||
// führt nach Ablauf der Stale-Lock-Frist zu erneuter Zustellung an einen
|
|
||||||
// zweiten Worker.
|
|
||||||
func TestDequeue_WorkerCrashMidRunLosesNoJob(t *testing.T) {
|
|
||||||
queue := setupQueue(t, 100*time.Millisecond)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
jobID, err := queue.EnqueueDelete(ctx, "mandant-src02-crash", "msg-crash-1")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
firstAttempt, err := queue.dequeue(ctx, "worker-1-abgestuerzt")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("erster dequeue: %v", err)
|
|
||||||
}
|
|
||||||
if firstAttempt.ID != jobID {
|
|
||||||
t.Fatalf("erwartete job-id %d, habe %d", jobID, firstAttempt.ID)
|
|
||||||
}
|
|
||||||
// worker-1 "stürzt ab": kein complete(), kein fail() — Job bleibt
|
|
||||||
// als "processing" mit veraltetem Lock stehen.
|
|
||||||
|
|
||||||
if _, err := queue.dequeue(ctx, "worker-2-sofort"); !errors.Is(err, ErrNoJobAvailable) {
|
|
||||||
t.Fatalf("erwartete kein verfügbarer job vor ablauf der stale-lock-frist, habe: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
time.Sleep(150 * time.Millisecond)
|
|
||||||
|
|
||||||
secondAttempt, err := queue.dequeue(ctx, "worker-2-nach-timeout")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("zweiter dequeue nach stale-lock-ablauf: %v", err)
|
|
||||||
}
|
|
||||||
if secondAttempt.ID != jobID {
|
|
||||||
t.Fatalf("erwartete erneute zustellung desselben jobs %d, habe %d", jobID, secondAttempt.ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := queue.complete(ctx, secondAttempt.ID); err != nil {
|
|
||||||
t.Fatalf("complete: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestEnqueueAndStatus_RoundTrip deckt Akzeptanzkriterium 3 (Job-Status
|
|
||||||
// abrufbar) auf Queue-Ebene ab.
|
|
||||||
func TestEnqueueAndStatus_RoundTrip(t *testing.T) {
|
|
||||||
queue := setupQueue(t, time.Minute)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
payload, _ := json.Marshal(map[string]string{"subject": "Test"})
|
|
||||||
jobID, err := queue.EnqueueIndex(ctx, "mandant-src02-status", "msg-status-1", payload)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
job, err := queue.Status(ctx, jobID)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("status: %v", err)
|
|
||||||
}
|
|
||||||
if job.Status != StatusPending {
|
|
||||||
t.Fatalf("erwartete status 'pending', habe %q", job.Status)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,74 +0,0 @@
|
|||||||
package indexworker
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/search"
|
|
||||||
)
|
|
||||||
|
|
||||||
// indexPayload sind die für die Indexierung nötigen Felder, wie sie beim
|
|
||||||
// EnqueueIndex als JSON übergeben werden.
|
|
||||||
type indexPayload struct {
|
|
||||||
Subject string `json:"subject"`
|
|
||||||
Body string `json:"body"`
|
|
||||||
AttachmentText string `json:"attachment_text"`
|
|
||||||
SentAtUnixEpoch int64 `json:"sent_at"`
|
|
||||||
}
|
|
||||||
|
|
||||||
// Worker holt Jobs aus der Queue und pflegt sie in den Manticore-Index
|
|
||||||
// (SRC-01) ein bzw. entfernt sie daraus.
|
|
||||||
type Worker struct {
|
|
||||||
queue *Queue
|
|
||||||
searchClient *search.Client
|
|
||||||
id string
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewWorker(queue *Queue, searchClient *search.Client, workerID string) *Worker {
|
|
||||||
return &Worker{queue: queue, searchClient: searchClient, id: workerID}
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunOnce verarbeitet genau einen Job, falls vorhanden. Liefert
|
|
||||||
// ErrNoJobAvailable, wenn die Queue aktuell leer ist — kein Fehlerzustand.
|
|
||||||
func (w *Worker) RunOnce(ctx context.Context) error {
|
|
||||||
job, err := w.queue.dequeue(ctx, w.id)
|
|
||||||
if err != nil {
|
|
||||||
return err
|
|
||||||
}
|
|
||||||
|
|
||||||
if procErr := w.process(ctx, job); procErr != nil {
|
|
||||||
if failErr := w.queue.fail(ctx, job.ID, procErr); failErr != nil {
|
|
||||||
return fmt.Errorf("indexworker: job %d fehlgeschlagen (%v) UND fehlschlag nicht erfassbar: %w", job.ID, procErr, failErr)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
return w.queue.complete(ctx, job.ID)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (w *Worker) process(ctx context.Context, job *dequeuedJob) error {
|
|
||||||
docID := search.DocumentID(job.TenantSlug, job.MessageID)
|
|
||||||
|
|
||||||
switch job.JobType {
|
|
||||||
case JobTypeIndex:
|
|
||||||
var p indexPayload
|
|
||||||
if err := json.Unmarshal(job.Payload, &p); err != nil {
|
|
||||||
return fmt.Errorf("indexierungs-payload lesen: %w", err)
|
|
||||||
}
|
|
||||||
return w.searchClient.Index(ctx, search.Document{
|
|
||||||
ID: docID,
|
|
||||||
TenantSlug: job.TenantSlug,
|
|
||||||
MessageID: job.MessageID,
|
|
||||||
Subject: p.Subject,
|
|
||||||
Body: p.Body,
|
|
||||||
AttachmentText: p.AttachmentText,
|
|
||||||
SentAtUnixEpoch: p.SentAtUnixEpoch,
|
|
||||||
})
|
|
||||||
case JobTypeDelete:
|
|
||||||
return w.searchClient.Delete(ctx, docID)
|
|
||||||
default:
|
|
||||||
return errors.New("unbekannter job-typ: " + job.JobType)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,177 +0,0 @@
|
|||||||
// Integrationstest (SRC-02): echte Postgres- UND Manticore-Instanz,
|
|
||||||
// folgt derselben TEST_*-Env-Konvention wie mail/internal/search.
|
|
||||||
package indexworker
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"encoding/json"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/search"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupWorkerEnv(t *testing.T) (*Queue, *search.Client) {
|
|
||||||
t.Helper()
|
|
||||||
if os.Getenv("TEST_TENANT_DSN") == "" || os.Getenv("TEST_MANTICORE_URL") == "" {
|
|
||||||
t.Skip("TEST_TENANT_DSN/TEST_MANTICORE_URL nicht gesetzt, Integrationstest übersprungen")
|
|
||||||
}
|
|
||||||
queue := setupQueue(t, time.Minute)
|
|
||||||
searchClient := search.NewClient(os.Getenv("TEST_MANTICORE_URL"))
|
|
||||||
if err := searchClient.EnsureSchema(context.Background()); err != nil {
|
|
||||||
t.Fatalf("search-schema: %v", err)
|
|
||||||
}
|
|
||||||
return queue, searchClient
|
|
||||||
}
|
|
||||||
|
|
||||||
func drainQueue(t *testing.T, worker *Worker, maxJobs int) {
|
|
||||||
t.Helper()
|
|
||||||
ctx := context.Background()
|
|
||||||
for i := 0; i < maxJobs; i++ {
|
|
||||||
if err := worker.RunOnce(ctx); err != nil {
|
|
||||||
if err == ErrNoJobAvailable {
|
|
||||||
return
|
|
||||||
}
|
|
||||||
t.Fatalf("worker.RunOnce: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestIndexJob_MakesMailSearchable ist die geforderte Funktionsprüfung zu
|
|
||||||
// Akzeptanzkriterium 1: eine eingereihte Indexierungsaufgabe macht die Mail
|
|
||||||
// nach Verarbeitung durch den Worker durchsuchbar.
|
|
||||||
func TestIndexJob_MakesMailSearchable(t *testing.T) {
|
|
||||||
queue, searchClient := setupWorkerEnv(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-src02-index"
|
|
||||||
|
|
||||||
payload, _ := json.Marshal(map[string]any{
|
|
||||||
"subject": "Jahresabschluss 2025",
|
|
||||||
"body": "Anbei der Jahresabschluss zur Prüfung.",
|
|
||||||
})
|
|
||||||
if _, err := queue.EnqueueIndex(ctx, tenant, "msg-idx-1", payload); err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
worker := NewWorker(queue, searchClient, "worker-test-index")
|
|
||||||
drainQueue(t, worker, 5)
|
|
||||||
|
|
||||||
results, err := searchClient.Search(ctx, tenant, "Jahresabschluss")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("search: %v", err)
|
|
||||||
}
|
|
||||||
found := false
|
|
||||||
for _, r := range results {
|
|
||||||
if r.MessageID == "msg-idx-1" {
|
|
||||||
found = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !found {
|
|
||||||
t.Fatalf("erwarteten treffer msg-idx-1 nach indexierung nicht gefunden, habe: %+v", results)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDeleteJob_RemovesMailFromSearchResults ist die geforderte
|
|
||||||
// Pflichtprüfung 2: Löschung einer Mail entfernt sie zuverlässig aus
|
|
||||||
// Suchtreffern.
|
|
||||||
func TestDeleteJob_RemovesMailFromSearchResults(t *testing.T) {
|
|
||||||
queue, searchClient := setupWorkerEnv(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-src02-delete"
|
|
||||||
|
|
||||||
payload, _ := json.Marshal(map[string]any{
|
|
||||||
"subject": "Vertraulicher Vorgang Zeta",
|
|
||||||
"body": "Nur für internen Gebrauch.",
|
|
||||||
})
|
|
||||||
if _, err := queue.EnqueueIndex(ctx, tenant, "msg-del-1", payload); err != nil {
|
|
||||||
t.Fatalf("enqueue index: %v", err)
|
|
||||||
}
|
|
||||||
worker := NewWorker(queue, searchClient, "worker-test-delete")
|
|
||||||
drainQueue(t, worker, 5)
|
|
||||||
|
|
||||||
preResults, err := searchClient.Search(ctx, tenant, "Zeta")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("search vor löschung: %v", err)
|
|
||||||
}
|
|
||||||
preFound := false
|
|
||||||
for _, r := range preResults {
|
|
||||||
if r.MessageID == "msg-del-1" {
|
|
||||||
preFound = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !preFound {
|
|
||||||
t.Fatal("voraussetzung nicht erfüllt: mail vor löschung nicht auffindbar")
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := queue.EnqueueDelete(ctx, tenant, "msg-del-1"); err != nil {
|
|
||||||
t.Fatalf("enqueue delete: %v", err)
|
|
||||||
}
|
|
||||||
drainQueue(t, worker, 5)
|
|
||||||
|
|
||||||
postResults, err := searchClient.Search(ctx, tenant, "Zeta")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("search nach löschung: %v", err)
|
|
||||||
}
|
|
||||||
for _, r := range postResults {
|
|
||||||
if r.MessageID == "msg-del-1" {
|
|
||||||
t.Fatal("gelöschte mail weiterhin in suchtreffern gefunden")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestConsistency_DatabaseAndIndexMatchOnSample ist die geforderte
|
|
||||||
// Pflichtprüfung 3: Konsistenztest vergleicht Datenbankbestand (erfolgreich
|
|
||||||
// abgeschlossene Index-Jobs) mit Indexbestand stichprobenartig.
|
|
||||||
func TestConsistency_DatabaseAndIndexMatchOnSample(t *testing.T) {
|
|
||||||
queue, searchClient := setupWorkerEnv(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-src02-konsistenz"
|
|
||||||
|
|
||||||
messageIDs := []string{"msg-konsistenz-1", "msg-konsistenz-2", "msg-konsistenz-3"}
|
|
||||||
for _, mid := range messageIDs {
|
|
||||||
payload, _ := json.Marshal(map[string]any{
|
|
||||||
"subject": "Konsistenzprobe " + mid,
|
|
||||||
"body": "Inhalt zur Konsistenzprüfung.",
|
|
||||||
})
|
|
||||||
if _, err := queue.EnqueueIndex(ctx, tenant, mid, payload); err != nil {
|
|
||||||
t.Fatalf("enqueue: %v", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
worker := NewWorker(queue, searchClient, "worker-test-konsistenz")
|
|
||||||
drainQueue(t, worker, 10)
|
|
||||||
|
|
||||||
for _, mid := range messageIDs {
|
|
||||||
job, err := findJobByMessageID(ctx, queue, tenant, mid)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("job für %s: %v", mid, err)
|
|
||||||
}
|
|
||||||
if job.Status != StatusSucceeded {
|
|
||||||
t.Fatalf("job für %s hat status %q, erwartet 'succeeded'", mid, job.Status)
|
|
||||||
}
|
|
||||||
|
|
||||||
results, err := searchClient.Search(ctx, tenant, "Konsistenzprobe")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("search: %v", err)
|
|
||||||
}
|
|
||||||
present := false
|
|
||||||
for _, r := range results {
|
|
||||||
if r.MessageID == mid {
|
|
||||||
present = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if !present {
|
|
||||||
t.Fatalf("datenbank meldet job für %s als succeeded, aber index enthält kein passendes dokument", mid)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
func findJobByMessageID(ctx context.Context, queue *Queue, tenantSlug, messageID string) (*Job, error) {
|
|
||||||
var j Job
|
|
||||||
err := queue.pool.QueryRow(ctx, `
|
|
||||||
SELECT id, job_type, tenant_slug, message_id, status, attempts
|
|
||||||
FROM mail_index_jobs WHERE tenant_slug = $1 AND message_id = $2 AND job_type = 'index'
|
|
||||||
ORDER BY id DESC LIMIT 1
|
|
||||||
`, tenantSlug, messageID).Scan(&j.ID, &j.JobType, &j.TenantSlug, &j.MessageID, &j.Status, &j.Attempts)
|
|
||||||
return &j, err
|
|
||||||
}
|
|
||||||
@@ -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,124 +0,0 @@
|
|||||||
// SRC-10: Spracherkennung & OCR-Qualitätsbewertung. Tesseract erkennt bei
|
|
||||||
// kombinierten Sprachpaketen (Languages = "deu+eng") nicht, WELCHE Sprache
|
|
||||||
// tatsächlich vorlag — daher wird das Bild hier bewusst EINZELN mit jedem
|
|
||||||
// Kandidaten aus candidateLanguages erkannt, und die Sprache mit dem
|
|
||||||
// höheren durchschnittlichen Worterkennungs-Konfidenzwert gewinnt
|
|
||||||
// (Akzeptanzkriterium 1). Derselbe Tesseract-TSV-Lauf liefert den
|
|
||||||
// Konfidenzwert direkt mit (Akzeptanzkriterium 2) — keine zweite externe
|
|
||||||
// Bibliothek für Sprach- ODER Konfidenzerkennung nötig.
|
|
||||||
package ocr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"os/exec"
|
|
||||||
"path/filepath"
|
|
||||||
"strconv"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// candidateLanguages sind die unterstützten Einzelsprachen — muss eine
|
|
||||||
// Teilmenge der in Languages kombinierten Sprachpakete sein.
|
|
||||||
var candidateLanguages = []string{"deu", "eng"}
|
|
||||||
|
|
||||||
// RecognizedText ist das Ergebnis einer sprach- und konfidenzbewussten
|
|
||||||
// Texterkennung.
|
|
||||||
type RecognizedText struct {
|
|
||||||
Text string
|
|
||||||
// Language ist der ISO-639-2-Sprachcode aus candidateLanguages mit dem
|
|
||||||
// höchsten Konfidenzwert (Akzeptanzkriterium 1).
|
|
||||||
Language string
|
|
||||||
// Confidence ist der durchschnittliche Tesseract-Worterkennungs-
|
|
||||||
// Konfidenzwert (0–100) der gewählten Sprache (Akzeptanzkriterium 2).
|
|
||||||
Confidence float64
|
|
||||||
}
|
|
||||||
|
|
||||||
// RecognizeWithLanguageAndConfidence erkennt Sprache und Text eines Bildes
|
|
||||||
// und liefert einen auswertbaren Konfidenzwert.
|
|
||||||
func RecognizeWithLanguageAndConfidence(ctx context.Context, imageBytes []byte) (RecognizedText, error) {
|
|
||||||
var best RecognizedText
|
|
||||||
haveResult := false
|
|
||||||
|
|
||||||
for _, lang := range candidateLanguages {
|
|
||||||
text, confidence, err := recognizeWithTSV(ctx, imageBytes, lang)
|
|
||||||
if err != nil {
|
|
||||||
return RecognizedText{}, err
|
|
||||||
}
|
|
||||||
if !haveResult || confidence > best.Confidence {
|
|
||||||
best = RecognizedText{Text: text, Language: lang, Confidence: confidence}
|
|
||||||
haveResult = true
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return best, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// recognizeWithTSV führt Tesseract mit GENAU einer Sprache im TSV-Ausgabe-
|
|
||||||
// modus aus und liefert den zusammengesetzten Text sowie den
|
|
||||||
// durchschnittlichen Konfidenzwert über alle erkannten Wörter (Tesseract-
|
|
||||||
// TSV-Zeilen mit level=5, conf>=0 — negative Konfidenzwerte markieren
|
|
||||||
// Struktur-/Layoutzeilen ohne eigenen Text, siehe Tesseract-TSV-Format).
|
|
||||||
func recognizeWithTSV(ctx context.Context, imageBytes []byte, lang string) (text string, confidence float64, err error) {
|
|
||||||
workDir, err := os.MkdirTemp("", "mail-ocr-lang-*")
|
|
||||||
if err != nil {
|
|
||||||
return "", 0, fmt.Errorf("ocr: arbeitsverzeichnis anlegen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = os.RemoveAll(workDir) }()
|
|
||||||
|
|
||||||
imagePath := filepath.Join(workDir, "input")
|
|
||||||
if err := os.WriteFile(imagePath, imageBytes, 0o600); err != nil {
|
|
||||||
return "", 0, fmt.Errorf("ocr: bild schreiben: %w", err)
|
|
||||||
}
|
|
||||||
outBase := filepath.Join(workDir, "output")
|
|
||||||
|
|
||||||
cmd := exec.CommandContext(ctx, "tesseract", imagePath, outBase, "-l", lang, "tsv")
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
if err := cmd.Run(); err != nil {
|
|
||||||
return "", 0, fmt.Errorf("ocr: tesseract (tsv, %s) fehlgeschlagen: %w (%s)", lang, err, stderr.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
tsvBytes, err := os.ReadFile(outBase + ".tsv")
|
|
||||||
if err != nil {
|
|
||||||
return "", 0, fmt.Errorf("ocr: tsv-ausgabe lesen: %w", err)
|
|
||||||
}
|
|
||||||
return parseTSV(string(tsvBytes))
|
|
||||||
}
|
|
||||||
|
|
||||||
// tsvWordLevel ist der Tesseract-TSV-"level"-Wert für einzelne Wörter
|
|
||||||
// (1=Seite, 2=Block, 3=Absatz, 4=Zeile, 5=Wort).
|
|
||||||
const tsvWordLevel = "5"
|
|
||||||
|
|
||||||
func parseTSV(tsv string) (text string, confidence float64, err error) {
|
|
||||||
lines := strings.Split(tsv, "\n")
|
|
||||||
var words []string
|
|
||||||
var confSum float64
|
|
||||||
var confCount int
|
|
||||||
|
|
||||||
for i, line := range lines {
|
|
||||||
if i == 0 || strings.TrimSpace(line) == "" {
|
|
||||||
continue // Kopfzeile bzw. Leerzeile überspringen
|
|
||||||
}
|
|
||||||
cols := strings.Split(line, "\t")
|
|
||||||
if len(cols) < 12 || cols[0] != tsvWordLevel {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
conf, convErr := strconv.ParseFloat(cols[10], 64)
|
|
||||||
if convErr != nil || conf < 0 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
word := cols[11]
|
|
||||||
if word == "" {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
words = append(words, word)
|
|
||||||
confSum += conf
|
|
||||||
confCount++
|
|
||||||
}
|
|
||||||
|
|
||||||
if confCount == 0 {
|
|
||||||
return "", 0, nil
|
|
||||||
}
|
|
||||||
return strings.Join(words, " "), confSum / float64(confCount), nil
|
|
||||||
}
|
|
||||||
@@ -1,101 +0,0 @@
|
|||||||
package ocr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"image"
|
|
||||||
"image/color"
|
|
||||||
"image/png"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
// TestRecognizeWithLanguageAndConfidence_MultilingualCorpus ist die
|
|
||||||
// geforderte Pflichtprüfung 1: Test mit mehrsprachigem Testkorpus
|
|
||||||
// bestätigt korrekte Spracherkennung.
|
|
||||||
func TestRecognizeWithLanguageAndConfidence_MultilingualCorpus(t *testing.T) {
|
|
||||||
requireTools(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
germanImage := knownTextImage(t, ctx, "Rechnung ueber Lieferung Nummer Zwei")
|
|
||||||
englishImage := knownTextImage(t, ctx, "Invoice for delivery number two")
|
|
||||||
|
|
||||||
germanResult, err := RecognizeWithLanguageAndConfidence(ctx, germanImage)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("deutsches bild: %v", err)
|
|
||||||
}
|
|
||||||
if germanResult.Language != "deu" {
|
|
||||||
t.Fatalf("erwartete sprache 'deu' für deutschen text, habe %q (text: %q)", germanResult.Language, germanResult.Text)
|
|
||||||
}
|
|
||||||
|
|
||||||
englishResult, err := RecognizeWithLanguageAndConfidence(ctx, englishImage)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("englisches bild: %v", err)
|
|
||||||
}
|
|
||||||
if englishResult.Language != "eng" {
|
|
||||||
t.Fatalf("erwartete sprache 'eng' für englischen text, habe %q (text: %q)", englishResult.Language, englishResult.Text)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRecognizeWithLanguageAndConfidence_DegradedImageLowersConfidence ist
|
|
||||||
// die geforderte Pflichtprüfung 2: künstlich verschlechtertes Bild erzeugt
|
|
||||||
// niedrigeren Konfidenzwert.
|
|
||||||
func TestRecognizeWithLanguageAndConfidence_DegradedImageLowersConfidence(t *testing.T) {
|
|
||||||
requireTools(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
original := knownTextImage(t, ctx, "Qualitaetsvergleich Testbild Konfidenz")
|
|
||||||
originalImg, err := png.Decode(bytes.NewReader(original))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("original dekodieren: %v", err)
|
|
||||||
}
|
|
||||||
degradedImg := pixelate(originalImg, 12)
|
|
||||||
var degradedBuf bytes.Buffer
|
|
||||||
if err := png.Encode(°radedBuf, degradedImg); err != nil {
|
|
||||||
t.Fatalf("verschlechtertes bild kodieren: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
originalResult, err := RecognizeWithLanguageAndConfidence(ctx, original)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("original erkennen: %v", err)
|
|
||||||
}
|
|
||||||
degradedResult, err := RecognizeWithLanguageAndConfidence(ctx, degradedBuf.Bytes())
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("verschlechtertes bild erkennen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
t.Logf("original: conf=%.2f text=%q — verschlechtert: conf=%.2f text=%q",
|
|
||||||
originalResult.Confidence, originalResult.Text, degradedResult.Confidence, degradedResult.Text)
|
|
||||||
if degradedResult.Confidence >= originalResult.Confidence {
|
|
||||||
t.Fatalf("erwartete niedrigeren konfidenzwert für verschlechtertes bild, habe original=%.2f verschlechtert=%.2f",
|
|
||||||
originalResult.Confidence, degradedResult.Confidence)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// pixelate verschlechtert img künstlich, reproduzierbar und ohne externe
|
|
||||||
// Werkzeuge: Downsample um factor per Nearest-Neighbor, dann wieder auf
|
|
||||||
// Originalgröße hochskaliert — zerstört Feindetails der Textglyphen.
|
|
||||||
func pixelate(img image.Image, factor int) image.Image {
|
|
||||||
bounds := img.Bounds()
|
|
||||||
w, h := bounds.Dx(), bounds.Dy()
|
|
||||||
out := image.NewRGBA(bounds)
|
|
||||||
for y := 0; y < h; y++ {
|
|
||||||
for x := 0; x < w; x++ {
|
|
||||||
blockX := (x / factor) * factor
|
|
||||||
blockY := (y / factor) * factor
|
|
||||||
c := img.At(bounds.Min.X+blockX, bounds.Min.Y+blockY)
|
|
||||||
out.Set(bounds.Min.X+x, bounds.Min.Y+y, colorToGray50(c))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return out
|
|
||||||
}
|
|
||||||
|
|
||||||
// colorToGray50 mischt zusätzlich mit 50% Grau, um den Kontrast zu
|
|
||||||
// verringern — verstärkt die künstliche Qualitätsverschlechterung über
|
|
||||||
// reine Pixelierung hinaus.
|
|
||||||
func colorToGray50(c color.Color) color.Color {
|
|
||||||
r, g, b, a := c.RGBA()
|
|
||||||
mix := func(v uint32) uint8 {
|
|
||||||
return uint8((v>>8)/2 + 128/2)
|
|
||||||
}
|
|
||||||
return color.RGBA{R: mix(r), G: mix(g), B: mix(b), A: uint8(a >> 8)}
|
|
||||||
}
|
|
||||||
@@ -1,187 +0,0 @@
|
|||||||
// Package ocr implementiert SRC-07: eine OCR-Pipeline für Bild-/PDF-
|
|
||||||
// Anhänge, als eigener Mail-OCR-Pfad unabhängig vom DMS-Board (siehe
|
|
||||||
// repos-analyse-mail-reuse.md: dupliziertes Sprintf-WHERE-Muster aus
|
|
||||||
// archivmail wird NICHT übernommen — dieses Paket baut keine SQL-Klauseln,
|
|
||||||
// ruft ausschließlich externe Kommandozeilenwerkzeuge mit festen
|
|
||||||
// Argumentlisten auf, niemals über eine Shell/String-Konkatenation).
|
|
||||||
//
|
|
||||||
// Zustandslos: dieses Paket kennt weder Mandanten noch Speicher — es
|
|
||||||
// nimmt Anhangs-Bytes entgegen und liefert erkannten Text zurück, exakt
|
|
||||||
// wie mail/internal/crypto und mail/internal/dedup. Tenant-Trennung
|
|
||||||
// entsteht dadurch strukturell: es gibt keinen geteilten Zustand
|
|
||||||
// zwischen Aufrufen, den unterschiedliche Mandanten sehen könnten (jeder
|
|
||||||
// Aufruf bekommt sein eigenes Temp-Verzeichnis, siehe workDir).
|
|
||||||
//
|
|
||||||
// Bekannter Fehler vermeiden (siehe ARC-03-Ticket): OCR darf erst NACH
|
|
||||||
// abgeschlossener Duplikatsprüfung laufen — das ist Sache des Aufrufers
|
|
||||||
// (spätere Ingest-Tickets), dieses Paket kennt mail/internal/dedup nicht.
|
|
||||||
package ocr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"os/exec"
|
|
||||||
"path/filepath"
|
|
||||||
"sort"
|
|
||||||
"strings"
|
|
||||||
)
|
|
||||||
|
|
||||||
// Languages ist die feste Tesseract-Sprachkombination (Akzeptanzkriterium
|
|
||||||
// 1 aus SRC-10 baut hierauf auf) — Deutsch und Englisch, passend zum
|
|
||||||
// deutschsprachigen NEXARCH-Einsatzkontext mit englischsprachigen
|
|
||||||
// Geschäftskorrespondenzen.
|
|
||||||
const Languages = "deu+eng"
|
|
||||||
|
|
||||||
// ExtractTextFromImage führt Tesseract-OCR auf einem einzelnen Bild aus
|
|
||||||
// (PNG/JPEG/TIFF/BMP — von Tesseract/Leptonica unterstützte Formate).
|
|
||||||
func ExtractTextFromImage(ctx context.Context, imageBytes []byte) (string, error) {
|
|
||||||
workDir, err := os.MkdirTemp("", "mail-ocr-*")
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: arbeitsverzeichnis anlegen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = os.RemoveAll(workDir) }()
|
|
||||||
|
|
||||||
imagePath := filepath.Join(workDir, "input")
|
|
||||||
if err := os.WriteFile(imagePath, imageBytes, 0o600); err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: bild schreiben: %w", err)
|
|
||||||
}
|
|
||||||
outBase := filepath.Join(workDir, "output")
|
|
||||||
|
|
||||||
cmd := exec.CommandContext(ctx, "tesseract", imagePath, outBase, "-l", Languages)
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
if err := cmd.Run(); err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: tesseract fehlgeschlagen: %w (%s)", err, stderr.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
text, err := os.ReadFile(outBase + ".txt")
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: erkannten text lesen: %w", err)
|
|
||||||
}
|
|
||||||
return strings.TrimSpace(string(text)), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// minTextLayerLength ist die Mindestanzahl nicht-leerer Zeichen, ab der
|
|
||||||
// ein PDF als "hat bereits eine Textebene" gilt (Akzeptanzkriterium 3).
|
|
||||||
// Ein paar Steuerzeichen/Leerzeichen aus pdftotext bei einem rein
|
|
||||||
// bildbasierten PDF dürfen keine OCR-Umgehung auslösen.
|
|
||||||
const minTextLayerLength = 10
|
|
||||||
|
|
||||||
// HasTextLayer prüft über pdftotext, ob pdfBytes bereits durchsuchbaren
|
|
||||||
// Text enthält (Akzeptanzkriterium 3: bereits durchsuchbare PDFs werden
|
|
||||||
// nicht unnötig erneut per OCR verarbeitet).
|
|
||||||
func HasTextLayer(ctx context.Context, pdfBytes []byte) (bool, error) {
|
|
||||||
text, err := extractPDFText(ctx, pdfBytes)
|
|
||||||
if err != nil {
|
|
||||||
return false, err
|
|
||||||
}
|
|
||||||
return len(strings.TrimSpace(text)) >= minTextLayerLength, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
func extractPDFText(ctx context.Context, pdfBytes []byte) (string, error) {
|
|
||||||
workDir, err := os.MkdirTemp("", "mail-ocr-pdf-*")
|
|
||||||
if err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: arbeitsverzeichnis anlegen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = os.RemoveAll(workDir) }()
|
|
||||||
|
|
||||||
pdfPath := filepath.Join(workDir, "input.pdf")
|
|
||||||
if err := os.WriteFile(pdfPath, pdfBytes, 0o600); err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: pdf schreiben: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
cmd := exec.CommandContext(ctx, "pdftotext", pdfPath, "-")
|
|
||||||
var stdout, stderr bytes.Buffer
|
|
||||||
cmd.Stdout = &stdout
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
if err := cmd.Run(); err != nil {
|
|
||||||
return "", fmt.Errorf("ocr: pdftotext fehlgeschlagen: %w (%s)", err, stderr.String())
|
|
||||||
}
|
|
||||||
return stdout.String(), nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// PDFResult ist das Ergebnis von ExtractTextFromPDF.
|
|
||||||
type PDFResult struct {
|
|
||||||
Text string
|
|
||||||
// OCRPerformed ist false, wenn eine vorhandene Textebene genutzt
|
|
||||||
// wurde (Akzeptanzkriterium 3), true, wenn tatsächlich per Tesseract
|
|
||||||
// erkannt wurde (Akzeptanzkriterium 1).
|
|
||||||
OCRPerformed bool
|
|
||||||
}
|
|
||||||
|
|
||||||
// ExtractTextFromPDF liefert den Text eines PDF-Anhangs: hat das PDF
|
|
||||||
// bereits eine Textebene, wird sie direkt übernommen (schneller,
|
|
||||||
// zuverlässiger als OCR, Akzeptanzkriterium 3). Sonst wird jede Seite
|
|
||||||
// gerastert und per Tesseract erkannt (Akzeptanzkriterium 1: gescannte
|
|
||||||
// PDF-Anhänge).
|
|
||||||
func ExtractTextFromPDF(ctx context.Context, pdfBytes []byte) (PDFResult, error) {
|
|
||||||
existingText, err := extractPDFText(ctx, pdfBytes)
|
|
||||||
if err != nil {
|
|
||||||
return PDFResult{}, err
|
|
||||||
}
|
|
||||||
if len(strings.TrimSpace(existingText)) >= minTextLayerLength {
|
|
||||||
return PDFResult{Text: strings.TrimSpace(existingText), OCRPerformed: false}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
pageImages, err := rasterizePDF(ctx, pdfBytes)
|
|
||||||
if err != nil {
|
|
||||||
return PDFResult{}, err
|
|
||||||
}
|
|
||||||
|
|
||||||
var pages []string
|
|
||||||
for _, imageBytes := range pageImages {
|
|
||||||
pageText, err := ExtractTextFromImage(ctx, imageBytes)
|
|
||||||
if err != nil {
|
|
||||||
return PDFResult{}, err
|
|
||||||
}
|
|
||||||
pages = append(pages, pageText)
|
|
||||||
}
|
|
||||||
return PDFResult{Text: strings.TrimSpace(strings.Join(pages, "\n")), OCRPerformed: true}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// rasterizePDF rastert jede Seite von pdfBytes über pdftoppm in ein PNG
|
|
||||||
// und liefert die Seiten in Reihenfolge.
|
|
||||||
func rasterizePDF(ctx context.Context, pdfBytes []byte) ([][]byte, error) {
|
|
||||||
workDir, err := os.MkdirTemp("", "mail-ocr-raster-*")
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("ocr: arbeitsverzeichnis anlegen: %w", err)
|
|
||||||
}
|
|
||||||
defer func() { _ = os.RemoveAll(workDir) }()
|
|
||||||
|
|
||||||
pdfPath := filepath.Join(workDir, "input.pdf")
|
|
||||||
if err := os.WriteFile(pdfPath, pdfBytes, 0o600); err != nil {
|
|
||||||
return nil, fmt.Errorf("ocr: pdf schreiben: %w", err)
|
|
||||||
}
|
|
||||||
outBase := filepath.Join(workDir, "page")
|
|
||||||
|
|
||||||
cmd := exec.CommandContext(ctx, "pdftoppm", "-png", "-r", "300", pdfPath, outBase)
|
|
||||||
var stderr bytes.Buffer
|
|
||||||
cmd.Stderr = &stderr
|
|
||||||
if err := cmd.Run(); err != nil {
|
|
||||||
return nil, fmt.Errorf("ocr: pdftoppm fehlgeschlagen: %w (%s)", err, stderr.String())
|
|
||||||
}
|
|
||||||
|
|
||||||
entries, err := os.ReadDir(workDir)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("ocr: gerasterte seiten auflisten: %w", err)
|
|
||||||
}
|
|
||||||
var pagePaths []string
|
|
||||||
for _, e := range entries {
|
|
||||||
if strings.HasSuffix(e.Name(), ".png") {
|
|
||||||
pagePaths = append(pagePaths, filepath.Join(workDir, e.Name()))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
sort.Strings(pagePaths)
|
|
||||||
|
|
||||||
var pages [][]byte
|
|
||||||
for _, p := range pagePaths {
|
|
||||||
data, err := os.ReadFile(p)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("ocr: gerasterte seite lesen: %w", err)
|
|
||||||
}
|
|
||||||
pages = append(pages, data)
|
|
||||||
}
|
|
||||||
return pages, nil
|
|
||||||
}
|
|
||||||
@@ -1,156 +0,0 @@
|
|||||||
package ocr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"image/png"
|
|
||||||
"os/exec"
|
|
||||||
"strings"
|
|
||||||
"testing"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
func requireTools(t *testing.T) {
|
|
||||||
t.Helper()
|
|
||||||
for _, tool := range []string{"tesseract", "pdftotext", "pdftoppm"} {
|
|
||||||
if _, err := exec.LookPath(tool); err != nil {
|
|
||||||
t.Skipf("%s nicht im PATH, Integrationstest übersprungen", tool)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// knownTextImage rastert ein hand-gebautes Text-PDF (bekannter Inhalt)
|
|
||||||
// über die echte pdftoppm-Pipeline in ein reales PNG-Bild — liefert damit
|
|
||||||
// ein Bild mit tatsächlich gerenderten, OCR-fähigen Glyphen, ohne eine
|
|
||||||
// zusätzliche Font-Rendering-Bibliothek einzuführen.
|
|
||||||
func knownTextImage(t *testing.T, ctx context.Context, text string) []byte {
|
|
||||||
t.Helper()
|
|
||||||
pdfBytes := buildTextLayerPDF(text)
|
|
||||||
pages, err := rasterizePDF(ctx, pdfBytes)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("testbild rastern: %v", err)
|
|
||||||
}
|
|
||||||
if len(pages) != 1 {
|
|
||||||
t.Fatalf("erwartete genau 1 gerasterte seite, habe %d", len(pages))
|
|
||||||
}
|
|
||||||
return pages[0]
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestExtractTextFromImage_KnownTextRecognized ist die geforderte
|
|
||||||
// Pflichtprüfung 1: Bildanhang mit bekanntem Text liefert erwartete
|
|
||||||
// Texterkennung.
|
|
||||||
func TestExtractTextFromImage_KnownTextRecognized(t *testing.T) {
|
|
||||||
requireTools(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
imageBytes := knownTextImage(t, ctx, "Rechnungsnummer 4711")
|
|
||||||
|
|
||||||
got, err := ExtractTextFromImage(ctx, imageBytes)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("extracttextfromimage: %v", err)
|
|
||||||
}
|
|
||||||
if !strings.Contains(got, "Rechnungsnummer") || !strings.Contains(got, "4711") {
|
|
||||||
t.Fatalf("erwarteten text nicht erkannt, habe: %q", got)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestExtractTextFromPDF_SkipsOCRWhenTextLayerPresent ist die geforderte
|
|
||||||
// Pflichtprüfung 2: PDF mit vorhandener Textebene wird korrekt
|
|
||||||
// übersprungen.
|
|
||||||
func TestExtractTextFromPDF_SkipsOCRWhenTextLayerPresent(t *testing.T) {
|
|
||||||
requireTools(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
pdfBytes := buildTextLayerPDF("Vertragsentwurf Version 3")
|
|
||||||
|
|
||||||
hasLayer, err := HasTextLayer(ctx, pdfBytes)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("hastextlayer: %v", err)
|
|
||||||
}
|
|
||||||
if !hasLayer {
|
|
||||||
t.Fatal("erwartete erkannte textebene im vektor-pdf")
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := ExtractTextFromPDF(ctx, pdfBytes)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("extracttextfrompdf: %v", err)
|
|
||||||
}
|
|
||||||
if result.OCRPerformed {
|
|
||||||
t.Fatal("ocr wurde durchgeführt, obwohl eine textebene vorhanden war")
|
|
||||||
}
|
|
||||||
if !strings.Contains(result.Text, "Vertragsentwurf") {
|
|
||||||
t.Fatalf("erwarteten text aus textebene nicht gefunden, habe: %q", result.Text)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestExtractTextFromPDF_PerformsOCRWhenNoTextLayer deckt
|
|
||||||
// Akzeptanzkriterium 1 (gescannte PDF-Anhänge) zusätzlich end-zu-Ende ab:
|
|
||||||
// ein PDF ohne Textebene, das nur ein Rasterbild enthält, wird real per
|
|
||||||
// OCR erkannt.
|
|
||||||
func TestExtractTextFromPDF_PerformsOCRWhenNoTextLayer(t *testing.T) {
|
|
||||||
requireTools(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
pngBytes := knownTextImage(t, ctx, "Gescannter Anhang Test")
|
|
||||||
img, err := png.Decode(bytes.NewReader(pngBytes))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("testbild dekodieren: %v", err)
|
|
||||||
}
|
|
||||||
scannedPDF, err := buildImageOnlyPDF(img)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("bild-pdf bauen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
hasLayer, err := HasTextLayer(ctx, scannedPDF)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("hastextlayer: %v", err)
|
|
||||||
}
|
|
||||||
if hasLayer {
|
|
||||||
t.Fatal("bild-only-pdf wurde fälschlich als textebene erkannt")
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := ExtractTextFromPDF(ctx, scannedPDF)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("extracttextfrompdf: %v", err)
|
|
||||||
}
|
|
||||||
if !result.OCRPerformed {
|
|
||||||
t.Fatal("erwartete durchgeführte ocr bei fehlender textebene")
|
|
||||||
}
|
|
||||||
if !strings.Contains(result.Text, "Gescannter") {
|
|
||||||
t.Fatalf("erwarteten text aus ocr nicht gefunden, habe: %q", result.Text)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestExtractTextFromPDF_ThroughputIsAcceptable ist die geforderte
|
|
||||||
// Pflichtprüfung 3: Durchsatztest bestätigt akzeptable Verarbeitungszeit
|
|
||||||
// je Anhang. Zielzeit 8s je Anhang (großzügig für Rasterung + OCR bei
|
|
||||||
// 300dpi, deckt aber real ab, dass kein pathologischer Ausreißer
|
|
||||||
// entsteht).
|
|
||||||
func TestExtractTextFromPDF_ThroughputIsAcceptable(t *testing.T) {
|
|
||||||
requireTools(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
const attachments = 3
|
|
||||||
const targetPerAttachment = 8 * time.Second
|
|
||||||
|
|
||||||
pngBytes := knownTextImage(t, ctx, "Durchsatztest Anhang")
|
|
||||||
img, err := png.Decode(bytes.NewReader(pngBytes))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("testbild dekodieren: %v", err)
|
|
||||||
}
|
|
||||||
scannedPDF, err := buildImageOnlyPDF(img)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("bild-pdf bauen: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
start := time.Now()
|
|
||||||
for i := 0; i < attachments; i++ {
|
|
||||||
if _, err := ExtractTextFromPDF(ctx, scannedPDF); err != nil {
|
|
||||||
t.Fatalf("anhang %d: %v", i, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
elapsed := time.Since(start)
|
|
||||||
perAttachment := elapsed / attachments
|
|
||||||
t.Logf("Durchsatz: %d Anhänge in %s (%s/Anhang, Ziel %s/Anhang)", attachments, elapsed, perAttachment, targetPerAttachment)
|
|
||||||
if perAttachment > targetPerAttachment {
|
|
||||||
t.Fatalf("verarbeitung zu langsam: %s/anhang, ziel %s/anhang", perAttachment, targetPerAttachment)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,95 +0,0 @@
|
|||||||
package ocr
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"fmt"
|
|
||||||
"image"
|
|
||||||
"image/jpeg"
|
|
||||||
)
|
|
||||||
|
|
||||||
// buildTextLayerPDF erzeugt ein minimales, aber ECHTES PDF mit einer
|
|
||||||
// vektorbasierten Textebene (Standardfont Helvetica, kein eingebettetes
|
|
||||||
// Fontprogramm nötig) — von Hand gebaut, keine externe Bibliothek/kein
|
|
||||||
// externes Werkzeug, damit der Test reproduzierbar und unabhängig von
|
|
||||||
// Systempaketen bleibt. pdftotext extrahiert text unmittelbar daraus.
|
|
||||||
func buildTextLayerPDF(text string) []byte {
|
|
||||||
var buf bytes.Buffer
|
|
||||||
offsets := make([]int, 0, 6)
|
|
||||||
|
|
||||||
buf.WriteString("%PDF-1.4\n")
|
|
||||||
|
|
||||||
writeObj := func(n int, body string) {
|
|
||||||
offsets = append(offsets, buf.Len())
|
|
||||||
fmt.Fprintf(&buf, "%d 0 obj\n%s\nendobj\n", n, body)
|
|
||||||
}
|
|
||||||
|
|
||||||
writeObj(1, "<< /Type /Catalog /Pages 2 0 R >>")
|
|
||||||
writeObj(2, "<< /Type /Pages /Kids [3 0 R] /Count 1 >>")
|
|
||||||
writeObj(3, "<< /Type /Page /Parent 2 0 R /Resources << /Font << /F1 5 0 R >> >> /MediaBox [0 0 400 200] /Contents 4 0 R >>")
|
|
||||||
|
|
||||||
content := fmt.Sprintf("BT /F1 24 Tf 20 100 Td (%s) Tj ET", text)
|
|
||||||
stream := fmt.Sprintf("<< /Length %d >>\nstream\n%s\nendstream", len(content), content)
|
|
||||||
writeObj(4, stream)
|
|
||||||
writeObj(5, "<< /Type /Font /Subtype /Type1 /BaseFont /Helvetica >>")
|
|
||||||
|
|
||||||
xrefStart := buf.Len()
|
|
||||||
fmt.Fprintf(&buf, "xref\n0 %d\n", len(offsets)+1)
|
|
||||||
buf.WriteString("0000000000 65535 f \n")
|
|
||||||
for _, off := range offsets {
|
|
||||||
fmt.Fprintf(&buf, "%010d 00000 n \n", off)
|
|
||||||
}
|
|
||||||
fmt.Fprintf(&buf, "trailer\n<< /Size %d /Root 1 0 R >>\nstartxref\n%d\n%%%%EOF", len(offsets)+1, xrefStart)
|
|
||||||
|
|
||||||
return buf.Bytes()
|
|
||||||
}
|
|
||||||
|
|
||||||
// buildImageOnlyPDF erzeugt ein minimales, ECHTES PDF, dessen einzige
|
|
||||||
// Seite ausschließlich aus einem eingebetteten Rasterbild besteht (JPEG
|
|
||||||
// via /DCTDecode — von PDF nativ unterstützt, kein zusätzlicher Codec
|
|
||||||
// nötig) — simuliert ein gescanntes PDF ohne Textebene
|
|
||||||
// (Akzeptanzkriterium 1).
|
|
||||||
func buildImageOnlyPDF(img image.Image) ([]byte, error) {
|
|
||||||
var jpegBuf bytes.Buffer
|
|
||||||
if err := jpeg.Encode(&jpegBuf, img, &jpeg.Options{Quality: 90}); err != nil {
|
|
||||||
return nil, fmt.Errorf("jpeg kodieren: %w", err)
|
|
||||||
}
|
|
||||||
bounds := img.Bounds()
|
|
||||||
w, h := bounds.Dx(), bounds.Dy()
|
|
||||||
|
|
||||||
var buf bytes.Buffer
|
|
||||||
offsets := make([]int, 0, 6)
|
|
||||||
buf.WriteString("%PDF-1.4\n")
|
|
||||||
|
|
||||||
writeObj := func(n int, header string, body []byte) {
|
|
||||||
offsets = append(offsets, buf.Len())
|
|
||||||
fmt.Fprintf(&buf, "%d 0 obj\n%s\n", n, header)
|
|
||||||
if body != nil {
|
|
||||||
buf.Write(body)
|
|
||||||
buf.WriteString("\nendstream\n")
|
|
||||||
}
|
|
||||||
buf.WriteString("endobj\n")
|
|
||||||
}
|
|
||||||
|
|
||||||
writeObj(1, "<< /Type /Catalog /Pages 2 0 R >>", nil)
|
|
||||||
writeObj(2, "<< /Type /Pages /Kids [3 0 R] /Count 1 >>", nil)
|
|
||||||
writeObj(3, fmt.Sprintf("<< /Type /Page /Parent 2 0 R /Resources << /XObject << /Im0 5 0 R >> >> /MediaBox [0 0 %d %d] /Contents 4 0 R >>", w, h), nil)
|
|
||||||
|
|
||||||
content := fmt.Sprintf("q %d 0 0 %d 0 0 cm /Im0 Do Q", w, h)
|
|
||||||
writeObj(4, fmt.Sprintf("<< /Length %d >>\nstream", len(content)), []byte(content))
|
|
||||||
|
|
||||||
imgHeader := fmt.Sprintf(
|
|
||||||
"<< /Type /XObject /Subtype /Image /Width %d /Height %d /ColorSpace /DeviceRGB /BitsPerComponent 8 /Filter /DCTDecode /Length %d >>\nstream",
|
|
||||||
w, h, jpegBuf.Len(),
|
|
||||||
)
|
|
||||||
writeObj(5, imgHeader, jpegBuf.Bytes())
|
|
||||||
|
|
||||||
xrefStart := buf.Len()
|
|
||||||
fmt.Fprintf(&buf, "xref\n0 %d\n", len(offsets)+1)
|
|
||||||
buf.WriteString("0000000000 65535 f \n")
|
|
||||||
for _, off := range offsets {
|
|
||||||
fmt.Fprintf(&buf, "%010d 00000 n \n", off)
|
|
||||||
}
|
|
||||||
fmt.Fprintf(&buf, "trailer\n<< /Size %d /Root 1 0 R >>\nstartxref\n%d\n%%%%EOF", len(offsets)+1, xrefStart)
|
|
||||||
|
|
||||||
return buf.Bytes(), nil
|
|
||||||
}
|
|
||||||
@@ -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,162 +0,0 @@
|
|||||||
// Package qagate implementiert QA-03: das Prüfgate für Archivierung &
|
|
||||||
// Suche. Verbindliche Kriterien: (1) die Archivierungs- und
|
|
||||||
// Suchindex-Testsuiten bestehen, einschließlich Schlüsselrotation
|
|
||||||
// (ARC-08), (2) der Suchpfad baut keine SQL-Klauseln dynamisch zusammen,
|
|
||||||
// (3) das Gate-Ergebnis ist dokumentiert und mit Zeitstempel
|
|
||||||
// nachvollziehbar.
|
|
||||||
package qagate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"bytes"
|
|
||||||
"context"
|
|
||||||
"fmt"
|
|
||||||
"os"
|
|
||||||
"os/exec"
|
|
||||||
"path/filepath"
|
|
||||||
"strings"
|
|
||||||
"time"
|
|
||||||
)
|
|
||||||
|
|
||||||
// ArchiveAndSearchPackages sind die Pakete, deren Testsuiten das Gate
|
|
||||||
// ausführt (Akzeptanzkriterium 1: Archivierung — storage/crypto/
|
|
||||||
// encstorage, inklusive Schlüsselrotation aus ARC-08 — UND Suchindex —
|
|
||||||
// search, inklusive Facetten/Reindex/OCR-Konfidenz).
|
|
||||||
var ArchiveAndSearchPackages = []string{
|
|
||||||
"./internal/storage/...",
|
|
||||||
"./internal/crypto/...",
|
|
||||||
"./internal/encstorage/...",
|
|
||||||
"./internal/search/...",
|
|
||||||
}
|
|
||||||
|
|
||||||
// dynamicSQLBuildMarker ist das Muster, dessen Anwesenheit im Suchpfad
|
|
||||||
// (Akzeptanzkriterium 2) einen Verstoß bedeutet — dieselbe Prüfung wie
|
|
||||||
// mail/internal/search/no_dynamic_sql_test.go, hier auf alle
|
|
||||||
// Suchpfad-Dateien verallgemeinert statt nur auf client.go beschränkt.
|
|
||||||
// Der abschließende "(" grenzt einen tatsächlichen Funktionsaufruf von
|
|
||||||
// bloßer Erwähnung in Kommentaren ab (z. B. "kein fmt.Sprintf/strings.Join"
|
|
||||||
// in Erklärtexten, real als Fehlalarm aufgetreten und hiermit behoben).
|
|
||||||
const dynamicSQLBuildMarker = "fmt.Sprintf("
|
|
||||||
|
|
||||||
// sqlBuildExceptionFiles sind Dateien, die fmt.Sprintf bewusst und
|
|
||||||
// dokumentiert für Schema-/DDL-Verwaltung nutzen (Tabellennamen aus
|
|
||||||
// paketintern erzeugten, regex-geprüften Werten — SRC-09 reindex.go),
|
|
||||||
// NICHT für den eigentlichen Abfrage-/Suchpfad. Diese Unterscheidung
|
|
||||||
// steht bereits im Quelltext von reindex.go dokumentiert.
|
|
||||||
var sqlBuildExceptionFiles = map[string]bool{
|
|
||||||
"reindex.go": true,
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestSuiteResult ist das Ergebnis eines `go test`-Laufs über die
|
|
||||||
// Archivierungs-/Suchindex-Pakete.
|
|
||||||
type TestSuiteResult struct {
|
|
||||||
Passed bool
|
|
||||||
Output string
|
|
||||||
}
|
|
||||||
|
|
||||||
// SQLScanResult ist das Ergebnis des statischen Suchpfad-Scans.
|
|
||||||
type SQLScanResult struct {
|
|
||||||
Passed bool
|
|
||||||
Violations []string // "<Datei>: enthält fmt.Sprintf"
|
|
||||||
}
|
|
||||||
|
|
||||||
// GateResult fasst ein vollständiges Gate-Ergebnis zusammen
|
|
||||||
// (Akzeptanzkriterium 3: dokumentiert, mit Zeitstempel).
|
|
||||||
type GateResult struct {
|
|
||||||
Timestamp time.Time
|
|
||||||
TestSuite TestSuiteResult
|
|
||||||
SQLScan SQLScanResult
|
|
||||||
}
|
|
||||||
|
|
||||||
// Passed ist true, wenn ALLE Kriterien erfüllt sind.
|
|
||||||
func (r GateResult) Passed() bool {
|
|
||||||
return r.TestSuite.Passed && r.SQLScan.Passed
|
|
||||||
}
|
|
||||||
|
|
||||||
// RunTestSuites führt `go test` über ArchiveAndSearchPackages im
|
|
||||||
// angegebenen Modulverzeichnis aus (Akzeptanzkriterium 1). Umgebungs-
|
|
||||||
// variablen (z. B. TEST_TENANT_DSN/TEST_MANTICORE_URL für die echten
|
|
||||||
// Integrationstests, darunter ARC-08s Schlüsselrotationstests) werden
|
|
||||||
// unverändert vom aufrufenden Prozess vererbt — das Gate setzt selbst
|
|
||||||
// keine Zugangsdaten.
|
|
||||||
func RunTestSuites(ctx context.Context, moduleDir string) (TestSuiteResult, error) {
|
|
||||||
args := append([]string{"test", "-count=1"}, ArchiveAndSearchPackages...)
|
|
||||||
cmd := exec.CommandContext(ctx, "go", args...)
|
|
||||||
cmd.Dir = moduleDir
|
|
||||||
var out bytes.Buffer
|
|
||||||
cmd.Stdout = &out
|
|
||||||
cmd.Stderr = &out
|
|
||||||
err := cmd.Run()
|
|
||||||
if err != nil {
|
|
||||||
if _, isExitErr := err.(*exec.ExitError); !isExitErr {
|
|
||||||
return TestSuiteResult{}, fmt.Errorf("qagate: go test ausführen: %w", err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return TestSuiteResult{Passed: err == nil, Output: out.String()}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// ScanSearchPathForDynamicSQL prüft alle Nicht-Test-.go-Dateien in
|
|
||||||
// searchPkgDir auf dynamische SQL-Klauselbildung (Akzeptanzkriterium 2),
|
|
||||||
// mit Ausnahme der dokumentierten DDL-Verwaltung (reindex.go).
|
|
||||||
func ScanSearchPathForDynamicSQL(searchPkgDir string) (SQLScanResult, error) {
|
|
||||||
entries, err := os.ReadDir(searchPkgDir)
|
|
||||||
if err != nil {
|
|
||||||
return SQLScanResult{}, fmt.Errorf("qagate: suchpfad-verzeichnis lesen: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var violations []string
|
|
||||||
for _, e := range entries {
|
|
||||||
name := e.Name()
|
|
||||||
if e.IsDir() || !strings.HasSuffix(name, ".go") || strings.HasSuffix(name, "_test.go") {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if sqlBuildExceptionFiles[name] {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
content, err := os.ReadFile(filepath.Join(searchPkgDir, name))
|
|
||||||
if err != nil {
|
|
||||||
return SQLScanResult{}, fmt.Errorf("qagate: %s lesen: %w", name, err)
|
|
||||||
}
|
|
||||||
if strings.Contains(string(content), dynamicSQLBuildMarker) {
|
|
||||||
violations = append(violations, fmt.Sprintf("%s: enthält %s", name, dynamicSQLBuildMarker))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return SQLScanResult{Passed: len(violations) == 0, Violations: violations}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Run führt das vollständige Gate aus.
|
|
||||||
func Run(ctx context.Context, moduleDir string) (GateResult, error) {
|
|
||||||
testResult, err := RunTestSuites(ctx, moduleDir)
|
|
||||||
if err != nil {
|
|
||||||
return GateResult{}, err
|
|
||||||
}
|
|
||||||
sqlResult, err := ScanSearchPathForDynamicSQL(filepath.Join(moduleDir, "internal", "search"))
|
|
||||||
if err != nil {
|
|
||||||
return GateResult{}, err
|
|
||||||
}
|
|
||||||
return GateResult{
|
|
||||||
Timestamp: time.Now().UTC(),
|
|
||||||
TestSuite: testResult,
|
|
||||||
SQLScan: sqlResult,
|
|
||||||
}, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Report erzeugt den dokumentierten, zeitgestempelten Gate-Bericht
|
|
||||||
// (Akzeptanzkriterium 3).
|
|
||||||
func (r GateResult) Report() string {
|
|
||||||
status := "BESTANDEN"
|
|
||||||
if !r.Passed() {
|
|
||||||
status = "FEHLGESCHLAGEN"
|
|
||||||
}
|
|
||||||
var b strings.Builder
|
|
||||||
fmt.Fprintf(&b, "# QA-03 Gate-Ergebnis: %s\n\n", status)
|
|
||||||
fmt.Fprintf(&b, "Zeitstempel (UTC): %s\n\n", r.Timestamp.Format(time.RFC3339))
|
|
||||||
fmt.Fprintf(&b, "## Testsuiten (Archivierung & Suche, inkl. Schlüsselrotation)\n\nBestanden: %v\n\n", r.TestSuite.Passed)
|
|
||||||
fmt.Fprintf(&b, "## Statischer Suchpfad-Scan (keine dynamische SQL-Klauselbildung)\n\nBestanden: %v\n", r.SQLScan.Passed)
|
|
||||||
if len(r.SQLScan.Violations) > 0 {
|
|
||||||
fmt.Fprintf(&b, "Verstöße:\n")
|
|
||||||
for _, v := range r.SQLScan.Violations {
|
|
||||||
fmt.Fprintf(&b, "- %s\n", v)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return b.String()
|
|
||||||
}
|
|
||||||
@@ -1,112 +0,0 @@
|
|||||||
package qagate
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"path/filepath"
|
|
||||||
"testing"
|
|
||||||
)
|
|
||||||
|
|
||||||
func moduleRoot(t *testing.T) string {
|
|
||||||
t.Helper()
|
|
||||||
wd, err := os.Getwd()
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("arbeitsverzeichnis ermitteln: %v", err)
|
|
||||||
}
|
|
||||||
// gate_test.go liegt in internal/qagate — Modulwurzel ist zwei Ebenen
|
|
||||||
// darüber.
|
|
||||||
return filepath.Join(wd, "..", "..")
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScanSearchPathForDynamicSQL_RealSearchPackagePasses ist die
|
|
||||||
// geforderte Pflichtprüfung 2: Codereview-Stichprobe bestätigt
|
|
||||||
// statischen Query-Builder — automatisiert und reproduzierbar gegen den
|
|
||||||
// echten mail/internal/search-Quelltext ausgeführt statt rein manuell
|
|
||||||
// behauptet.
|
|
||||||
func TestScanSearchPathForDynamicSQL_RealSearchPackagePasses(t *testing.T) {
|
|
||||||
root := moduleRoot(t)
|
|
||||||
result, err := ScanSearchPathForDynamicSQL(filepath.Join(root, "internal", "search"))
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("scan: %v", err)
|
|
||||||
}
|
|
||||||
if !result.Passed {
|
|
||||||
t.Fatalf("erwartete bestandenen scan, habe verstöße: %v", result.Violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScanSearchPathForDynamicSQL_DetectsRealViolation beweist, dass der
|
|
||||||
// Scanner einen tatsächlichen Verstoß auch real erkennt (Negativtest,
|
|
||||||
// analog zu no_dynamic_sql_test.go) — ein Gate, das nie einen Verstoß
|
|
||||||
// melden kann, wäre wertlos.
|
|
||||||
func TestScanSearchPathForDynamicSQL_DetectsRealViolation(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
violatingFile := "bad_query.go"
|
|
||||||
content := []byte("package search\n\nimport \"fmt\"\n\nfunc bad(field string) string {\n\treturn fmt.Sprintf(\"WHERE %s = 1\", field)\n}\n")
|
|
||||||
if err := os.WriteFile(filepath.Join(dir, violatingFile), content, 0o600); err != nil {
|
|
||||||
t.Fatalf("testdatei schreiben: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := ScanSearchPathForDynamicSQL(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("scan: %v", err)
|
|
||||||
}
|
|
||||||
if result.Passed {
|
|
||||||
t.Fatal("erwartete erkannten verstoß, scan meldet bestanden")
|
|
||||||
}
|
|
||||||
if len(result.Violations) != 1 || result.Violations[0] != violatingFile+": enthält fmt.Sprintf(" {
|
|
||||||
t.Fatalf("unerwartetes verstoßergebnis: %+v", result.Violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestScanSearchPathForDynamicSQL_ExemptsDocumentedDDLFile bestätigt,
|
|
||||||
// dass die dokumentierte Ausnahme (reindex.go, Schema-/DDL-Verwaltung,
|
|
||||||
// kein Abfragepfad) NICHT als Verstoß gewertet wird.
|
|
||||||
func TestScanSearchPathForDynamicSQL_ExemptsDocumentedDDLFile(t *testing.T) {
|
|
||||||
dir := t.TempDir()
|
|
||||||
content := []byte("package search\n\nimport \"fmt\"\n\nfunc ddl(name string) string {\n\treturn fmt.Sprintf(\"CREATE TABLE %s (...)\", name)\n}\n")
|
|
||||||
if err := os.WriteFile(filepath.Join(dir, "reindex.go"), content, 0o600); err != nil {
|
|
||||||
t.Fatalf("testdatei schreiben: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
result, err := ScanSearchPathForDynamicSQL(dir)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("scan: %v", err)
|
|
||||||
}
|
|
||||||
if !result.Passed {
|
|
||||||
t.Fatalf("erwartete bestandenen scan (dokumentierte ausnahme), habe: %v", result.Violations)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestRun_RealGateAgainstCurrentARC08SRC10State ist die geforderte
|
|
||||||
// Pflichtprüfung 1: Gate-Lauf gegen aktuellen Stand von ARC-08/SRC-10
|
|
||||||
// dokumentiert — führt das vollständige Gate real gegen den aktuellen
|
|
||||||
// Modul-Quelltext aus (inklusive echter Postgres-/Manticore-
|
|
||||||
// Integrationstests, darunter ARC-08s Schlüsselrotation und SRC-10s
|
|
||||||
// OCR-Konfidenzabfrage) und dokumentiert das Ergebnis mit Zeitstempel.
|
|
||||||
func TestRun_RealGateAgainstCurrentARC08SRC10State(t *testing.T) {
|
|
||||||
if os.Getenv("TEST_TENANT_DSN") == "" || os.Getenv("TEST_MANTICORE_URL") == "" {
|
|
||||||
t.Skip("TEST_TENANT_DSN/TEST_MANTICORE_URL nicht gesetzt, Integrationstest übersprungen")
|
|
||||||
}
|
|
||||||
root := moduleRoot(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
|
|
||||||
result, err := Run(ctx, root)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("gate-lauf: %v", err)
|
|
||||||
}
|
|
||||||
if result.Timestamp.IsZero() {
|
|
||||||
t.Fatal("erwarteter zeitstempel fehlt")
|
|
||||||
}
|
|
||||||
if !result.SQLScan.Passed {
|
|
||||||
t.Fatalf("statischer scan fehlgeschlagen: %v", result.SQLScan.Violations)
|
|
||||||
}
|
|
||||||
if !result.TestSuite.Passed {
|
|
||||||
t.Fatalf("testsuiten fehlgeschlagen, ausgabe:\n%s", result.TestSuite.Output)
|
|
||||||
}
|
|
||||||
|
|
||||||
reportPath := filepath.Join(t.TempDir(), "qa-03-gate-report.md")
|
|
||||||
if err := os.WriteFile(reportPath, []byte(result.Report()), 0o600); err != nil {
|
|
||||||
t.Fatalf("bericht schreiben: %v", err)
|
|
||||||
}
|
|
||||||
t.Logf("Gate-Bericht (%s):\n%s", reportPath, result.Report())
|
|
||||||
}
|
|
||||||
@@ -1,11 +0,0 @@
|
|||||||
CREATE TABLE IF NOT EXISTS mail_saved_searches (
|
|
||||||
id BIGSERIAL PRIMARY KEY,
|
|
||||||
tenant_slug TEXT NOT NULL,
|
|
||||||
user_id TEXT NOT NULL,
|
|
||||||
name TEXT NOT NULL,
|
|
||||||
query_text TEXT NOT NULL DEFAULT '',
|
|
||||||
filters JSONB NOT NULL DEFAULT '[]'::jsonb,
|
|
||||||
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
updated_at TIMESTAMPTZ NOT NULL DEFAULT now(),
|
|
||||||
UNIQUE (tenant_slug, user_id, name)
|
|
||||||
)
|
|
||||||
@@ -1,174 +0,0 @@
|
|||||||
// Package savedsearch implementiert SRC-08: benannte, wiederausführbare
|
|
||||||
// Suchanfragen inklusive aktiver Filter. Speichert ausschließlich die
|
|
||||||
// SUCHKRITERIEN (Suchtext + Filter), niemals Trefferlisten — Execute ruft
|
|
||||||
// bei jeder Ausführung real gegen mail/internal/search (SRC-01/SRC-03/
|
|
||||||
// SRC-05) auf, damit stets aktuelle Treffer geliefert werden, kein
|
|
||||||
// eingefrorener Snapshot (Akzeptanzkriterium 2). Kombiniert bewusst zwei
|
|
||||||
// bereits fertige, unveränderte Pakete (Postgres-Speicherung hier,
|
|
||||||
// Ausführung über search.Client) statt eines davon zu erweitern.
|
|
||||||
//
|
|
||||||
// "Benutzer" ist bis zu einer zentralen Session-/IAM-Anbindung (Core-
|
|
||||||
// Board-Scope, nicht Bestandteil dieser Kachel) ein vom Aufrufer
|
|
||||||
// mitgegebener opaker userID-String — dieselbe Konvention wie der
|
|
||||||
// Tenant-Kontext in web/mail-search (SRC-04).
|
|
||||||
package savedsearch
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
_ "embed"
|
|
||||||
"encoding/json"
|
|
||||||
"errors"
|
|
||||||
"fmt"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5"
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/search"
|
|
||||||
)
|
|
||||||
|
|
||||||
//go:embed migrations/0001_mail_saved_searches.sql
|
|
||||||
var schemaMigration string
|
|
||||||
|
|
||||||
// ErrNotFound wird geliefert, wenn keine gespeicherte Suche mit den
|
|
||||||
// angegebenen Bezugsdaten existiert.
|
|
||||||
var ErrNotFound = errors.New("savedsearch: gespeicherte suche nicht gefunden")
|
|
||||||
|
|
||||||
// SavedSearch ist eine benannte, wiederausführbare Suchanfrage.
|
|
||||||
type SavedSearch struct {
|
|
||||||
ID int64
|
|
||||||
TenantSlug string
|
|
||||||
UserID string
|
|
||||||
Name string
|
|
||||||
QueryText string
|
|
||||||
Filters []search.FacetFilter
|
|
||||||
}
|
|
||||||
|
|
||||||
// Store persistiert gespeicherte Suchen in Postgres.
|
|
||||||
type Store struct {
|
|
||||||
pool *pgxpool.Pool
|
|
||||||
}
|
|
||||||
|
|
||||||
func NewStore(pool *pgxpool.Pool) *Store {
|
|
||||||
return &Store{pool: pool}
|
|
||||||
}
|
|
||||||
|
|
||||||
// EnsureSchema legt die Tabelle an, falls sie noch nicht existiert —
|
|
||||||
// gleiches Muster wie mail/internal/dedup/indexworker (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, schemaMigration); err != nil {
|
|
||||||
return fmt.Errorf("savedsearch: schema anlegen: %w", err)
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Save legt eine gespeicherte Suche unter name an oder aktualisiert sie,
|
|
||||||
// falls unter demselben Namen für denselben Benutzer/Mandanten bereits
|
|
||||||
// eine existiert (Akzeptanzkriterium 1).
|
|
||||||
func (s *Store) Save(ctx context.Context, tenantSlug, userID, name, queryText string, filters []search.FacetFilter) (int64, error) {
|
|
||||||
filtersJSON, err := json.Marshal(filters)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("savedsearch: filter serialisieren: %w", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
var id int64
|
|
||||||
err = s.pool.QueryRow(ctx, `
|
|
||||||
INSERT INTO mail_saved_searches (tenant_slug, user_id, name, query_text, filters)
|
|
||||||
VALUES ($1, $2, $3, $4, $5)
|
|
||||||
ON CONFLICT (tenant_slug, user_id, name) DO UPDATE
|
|
||||||
SET query_text = EXCLUDED.query_text, filters = EXCLUDED.filters, updated_at = now()
|
|
||||||
RETURNING id
|
|
||||||
`, tenantSlug, userID, name, queryText, filtersJSON).Scan(&id)
|
|
||||||
if err != nil {
|
|
||||||
return 0, fmt.Errorf("savedsearch: speichern: %w", err)
|
|
||||||
}
|
|
||||||
return id, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// List liefert alle gespeicherten Suchen eines Benutzers innerhalb eines
|
|
||||||
// Mandanten (Akzeptanzkriterium 3: je Benutzer/Mandant getrennt sichtbar).
|
|
||||||
func (s *Store) List(ctx context.Context, tenantSlug, userID string) ([]SavedSearch, error) {
|
|
||||||
rows, err := s.pool.Query(ctx, `
|
|
||||||
SELECT id, tenant_slug, user_id, name, query_text, filters
|
|
||||||
FROM mail_saved_searches
|
|
||||||
WHERE tenant_slug = $1 AND user_id = $2
|
|
||||||
ORDER BY name
|
|
||||||
`, tenantSlug, userID)
|
|
||||||
if err != nil {
|
|
||||||
return nil, fmt.Errorf("savedsearch: liste lesen: %w", err)
|
|
||||||
}
|
|
||||||
defer rows.Close()
|
|
||||||
|
|
||||||
var results []SavedSearch
|
|
||||||
for rows.Next() {
|
|
||||||
item, err := scanSavedSearch(rows)
|
|
||||||
if err != nil {
|
|
||||||
return nil, err
|
|
||||||
}
|
|
||||||
results = append(results, item)
|
|
||||||
}
|
|
||||||
if err := rows.Err(); err != nil {
|
|
||||||
return nil, fmt.Errorf("savedsearch: liste iterieren: %w", err)
|
|
||||||
}
|
|
||||||
return results, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Get liefert eine einzelne gespeicherte Suche, streng auf Mandant und
|
|
||||||
// Benutzer beschränkt.
|
|
||||||
func (s *Store) Get(ctx context.Context, tenantSlug, userID string, id int64) (SavedSearch, error) {
|
|
||||||
row := s.pool.QueryRow(ctx, `
|
|
||||||
SELECT id, tenant_slug, user_id, name, query_text, filters
|
|
||||||
FROM mail_saved_searches
|
|
||||||
WHERE tenant_slug = $1 AND user_id = $2 AND id = $3
|
|
||||||
`, tenantSlug, userID, id)
|
|
||||||
item, err := scanSavedSearch(row)
|
|
||||||
if err != nil {
|
|
||||||
if errors.Is(err, pgx.ErrNoRows) {
|
|
||||||
return SavedSearch{}, ErrNotFound
|
|
||||||
}
|
|
||||||
return SavedSearch{}, err
|
|
||||||
}
|
|
||||||
return item, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Delete entfernt GENAU EINE gespeicherte Suche, streng auf Mandant und
|
|
||||||
// Benutzer beschränkt (Akzeptanzkriterium/Pflichtprüfung 3: Löschen
|
|
||||||
// entfernt nur diese eine gespeicherte Suche).
|
|
||||||
func (s *Store) Delete(ctx context.Context, tenantSlug, userID string, id int64) error {
|
|
||||||
tag, err := s.pool.Exec(ctx, `
|
|
||||||
DELETE FROM mail_saved_searches WHERE tenant_slug = $1 AND user_id = $2 AND id = $3
|
|
||||||
`, tenantSlug, userID, id)
|
|
||||||
if err != nil {
|
|
||||||
return fmt.Errorf("savedsearch: löschen: %w", err)
|
|
||||||
}
|
|
||||||
if tag.RowsAffected() == 0 {
|
|
||||||
return ErrNotFound
|
|
||||||
}
|
|
||||||
return nil
|
|
||||||
}
|
|
||||||
|
|
||||||
type rowScanner interface {
|
|
||||||
Scan(dest ...any) error
|
|
||||||
}
|
|
||||||
|
|
||||||
func scanSavedSearch(row rowScanner) (SavedSearch, error) {
|
|
||||||
var item SavedSearch
|
|
||||||
var filtersJSON []byte
|
|
||||||
if err := row.Scan(&item.ID, &item.TenantSlug, &item.UserID, &item.Name, &item.QueryText, &filtersJSON); err != nil {
|
|
||||||
return SavedSearch{}, fmt.Errorf("savedsearch: zeile lesen: %w", err)
|
|
||||||
}
|
|
||||||
if err := json.Unmarshal(filtersJSON, &item.Filters); err != nil {
|
|
||||||
return SavedSearch{}, fmt.Errorf("savedsearch: filter parsen: %w", err)
|
|
||||||
}
|
|
||||||
return item, nil
|
|
||||||
}
|
|
||||||
|
|
||||||
// Execute führt eine gespeicherte Suche LIVE gegen client aus
|
|
||||||
// (Akzeptanzkriterium 2: aktuelle Treffer, kein eingefrorener Snapshot —
|
|
||||||
// Execute speichert selbst nichts zwischen, jeder Aufruf fragt Manticore
|
|
||||||
// neu ab). Hinterlegte Filter werden über search.Client.SearchWithFilters
|
|
||||||
// tatsächlich auf die Treffermenge angewandt (UND-Verknüpfung), nicht nur
|
|
||||||
// auf ihr Vorhandensein geprüft.
|
|
||||||
func Execute(ctx context.Context, client *search.Client, saved SavedSearch) ([]search.Result, error) {
|
|
||||||
return client.SearchWithFilters(ctx, saved.TenantSlug, saved.QueryText, saved.Filters)
|
|
||||||
}
|
|
||||||
@@ -1,202 +0,0 @@
|
|||||||
// Integrationstest (SRC-08): echte Postgres- UND Manticore-Instanz,
|
|
||||||
// folgt derselben TEST_*-Env-Konvention wie mail/internal/search.
|
|
||||||
package savedsearch
|
|
||||||
|
|
||||||
import (
|
|
||||||
"context"
|
|
||||||
"os"
|
|
||||||
"testing"
|
|
||||||
|
|
||||||
"github.com/jackc/pgx/v5/pgxpool"
|
|
||||||
|
|
||||||
"gitea.perlbach24.de/scripte/nexarch/mail/internal/search"
|
|
||||||
)
|
|
||||||
|
|
||||||
func setupStore(t *testing.T) *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)
|
|
||||||
if err := store.EnsureSchema(ctx); err != nil {
|
|
||||||
t.Fatalf("schema: %v", err)
|
|
||||||
}
|
|
||||||
t.Cleanup(func() {
|
|
||||||
_, _ = pool.Exec(context.Background(), `DELETE FROM mail_saved_searches WHERE tenant_slug LIKE 'mandant-src08-%'`)
|
|
||||||
})
|
|
||||||
return store
|
|
||||||
}
|
|
||||||
|
|
||||||
func setupSearchClient(t *testing.T) *search.Client {
|
|
||||||
t.Helper()
|
|
||||||
baseURL := os.Getenv("TEST_MANTICORE_URL")
|
|
||||||
if baseURL == "" {
|
|
||||||
t.Skip("TEST_MANTICORE_URL nicht gesetzt, Integrationstest übersprungen")
|
|
||||||
}
|
|
||||||
client := search.NewClient(baseURL)
|
|
||||||
if err := client.EnsureSchema(context.Background()); err != nil {
|
|
||||||
t.Fatalf("search-schema: %v", err)
|
|
||||||
}
|
|
||||||
return client
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestExecute_SavedSearchWithMultipleFiltersReproducesCorrectly ist die
|
|
||||||
// geforderte Pflichtprüfung 1: gespeicherte Suche mit mehreren Filtern
|
|
||||||
// wird korrekt reproduziert.
|
|
||||||
func TestExecute_SavedSearchWithMultipleFiltersReproducesCorrectly(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
searchClient := setupSearchClient(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-src08-filter"
|
|
||||||
|
|
||||||
docs := []search.Document{
|
|
||||||
{MessageID: "msg-sv-treffer", Subject: "Quartalsbericht", Sender: "alice@example.com", Mailbox: "inbox"},
|
|
||||||
{MessageID: "msg-sv-falscher-sender", Subject: "Quartalsbericht", Sender: "bob@example.com", Mailbox: "inbox"},
|
|
||||||
{MessageID: "msg-sv-falsche-mailbox", Subject: "Quartalsbericht", Sender: "alice@example.com", Mailbox: "archiv"},
|
|
||||||
}
|
|
||||||
for _, d := range docs {
|
|
||||||
d.TenantSlug = tenant
|
|
||||||
d.ID = search.DocumentID(tenant, d.MessageID)
|
|
||||||
if err := searchClient.Index(ctx, d); err != nil {
|
|
||||||
t.Fatalf("index %s: %v", d.MessageID, err)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
filters := []search.FacetFilter{
|
|
||||||
{Field: search.FieldSender, Value: "alice@example.com"},
|
|
||||||
{Field: search.FieldMailbox, Value: "inbox"},
|
|
||||||
}
|
|
||||||
id, err := store.Save(ctx, tenant, "user-1", "Alice Inbox Quartalsbericht", "Quartalsbericht", filters)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("save: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
saved, err := store.Get(ctx, tenant, "user-1", id)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
results, err := Execute(ctx, searchClient, saved)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("execute: %v", err)
|
|
||||||
}
|
|
||||||
if len(results) != 1 || results[0].MessageID != "msg-sv-treffer" {
|
|
||||||
t.Fatalf("erwartete genau msg-sv-treffer, habe: %+v", results)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestExecute_ReturnsCurrentResultsNotFrozenSnapshot deckt
|
|
||||||
// Akzeptanzkriterium 2 ab: aktuelle Treffer, kein eingefrorener Snapshot.
|
|
||||||
func TestExecute_ReturnsCurrentResultsNotFrozenSnapshot(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
searchClient := setupSearchClient(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-src08-live"
|
|
||||||
|
|
||||||
docID := search.DocumentID(tenant, "msg-live-1")
|
|
||||||
// Verteidigung gegen Testreste eines vorherigen Laufs (Manticore wird
|
|
||||||
// zwischen Testläufen nicht automatisch geleert, anders als Postgres
|
|
||||||
// über t.Cleanup) — Ausgangszustand muss real leer sein, damit der
|
|
||||||
// Test die Aussage "kein eingefrorener Snapshot" beweiskräftig prüft.
|
|
||||||
_ = searchClient.Delete(ctx, docID)
|
|
||||||
t.Cleanup(func() { _ = searchClient.Delete(context.Background(), docID) })
|
|
||||||
|
|
||||||
id, err := store.Save(ctx, tenant, "user-1", "Alles zu Zylotharion", "Zylotharion", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("save: %v", err)
|
|
||||||
}
|
|
||||||
saved, err := store.Get(ctx, tenant, "user-1", id)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("get: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
before, err := Execute(ctx, searchClient, saved)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("execute (vorher): %v", err)
|
|
||||||
}
|
|
||||||
if len(before) != 0 {
|
|
||||||
t.Fatalf("erwartete 0 treffer vor indexierung, habe %d", len(before))
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := searchClient.Index(ctx, search.Document{
|
|
||||||
ID: docID,
|
|
||||||
TenantSlug: tenant,
|
|
||||||
MessageID: "msg-live-1",
|
|
||||||
Subject: "Neuigkeiten zu Zylotharion",
|
|
||||||
}); err != nil {
|
|
||||||
t.Fatalf("index: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
after, err := Execute(ctx, searchClient, saved)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("execute (nachher): %v", err)
|
|
||||||
}
|
|
||||||
if len(after) != 1 {
|
|
||||||
t.Fatalf("erwartete 1 aktuellen treffer nach neuer indexierung (kein eingefrorener snapshot), habe %d", len(after))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestList_UserSeesNoOtherTenantsSavedSearches ist die geforderte
|
|
||||||
// Pflichtprüfung 2: Benutzer sieht keine gespeicherten Suchen anderer
|
|
||||||
// Mandanten.
|
|
||||||
func TestList_UserSeesNoOtherTenantsSavedSearches(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenantA := "mandant-src08-iso-a"
|
|
||||||
tenantB := "mandant-src08-iso-b"
|
|
||||||
|
|
||||||
if _, err := store.Save(ctx, tenantA, "user-1", "Suche A", "irgendwas", nil); err != nil {
|
|
||||||
t.Fatalf("save mandant a: %v", err)
|
|
||||||
}
|
|
||||||
if _, err := store.Save(ctx, tenantB, "user-1", "Suche B", "irgendwas", nil); err != nil {
|
|
||||||
t.Fatalf("save mandant b: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
listB, err := store.List(ctx, tenantB, "user-1")
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("list mandant b: %v", err)
|
|
||||||
}
|
|
||||||
if len(listB) != 1 || listB[0].Name != "Suche B" {
|
|
||||||
t.Fatalf("mandant b sieht fremde/fehlende suchen: %+v", listB)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// TestDelete_RemovesOnlyThatSavedSearch ist die geforderte Pflichtprüfung
|
|
||||||
// 3: Löschen einer gespeicherten Suche entfernt nur diese.
|
|
||||||
func TestDelete_RemovesOnlyThatSavedSearch(t *testing.T) {
|
|
||||||
store := setupStore(t)
|
|
||||||
ctx := context.Background()
|
|
||||||
tenant := "mandant-src08-delete"
|
|
||||||
|
|
||||||
idA, err := store.Save(ctx, tenant, "user-1", "Suche A", "a", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("save a: %v", err)
|
|
||||||
}
|
|
||||||
idB, err := store.Save(ctx, tenant, "user-1", "Suche B", "b", nil)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("save b: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if err := store.Delete(ctx, tenant, "user-1", idA); err != nil {
|
|
||||||
t.Fatalf("delete a: %v", err)
|
|
||||||
}
|
|
||||||
|
|
||||||
if _, err := store.Get(ctx, tenant, "user-1", idA); err != ErrNotFound {
|
|
||||||
t.Fatalf("erwartete ErrNotFound für gelöschte suche a, habe: %v", err)
|
|
||||||
}
|
|
||||||
stillThere, err := store.Get(ctx, tenant, "user-1", idB)
|
|
||||||
if err != nil {
|
|
||||||
t.Fatalf("suche b sollte weiterhin existieren: %v", err)
|
|
||||||
}
|
|
||||||
if stillThere.Name != "Suche B" {
|
|
||||||
t.Fatalf("unerwarteter inhalt für suche b: %+v", stillThere)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user