Duo Protection for HipChat with Duo Access Gateway

These are instructions for protecting HipChat Server with the Duo Access Gateway. HipChat cloud accounts are not supported.

Overview

As business applications move from on-premises to cloud hosted solutions, users experience password fatigue due to disparate logons for different applications. Single sign-on (SSO) technologies seek to unify identities across systems and reduce the number of different credentials a user has to remember or input to gain access to resources.

While SSO is convenient for users, it presents new security challenges. If a user's primary password is compromised, attackers may be able to gain access to multiple resources. In addition, as sensitive information makes its way to cloud-hosted services it is even more important to secure access by implementing two-factor authentication and zero-trust policies.

Duo Access Gateway

Duo Access Gateway (DAG), our on-premises SSO product, layers Duo's strong authentication and flexible policy engine on top of HipChat logins using the Security Assertion Markup Language (SAML) 2.0 authentication standard. Duo Access Gateway acts as an identity provider (IdP), authenticating your users using existing on-premises or cloud-based directory credentials and prompting for two-factor authentication before permitting access to HipChat.

Duo Access Gateway is included in the Duo Premier, Duo Advantage, and Duo Essentials plans, which also include the ability to define policies that enforce unique controls for each individual SSO application. For example, you can require that Salesforce users complete two-factor authentication at every login, but only once every seven days when accessing HipChat. Duo checks the user, device, and network against an application's policy before allowing access to the application.

Deploy or Update Duo Access Gateway

1. Install Duo Access Gateway on a server in your DMZ. Follow our instructions for deploying the server, configuring DAG settings, and adding your primary authentication source.

2. Add the attributes from the table below that correspond to the Duo attributes Mail attribute, First name attribute, and Last name attribute in the "Attributes" field when configuring your Active Directory or OpenLDAP authentication source in the DAG admin console, separated by a comma. For example, if Active Directory is your authentication source, enter mail,givenName,sn in the "Attributes" field.

   Duo Attribute	Active Directory	OpenLDAP
   Mail attribute	mail	mail
   First name attribute	givenName	gn
   Last name attribute	sn	sn

   If your organization uses other directory attributes than the ones listed here then enter those attribute names instead. If you've already configured the attributes list for another cloud service provider, append the additional attributes not already present to the list, separated by a comma.

3. After completing the initial DAG configuration steps, click Applications on the left side of the Duo Access Gateway admin console.

4. Scroll down the Applications page to the Metadata section. This is the information you need to provide to HipChat when configuring SSO. Click the Download XML metadata link to obtain the DAG metadata file (the downloaded file is named "dag.xml").

   

Create the HipChat Application in Duo

1. Log on to the Duo Admin Panel and navigate to Applications → Protect an Application.

2. Locate the entry for HipChat with a protection type of "2FA with SSO self-hosted (Duo Access Gateway)" in the applications list. Click Protect to the far-right to start configuring HipChat. See Protecting Applications for more information about protecting applications in Duo and additional application options.

3. Enter the server name used when logging into your company's HipChat server Domain name. For example, if your HipChat login URL is https://hipchat.yourcompany.com then enter hipchat.yourcompany.com.

4. HipChat uses the Mail attribute, First name attribute, and Last name attribute when authenticating. We've mapped those to DAG supported authentication source attributes as follows:

   Duo Attribute	Active Directory	OpenLDAP	SAML IdP	Google	Azure
   Mail attribute	mail	mail	mail	email	mail
   First name attribute	givenName	gn	givenName	given_name	givenName
   Last name attribute	sn	sn	sn	family_name	surname

   If you are using non-standard attributes for your authentication source, check the Custom attributes box and enter the names of the attributes you wish to use instead.

5. Click Save Configuration to generate a downloadable configuration file.

   

6. You can adjust additional settings for your new SAML application at this time — like changing the application's name from the default value, enabling self-service, or assigning a group policy — or come back and change the application's policies and settings after you finish SSO setup. If you do update any settings, click the Save Changes button when done.

