JumpCloud SAML Implementation

This article contains JumpCloud-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 vault and the JumpCloud 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.

Download Sample

Open SSO in the web vault

Navigate to your organization's SettingsSingle Sign-On screen:

SAML 2.0 Configuration
SAML 2.0 Configuration

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

If you are self-hosting Bitwarden, you can use alternative Member Decryption Options. This feature is disabled by default, so continue with Master Password decryption for now and learn how to get started using Key Connector once your configuration is complete and successfully working.

Create a JumpCloud SAML application

In the JumpCloud Portal, select SSO from the menu and select the Add icon:

Add JumpCloud App
Add JumpCloud App

Enter Bitwarden in the search box and select the configure button:

Configure Bitwarden
Configure Bitwarden
tip

If you are more comfortable with SAML, or want more control over things like NameID Format and Signing Algorithms, create a Custom SAML Application instead.

General info

In the General Info section, configure the following information:

Field Description
Display Label Give the Application a Bitwarden-specific name.

Single sign-on configuration

In the Single Sign-On Configuration section, configure the following information:

Single Sign-On Configuration
Single Sign-On Configuration
Field Description
IdP Entity ID Set this field to a unique, Bitwarden-specific value, for example, bitwardensso_yourcompany.
SP 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.
ACS URL Set this field to the pre-generated 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.

Custom SAML app only

If you created a Custom SAML Application, you will also need to configure the following Single Sign-On Configuration fields:

Field Description
SAMLSubject NameID Specify the JumpCloud attribute that will be sent in SAML responses as the NameID.
SAMLSubject NameID Format Specify the format of the NameID sent in SAML responses.
Signature Algoritm Select the algorithm to use to sign SAML assertions or reponses.
Sign Assertion By default, JumpCloud will sign the SAML response. Check this box the sign the SAML assertion.
Login URL Specify the URL from which your users will login to Bitwarden via SSO. For cloud-hosted customers, this is always https://vault.bitwarden.com/#/sso. For self-hosted instances, this is determined by your configured server URL, for example https://your.domain.com/#/sso.

Attributes

In the Single Sign-On ConfigurationAttributes section, construct the following SP → IdP attribute mappings. If you selected the Bitwarden Application in JumpCloud, these should already be constructed:

Attribute Mapping
Attribute Mapping

Once you are finished, select the activate button.

Download the certificate

Once the application is activated, use the SSO menu option again to open the created Bitwarden application. Select the IDP Certificate dropdown and Download certificate:

Download Certificate
Download Certificate

Bind user groups

In the JumpCloud Portal, select User Groups from the menu:

User Groups
User Groups

Either create a Bitwarden-specific user group, or open the All Users default user group. In either case, select the Applications tab and enable access to the created Bitwarden SSO application for that user group:

Bind App Access
Bind App Access
tip

Alternatively, you can bind access to user groups directly from the SSOBitwarden Application screen.

Back to the web vault

At this point, you have configured everything you need within the context of the JumpCloud 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.

Service provider configuration

Configure the following fields according to the choices selected in the JumpCloud Portal during app creation:

Field Description
Name ID Format If you created a Custom SAML Application, set this to whatever the specified SAMLSubject NameID Format is. Otherwise, leave Unspecified.
Outbound Signing Algorithm The algorithm Bitwarden will use to sign SAML requests.
Signing Behavior Whether/when SAML requests will be signed. By default, JumpCloud will not require requests to be signed.
Minimum Incoming Signing Algorithm If you created a Custom SAML Application, set this to whichever Signature Algorithm you selected. Otherwise, leave as rsa-sha256.
Want Assertions Signed If you created a Custom SAML Application, check this box if you set the Sign Assertion option in JumpCloud. Otherwise, leave unchecked.
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

Identity provider configuration will often require you to refer back to the JumpCloud Portal to retrieve application values:

Field Description
Entity ID Enter your JumpCloud IdP Entity ID, which can be retrieved from the JumpCloud Single Sign-On Configuration screen. This field is case sensitive.
Binding Type Set to Redirect.
Single Sign On Service URL Enter your JumpCloud IdP URL, which can be retrieved from the JumpCloud Single Sign-On Configuration screen.
Single Log Out Service URL Login with SSO currently does not support SLO. This option is planned for future development.
X509 Public Certificate Paste the retrieved certificate, removing -----BEGIN CERTIFICATE----- and -----END CERTIFICATE-----.

The certificate value is case sensitive, extra spaces, carriage returns, and other extraneous characters will cause certifiation validation to fail.
Outbound Signing Algorithm If you created a Custom SAML Application, set this to whichever Signature Algorithm you selected. Otherwise, leave as rsa-sha256.
Disable Outbound Logout Requests Login with SSO currently does not support SLO. This option is planned for future development.
Want Authentication Requests Signed Whether JumpCloud 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.

Test the configuration

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:

Enterprise single sign on and master password
Enterprise single sign on and master password

Enter the configured organization identifier and select Log In. If your implementation is successfully configured, you will be redirected to the JumpCloud login screen:

JumpCloud Login
JumpCloud Login

After you authenticate with your JumpCloud credentials, enter your Bitwarden master password to decrypt your vault!


言語
© 2022 Bitwarden, Inc.
利用規約プライバシーポリシーサイトマップ