Doku: Audit-Siegel (AUDIT_HMAC_KEY) verstaendlich erklaert
README und .env.example erklaeren jetzt zuerst in Alltagssprache, was das Audit-Log ist, wogegen der Schluessel schuetzt und was passiert, wenn man ihn weglaesst oder verliert - inklusive Bild vom Notarstempel. Die technische Ebene bleibt vollstaendig erhalten, in der README als aufklappbarer Block (Hash-Versionen 1/2/3, Version-Floor, Loeschungs-Manifest, Rueckgabefelder von /verify, bekannte Grenze) und in .env.example als eigener Abschnitt. Ausserdem dokumentiert: Schluesselwechsel ueber AUDIT_HMAC_KEY_OLD ohne Rehash, pro Umgebung ein eigener Schluessel, und die Warnung zu den beiden Endpunkten mit Nebenwirkung (rehash/cleanup). AUDIT_HMAC_KEY zusaetzlich in die Production-Checkliste aufgenommen. Korrigiert: Die Integritaetspruefung ist NICHT ueber die Oberflaeche erreichbar (verifyIntegrity wird von keiner Komponente genutzt) - die Doku zeigt jetzt den API-Aufruf. Rechte, Endpunkte und Rueckgabefelder gegen den Code geprueft. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This commit is contained in:
@@ -281,6 +281,10 @@ LISTEN_ADDR=127.0.0.1
|
||||
|
||||
# Bei separatem Frontend-Host: erlaubte Origins
|
||||
CORS_ORIGINS=https://crm.deine-domain.de
|
||||
|
||||
# Siegel fuer das Audit-Log – schuetzt die Beweisspur vor nachtraeglicher
|
||||
# Faelschung. Siehe Abschnitt "Audit-Siegel" weiter unten.
|
||||
AUDIT_HMAC_KEY=$(openssl rand -hex 32)
|
||||
```
|
||||
|
||||
### Deployment-Modus: On-Prem vs. Cloud
|
||||
@@ -298,6 +302,148 @@ SSRF-Schalter:
|
||||
SSRF_BLOCK_PRIVATE_IPS=true
|
||||
```
|
||||
|
||||
### Audit-Siegel (`AUDIT_HMAC_KEY`)
|
||||
|
||||
**Worum geht es?**
|
||||
OpenCRM führt ein Audit-Log: eine lückenlose Aufzeichnung, wer wann welche
|
||||
Daten gesehen oder geändert hat. Das ist die Beweisspur, wenn es Streit gibt,
|
||||
etwas verschwindet oder der Datenschutz nachfragt.
|
||||
|
||||
Damit diese Aufzeichnung etwas wert ist, muss man ihr ansehen können, ob
|
||||
jemand nachträglich daran herumgeschrieben hat. Dafür trägt jeder Eintrag
|
||||
einen Fingerabdruck, der auch den Fingerabdruck des vorherigen Eintrags
|
||||
enthält – wie eine Kette. Ändert jemand einen alten Eintrag, passen die
|
||||
Fingerabdrücke nicht mehr und es fällt auf.
|
||||
|
||||
**Und wozu dann noch ein Schlüssel?**
|
||||
Weil jemand mit Zugriff auf die Datenbank die ganze Kette neu berechnen
|
||||
könnte. Er ändert also einen Eintrag – zum Beispiel einen fehlgeschlagenen
|
||||
Login-Versuch in einen erfolgreichen – und zieht anschließend alle
|
||||
Fingerabdrücke glatt. Danach sieht die Fälschung echt aus.
|
||||
|
||||
Mit `AUDIT_HMAC_KEY` bekommt jeder Eintrag zusätzlich ein **Siegel**, das sich
|
||||
nur mit diesem Schlüssel erzeugen lässt. Der Schlüssel liegt in der
|
||||
`.env`-Datei, also **außerhalb der Datenbank**. Wer nur die Datenbank in die
|
||||
Hände bekommt, kann damit nichts fälschen, ohne dass es auffliegt.
|
||||
|
||||
> Bildlich: Die Fingerabdruck-Kette ist die fortlaufende Nummerierung der
|
||||
> Aktenseiten. Der Schlüssel ist der Stempel des Notars. Die Akte steht zwar
|
||||
> im Schrank – aber den Stempel hat nur der Notar.
|
||||
|
||||
**Einrichten**
|
||||
|
||||
```bash
|
||||
# Einmalig pro Umgebung einen Schlüssel erzeugen
|
||||
openssl rand -hex 32
|
||||
```
|
||||
|
||||
Den Wert in die `.env` der jeweiligen Umgebung eintragen. Wichtig: **pro
|
||||
Umgebung ein eigener Schlüssel** (Entwicklung, Test, Produktion) – und
|
||||
niemals ins Git-Repository.
|
||||
|
||||
**Häufige Fragen**
|
||||
|
||||
| Frage | Antwort |
|
||||
|---|---|
|
||||
| Was, wenn ich den Schlüssel gar nicht setze? | Nichts fällt aus. Das Audit-Log läuft normal weiter, nur ohne dieses zusätzliche Siegel. |
|
||||
| Was, wenn ich ihn verliere? | Die damit gesiegelten Einträge lassen sich nicht mehr prüfen. Sie gelten dann als **„nicht prüfbar"** – ausdrücklich nicht als gefälscht. Kein Fehlalarm, aber der Nachweis für diesen Zeitraum ist weg. Deshalb: sichern wie ein Passwort. |
|
||||
| Muss ich ihn irgendwo eintragen außer in der `.env`? | Nein. Einmal setzen, Backup anlegen, fertig. |
|
||||
| Verlangsamt das etwas? | Nein, spürbar nicht. |
|
||||
|
||||
**Schlüssel wechseln (`AUDIT_HMAC_KEY_OLD`)**
|
||||
|
||||
Möchtest du den Schlüssel austauschen – etwa weil du vermutest, dass er in
|
||||
falsche Hände geraten ist – geht das ohne Datenverlust:
|
||||
|
||||
```env
|
||||
AUDIT_HMAC_KEY=<neuer Schlüssel>
|
||||
AUDIT_HMAC_KEY_OLD=<bisheriger Schlüssel>
|
||||
```
|
||||
|
||||
Neue Einträge werden ab sofort mit dem neuen Schlüssel gesiegelt, die
|
||||
bisherigen bleiben über den alten Schlüssel weiterhin prüfbar. Nach einer
|
||||
Übergangszeit kann `AUDIT_HMAC_KEY_OLD` geleert werden – danach sind die alten
|
||||
Einträge allerdings nicht mehr prüfbar.
|
||||
|
||||
**Prüfen, ob alles in Ordnung ist**
|
||||
|
||||
Die Prüfung läuft derzeit nur über die API (eine Schaltfläche in der Oberfläche
|
||||
gibt es dafür noch nicht) – als angemeldeter Benutzer mit dem Recht
|
||||
`audit:read`:
|
||||
|
||||
```bash
|
||||
curl -X POST https://crm.deine-domain.de/api/audit-logs/verify \
|
||||
-H "Authorization: Bearer <Access-Token>"
|
||||
```
|
||||
|
||||
Die Antwort enthält einen Klartext-Satz im Feld `message` und unterscheidet
|
||||
zwei Dinge:
|
||||
|
||||
- **„Manipulierte Einträge"** – jemand hat einen bestehenden Eintrag
|
||||
nachträglich verändert. Das ist ernst.
|
||||
- **„Strukturelle Lücken"** – die Kette hat eine Unterbrechung, die Inhalte
|
||||
sind aber unverändert. Meist harmlos (z. B. gelöschte alte Einträge).
|
||||
Notiere dir die Zahl nach dem ersten Deploy: Bleibt sie konstant, ist alles
|
||||
in Ordnung. Steigt sie, lohnt ein Blick.
|
||||
|
||||
<details>
|
||||
<summary><b>Technische Details</b> (für Entwickler/Admins)</summary>
|
||||
|
||||
**Verfahren.** Jeder Audit-Eintrag trägt einen Hash über seine Inhaltsspalten
|
||||
plus den Hash des Vorgängers (`previousHash`) – daraus entsteht die Kette. Es
|
||||
gibt drei Hash-Versionen, die Spalte `hashVersion` hält fest, welche verwendet
|
||||
wurde:
|
||||
|
||||
| Version | Verfahren | Abdeckung |
|
||||
|---|---|---|
|
||||
| 1 | SHA-256 | 7 Felder – Altbestand vor der Härtung |
|
||||
| 2 | SHA-256 | alle 24 Inhaltsspalten, unsigniert |
|
||||
| 3 | **HMAC-SHA256** mit `AUDIT_HMAC_KEY` | alle 24 Inhaltsspalten, signiert |
|
||||
|
||||
Bestandsdaten werden **nicht** nachträglich neu berechnet – ein Rehash würde die
|
||||
Beweiskraft der Vergangenheit überschreiben. Alte Einträge bleiben mit ihrer
|
||||
Version gültig.
|
||||
|
||||
**Version-Floor.** Die zu erwartende Version wird aus der Kette abgeleitet
|
||||
(erste je mit Version *n* geschriebene Zeile), **nicht** aus der Selbstauskunft
|
||||
der Zeile. Sonst ließe sich per Downgrade (`hashVersion` 3 → 1) die schwächere
|
||||
Prüfung erzwingen und anschließend ein gültiger Hash über die wenigen
|
||||
abgedeckten Felder nachziehen. Zusätzlich gilt: Eine unerklärte Lücke direkt vor
|
||||
einer signierten Zeile ist ein Befund, kein struktureller Zufall – deren
|
||||
`previousHash` lässt sich ohne Schlüssel nicht fälschen.
|
||||
|
||||
**Löschungen.** `POST /api/audit-logs/cleanup` schreibt ein Manifest
|
||||
(ID-Bereich, Anzahl, Policy, Cutoff) als eigenen verketteten Eintrag. Die
|
||||
Prüfung liest es aus und meldet nur Lücken **ohne** dokumentierte Löschung als
|
||||
erklärungsbedürftig (`unexplainedGaps`) – sonst könnte sich eine böswillige
|
||||
Löschung als harmlose Lücke tarnen.
|
||||
|
||||
**Rückgabe von `POST /api/audit-logs/verify`:**
|
||||
|
||||
| Feld | Bedeutung |
|
||||
|---|---|
|
||||
| `tamperedEntries` | Inhalt nachträglich verändert, Versions-Downgrade oder gebrochener Anker – **ernst** |
|
||||
| `chainGaps` | Verkettung unterbrochen (alle) |
|
||||
| `unexplainedGaps` | Teilmenge davon ohne dokumentierte Löschung |
|
||||
| `unverifiableEntries` | signiert, aber kein Schlüssel konfiguriert – **kein** Manipulationsverdacht |
|
||||
|
||||
**Fail-safe.** Ohne `AUDIT_HMAC_KEY` schreibt der Dienst weiter Version 2; das
|
||||
Logging fällt nie wegen fehlender Konfiguration aus.
|
||||
|
||||
**Bekannte Grenze.** Der Anker schützt gegen reinen Datenbank-Schreibzugriff.
|
||||
Wer Schlüssel *und* Datenbank kontrolliert, kann die Kette konsistent neu
|
||||
rechnen. Eine Off-Site-Notarisierung (regelmäßiger Export/Versiegelung des
|
||||
Kettenkopfes außerhalb des Systems) wäre die nächste Stufe.
|
||||
|
||||
**Achtung – zwei Endpunkte mit Nebenwirkung:**
|
||||
`POST /api/audit-logs/rehash` berechnet alle Hashes neu; danach meldet die
|
||||
Prüfung überall „gültig", aber eine bestehende Fälschung würde mitbesiegelt.
|
||||
`POST /api/audit-logs/cleanup` löscht nach Aufbewahrungsregeln, jede gelöschte
|
||||
Zeile erzeugt eine Lücke. Beide laufen nur manuell und schreiben einen Marker
|
||||
ins Log.
|
||||
|
||||
</details>
|
||||
|
||||
Cloud-Metadata-Endpoints (`169.254.169.254`, `metadata.google.internal` etc.)
|
||||
sind UNABHÄNGIG vom Flag **immer** geblockt – das ist Mindestschutz gegen
|
||||
AWS/GCP/Azure-IMDS-Diebstahl.
|
||||
|
||||
Reference in New Issue
Block a user