7. Click the Download your configuration file link to obtain the HipChat application settings (as a JSON file).

   Important: This file contains information that uniquely identifies this application to Duo. Secure this file as you would any other sensitive or password information. Don't share it with unauthorized individuals or email it to anyone under any circumstances!

Add the HipChat Application to Duo Access Gateway

Before you do this, verify that you updated the "Attributes" list for your Duo Access Gateway authentication source as specified here.

1. Return to the Applications page of the DAG admin console session.

2. Click the Choose File button in the "Add Application" section of the page and locate the HipChat SAML application JSON file you downloaded from the Duo Admin Panel earlier. Click the Upload button after selecting the JSON configuration file.

3. The HipChat SAML application is added.

   

Enable HipChat SSO

1. Log into your HipChat server as an administrative user. Click Group admin at the top of the screen.

2. Click the Authentication tab.

3. Click the Configure button under the SAML single sign-on option.

4. Select Custom SAML 2.0 from the drop-down next to "Providers". New options will appear.

5. Under Identity Provider metadata click Click here to upload. A file browser will appear; select the dag.xml file downloaded earlier.

6. The data from the metadata file will be uploaded into the "Identity Provider metadata" field.

7. Near the bottom of the screen you will find additional options you can set, such as configuring just in time (JIT) provisioning of users that do not have HipChat accounts by checking the box next to Enable just in time (JIT) provisioning.

8. You can update users' names and titles each time a user logs in by checking the box next to Enable profile syncing.

9. You can require HipChat users to log in with SSO by unchecking the box next to Allow both internal directory and SAML single sign-on. This option is recommended after you have tested your HipChat SSO configuration.

10. After you've entered all the required information click Save.

More information about HipChat's SSO support is available at the Atlassian Documentation site.

Verify SSO

If your organization enabled the Duo Access Gateway portal, log into the portal page using the link provided by your administrator. Click HipChat from the dashboard to access the application.

You can also log on to HipChat using your organization’s login page e.g. https://hipchat.yourcompany.com and clicking Log in with single sign-on. This redirects to the Duo Access Gateway login page. Enter your primary directory logon information, approve Duo two-factor authentication, and get redirected back to the HipChat site after authenticating.

To log in using the HipChat mobile app, tap Log in to HipChat Server. Type the HipChat server name in the "Server" field and tap Next. Tap Log in with single sign-on redirects you to the Duo Access Gateway login page. Complete primary and Duo authentication to login on the HipChat app.

Congratulations! Your HipChat users now authenticate using Duo Access Gateway.

Microsoft AD FS

Microsoft's Active Directory Federation Services (AD FS) is a popular choice for SSO because it easily integrates with the AD identity store many organizations already have deployed. Duo's support for cloud applications and SSO drops in to an existing AD FS installation to provide secondary authentication after a user passes primary authentication (successful Active Directory logon).

If you don't already have AD federation running the first step is to install and configure Microsoft AD FS in your organization. Deployment Guides for AD FS versions 2.1, and 3.0/4.0 are available from Microsoft.

Once your AD FS services are up and running, the second step is to configure the SSO partnership between your AD FS service and the external cloud resource, in this case HipChat. Learn more about configuring HipChat SSO with AD FS at the Atlassian Documentation site.

After you have successfully configured and tested AD FS SSO login to HipChat using your AD domain credentials, you can then install the Duo AD FS integration. AD FS protection is included with Duo's paid plans.

With the Duo integration for AD FS installed, users pass primary authentication to the AD FS service as usual. Once primary authentication succeeds, users are forwarded to the Duo service for secondary authentication. After approving logon using one of Duo's authentication methods, the user is fully logged in to HipChat.

Other Identity Partners

Using a third-party SSO provider for cloud application access? Duo partners with leading cloud SSO providers like Okta and OneLogin to secure access with our strong and flexible authentication platform.

You can also use Duo two-factor authentication with CAS and Shibboleth on-premises IdPs.

Troubleshooting

Need some help? Try searching our Knowledge Base articles or Community discussions. For further assistance, contact Support.