Azure SAML Implementation
This article contains Azure-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 vault and the Azure 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.
Navigate to your organization's Settings → Single sign-on screen:
If you haven't already, create a unique SSO identifier for your organization. Otherwise, you don't need to edit anything on this screen yet, but keep it open for easy reference.
tip
There are alternative Member decryption options. Learn how to get started using SSO with trusted devices or Key Connector.
In the Azure Portal, navigate to Azure Active Directory and select Enterprise applications from the navigation menu:
Select the New application button:
On the Browse Azure AD Gallery screen, select the Create your own application button:
On the Create your own application screen, give the application a unique, Bitwarden-specific name and select the Create button.
From the Application Overview screen, select Single sign-on from the navigation:
On the Single Sign-On screen, select SAML.
Select the Edit button and configure the following fields:
Field | Description |
|---|---|
Identifier (Entity ID) | Set this field to the pre-generated SP Entity ID retrieved from the Bitwarden SSO Configuration screen. |
Reply URL (Assertion Consumer Service URL) | Set this field to the pre-generated Assertion Consumer Service (ACS) URL retrieved from the Bitwarden SSO configuration screen. |
Sign on URL | Set this field to the login URL from which users will access Bitwarden. |
The default claims constructed by Azure will work with login with SSO, however you can optionally use this section to configure the NameID format used by Azure in SAML responses.
Select the Edit button and select the Unique User Identifier (Name ID) entry to edit the NameID claim:
Options include Default, Email Address, Persistent, Unspecified, and Windows qualified domain name. For more information, refer to Microsoft Azure documentation.
Download the Base64 Certificate for use during a later step.
Copy or take note of the Login URL and Azure AD Identifier in this section for use during a later step:
note
If you receive any key errors when logging in via SSO, try copying the X509 certificate information from the Federation Metadata XML file instead.
Select Users and groups from the navigation:
Select the Add user/group button to assign access to the login with SSO application on a user or group-level.
At this point, you have configured everything you need within the context of the Azure Portal. Return to the Bitwarden web vault 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.
Configure the following fields:
Field | Description |
|---|---|
Name ID Format | By default, Azure will use email address. If you changed this setting, select the corresponding value. Otherwise, set this field to Unspecified or Email Address. |
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 | By default, Azure will sign with RSA SHA-256. Select |
Want Assertions Signed | Whether Bitwarden expects SAML assertions to be signed. |
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. |
When you are done with the service provider configuration, Save your work.
Identity provider configuration will often require you to refer back to the Azure Portal to retrieve application values:
Field | Description |
|---|---|
Entity ID | Enter your Azure AD Identifier, retrieved from the Azure Portal's Set up your application section. This field is case sensitive. |
Binding Type | Set to HTTP POST or Redirect. |
Single Sign On Service URL | Enter your Login URL, retrieved from the Azure Portal's Set up your application section. |
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 | Paste the downloaded certificate, removing
and
|
Outbound Signing Algorithm | By default, Azure will sign with RSA SHA-256. 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 Azure expects SAML requests to be signed. |
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 Microsoft login screen:
After you authenticate with your Azure 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. Azure SAML administrators can setup an App Registration for users to be directed to the Bitwarden web vault login page.
Disable the existing Bitwarden button in the All Applications page by navigating to the current Bitwarden Enterprise application and selecting properties and set the Visible to users option to No.
Create the App Registration by navigating to App Registrations and selecting New Registration.
Provide a name for the application such as Bitwarden SSO. No not specify a Redirect URL. Select Register to complete the forum.
Once the app has been created, navigate to Branding & Properties located on the navigation menu.
Add the following settings to the application:
Upload a logo for end user recognition. You can retrieve the Bitwarden logo here.
Set the Home page URL to your Bitwarden client login page such as
https://vault.bitwarden.com/#/loginoryour-self-hostedURL.com.
Once this process has been completed, assigned users will have a Bitwarden application that will link them directly to the Bitwarden web vault login page.