SAML Single Sign On (SSO) Into Bitbucket Using SimpleSAML

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.

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 like this: $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 wordpress domain name. */ $metadata['https://example.com/wp-content/plugins/miniorange-saml-20-single-sign-on/'] = 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 add-on:

Configure Bitbucket Flow Driven Setup
Configure Identity Provider Setup

Configure Bitbucket Flow Driven Setup

Configuring IDP First Time

You can skip the Flow Driven setup by closing it by clicking on SKIP Quick Setup and continue with setting up using Single IDP Setup.

1. Click on the Configure button from the plugin's list. It will show you the following page to download the setup guide. Click Next

2. Note down the following information. This information is required for creating an application on IdP. Click Next.

SP Entity ID / Issuer
ACS URL
Certificate

3. We can configure IDP Settings in Bitbucket in four ways:

3.1. Using Metadata URL
Enter IDP Name, select IDP Metadata as URL & enter your IDP metadata URL in the given textbox. Click on Import to fetch IDP settings.

bitbucket sso-2

3.2. Using Metadata File
Enter IDP Name, select IDP Metadata as File & browse your IDP metadata file. Click on Import to fetch IDP settings.

bitbucket sso-3

3.3. Using Metadata Text
Enter IDP Name, select IDP Metadata as Text & add your IDP metadata XML content in the given text area. Click on Import to fetch IDP settings.

bitbucket sso-4

3.4. Manual Configuration
You can also configure IDP settings on Bitbucket manually. For that, you need to click here.

bitbucket sso-5

Enter the following details

IDP Entity ID /Issuer
Single Sign-on URL
Single Logout URL
IDP Signing Certificate

4. Enter username attribute name & email address attribute name from IDP. Click on the Save button after adding valid information. If you are not sure about this information, you can configure this later.

bitbucket sso-7

5. Click on Finish.

bitbucket sso-8

Configure Identity Provider Setup

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

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

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

Step 3: Setting up Bitbucket user profile attributes

Matching a User

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

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

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

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