Files
lockaway/README.md
T
andreas.dinauerandClaude Opus 5.5 0adb2594d1 📝 Add README
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-10-01 19:44:53 +02:00

25 lines
2.0 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Lockaway
Lockaway ist eine kleine, selbst gehostete Secret-Verwaltung für Kubernetes. Secrets werden zentral in einer Web-Oberfläche gepflegt und automatisch als native Kubernetes-`Secret`s in die gewünschten Namespaces ausgerollt – ohne dass Klartext-Werte je in der Datenbank oder im Backend landen.
## Wie es funktioniert
```
Browser (Vue) ──verschlüsselt──▶ Backend (Quarkus + Postgres) ◀──pollt── Reconciler ──▶ Kubernetes Secrets
```
- **Frontend** (`frontend/`, Vue + Vite): Nach Eingabe eines Master-Passworts wird daraus im Browser ein AES-256-GCM-Schlüssel abgeleitet (HKDF-SHA256). Alle Werte werden clientseitig ver- und entschlüsselt. Ein Secret besteht aus Name, Typ (z. B. `Opaque`), Key/Value-Einträgen und einer Liste von Ziel-Namespaces. Import/Export ist ebenfalls möglich.
- **Backend** (`backend/`, Quarkus + PostgreSQL/Flyway): Speichert die Secrets ausschließlich verschlüsselt und stellt eine REST-API bereit (`/secrets`, `/_import`, `/_export`). Ein Verifikationswert stellt sicher, dass alle Clients dasselbe Master-Passwort verwenden.
- **Reconciler** (`reconciler/`, Quarkus + Fabric8): Läuft im Cluster, kennt denselben Master-Key, holt alle 60 Sekunden die Secrets vom Backend, entschlüsselt sie und gleicht sie per Server-Side-Apply mit dem Cluster ab – anlegen, aktualisieren (über einen Content-Hash) und entfernen. Verwaltete Secrets tragen das Label `lockaway.dev/secret-name`; bestehende, nicht von Lockaway verwaltete Secrets werden nie überschrieben oder gelöscht. Namespaces, die (noch) nicht existieren, werden übersprungen.
## Lokale Entwicklung
```shell
docker compose -f dev/docker-compose.yaml up -d # Postgres auf Port 32876
cd backend && ./mvnw quarkus:dev # API auf :8080
cd frontend && npm install && npm run dev
cd reconciler && ./mvnw quarkus:dev -Dquarkus.http.port=8081 # benötigt kubeconfig
```
Der Master-Key des Reconcilers wird über `lockaway.master.key` konfiguriert und muss dem im Frontend verwendeten Master-Passwort entsprechen.