Keycloak

Nachfolgend wird beschrieben, wie Sie Trustcaptcha in Ihr Keycloak integrieren.

Folgende Vorbereitungen sollten Sie treffen, bevor Sie mit der Integration von Trustcaptcha in Ihr Keycloak beginnen.

Voraussetzungen

Unterstützte Keycloak-Flows

Keycloak arbeitet mit sogenannten Flows, die von Ihnen bearbeitet und angepasst werden können. Trustcaptcha unterstützt derzeit folgende Flows:

Wir arbeiten kontinuierlich daran, die Kompatibilität unserer Plugins zu erweitern. Bei weiteren Fragen oder Anliegen können Sie sich jederzeit an unseren Support wenden.

Installieren Sie unser Trustcaptcha-Plugin in Ihre Keycloak-Installation wie folgt:

1. Laden Sie die neueste Version unseres Plugins trustcaptcha_keycloak_1-8-0.jar hier herunter.
2. Kopieren Sie die Datei trustcaptcha_keycloak_1-8-0.jar in das Verzeichnis providers Ihrer Keycloak-Installation.

In den folgenden Anleitungen und praktischen Videobeispielen zeigen wir Ihnen, wie Sie Trustcaptcha in die verschiedenen Flows von Keycloak integrieren können.

Registrierung

Die folgenden Schritte sind notwendig, um Trustcaptcha in Ihren Registrierungs-Flow zu integrieren:

1. Melden Sie sich als Administrator in Ihrer Keycloak-Installation an.
2. Navigieren Sie in Ihrem Realm zu Authentication und anschließend zu Flows.
3. Duplizieren Sie den bestehenden registration-Flow, vergeben Sie einen neuen Namen (z. B. Registration (Trustcaptcha)) und bestätigen Sie die Duplizierung.
4. Klicken Sie im obersten Schritt auf Add und anschließend auf Add step. Suchen Sie nach Trustcaptcha / Registration Form Action und fügen Sie diesen Schritt hinzu.
5. Positionieren Sie den neuen Trustcaptcha-Schritt auf der gleichen Ebene über oder unter den bestehenden Recaptcha-Schritt und löschen Sie anschließend den Recaptcha-Schritt.
6. Öffnen Sie die Einstellungen des neuen Trustcaptcha-Schrittes, legen Sie den Alias fest (z. B. tc-registration), hinterlegen Sie den Site-Key und den Secret-Key Ihres Captchas und speichern Sie die Einstellungen.
7. Drücken Sie abschließend auf Actions und dann auf Bind flow. Wählen Sie den Flow-Typ Registration flow aus und klicken Sie auf Speichern.
8. Trustcaptcha ist jetzt in der Registrierungsmaske einsatzbereit! 🎉

Anmeldung

Die folgenden Schritte sind notwendig, um Trustcaptcha in Ihren Anmelde-Flow zu integrieren:

1. Melden Sie sich als Administrator in Ihrer Keycloak-Installation an.
2. Navigieren Sie in Ihrem Realm zu Authentication und anschließend zu Flows.
3. Duplizieren Sie den bestehenden browser-Flow, vergeben Sie einen neuen Namen (z. B. Browser (Trustcaptcha)) und bestätigen Sie die Duplizierung.
4. Klicken Sie auf Add step. Suchen Sie nach Trustcaptcha / Username Password Form und fügen Sie diesen Schritt hinzu.
5. Positionieren Sie den neuen Trustcaptcha-Schritt unmittelbar auf der gleichen Ebene über oder unter den bestehenden Username Password Form-Schritt und löschen Sie anschließend den Username Password Form-Schritt.
6. Öffnen Sie die Einstellungen des neuen Trustcaptcha-Schrittes, legen Sie den Alias fest (z. B. tc-login), hinterlegen Sie den Site-Key und den Secret-Key Ihres Captchas und speichern Sie die Einstellungen.
7. Drücken Sie abschließend auf Actions und dann auf Bind flow. Wählen Sie den Flow-Typ Browser flow aus und klicken Sie auf Speichern.
8. Trustcaptcha ist jetzt in der Anmeldemaske einsatzbereit! 🎉

Passwort vergessen

Die folgenden Schritte sind notwendig, um Trustcaptcha in Ihren Passwort vergessen-Flow zu integrieren:

1. Melden Sie sich als Administrator in Ihrer Keycloak-Installation an.
2. Navigieren Sie in Ihrem Realm zu Authentication und anschließend zu Flows.
3. Duplizieren Sie den bestehenden reset credentials-Flow, vergeben Sie einen neuen Namen (z. B. Reset Credentials (Trustcaptcha)) und bestätigen Sie die Duplizierung.
4. Klicken Sie auf Add step. Suchen Sie nach Trustcaptcha / Reset Credentials Choose User und fügen Sie diesen Schritt hinzu.
5. Positionieren Sie den neuen Trustcaptcha-Schritt unmittelbar auf der gleichen Ebene über oder unter den bestehenden Choose User-Schritt und löschen Sie anschließend den Choose User-Schritt.
6. Öffnen Sie die Einstellungen des neuen Trustcaptcha-Schrittes, legen Sie den Alias fest (z. B. tc-reset), hinterlegen Sie den Site-Key und den Secret-Key Ihres Captchas und speichern Sie die Einstellungen.
7. Drücken Sie abschließend auf Actions und dann auf Bind flow. Wählen Sie den Flow-Typ Reset credentials flow aus und klicken Sie auf Speichern.
8. Trustcaptcha ist jetzt in der Passwort-vergessen-Maske einsatzbereit! 🎉

Trustcaptcha bietet zwei Optionen für die Frontend-Integration:

Insert Automatically

Mit dieser Option integriert sich Trustcaptcha automatisch in die bestehenden Anmelde-, Registrierungs- und Passwort-vergessen-Masken von Keycloak. Dabei sucht Trustcaptcha nach button- oder input-Elementen mit type=submit und fügt sich darüber ein.

Individuelle Templates

Wenn Sie keine button- oder input-Elemente mit type=submit verwenden oder das CAPTCHA aus Designgründen individuell anpassen möchten, können Sie die Funktion Insert Automatically in den Trustcaptcha-Einstellungen deaktivieren. Anschließend können Sie in Ihren Templates einen div-Container mit der Klasse trustcaptcha definieren. Trustcaptcha wird dann automatisch über diesem Container eingefügt.