help/_articles/login-with-sso/saml-adfs.md

layout, title, categories, featured, popular, hidden, tags, order

layout	title	categories	featured	popular	hidden	tags	order
article	ADFS SAML Implementation	login-with-sso	false	false	true	sso saml adfs

This article contains Active Directory Federation Services (AD FS)-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 Business Portal and the AD FS Server Manager. As you proceed, we recommend having both readily available and completing steps in the order they're documented.

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

{% icon fa-download %} Download Sample {% endcallout %}

Open the Business Portal

If you're coming straight from SAML 2.0 Configuration, you should already have an Organization ID created and the SSO Configuration screen open. If you don't, refer to that article to create an Organization ID and open your Business Portal to the SSO Configuration section:

{% image sso/sso-saml1.png SAML 2.0 Configuration %}

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

Create a Relying Party Trust

In the AD FS Server Manager, select Tools → AD FS Management → Action → Add Relying Party Trust. In the Wizard, make the following selections:

1. On the Welcome screen, select Claims Aware.

2. On the Select Data Source screen, select Enter data about the relying party manually.

3. On the Specify Display Name screen, enter a Bitwarden-specific display name.

4. On the Configure URL screen, select Enable support for SAML 2.0 WebSSO protocol.

   • In the Relying party SAML 2.0 SSO service URL input, enter the Assertion Consumer Service (ACS) URL retrieved 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.com/sso/saml2/your-org-id/Acs.

5. On the Choose Access Control Policy screen, select the

6. On the Configure Identifiers screen, add the SP Entity ID (retrieved from the Bitwarden SSO Configuration screen) as a relying party trust identifier.

   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.

7. On the Choose Access Control Policy screen, select the desired policy (by default, Permit Everyone).

8. On the Ready to Add Trust screen, review your selections.

Advanced Options

Once the Relying Party Trust is created, you can further configure its settings by selecting Relying Party Trusts from the left-hand file navigator and selecting the correct display name.

Hash Algorithm

To change the Secure hash algorithm (by default, SHA-256), navigate to the Advanced tab:

{% image sso/cheatsheets/saml-adfs/saml-adfs3.png Set a Secure Hash Algorithm %}

Endpoint Binding

To change the endpoint Binding (by default, POST), navigate to the Endpoints tab and select the configured ACS URL:

{% image sso/cheatsheets/saml-adfs/saml-adfs4.png %}

Edit Claim Issuance Rules

Construct Claim Issuance Rules to ensure that the appropriate claims, including Name ID, are passed to Bitwarden. The following tabs illustrate a sample ruleset:

• Rule 1
• Rule 2
• Rule 3

{% capture givenname %} ### Rule 1

{% image sso/cheatsheets/saml-adfs/saml-adfs5.png %}

{% endcapture %} {{ givenname | markdownify}}

{% capture surname %} ### Rule 2

{% image sso/cheatsheets/saml-adfs/saml-adfs6.png %}

{% endcapture %} {{ surname | markdownify}}

{% capture email %} ### Rule 3

{% image sso/cheatsheets/saml-adfs/saml-adfs7.png %}

{% endcapture %} {{ email | markdownify}}

Get Certificate

In the left-hand file navigator, select AD FS → Service → Certificates to open the list of certificates. Select the Token-signing certificate, navigate to its Details tab, and select the Copy to File... button to export the Base-64 encoded token signing certificate:

{% image sso/cheatsheets/saml-adfs/saml-adfs8.png Get token-signing Certificate %}

You will need this certificate during a later step.

Get Federation Service Identifier

In the left-hand file navigator, select AD FS and from the right-hand options menu select Edit Federation Service Properties. In the Federation Service Properties window, copy the Federation Service Identifier:

{% image sso/cheatsheets/saml-adfs/saml-adfs9.png Get Federation Service Identifier %}

You will need this identifier during a later step.

Back to the Business Portal

At this point, you've configured everything you need within the context of the AD FS Server Manager. Jump back over to the Bitwarden Business Portal to complete configuration.

The Business Portal 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

In the Service Provider Configuration section, configure the following fields:

Field	Description
Name ID Format	Select the Outgoing Name ID Format selected when constructing Claims Issuance Rules (see Rule 3).
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, AD FS will sign with SHA-256. Select SHA-256 from the dropdown unless you've configured AD FS to use different algorithm.
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 within 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 AD FS Server Manager to retrieve values:

Field	Description
Entity ID	Enter the retrieved Federation Service Identifier. Please note, this may not use HTTPS.
Binding Type	By default, AD FS with use HTTP POST endpoint binding. Select HTTP POST unless you've configured AD FS to use a different method.
Single Sign On Service URL	Enter the SSO Service Endpoint. This value can be retrieved from the Service → Endpoints tab in AD FS Manager and by default should begin with http:// and end with /adfs/services/ls.
Artifact Resolution Service URL	Only use this field if you have selected Artifact as the endpoint binding method of your Relying Party Trust.
X509 Public Certificate	Paste the downloaded certificate, removing -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----. Extra spaces, carriage returns, and other extraneous characters will cause certification to fail.
Outbound Signing Algorithm	By default, AD FS will sign with SHA-256. Select SHA-256 from the dropdown unless you've configured AD FS to use different algorithm.
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 AD FS 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{:target="_blank"} and selecting the Enterprise Single-On button:

{% image sso/sso-button-lg.png 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 AD FS SSO login screen. After you authenticate with your AD FS credentials, enter your Bitwarden Master Password to decrypt your Vault!

{% comment %} {% image sso/cheatsheets/saml-adfs/saml-adfs2.png %}

{% image sso/cheatsheets/saml-adfs/saml-adfs1.png %} {% endcomment %}