feat(archive): RET-06-API Aufbewahrungsfristen-Konfigurations-Backend

Board-Entscheidung: Backend-API zuerst, echtes Next.js-Frontend als
separates Folgeticket - vermeidet Pseudo-Frontend-Protokoll.
internal/retentionapi: 4 Endpunkte (anlegen/aendern, deaktivieren,
liste, vorschau), Vorschau nutzt dieselbe ListExpiringObjects-Funktion
wie RET-02s periodischer Job (keine Doppel-Implementierung).
RequireRole ist AUSDRUECKLICH kein RBAC-02-Ersatz, sondern ein
dokumentiertes Provisorium (Header-Check) - RBAC-02 ist reiner
Core-interner Go-Code ohne HTTP-Schnittstelle fuer andere Module,
derselbe Befund wie FDN-03/FDN-09. Provisorium real getestet inkl.
Negativfall (403 ohne/mit falscher Rolle). retention_class_rules um
active-Flag erweitert (deaktivieren ohne Historienverlust). Real auf
131 deployed und per curl end-to-end verifiziert.
This commit is contained in:
sysops
2026-08-30 02:09:37 +02:00
parent 2c9a7482b6
commit 21278f1405
11 changed files with 644 additions and 3 deletions
+48
View File
@@ -0,0 +1,48 @@
// Package retentionapi implementiert RET-06-API: die Backend-Seite der
// Aufbewahrungsfristen-Konfigurationsoberfläche (CRUD auf
// Aufbewahrungsklassen + Vorschauliste ablaufender Objekte). Das
// Next.js-Frontend selbst ist NICHT Teil dieses Tickets (Board-
// Entscheidung: Backend-API zuerst, Frontend als eigenes Folgeticket).
package retentionapi
import (
"net/http"
"strings"
)
// requiredRoleHeader ist der Header-Name des PROVISORISCHEN Rollen-
// Checks (siehe RequireRole-Dokumentation).
const requiredRoleHeader = "X-Admin-Roles"
// RequireRole ist ein PROVISORISCHER Rollen-Check, KEIN RBAC-02-Aufruf.
//
// Core RBAC-02 (internal/policy, Enforcer.Authorize) ist reiner
// Go-Code innerhalb des Core-Moduls, hat keine HTTP-Schnittstelle, über
// die Archive (physisch getrenntes Go-Modul) es aufrufen könnte —
// derselbe "gefunden, aber nicht modulübergreifend verdrahtet"-Befund
// wie bei Core FDN-03/FDN-09. Bis ein Core-seitiger HTTP-Wrapper um
// RBAC-02 existiert (eigenes, künftiges Core-Ticket, z. B. RBAC-06),
// prüft dieser Middleware NUR einen einfachen, selbst gesetzten Header
// (`X-Admin-Roles`, kommagetrennt) auf das Vorhandensein der
// geforderten Rolle — KEINE echte Autorisierung gegen Core, leicht zu
// fälschen von jedem, der den Header selbst setzen kann. Muss ersetzt
// werden, sobald der Core-HTTP-Wrapper existiert.
func RequireRole(requiredRole string, next http.HandlerFunc) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
roles := r.Header.Get(requiredRoleHeader)
if !containsRole(roles, requiredRole) {
http.Error(w, "zugriff verweigert: rolle "+requiredRole+" erforderlich (provisorischer check, siehe RequireRole)", http.StatusForbidden)
return
}
next(w, r)
}
}
func containsRole(commaSeparated, role string) bool {
for _, r := range strings.Split(commaSeparated, ",") {
if strings.TrimSpace(r) == role {
return true
}
}
return false
}
@@ -0,0 +1,60 @@
package retentionapi
import (
"net/http"
"net/http/httptest"
"testing"
)
// TestRequireRole_MissingRoleReturns403 ist die vom Nutzer geforderte
// Negativpruefung fuer den provisorischen Rollen-Check: keine/falsche
// Rolle => 403, sonst waere der Check nicht pruefbar.
func TestRequireRole_MissingRoleReturns403(t *testing.T) {
handler := RequireRole(adminRole, func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
})
server := httptest.NewServer(handler)
defer server.Close()
// Kein Header gesetzt.
resp, err := http.Get(server.URL)
if err != nil {
t.Fatalf("get: %v", err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode != http.StatusForbidden {
t.Fatalf("ohne rollen-header: status = %d, want 403", resp.StatusCode)
}
// Falsche Rolle gesetzt.
req, _ := http.NewRequest(http.MethodGet, server.URL, nil)
req.Header.Set("X-Admin-Roles", "irgendwas_anderes")
resp2, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("get: %v", err)
}
defer func() { _ = resp2.Body.Close() }()
if resp2.StatusCode != http.StatusForbidden {
t.Fatalf("mit falscher rolle: status = %d, want 403", resp2.StatusCode)
}
}
// TestRequireRole_CorrectRoleAllowsAccess ist der positive Gegentest.
func TestRequireRole_CorrectRoleAllowsAccess(t *testing.T) {
handler := RequireRole(adminRole, func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusOK)
})
server := httptest.NewServer(handler)
defer server.Close()
req, _ := http.NewRequest(http.MethodGet, server.URL, nil)
req.Header.Set("X-Admin-Roles", "irgendwas_anderes, archive_admin")
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("get: %v", err)
}
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode != http.StatusOK {
t.Fatalf("mit korrekter rolle: status = %d, want 200", resp.StatusCode)
}
}
+98
View File
@@ -0,0 +1,98 @@
package retentionapi
import (
"encoding/json"
"net/http"
"time"
"github.com/jackc/pgx/v5/pgxpool"
"gitea.perlbach24.de/scripte/nexarch/archive/internal/retentionengine"
)
const adminRole = "archive_admin"
// Mount registriert alle RET-06-API-Endpunkte auf mux, jeweils hinter
// dem provisorischen Rollen-Check (siehe authz.go) — Akzeptanzkriterium
// 3: Änderungen an Fristen sind nur berechtigten Rollen zugänglich.
func Mount(mux *http.ServeMux, pool *pgxpool.Pool) {
mux.HandleFunc("POST /retention-classes", RequireRole(adminRole, configureHandler(pool)))
mux.HandleFunc("POST /retention-classes/{class}/deactivate", RequireRole(adminRole, deactivateHandler(pool)))
mux.HandleFunc("GET /retention-classes", RequireRole(adminRole, listHandler(pool)))
mux.HandleFunc("GET /retention-classes/preview", RequireRole(adminRole, previewHandler(pool)))
}
type configureRequest struct {
RetentionClass string `json:"retention_class"`
Duration string `json:"duration"`
}
// configureHandler: Aufbewahrungsklasse anlegen ODER ändern
// (Akzeptanzkriterium 1) — `retentionengine.ConfigureClassRule` ist ein
// UPSERT, eine Änderung wirkt erst ab jetzt auf künftige
// Stichtagsberechnungen (Pflichtprüfung: nicht rückwirkend).
func configureHandler(pool *pgxpool.Pool) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
var req configureRequest
if err := json.NewDecoder(r.Body).Decode(&req); err != nil {
http.Error(w, "ungültiger request-body: "+err.Error(), http.StatusBadRequest)
return
}
if req.RetentionClass == "" || req.Duration == "" {
http.Error(w, "retention_class und duration sind pflichtfelder", http.StatusBadRequest)
return
}
if err := retentionengine.ConfigureClassRule(r.Context(), pool, req.RetentionClass, req.Duration); err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.WriteHeader(http.StatusOK)
}
}
// deactivateHandler: Aufbewahrungsklasse deaktivieren (Akzeptanzkriterium 1).
func deactivateHandler(pool *pgxpool.Pool) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
class := r.PathValue("class")
if err := retentionengine.DeactivateClassRule(r.Context(), pool, class); err != nil {
http.Error(w, err.Error(), http.StatusNotFound)
return
}
w.WriteHeader(http.StatusOK)
}
}
// listHandler liefert alle konfigurierten Aufbewahrungsklassen (aktiv
// und deaktiviert) — Grundlage der künftigen Konfigurationsoberfläche.
func listHandler(pool *pgxpool.Pool) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
rules, err := retentionengine.ListClassRules(r.Context(), pool)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
_ = json.NewEncoder(w).Encode(rules)
}
}
// previewHandler liefert die Vorschauliste bald ablaufender Objekte
// (Akzeptanzkriterium 2: Standard 30 Tage, per `days`-Query-Parameter
// überschreibbar). Nutzt DIESELBE `ListExpiringObjects`-Funktion wie
// der periodische Job (RET-02) — Pflichtprüfung: Vorschauliste stimmt
// mit dem Ergebnis des periodischen Jobs überein (keine zweite,
// abweichende Implementierung).
func previewHandler(pool *pgxpool.Pool) http.HandlerFunc {
return func(w http.ResponseWriter, r *http.Request) {
days := 30
asOf := time.Now().UTC().AddDate(0, 0, days)
objects, err := retentionengine.ListExpiringObjects(r.Context(), pool, asOf)
if err != nil {
http.Error(w, err.Error(), http.StatusInternalServerError)
return
}
w.Header().Set("Content-Type", "application/json")
_ = json.NewEncoder(w).Encode(objects)
}
}
@@ -0,0 +1,174 @@
package retentionapi
import (
"bytes"
"context"
"encoding/json"
"net/http"
"net/http/httptest"
"os"
"testing"
"time"
"github.com/jackc/pgx/v5/pgxpool"
"gitea.perlbach24.de/scripte/nexarch/archive/internal/retentionengine"
)
func requireTestPool(t *testing.T) *pgxpool.Pool {
t.Helper()
dsn := os.Getenv("TEST_TENANT_DSN")
if dsn == "" {
t.Skip("TEST_TENANT_DSN nicht gesetzt, Integrationstest uebersprungen")
}
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 EXTENSION IF NOT EXISTS pgcrypto;
CREATE TABLE IF NOT EXISTS retention_objects (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(), object_type TEXT NOT NULL,
object_reference TEXT NOT NULL,
status TEXT NOT NULL DEFAULT 'active' CHECK (status IN ('active', 'expired', 'deleted')),
created_at TIMESTAMPTZ NOT NULL DEFAULT now(),
UNIQUE (object_type, object_reference)
);
CREATE TABLE IF NOT EXISTS retention_class_assignments (
id UUID PRIMARY KEY DEFAULT gen_random_uuid(),
retention_object_id UUID NOT NULL REFERENCES retention_objects(id) ON DELETE CASCADE,
retention_class TEXT NOT NULL, assigned_at TIMESTAMPTZ NOT NULL DEFAULT now()
);
CREATE TABLE IF NOT EXISTS retention_class_rules (
retention_class TEXT PRIMARY KEY, duration INTERVAL NOT NULL,
active BOOLEAN NOT NULL DEFAULT true
);
`); err != nil {
t.Fatalf("schema: %v", err)
}
t.Cleanup(func() {
_, _ = pool.Exec(context.Background(), `TRUNCATE retention_class_assignments, retention_objects CASCADE; TRUNCATE retention_class_rules`)
})
return pool
}
func authedRequest(t *testing.T, method, url string, body []byte) *http.Response {
t.Helper()
var reader *bytes.Reader
if body != nil {
reader = bytes.NewReader(body)
} else {
reader = bytes.NewReader(nil)
}
req, err := http.NewRequest(method, url, reader)
if err != nil {
t.Fatalf("request erstellen: %v", err)
}
req.Header.Set("X-Admin-Roles", adminRole)
resp, err := http.DefaultClient.Do(req)
if err != nil {
t.Fatalf("request senden: %v", err)
}
return resp
}
// TestConfigureAndListHandler_RealHTTPRoundTrip: Klasse anlegen, ändern,
// über die Liste sichtbar - Akzeptanzkriterium 1.
func TestConfigureAndListHandler_RealHTTPRoundTrip(t *testing.T) {
pool := requireTestPool(t)
mux := http.NewServeMux()
Mount(mux, pool)
server := httptest.NewServer(mux)
defer server.Close()
body, _ := json.Marshal(configureRequest{RetentionClass: "klasse-api", Duration: "5 years"})
resp := authedRequest(t, http.MethodPost, server.URL+"/retention-classes", body)
if resp.StatusCode != http.StatusOK {
t.Fatalf("anlegen: status = %d, want 200", resp.StatusCode)
}
_ = resp.Body.Close()
listResp := authedRequest(t, http.MethodGet, server.URL+"/retention-classes", nil)
defer func() { _ = listResp.Body.Close() }()
var rules []retentionengine.ClassRule
if err := json.NewDecoder(listResp.Body).Decode(&rules); err != nil {
t.Fatalf("liste dekodieren: %v", err)
}
if len(rules) != 1 || rules[0].RetentionClass != "klasse-api" || !rules[0].Active {
t.Fatalf("unerwartete liste: %+v", rules)
}
}
// TestDeactivateHandler_RealHTTPRoundTrip: Deaktivierung wirkt real.
func TestDeactivateHandler_RealHTTPRoundTrip(t *testing.T) {
pool := requireTestPool(t)
ctx := context.Background()
if err := retentionengine.ConfigureClassRule(ctx, pool, "klasse-deakt", "1 year"); err != nil {
t.Fatal(err)
}
mux := http.NewServeMux()
Mount(mux, pool)
server := httptest.NewServer(mux)
defer server.Close()
resp := authedRequest(t, http.MethodPost, server.URL+"/retention-classes/klasse-deakt/deactivate", nil)
defer func() { _ = resp.Body.Close() }()
if resp.StatusCode != http.StatusOK {
t.Fatalf("deaktivieren: status = %d, want 200", resp.StatusCode)
}
rules, err := retentionengine.ListClassRules(ctx, pool)
if err != nil {
t.Fatalf("listclassrules: %v", err)
}
if len(rules) != 1 || rules[0].Active {
t.Fatalf("erwartet deaktivierte klasse, habe %+v", rules)
}
}
// TestPreviewHandler_MatchesPeriodicJobResult ist die geforderte
// Pflichtpruefung: Vorschauliste stimmt mit dem Ergebnis des
// periodischen Jobs ueberein - beide nutzen dieselbe Funktion, real
// per HTTP UND direkt verglichen.
func TestPreviewHandler_MatchesPeriodicJobResult(t *testing.T) {
pool := requireTestPool(t)
ctx := context.Background()
if err := retentionengine.ConfigureClassRule(ctx, pool, "klasse-preview", "1 day"); err != nil {
t.Fatal(err)
}
var objID string
if err := pool.QueryRow(ctx, `INSERT INTO retention_objects (object_type, object_reference) VALUES ('dms_document', 'preview-doc') RETURNING id`).Scan(&objID); err != nil {
t.Fatal(err)
}
if _, err := pool.Exec(ctx, `INSERT INTO retention_class_assignments (retention_object_id, retention_class) VALUES ($1, 'klasse-preview')`, objID); err != nil {
t.Fatal(err)
}
mux := http.NewServeMux()
Mount(mux, pool)
server := httptest.NewServer(mux)
defer server.Close()
resp := authedRequest(t, http.MethodGet, server.URL+"/retention-classes/preview", nil)
defer func() { _ = resp.Body.Close() }()
var httpResult []retentionengine.ExpiringObject
if err := json.NewDecoder(resp.Body).Decode(&httpResult); err != nil {
t.Fatalf("preview-antwort dekodieren: %v", err)
}
directResult, err := retentionengine.ListExpiringObjects(ctx, pool, time.Now().UTC().AddDate(0, 0, 30))
if err != nil {
t.Fatalf("listexpiringobjects direkt: %v", err)
}
if len(httpResult) != len(directResult) || len(httpResult) != 1 {
t.Fatalf("http-vorschau (%d) und periodischer job (%d) stimmen nicht ueberein", len(httpResult), len(directResult))
}
if httpResult[0].RetentionObjectID != directResult[0].RetentionObjectID {
t.Fatalf("http-vorschau und periodischer job liefern unterschiedliche objekte: %+v vs %+v", httpResult[0], directResult[0])
}
}