WompSchmiede/FamilienFeierPlaner
SHA256
1
1
Fork 0
Code Issues 18 Pull requests Projects Releases 5 Packages 3 Wiki Activity Actions

Passwort-Vergessen-Funktion (Recherche: Keycloak vs. Frontend) #91

New issue
Closed
opened 2026-06-23 14:45:24 +02:00 by niboer · 2 comments
niboer commented 2026-06-23 14:45:24 +02:00
Owner
Copy link

Beschreibung

Es soll eine "Passwort vergessen"-Funktion implementiert werden, die es Benutzern ermoeglicht, ihr Passwort zurueckzusetzen, ohne sich anmelden zu muessen.

Aufgabe

Zunaechst ist zu recherchieren und zu klaeren, welcher Ansatz besser geeignet ist:

Option A: Keycloak-eigene Oberflaeche

  • Keycloak bietet von Haus aus eine "Forgot Password"-Funktion ueber den Login-Flow
  • Ermoeglicht Passwort-Reset via E-Mail-Link
  • Anpassbar via Keycloak-Theme (bereits vorhanden)
  • Geringerer Entwicklungsaufwand

Option B: Eigenes Frontend

  • Eigenstaendige Seite im SvelteKit-Frontend
  • API-Kommunikation mit Keycloak (Account Console API oder Admin API)
  • Vollstaendig kontrolliertes UI/UX
  • Hoeherer Entwicklungsaufwand

Entscheidungskriterien

  • Aufwand / Nutzen-Verhaeltnis
  • Sicherheit (E-Mail-Verifikation, Token-Laufzeit)
  • UX-Konsistenz mit bestehendem Frontend
  • Wartbarkeit

Umsetzung (nach Entscheidung)

  • Implementierung des gewaehlten Ansatzes
  • Tests
  • Dokumentation
### Beschreibung Es soll eine "Passwort vergessen"-Funktion implementiert werden, die es Benutzern ermoeglicht, ihr Passwort zurueckzusetzen, ohne sich anmelden zu muessen. ### Aufgabe Zunaechst ist zu recherchieren und zu klaeren, welcher Ansatz besser geeignet ist: **Option A: Keycloak-eigene Oberflaeche** - Keycloak bietet von Haus aus eine "Forgot Password"-Funktion ueber den Login-Flow - Ermoeglicht Passwort-Reset via E-Mail-Link - Anpassbar via Keycloak-Theme (bereits vorhanden) - Geringerer Entwicklungsaufwand **Option B: Eigenes Frontend** - Eigenstaendige Seite im SvelteKit-Frontend - API-Kommunikation mit Keycloak (Account Console API oder Admin API) - Vollstaendig kontrolliertes UI/UX - Hoeherer Entwicklungsaufwand ### Entscheidungskriterien - Aufwand / Nutzen-Verhaeltnis - Sicherheit (E-Mail-Verifikation, Token-Laufzeit) - UX-Konsistenz mit bestehendem Frontend - Wartbarkeit ### Umsetzung (nach Entscheidung) - Implementierung des gewaehlten Ansatzes - Tests - Dokumentation
niboer commented 2026-07-01 21:21:26 +02:00
Author
Owner
Copy link

Entscheidung: Option A — Keycloak-eigene Oberflaeche

Die Recherche ergibt eine klare Praeferenz fuer die Keycloak-interne Loesung:

  1. Keycloak stellt via parent=keycloak.v2 bereits alle benoetigten FTL-Templates bereit (login-reset-password.ftl, login-update-password.ftl, E-Mail-Vorlagen)
  2. login.css styled die PatternFly-v5-Klassen der Reset-Templates
  3. Kein Backend-Code fuer den eigentlichen Flow noetig (Keycloak uebernimmt Reset-Token, E-Mail-Versand, Passwort-Aenderung)
  4. Keine neuen Frontend-Seiten — Der Link erscheint automatisch auf Keycloaks Login-Seite sobald resetPasswordAllowed aktiviert ist
  5. Keine Secrets in der Applikation — SMTP-Zugangsdaten bleiben in Keycloak

Umsetzungsplan (5 Commits)

Commit 1 — chore(infra): MailHog fuer E-Mail-Tests in Docker-Compose integriert

