Keycloak SAML Implementation
This article contains Keycloak-specific help for configuring login with SSO via SAML 2.0. For help configuring login with SSO for another IdP, refer to SAML 2.0 Configuration.
Configuration involves working simultaneously with the Bitwarden web app and the Keycloak Portal. As you proceed, we recommend having both readily available and completing steps in the order they are documented.
tip
Already an SSO expert? Skip the instructions in this article and download screenshots of sample configurations to compare against your own.
Log in to the Bitwarden web app and open the Admin Console using the product switcher ():
Open your organization's Settings → Single sign-on screen:
If you haven't already, create a unique SSO identifier for your organization and select SAML from the the Type dropdown. Keep this screen open for easy reference.
You can turn off the Set a unique SP entity ID option at this stage if you wish. Doing so will remove your organization ID from your SP entity ID value, however in almost all cases it is recommended to leave this option on.
tip
There are alternative Member decryption options. Learn how to get started using SSO with trusted devices or Key Connector.
Login to Keycloak and select Clients → Create Client.
On the Create client screen fill in the following fields:
Field | Description |
|---|---|
Client type | Select SAML. |
Client ID | Set this field to the pre-generated SP Entity ID. This automatically-generated value can be copied from the organization's Settings → Single sign-on screen and will vary based on your setup. |
Name | Enter a name of your choice for the Keycloak client. |
Once you have filled in the required fields on the General Settings page, click Next.
On the Login settings screen, fill in the following field:
Field | Description |
|---|---|
Valid redirect URIs | Set this field to the pre-generated Assertion Consumer Service (ACS) URL. This automatically-generated value can be copied from the organization's Settings → Single sign-on screen and will vary based on your setup. |
Select Save.
Select the Keys tab and toggle the Client signature required option to Off.
Lastly, on the Keycloak main navigation, select Realm settings and then the Keys tab. Locate the RS256 Certificate and select Certificate.
The value for the certificate will be required for the following section.
At this point, you have configured everything you need within the context of the Keycloak Portal. Return to the Bitwarden web app and select Settings → Single sign-on from the navigation.
The Single sign-on screen separates configuration into two sections:
SAML service provider configuration will determine the format of SAML requests.
SAML identity provider configuration will determine the format to expect for SAML responses.
Complete the following fields in the SAML service provider configuration section:
Field | Description |
|---|---|
Name ID format | Select Email. |
Outbound Signing Algorithm | The algorithm Bitwarden will use to sign SAML requests. |
Signing Behavior | Whether/when SAML requests will be signed. |
Minimum Incoming Signing Algorithm | Select the algorithm the Keycloak client is configured to use to sign SAML documents or assertions. |
Want Assertions Signed | Whether Bitwarden expects SAML assertions to be signed. If toggled on, make sure you configure the Keycloak client to sign assertions. |
Validate Certificates | Check this box when using trusted and valid certificates from your IdP through a trusted CA. Self-signed certificates may fail unless proper trust chains are configured with the Bitwarden login with SSO docker image. |
Complete the following fields in the SAML identity provider configuration section:
Field | Description |
|---|---|
Entity ID | Enter the URL of the Keycloak realm on which the client was created, for example |
Binding type | Select Redirect. |
Single sign-on service URL | Enter your master SAML processing URL, for example |
Single Log Out Service URL | Login with SSO currently does not support SLO. This option is planned for future development, however you may preconfigure it with your Logout URL if you wish. |
X509 public certificate | Enter the RS256 certificate that was copied in the previous step. The certificate value is case sensitive, extra spaces, carriage returns, and other extraneous characters will cause certificate validation to fail. |
Outbound Signing Algorithm | Select the algorithm the Keycloak client is configured to use to sign SAML documents or assertions. |
Disable Outbound Logout Requests | Login with SSO currently does not support SLO. This option is planned for future development. |
Want Authentication Requests Signed | Whether Keycloak expects SAML requests to be signed. |
note
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.
When you're done with the identity provider configuration, Save your work.
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.
On the Keycloak Client Settings tab, additional configuration options are available:
Field | Description |
|---|---|
Sign Documents | Specify whether SAML documents should be signed by the Keycloak realm. |
Sign Assertions | Specify whether SAML assertions should be signed by the Keycloak realm. |
Signature Algorithm | If Sign Assertions is enabled, select what algorithm to sign with ( |
Name ID Format | Select the Name ID Format for Keycloak to use in SAML responses. |
Once you have completed the forum, select Save.
Once your configuration is complete, test it by navigating to https://vault.bitwarden.com, entering your email address, selecting Continue, and selecting the Enterprise Single-On button:
Enter the configured organization identifier and select Log In. If your implementation is successfully configured, you will be redirected to the Keycloak login screen:
After you authenticate with your Keycloak credentials, enter your Bitwarden master password to decrypt your vault!
note
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.