Azure SAML Implementation

Category: Login with SSO
On this page:

    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’re documented.

    Tip

    Already an SSO expert? Skip the instructions in this article and download screenshots of sample configurations to compare against your own.

    Download Sample

    Open SSO in the Web Vault

    If you’re coming straight from SAML 2.0 Configuration, you should already have an Organization ID created. If you don’t refer to that article to create an Organization ID for SSO.

    Navigate to your Organization’s ManageSingle Sign-On screen:

    SAML 2.0 Configuration
    SAML 2.0 Configuration

    You don’t need to edit anything on this screen yet, but keep it open for easy reference.

    Create an Enterprise Application

    In the Azure Portal, navigate to Azure Active Directory and select Enterprise applications from the navigation menu:

    Enterprise applications
    Enterprise applications

    Select the New application button:

    Create new application
    Create new application

    On the Browse Azure AD Gallery screen, select the Create your own application button:

    Create your own application
    Create your own application

    On the Create your own application screen, give the application a unique, Bitwarden-specific name and select the Create button.

    Enable Single Sign-on

    From the Application Overview screen, select Single sign-on from the navigation:

    Configure Single sign-on
    Configure Single sign-on

    On the Single sign-on screen, select SAML.

    SAML Setup

    Basic SAML Configuration

    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.

    For Cloud-hosted customers, this is always https://sso.bitwarden.com/saml2. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain.com/sso/saml2.
    Reply URL (Assertion Consumer Service URL) Set this field to the pre-generated Assertion Consumer Service (ACS) URL retreived from the Bitwarden SSO configuration screen.

    For Cloud-hosted customers, this is always https://sso.bitwarden.com/saml2/your-org-id/Acs. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain/sso/your-org-id/Acs.
    Sign on URL Set this field to the login URL from which users will access Bitwarden.

    For Cloud-hosted customers, this is always https://vault.bitwarden.com/#/sso. For self-hosted instances, this is determined by you configured server URL, for example https://your-domain.com/#/sso.

    User Attributes & Claims

    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:

    Edit NameID Claim
    Edit NameID Claim

    Options include Default, Email Address, Persistent, Unspecified, and Windows qualified domain name. For more information, refer to Microsoft Azure documentation.

    SAML Signing Certificate

    Download the Base64 Certificate for use during a later step.

    Set up your Application

    Copy or take note of the Login URL and Azure AD Identifier in this section for use during a later step:

    Azure URLs
    Azure URLs

    Users and Groups

    Select Users and groups from the navigation:

    Assign users or groups
    Assign users or groups

    Select the Add user/group button to assign access to the Login with SSO application on a user or group-level.

    Back to the Web Vault

    At this point, you’ve configured everything you need within the context of the Azure Portal. Jump back over 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.

    Service Provider Configuration

    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 rsa-sha256 from the dropdown.
    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’re done with the Service Provider Configuration section, Save your work.

    Identity Provider Configuration

    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.
    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.
    Artifact Resolution Service URL Azure currently does not support Artifact binding, so leave this field blank.
    X509 Public Certificate Paste the downloaded certificate, removing -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

    Extra spaces, carriage returns, and other extraneous characters will cause certificate validation to fail.
    Outbound Signing Algorithm By default, Azure will sign with RSA SHA-256. Select rsa-sha256 from the dropdown.
    Allow Unsolicited Authentication Response Login with SSO currently does not support unsolicited (IdP-initiated) SAML assertions. This option is planned for future development.
    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’re done with the Identity Provider Configuration section, Save your work.

    Test the Configuration

    Once your configuration is complete, test it by navigating to https://vault.bitwarden.com and selecting the Enterprise Single Sign-On button:

    Enterprise Single Sign-On button
    Enterprise Single Sign-On button

    Enter the configured Organization Identifier and select Log In. If your implementation is successfully configured, you’ll be redirected to the Microsoft login screen:

    Azure login screen
    Azure login screen

    After you authenticate with your Azure credentials, enter your Bitwarden Master Password to decrypt your Vault!