Docker-Compose um MailHog-Service ergaenzen, SMTP-Env-Vars fuer Keycloak, Env-Vars fuer backend-provisioning.

Datei Aenderung
docker-compose.yml MailHog-Service (Port 1025 SMTP, 8025 Web-UI) + SMTP-Env-Vars Keycloak
.env + .env.example SMTP_HOST, SMTP_PORT, SMTP_FROM
PROJECT_STATE.md Aktualisieren

Commit 2 — feat(keycloak): Login-Theme auf keycloak.v2 umgestellt + resetPasswordAllowed aktiviert

Parent auf keycloak.v2 (PatternFly 5), CSS-Klassen migrieren, Realm-Schalter setzen.

Datei Aenderung
keycloak/themes/.../login/theme.properties parent=keycloak.v2
keycloak/themes/.../login/resources/css/login.css pf-c-* → pf-v5-c-*
keycloak/realm-export.json resetPasswordAllowed: true
PROJECT_STATE.md Aktualisieren

Commit 3 — feat(backend): SMTP-Config in Keycloak-Provisioning gesetzt

Neue Funktion configureRealmSmtp() in keycloak-provision.ts, ruft Admin-API PUT /admin/realms/{realm} auf.

Datei Aenderung
backend/src/lib/keycloak-provision.ts configureRealmSmtp() + Aufruf in provisionKeycloak()
PROJECT_STATE.md Aktualisieren

Commit 4 — test(backend): resetPasswordAllowed + SMTP-Provisioning getestet

Neue Tests in keycloak-roles.test.ts, ggf. keycloak-provision.test.ts.

Datei Aenderung
backend/src/__tests__/keycloak-roles.test.ts Test: resetPasswordAllowed === true
PROJECT_STATE.md Aktualisieren

Commit 5 — docs: Passwort-Vergessen-Flow dokumentiert — closes #91

Neuer Abschnitt in Auth-Dokumentation + PROJECT_STATE finalisieren.

Datei Aenderung
docs/design/05-authentifizierung.md Neuer Abschnitt "Passwort-Vergessen (Forgot Password)"
PROJECT_STATE.md Finales Update
## Entscheidung: Option A — Keycloak-eigene Oberflaeche Die Recherche ergibt eine klare Praeferenz fuer die Keycloak-interne Loesung: 1. **Keycloak** stellt via `parent=keycloak.v2` bereits alle benoetigten FTL-Templates bereit (`login-reset-password.ftl`, `login-update-password.ftl`, E-Mail-Vorlagen) 2. **login.css** styled die PatternFly-v5-Klassen der Reset-Templates 3. **Kein Backend-Code** fuer den eigentlichen Flow noetig (Keycloak uebernimmt Reset-Token, E-Mail-Versand, Passwort-Aenderung) 4. **Keine neuen Frontend-Seiten** — Der Link erscheint automatisch auf Keycloaks Login-Seite sobald `resetPasswordAllowed` aktiviert ist 5. **Keine Secrets in der Applikation** — SMTP-Zugangsdaten bleiben in Keycloak ## Umsetzungsplan (5 Commits) ### Commit 1 — `chore(infra): MailHog fuer E-Mail-Tests in Docker-Compose integriert` Docker-Compose um MailHog-Service ergaenzen, SMTP-Env-Vars fuer Keycloak, Env-Vars fuer backend-provisioning. | Datei | Aenderung | |---|---| | `docker-compose.yml` | MailHog-Service (Port 1025 SMTP, 8025 Web-UI) + SMTP-Env-Vars Keycloak | | `.env` + `.env.example` | `SMTP_HOST`, `SMTP_PORT`, `SMTP_FROM` | | `PROJECT_STATE.md` | Aktualisieren | ### Commit 2 — `feat(keycloak): Login-Theme auf keycloak.v2 umgestellt + resetPasswordAllowed aktiviert` Parent auf `keycloak.v2` (PatternFly 5), CSS-Klassen migrieren, Realm-Schalter setzen. | Datei | Aenderung | |---|---| | `keycloak/themes/.../login/theme.properties` | `parent=keycloak.v2` | | `keycloak/themes/.../login/resources/css/login.css` | `pf-c-*` → `pf-v5-c-*` | | `keycloak/realm-export.json` | `resetPasswordAllowed: true` | | `PROJECT_STATE.md` | Aktualisieren | ### Commit 3 — `feat(backend): SMTP-Config in Keycloak-Provisioning gesetzt` Neue Funktion `configureRealmSmtp()` in `keycloak-provision.ts`, ruft Admin-API `PUT /admin/realms/{realm}` auf. | Datei | Aenderung | |---|---| | `backend/src/lib/keycloak-provision.ts` | `configureRealmSmtp()` + Aufruf in `provisionKeycloak()` | | `PROJECT_STATE.md` | Aktualisieren | ### Commit 4 — `test(backend): resetPasswordAllowed + SMTP-Provisioning getestet` Neue Tests in `keycloak-roles.test.ts`, ggf. `keycloak-provision.test.ts`. | Datei | Aenderung | |---|---| | `backend/src/__tests__/keycloak-roles.test.ts` | Test: `resetPasswordAllowed === true` | | `PROJECT_STATE.md` | Aktualisieren | ### Commit 5 — `docs: Passwort-Vergessen-Flow dokumentiert` — `closes #91` Neuer Abschnitt in Auth-Dokumentation + PROJECT_STATE finalisieren. | Datei | Aenderung | |---|---| | `docs/design/05-authentifizierung.md` | Neuer Abschnitt "Passwort-Vergessen (Forgot Password)" | | `PROJECT_STATE.md` | Finales Update |
niboer commented 2026-07-01 21:24:56 +02:00
Author
Owner
Copy link

