SAML-implementatie van Keycloak
Dit artikel bevat Keycloak-specifieke hulp voor het configureren van inloggen met SSO via SAML 2.0. Raadpleeg SAML 2.0 Configuratie voor hulp bij het configureren van inloggen met SSO voor een andere IdP.
Bij de configuratie wordt tegelijkertijd gewerkt met de Bitwarden webapp en de Keycloak Portal. We raden u aan om beide documenten bij de hand te hebben en de stappen uit te voeren in de volgorde waarin ze zijn beschreven.
tip
Already an SSO expert? Skip the instructions in this article and download screenshots of sample configurations to compare against your own.
Log in op de Bitwarden web app en open de Admin Console met behulp van de product switcher ():
Open het scherm Instellingen → Eenmalige aanmelding van uw organisatie:
Als je dat nog niet hebt gedaan, maak dan een unieke SSO-identifier aan voor je organisatie en selecteer SAML in het keuzemenu Type . Houd dit scherm open voor gemakkelijke referentie.
U kunt de optie Een unieke SP entiteit ID instellen in dit stadium uitschakelen als u dat wilt. Als u dit doet, wordt uw organisatie-ID verwijderd uit uw SP entiteit-ID waarde, maar in bijna alle gevallen is het aan te raden om deze optie aan te laten staan.
tip
There are alternative Member decryption options. Learn how to get started using SSO with trusted devices or Key Connector.
Log in op Keycloak en selecteer Clients → Client aanmaken.
Vul in het scherm Client aanmaken de volgende velden in:
Veld | Beschrijving |
|---|---|
Type klant | Selecteer SAML. |
Klant-ID | Stel dit veld in op de vooraf gegenereerde SP entiteit ID. Deze automatisch gegenereerde waarde kan worden gekopieerd vanuit het Instellingen → Enkelvoudige aanmelding scherm van de organisatie en zal variëren afhankelijk van je instelling. |
Naam | Voer een naam naar keuze in voor de Keycloak-client. |
Klik op Volgende wanneer u de verplichte velden op de pagina Algemene instellingen hebt ingevuld.
Vul het volgende veld in op het scherm Aanmeldingsinstellingen:
Veld | Beschrijving |
|---|---|
Geldige omleidings-URL's | Stel dit veld in op de vooraf gegenereerde URL van de Assertion Consumer Service (ACS). Deze automatisch gegenereerde waarde kan worden gekopieerd vanuit het Instellingen → Enkelvoudige aanmelding scherm van de organisatie en zal variëren afhankelijk van je instelling. |
Selecteer Opslaan.
Selecteer het tabblad Keys en zet de optie Client signature required op Off.
Ten slotte selecteer je in de hoofdnavigatie van Keycloak Realm-instellingen en vervolgens het tabblad Keys. Zoek het RS256-certificaat en selecteer Certificaat.
De waarde voor het certificaat is nodig voor het volgende gedeelte.
Op dit punt heb je alles geconfigureerd wat je nodig hebt binnen de context van het Keycloak Portal. Ga terug naar de Bitwarden web app en selecteer Instellingen → Eenmalige aanmelding in de navigatie.
Het Single sign-on scherm verdeelt de configuratie in twee secties:
De configuratie van de SAML-serviceprovider bepaalt het formaat van SAML-verzoeken.
De configuratie van de SAML identiteitsprovider bepaalt het formaat dat wordt verwacht voor SAML antwoorden.
Vul de volgende velden in de SAML service provider configuratie sectie in:
Veld | Beschrijving |
|---|---|
Naam ID-indeling | Selecteer e-mail. |
Algoritme voor uitgaande ondertekening | Het algoritme dat Bitwarden gebruikt om SAML-verzoeken te ondertekenen. |
Ondertekengedrag | Of/wanneer SAML verzoeken ondertekend zullen worden. |
Algoritme voor minimale inkomende ondertekening | Selecteer het algoritme dat de Keycloak client gebruikt om SAML documenten of asserties te ondertekenen. |
Ondertekende beweringen | Of Bitwarden verwacht dat SAML-asserties worden ondertekend. Als dit aan staat, zorg er dan voor dat je de Keycloak client configureert om asserties te ondertekenen. |
Certificaten valideren | Vink dit vakje aan bij gebruik van vertrouwde en geldige certificaten van je IdP via een vertrouwde CA. Zelfondertekende certificaten kunnen mislukken tenzij de juiste vertrouwensketens zijn geconfigureerd met het Bitwarden login met SSO docker image. |
Vul de volgende velden in de SAML identity provider configuratiesectie in:
Veld | Beschrijving |
|---|---|
Entiteit ID | Voer de URL in van de Keycloak realm waarop de client is aangemaakt, bijvoorbeeld |
Bindend type | Selecteer Omleiden. |
URL voor service voor eenmalige aanmelding | Voer je master SAML-verwerkings-URL in, bijvoorbeeld |
URL voor service voor eenmalig afmelden | Inloggen met SSO ondersteunt momenteel geen SLO. Deze optie is gepland voor toekomstige ontwikkeling, maar u kunt deze desgewenst vooraf configureren met uw URL voor afmelden . |
X509 publiek certificaat | Voer het RS256-certificaat in dat in de vorige stap is gekopieerd. De certificaatwaarde is hoofdlettergevoelig, extra spaties, carriage returns en andere vreemde tekens zorgen ervoor dat de certificaatvalidatie mislukt. |
Algoritme voor uitgaande ondertekening | Selecteer het algoritme dat de Keycloak client gebruikt om SAML documenten of asserties te ondertekenen. |
Uitgaande afmeldverzoeken uitschakelen | Inloggen met SSO ondersteunt momenteel geen SLO. Deze optie is gepland voor toekomstige ontwikkeling. |
Authenticatieverzoeken ondertekend willen hebben | Of Keycloak verwacht dat SAML verzoeken worden ondertekend. |
noot
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.
Als je klaar bent met de configuratie van de identity provider, sla je je werk op.
tip
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.
Op hettabblad Keycloak ClientInstellingen zijn extra configuratieopties beschikbaar:
Veld | Beschrijving |
|---|---|
Documenten ondertekenen | Geef aan of SAML-documenten ondertekend moeten worden door de Keycloak realm. |
Beweringen ondertekenen | Geef aan of SAML-bevestigingen moeten worden ondertekend door de Keycloak realm. |
Handtekening algoritme | Als Ondertekenen van beweringen is ingeschakeld, selecteer dan met welk algoritme moet worden ondertekend (standaard |
Naam ID Formaat | Selecteer het Name ID-formaat voor Keycloak om te gebruiken in SAML-reacties. |
Als je het forum hebt ingevuld, selecteer je Opslaan.
Zodra je configuratie voltooid is, kun je deze testen door te navigeren naar https://vault.bitwarden.com, je e-mailadres in te voeren, Doorgaan te selecteren en de knop Enterprise Single-On te selecteren:
Voer de geconfigureerde organisatie-ID in en selecteer Aanmelden. Als uw implementatie succesvol is geconfigureerd, wordt u doorgestuurd naar het inlogscherm van Keycloak:
Nadat u zich hebt geverifieerd met uw Keycloak-referenties, voert u uw Bitwarden-hoofdwachtwoord in om uw kluis te ontsleutelen!
noot
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.