SAML Single Sign On (SSO) Into Bitbucket Using SimpleSAML

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 SimpleSAML. By the end of this guide, SimpleSAML users should be able to login and register to Bitbucket Software.

Pre-requisites

To configure SimpleSAML integration with Bitbucket SAML Single Sign On you need the following items:

  • Bitbucket should be installed and configured.
  • Bitbucket Server is https enabled.
  • Admin credentials are set up in Bitbucket.
  • Valid Bitbucket Server and Data center Licence.

Download And Installation

  • Log into your Bitbucket instance as an admin.
  • Navigate to the settings menu and Click Manage Apps.
  • Click Find new apps or Find new add-ons from the left-hand side of the page.
  • Locate Bitbucket SAML Single Sign On (SSO) via search.
  • Click Try free to begin a new trial or Buy now to purchase a license for Bitbucket SAML Single Sign On (SSO).
  • Enter your information and click Generate license when redirected to MyAtlassian.
  • Click Apply license.
Bitbucket download

Step 1: Setup SimpleSAML as Identity Provider

  • In config/config.php, make sure that 'enable.saml20-idp' is true. Example: ‘enable.saml20-idp’ => true
  • In metadata/saml20-idp-hosted.php, configure SimpleSAML as an Identity Provider by adding code below: $metadata['__DYNAMIC:1__'] = array(
        'host' => '__DEFAULT__',
        /* X.509 key and certificate. Relative to the cert directory.*/
        'privatekey' => '<YOUR_PRIVATE_KEY_FILE_NAME>',
        //eg. RSA_Private_Key.pem 'certificate' => '<YOUR_PUBLIC_KEY_FILE_NAME>',
        //eg. RSA_Public_Key.cer
        /* Authentication source to use. Configured in 'config/authsources.php'. */
        'auth' => '<YOUR_AUTH_SOURCE_NAME>',
    );
  • In metadata/saml20-sp-remote.php, register your Servider Provider like this:
    /* Replace example.com with your atlassian domain name. */ $metadata['https://example.com/plugins/servlet/saml/metadata'] = array(
        'AssertionConsumerService' => 'https://example.com/',
        'SingleLogoutService'      => 'https://example.com/',
        'NameIDFormat' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress',
        'simplesaml.nameidattribute' => 'mail',
        'simplesaml.attributes'      => true, 
        'attributes' => array('mail', 'givenname', 'sn', 'memberOf'),
    );

Step 2: Setup Bitbucket as Service Provider

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

configure single Identity Provider Setup

Configuring Single IDP

With the information you have been given by your IDP team, you 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(Eg. Azure AD), you can select Refresh metadata periodically. Select 5 minutes for the best results.
  • Click Import.

Bitbucket SAML Single Sign On, 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 SAML Single Sign On, 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 SAML Single Sign On, SSO-10

Configure Multiple Identity Provider(IDP) Setup

Configure New IDP

If you already have one IDP & you are looking to add second IDP then you can do it by performing the following steps.

  • Navigate to Configure IDP tab.
  • Click on Add new IDP.
  • It will present a blank form & you can configure new IDP using steps from Single IdP Setup.
Bitbucket SAML Single Sign On, SSO-5

Configure multiple IDPs

If you have configured more than two IDPs then it will show you the list of IDP that you have configured with Bitbucket.

Click on Add new IdP button for adding new IDP on Bitbucket. The steps for adding new IDP will remain the same.

Bitbucket SAML Single Sign On, SSO-6
An operation that you can perform with List of IdPs page.

  • Add / delete Identity Provider.
  • Test Connection between Bitbucket & IdP by click on Test button for respective IDP.
  • Edit the IdP configuration by clicking on the Edit button.
  • You can allow an only specific set of users to access Bitbucket by using Domain Mapping.

Single Sign-On with Multiple Identity Provider(IDP)

Select your IdP from the list. It will redirect you to selected IdP login page.

Bitbucket SAML Single Sign On, SSO-1
    Configure Domain Mapping

  • You can enable domain mapping using Use Domain Mapping option.
  • Once enable it, you need add domain name against each IDP.
  • After enabling Domain Mapping it allows SSO only for those users whose domain matches with the specified one.
Bitbucket SAML Single Sign On, SSO-2

    Single Sign-On using Domain mapping

  • Enter the user email address. It will check your domain name with the configured domain if it matches then it will redirect you to the respective Identity Provider login page.
    • Bitbucket SAML Single Sign On, SSO-3
  • This is how the login screen would appear after enabling domain mapping.

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 user Profile Mapping in User Profile tab and follow steps given in Matching a User.

    Bitbucket SAML Single Sign On, 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.

    a. 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 New Users using the option. Select None if you don't want to assign any default group to SSO users for the option Enable Default Groups for.
    • Bitbucket SAML Single Sign On - SSO - Default group
    b. 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.
  • Check Disable Group Mapping option if you don't want to update groups of existing users.

    • c. Group Mapping
    Group Mapping can be done in two ways:
  • Manual group mapping: If the names of groups in Bitbucket are different than the corresponding groups in IDP, then you should use Manual group mapping.
  • On-The-Fly group mapping: If the names of groups in Bitbucket and IDP are same, you should use On-The-Fly group mapping.

  • I. Manual Group Mapping

    • Check Restrict User Creation Based on Group Mapping option if you want new users to be created only if at least one of the user's IDP groups is mapped to a group in the application.
    • For mapping, first select a bitbucket group from the dropdown which lists all groups present in bitbucket and then enter the name of the IDP group to be mapped in the textbox beside.
    • For example, if you want all users in 'dev' group in IDP to be added to stash-user, you will need to select stash-user from the dropdown and enter 'dev' against stash-user.
    • Use '+1' and '+10' buttons to add extra mapping fields.
    • Use '-' button next to each mapping to delete that mapping.
    Bitbucket SAML Single Sign On - SSO - Manual group mapping
  • II. On-The Fly Group Mapping

    • Check Create New Groups option if you want new groups from IDP to be created if not found in Bitbucket.
    • If the user is part of some group in Bitbucket and that group is not present in the SAML response returned by IDP, then the user will be removed from that group in Bitbucket.
    • If you don't want On-The-Fly group mapping to affect Bitbucket groups which are managed locally then add those groups in Exclude Groups field.
    Bitbucket SAML Single Sign On - SSO - On the fly group mapping

Step 5: SSO Settings

    The settings in SSO Settings tab define the user experience for Single Sign On.
    a. Sign In Settings
  • Set Enable SSO for Bitbucket Server to allow SSO for Bitbucket users.
  • 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 SAML Single Sign On, SSO-13
    b. Custom Login Template
  • Design your own login template that will be used to intitate SSO.
    • Bitbucket SAML Single Sign On, SSO-11
    c. Sign Out Settings
  • Set Logout URL or Logout Template to redirect users after logout action.
    • Bitbucket SAML Single Sign On, SSO-14
    d. 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 SAML Single Sign On, SSO-15
    e.Advanced Settings
  • Allow Users to Change Password: Disable if you don't want user to chnage their local Bitbucket credential.
  • Remember Me-cookie: If enabled, user stays logged in until user explicitly logs out.
  • You can extend Bitbucket default session timeout using these steps. By default it is set to 30 mins.
  • Validate IDP's SAML Response: Configure time difference(in minute) here In case Bitbucket server time is not in sync with your IDP's time.
    • Bitbucket SAML Single Sign On, SSO-10



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