Auth0 SAML Implementation
This article contains Auth0-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 within the Bitwarden web app and the Auth0 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.
In the Auth0 Portal, use the Applications menu to create a Regular Web Application:
Click the Settings tab and configure the following information, some of which you will need to retrieve from the Bitwarden Single Sign-On screen:
Auth0 Setting | Description |
|---|---|
Name | Give the application a Bitwarden-specific name. |
Domain | Take note of this value. You will need it during a later step. |
Application Type | Select Regular Web Application. |
Token Endpoint Authentication Method | Select Post (HTTP Post), which will map to a Binding Type attribute you will configure later. |
Application Login URI | Set this field to the pre-generated SP Entity ID. |
Allowed Callback URLS | Set this field to the pre-generated Assertion Consumer Service (ACS) URL. |
Grant Types
In the Advanced Settings → Grant Types section, ensure that the following Grant Types are selected (they may be pre-selected):
Certificates
In the Advanced Settings → Certificates section, copy or download up your signing certificate. You won't need to do anything with it just yet, but you will need to reference it later.
Endpoints
You don't need to edit anything in the Advanced Settings → Endpoints section, but you will need the SAML endpoints to reference later.
tip
In smaller windows, the Endpoints tab can disappear behind the edge of the browser. If you're having trouble finding it, click the Certificates tab and hit the Right Arrow key (→).
Create rules to customize the SAML response behavior of your application. While Auth0 provides a number of options, this section will focus on only those that map to specifically to Bitwarden options. To create a custom SAML configuration ruleset, use the Auth Pipeline → Rules menu to Create Rules:
You may configure any of the following:
Key | Description |
|---|---|
| Algorithm Auth0 will use to sign the SAML assertion or response. This value should be set to |
| Algorithm used to calculate digest of SAML assertion or response. Set to |
| By default, Auth0 will sign only the SAML assertion. Set this to |
| By default, |
Implement these rules using a Script like the one below. For help, refer to Auth0's Documentation.
Bashfunction (user, context, callback) {
context.samlConfiguration.signatureAlgorithm = "rsa-sha256";
context.samlConfiguration.digestAlgorithm = "sha256";
context.samlConfiguration.signResponse = "true";
context.samlConfiguration.nameIdentifierFormat = "urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress"
context.samlConfiguration.binding = "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect";
callback(null, user, context);
}At this point, you have configured everything you need within the context of the Auth0 Portal. Return to the Bitwarden web app to complete configuration.
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.
Unless you have configured custom rules, your service provider configuration will already be complete. If you configured custom rules or want to make further changes to your implementation, edit the relevant fields:
Field | Description |
|---|---|
Name ID Format | NameID Format to specify in the SAML request ( |
Outbound Signing Algorithm | Algorithm used to sign SAML requests, by default |
Signing Behavior | Whether/when Bitwarden SAML requests will be signed. By default, Auth0 will not require requests to be signed. |
Minimum Incoming Signing Algorithm | The minimum signing algorithm Bitwarden will accept in SAML responses. Select |
Want Assertions Signed | Whether Bitwarden wants SAML assertions signed. By default, Auth0 will sign SAML assertions, so check this box unless you've configured a custom signing rule. |
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 within the Bitwarden Login with SSO docker image. |
When you are done with the service provider configuration, Save your work.
Identity provider configuration will often require you to refer back to the Auth0 Portal to retrieve application values:
Field | Description |
|---|---|
Entity ID | Enter the Domain value of your Auth0 application (see here), prefixed by |
Binding Type | Select HTTP POST to match the Token Endpoint Authentication Method value specified in your Auth0 application. |
Single Sign On Service URL | Enter the SAML Protocol URL (see Endpoints) of your Auth0 application. 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 pre-configure it if you wish. |
X509 Public Certificate | Paste the retrieved signing certificate, removing
and
|
Outbound Signing Algorithm | Select |
Disable Outbound Logout Requests | Login with SSO currently does not support SLO. This option is planned for future development. |
Want Authentication Requests Signed | Whether Auth0 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 are 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.
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 Auth0 login screen:
After you authenticate with your Auth0 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.