Implementierung abgeschlossen.

Commits:

  • 66e8341 — MailHog in Docker-Compose integriert
  • a79e60d — Login-Theme auf keycloak.v2 + resetPasswordAllowed
  • 753456a — SMTP-Config in Keycloak-Provisioning gesetzt
  • 966f1f4 — Tests fuer resetPasswordAllowed
  • 02a5843 — Dokumentation (closes)

Zusammenfassung:

  • Keycloak-eigener Forgot-Password-Flow (Option A) implementiert
  • MailHog als Dev-SMTP-Server in Docker-Compose
  • SMTP-Konfiguration via Backend-Provisioning (Admin API)
  • Login-Theme auf keycloak.v2 (PF5) migriert
  • resetPasswordAllowed: true im Realm aktiviert
  • Doku in 05-authentifizierung.md
Implementierung abgeschlossen. **Commits:** - `66e8341` — MailHog in Docker-Compose integriert - `a79e60d` — Login-Theme auf keycloak.v2 + resetPasswordAllowed - `753456a` — SMTP-Config in Keycloak-Provisioning gesetzt - `966f1f4` — Tests fuer resetPasswordAllowed - `02a5843` — Dokumentation (closes) **Zusammenfassung:** - Keycloak-eigener Forgot-Password-Flow (Option A) implementiert - MailHog als Dev-SMTP-Server in Docker-Compose - SMTP-Konfiguration via Backend-Provisioning (Admin API) - Login-Theme auf `keycloak.v2` (PF5) migriert - `resetPasswordAllowed: true` im Realm aktiviert - Doku in 05-authentifizierung.md
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
v0.5.0
v0.4.0
v0.3.0
v0.2.2
v0.2.1
v0.2.0
v0.1.0
Labels
Clear labels   
component/backend
Backend-Komponente

  
component/docs
Dokumentation (README, design.md, AGENTS.md)

  
component/e2e
E2E-Testinfrastruktur (Playwright, Docker-E2E-Runner)

  
component/frontend
Frontend (Cloudflare Worker, BFF, UI)

  
component/infra
Infrastruktur (Docker, CI/CD, Build)

  
component/keycloak
Keycloak (Realm, Theme, Admin API)

  
prio/high
Hohe Prioritaet (blockierend/kritisch)

  
prio/low
Niedrige Prioritaet

  
prio/medium
Mittlere Prioritaet

  
type/bug
Fehler oder unerwartetes Verhalten

  
type/chore
Wartungs- und Konfigurationsaufgaben

  
type/feature
Neues Feature

  
type/refactor
Refactoring

  
type/test
Tests

No labels
component/backend
component/docs
component/e2e
component/frontend
component/infra
component/keycloak
prio/high
prio/low
prio/medium
type/bug
type/chore
type/feature
type/refactor
type/test
Milestone
Clear milestone
No items
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
WompSchmiede/FamilienFeierPlaner#91
No description provided.