SAML Single Sign On (SSO) into Bitbucket using ADFS

Download

Bitbucket SAML app gives the ability to enable SAML Single Sign On for Bitbucket Software. Bitbucket Software is compatible with all SAML Identity Providers. Here we will go through a guide to configure SSO between Bitbucket and ADFS. By the end of this guide, ADFS users should be able to login and register to Bitbucket Software.

Step 1: Setup ADFS as Identity Provider

  • On ADFS, search for ADFS Management application.
    • ADFS sso-1
  • After opening the AD FS Management, select Relying Party Trust & then click on Add Relying Party Trust.
    • ADFS sso-2
  • Click the Start button from the Relying Party Trust Wizard pop up. But before that please make sure Claims Aware is selected.
    • ADFS sso-3
  • Select the options for adding a relying party trust.

      • miniorange img Using Metadata URL

      • In Select Data Source: Import data about the relying party published online or on the local network option & then add URL in Federation metadata address.
        • ADFS sso-4
      • Skip step-5 to step-8 & start configuring from step-9. Navigate to Service Provider Info tab from the plugin for getting SP Meatadata URL.

      miniorange img Using Metadata XML file

      • In Select Data Source: Import data about the relying party from a file option & then browse the metadata file.
        • ADFS sso-5
      • Skip step-5 to step-8 & start configuring from step-9.

      miniorange img Using Manual configuration

      • In Select Data Source: Enter Data about the relying party manually & Click on Next.
        • ADFS sso-6
  • Enter Display Name & Click Next.
  • Upload the certificate & click next. Download the certificate from plugin & use the same certificate to upload on ADFS.
  • Select Enable support for the SAML 2.0 WebSSO protocol & Enter ACS URL from the plugins Service Provider Info Tab. Click Next.
    • ADFS sso-7
  • Add Entity ID from plugins Service Provider Info Tab as Relying party trust identifier then click Add button & then click Next.
    • ADFS sso-8
  • Also download the Signing certificate from Service Provider Info Tab from the plugin.
  • Select Permit everyone as an Access Control Policy & click on Next.
    •  ADFS sso-9
  • Click the Next button from Ready to Add Trust & click Close.
  • It will show you the list of Relying Party Trusts. Select the respective application & click on Edit Claim Issuance Policy.
    • ADFS sso-11
  • Click on Add Rule button.
    • ADFS sso-12
  • Select Send LDAP Attributes as Claims & click on Next.
    • ADFS sso-13
  • Enter the following details & click on Finish.
    • Claim rule name: Attributes
    Attribute Store: Active Directory
    LDAP Attribute: E-Mail-Addresses
    Outgoing Claim Type: Name ID
    ADFS sso-14
  • Click Apply Ok.
  • Select property of the application & add the certificate downloaded from the add-on.
    • ADFS sso-15

Step 2: Setup Bitbucket as Service Provider

Now we will go through the steps to setup Bitbucket as a Service Provider using miniOrange add-on:

Configuring Single IDP

We can configure IDP settings in 3 ways:

A. By Metadata URL

  • Click on Import from Metadata in Configure IDP tab
  • Select IDP: Import From Metadata URL
  • Enter IDP metadata URL: Enter your metadata URL
  • If your IDP changes certificates at intervals, you can select Refresh metadata periodically. Select 5 minutes for the best results.
  • Click Import

bitbucket sso-8

B. By uploading Metadata XML file

  • Click on Import from Metadata in Configure IDP tab
  • Select IDP: Import from Metadata File
  • Upload metadata file
  • Click Import

bitbucket sso-9

C. Manual Configuration

Go to Configure IDP tab and enter the following details

  • IDP Entity ID
  • Single Sign On URL
  • Single Logout URL
  • X.509 Certificate
bitbucket sso-10

Step 3: Setting up Bitbucket user profile attributes

    We will be setting up user profile attributes for Bitbucket. If your users are stored in a directory that is Read Only, please check Disable Attribute Mapping in User Profile tab and follow steps given in Matching a User.

    bitbucket sso-11

    a. Finding correct attributes
  • Go to Configure IDP tab. Scroll down and click on Test Configuration.
  • You will see all the values returned by your IDP to Bitbucket in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your IDP to return this information.
  • Once you see all the values in Test Configuration, keep the window open and go to User Profile tab.
    • b. Setting profile attributes
  • In this tab, fill the values by matching the name of the attribute. For instance, if the Attribute Name in the Test Configuration window is NameID, enter NameID against Username
  • Setting up both Username and Email is required if you want to let users register. If you want existing users to the only login, configure the attribute using which you will match the user in Bitbucket.
    • c. Matching a User
    When the user logs into Bitbucket, one of the user's data/attribute coming in from the IDP is used to search the user in Bitbucket. This is used to detect the user in Bitbucket and log in the user to the same account.
  • Go to User Profile tab
  • Select Username or Email for Login/Search Bitbucket user account by
  • Enter the attribute name from IDP which corresponds to Username or Email using Finding Correct Attributes

Step 4: Assigning groups to users

    We will be setting up user group attributes for Bitbucket. If your users are stored in a directory that is Read Only, please check Disable Group Mapping in User Groups tab and skip to Setting default group.

    bitbucket sso-12
    a. Finding Group Attribute
  • Just like we found Attribute Name for User Profile attributes, we find group attribute.
  • Go to Configure IDP tab. Scroll down and click on Test Configuration.
  • You will see all the values returned by your IDP to Bitbucket in a table. If you don't see value with groups, make the required settings in your IDP to return group names.
  • Once you see all the values in Test Configuration, keep the window open and go to User Groups tab.
  • Enter the Attribute Name of group against Group Attribute
  • At the bottom of the page, all groups in Bitbucket are shown. You can map groups in IDP which correspond to Bitbucket groups. For example, if you want all users in dev-ops and dev groups in IDP to be added to crucible-users, you will need to enter dev-ops;dev against crucible-users
  • If you want user mapping to work for only limited groups in Bitbucket, check the option Update User Groups

    • b. Setting default group
  • Select the users' Default Group in the tab User Groups. If no group is mapped, users are added by default to this group.
  • You can enable default groups for all users or only new users using the option Enable Default Groups for.

Step 5: SSO Settings

    The settings in SSO Settings tab define the user experience for Single Sign On.
    a. Sign In Settings
  • Set button text for button on login page using Login Button Text
  • Set redirect URL after login using Relay State. Keep this empty for coming back to the same page user started from
  • Enable Auto-redirect to IDP if you want to allow users to login only using IDP. Enable backdoor for emergency
    • bitbucket sso-13
    b. Sign Out Settings
    Set Logout URL or Logout Template to redirect users after logout action.

    bitbucket sso-14
    c. SSO Error Settings
    Set error template to redirect users to a custom error page instead of login page. Use this if you have Auto-redirect to IDP enabled.

    bitbucket sso-15

Free Trial

If you are looking for anything which you cannot find, please drop us an email on info@xecurifty.com