Keycloak SAML Implementierung
Dieser Artikel enthält Keycloak-spezifische Hilfe zur Konfiguration der Zugangsdaten mit SSO über SAML 2.0. Für Hilfe bei der Konfiguration der Zugangsdaten mit SSO für einen anderen IdP, verweisen Sie auf SAML 2.0 Konfiguration.
Die Konfiguration beinhaltet die gleichzeitige Arbeit mit der Bitwarden-Webanwendung und dem Keycloak-Portal. Während Sie fortfahren, empfehlen wir, beides griffbereit zu haben und die Schritte in der Reihenfolge durchzuführen, in der sie dokumentiert sind.
Tipp
Already an SSO expert? Skip the instructions in this article and download screenshots of sample configurations to compare against your own.
Melden Sie sich bei der Bitwarden-Web-App an und öffnen Sie die Administrator-Konsole mit dem Produktumschalter ():
Öffnen Sie den Einstellungen → Single sign-on Bildschirm Ihrer Organisation:
Wenn Sie es noch nicht getan haben, erstellen Sie einen einzigartigen SSO-Identifikator für Ihre Organisation und wählen Sie SAML aus dem Typ-Dropdown aus. Lassen Sie diesen Bildschirm geöffnet, um leicht darauf zugreifen zu können.
Sie können die Option Legen Sie eine eindeutige SP-Entitäts-ID fest in diesem Stadium ausschalten, wenn Sie möchten. Wenn Sie dies tun, wird Ihre Organisations-ID aus Ihrem SP-Entity-ID-Wert entfernt. In fast allen Fällen wird jedoch empfohlen, diese Option aktiviert zu lassen.
Tipp
There are alternative Member decryption options. Learn how to get started using SSO with trusted devices or Key Connector.
Melden Sie sich bei Keycloak an und wählen Sie Clients → Client erstellen.
Auf dem Bildschirm "Client erstellen" füllen Sie die folgenden Felder aus:
Feld | Beschreibung |
|---|---|
Client-Typ | Wählen Sie SAML. |
Client-ID | Setzen Sie dieses Feld auf die vorab generierte SP Entity ID. Dieser automatisch generierte Wert kann von der Einstellungen → Single Sign-On Seite der Organisation kopiert werden und variiert je nach Ihrer Konfiguration. |
Name | Geben Sie einen Namen Ihrer Wahl für den Keycloak-Client ein. |
Sobald Sie die erforderlichen Felder auf der Seite Allgemeine Einstellungen ausgefüllt haben, klicken Sie auf Weiter.
Auf dem Bildschirm für die Zugangsdaten Einstellungen, füllen Sie das folgende Feld aus:
Feld | Beschreibung |
|---|---|
Gültige Weiterleitungs-URIs | Setzen Sie dieses Feld auf die vorab generierte Assertion Consumer Service (ACS) URL. Dieser automatisch generierte Wert kann von der Einstellungen → Single Sign-On Bildschirm der Organisation kopiert werden und variiert je nach Ihrer Konfiguration. |
Wählen Sie Speichern.
Wählen Sie die Tab "Keys" und schalten Sie die Option Client-Signatur erforderlich auf Aus um.
Zuletzt, in der Hauptnavigation von Keycloak, wählen Sie Realm Einstellungen und dann das Keys Tab. Finden Sie das RS256 Zertifikat und wählen Sie Zertifikat aus.
Der Wert für das Zertifikat wird für den folgenden Abschnitt benötigt.
Bis zu diesem Zeitpunkt haben Sie alles, was Sie im Kontext des Keycloak-Portals benötigen, konfiguriert. Kehren Sie zur Bitwarden-Web-App zurück und wählen Sie Einstellungen→ Einmaliges Anmelden aus der Navigation aus.
Der Single-Sign-On-Bildschirm teilt die Konfiguration in zwei Abschnitte auf:
Die Konfiguration des SAML-Dienstanbieters bestimmt das Format der SAML-Anfragen.
Durch die Konfiguration des SAML-Identitätsanbieters wird das zu erwartende Format für SAML-Antworten bestimmt.
Füllen Sie die folgenden Felder im Abschnitt SAML Service Provider Konfiguration aus:
Feld | Beschreibung |
|---|---|
Namen ID-Format | Wählen Sie E-Mail-Adresse. |
Ausgehendes Signaturalgorithmus | Der Algorithmus, den Bitwarden zur Signierung von SAML-Anfragen verwenden wird. |
Unterzeichnungsverhalten | Ob/wann SAML-Anfragen signiert werden. |
Minimales Eingehendes Signieralgorithmus | Wählen Sie den Algorithmus aus, den der Keycloak-Client verwendet, um SAML-Dokumente oder Behauptungen zu signieren. |
Möchte Behauptungen unterschrieben haben | Ob Bitwarden erwartet, dass SAML-Behauptungen signiert werden. Wenn aktiviert, stellen Sie sicher, dass Sie den Keycloak-Client so konfigurieren, dass er Behauptungen signiert. |
Zertifikate validieren | Markieren Sie dieses Kästchen, wenn Sie vertrauenswürdige und gültige Zertifikate von Ihrem IdP über eine vertrauenswürdige CA verwenden. Selbstsignierte Zertifikate können fehlschlagen, es sei denn, die richtigen Vertrauensketten sind mit den Bitwarden Zugangsdaten mit SSO Docker-Image konfiguriert. |
Füllen Sie die folgenden Felder im Abschnitt SAML Identitätsanbieter Konfiguration aus:
Feld | Beschreibung |
|---|---|
Entitäts-ID | Geben Sie die URL des Keycloak-Bereichs ein, in dem der Client erstellt wurde, zum Beispiel |
Bindungstyp | Wählen Sie Umleiten. |
Single Sign-on-Dienst-URL | Geben Sie Ihre Master-SAML-Verarbeitungs-URL ein, zum Beispiel |
URL des Einzelabmeldedienstes | Die Anmeldung mit SSO unterstützt derzeit nicht SLO. Diese Option ist für zukünftige Entwicklungen geplant, jedoch können Sie sie vorab mit Ihrer Abmelde-URL konfigurieren, wenn Sie möchten. |
Öffentliches X509-Zertifikat | Geben Sie das RS256 Zertifikat ein, das im vorherigen Schritt kopiert wurde. Der Zertifikatswert ist Groß- und Kleinschreibungssensitiv, zusätzliche Leerzeichen, Zeilenumbrüche und andere überflüssige Zeichen werden dazu führen, dass die Zertifikatsvalidierung fehlschlägt. |
Ausgehendes Signaturalgorithmus | Wählen Sie den Algorithmus aus, den der Keycloak-Client verwendet, um SAML-Dokumente oder Behauptungen zu signieren. |
Deaktivieren Sie ausgehende Abmeldeanfragen | Die Anmeldung mit SSO unterstützt derzeit nicht SLO. Diese Option ist für zukünftige Entwicklungen geplant. |
Möchte Authentifizierungsanfragen signiert haben | Ob Keycloak erwartet, dass SAML-Anfragen signiert werden. |
Hinweis
When completing the X509 certificate, take note of the expiration date. Certificates will have to be renewed in order to prevent any disruptions in service to SSO end users. If a certificate has expired, Admin and Owner accounts will always be able to log in with email address and master password.
Wenn Sie mit der Konfiguration des Identitätsanbieters fertig sind, speichern Sie Ihre Arbeit.
Tipp
You can require users to log in with SSO by activating the single sign-on authentication policy. Please note, this will require activating the single organization policy as well. Learn more.
Auf der Registerkarte „Keycloak-Client-Einstellungen“ stehen zusätzliche Konfigurationsoptionen zur Verfügung:
Feld | Beschreibung |
|---|---|
Unterzeichnen Sie Dokumente | Geben Sie an, ob SAML-Dokumente von der Keycloak-Domäne signiert werden sollen. |
Unterschriftsbehauptungen | Geben Sie an, ob SAML-Behauptungen von der Keycloak-Domäne signiert werden sollen. |
Signaturalgorithmus | Wenn Sign Assertions aktiviert ist, wählen Sie aus, mit welchem Algorithmus signiert werden soll ( |
Namens-ID-Format | Wählen Sie das Name-ID-Format, das Keycloak in SAML-Antworten verwenden soll. |
Sobald Sie das Forum ausgefüllt haben, wählen Sie Speichern.
Sobald Ihre Konfiguration abgeschlossen ist, testen Sie diese, indem Sie zu https://vault.bitwarden.com navigieren, Ihre E-Mail-Adresse eingeben, Weiter auswählen und den Enterprise Single-On Button auswählen:
Geben Sie die konfigurierte Organisationskennung ein und wählen Sie Anmelden. Wenn Ihre Implementierung erfolgreich konfiguriert ist, werden Sie zum Keycloak Zugangsdaten-Bildschirm weitergeleitet:
Nachdem Sie sich mit Ihren Keycloak-Anmeldedaten authentifiziert haben, geben Sie Ihr Bitwarden Master-Passwort ein, um Ihren Tresor zu entschlüsseln!
Hinweis
Bitwarden does not support unsolicited responses, so initiating login from your IdP will result in an error. The SSO login flow must be initiated from Bitwarden.