SAML Single Sign On (SSO) Into Bamboo Using AuthAnvil

Download

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

Pre-requisites

To integrate your Identity Provider(IDP) with Bamboo, you need the following items:

Bamboo should be installed and configured.
Bamboo Server is https enabled (optional).
Admin credentials are set up in Bamboo .
Valid Bamboo Server Licence.

Download And Installation

Log into your Bamboo 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 Bamboo SAML Single Sign On/SSO, SAML SSO via search.
Click Try free to begin a new trial or Buy now to purchase a license for Bamboo SAML Single Sign On/SSO, SAML SSO.
Enter your information and click Generate license when redirected to MyAtlassian.
Click Apply license.

SAML Single Sign On(SSO) into Bamboo using Identity Provider

Step 1: Setup AuthAnvil as Identity Provider

Prerequisites: Copy these values from the Service Provider Info tab of the SAML plugin.

SP Entity ID
ACS URL

Instructions:

Login to Authanvil and Go to SSO Manager +(add icon) and select Custom Application.
Enter the Application Name
Go to Protocol Type and Enter following info:

Protocol Type	SP-INIT
Assertion Consumer Service URL	ACS URL copied from the plugin
Allow Multiple Audiences	Unchecked
Identity issuer	SP Entity ID copied from the plugin
Service Entity ID	SP Entity ID copied from the plugin

SAML Single Sign On (SSO) using AuthAnvil Identity Provider, Application configuration

Enter Advanced Settings.

Include All Audience URIs Checked

Sign Token Response Checked

Sign Assertion Unchecked

Signing Algorithm SHA1
Go to Attribute Transformation Tab and select Specify custom attribute transform. Add the NameID attribute and click on Add. Then add the name attribute as given in the image.
Click on Add Application .
Go to Permissions tab and add Groups to which you want to give access to this application.
Click on Save Changes.
Open the app. Click on View Federation Metadata in Protocol Type Tab and save the generated metadata xml file. This metadata file will be required to configure the plugin.

Step 2: Setup Bamboo as Service Provider

Configure Single Identity Provider Setup
Configure Multiple Identity Provider(IdP) Setup

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:

By Metadata URL
By uploading Metadata XML file
Manual Configuration

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.

SAML Single Sign On (SSO) into Bamboo Service Provider, Import IDP Details using Metadata URL

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.

SAML Single Sign On (SSO) into Bamboo Service Provider, Import IDP Details using Metadata File

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

SAML Single Sign On (SSO) into Bamboo Service Provider, Configure IDP Details Manually

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.

SAML Single Sign On (SSO) into Bamboo Service Provider, Add new IDP

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 Bamboo.

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

SAML Single Sign On (SSO) into Bamboo Service Provider, List multiple configured IDP

SAML Single Sign On (SSO) into Bamboo Service Provider, List multiple configured IDP

An operation that you can perform with List of IdPs page.

Add / delete Identity Provider.
Test Connection between bamboo & 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 Bamboo 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.

SAML Single Sign On (SSO) into Bamboo Service Provider, Login Form with multiple IDP configuration

SAML Single Sign On (SSO) into Bamboo Service Provider, Login Form with multiple IDP configuration

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.

SAML Single Sign On (SSO) into Bamboo Service Provider, Domain mapping configuration

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.

SAML Single Sign On (SSO) into Bamboo Service Provider, Domain mapping form while doing SSO

This is how the login screen would appear after enabling domain mapping.

Step 3: Setting up Bamboo user profile attributes

Read Only

Disable Attribute Mapping

User Profile

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 Bamboo 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 Bamboo.

c. Matching a User

Go to User Profile tab.
Select Username or Email for Login/Search Bamboo 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

Read Only

Disable Group Mapping

User Groups

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. Using the option Enable Default Groups for.

saml single Sign On (SSO) into Bamboo Service Provider, Default groups configuration

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 Bamboo 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

Manual group mapping: If the names of groups in Bamboo 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 Bamboo 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 Bamboo group from the dropdown which lists all groups present in Bamboo 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 bamboo-users, you will need to select bamboo-users from the dropdown and enter 'dev' against bamboo-users.
- Use '+1' and '+10' buttons to add extra mapping fields.
- Use '-' button next to each mapping to delete that 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 Bamboo.
- If the user is part of some group in Bamboo and that group is not present in the SAML response returned by IDP, then the user will be removed from that group in Bamboo.
- If you don't want On-The-Fly group mapping to affect Bamboo groups which are managed locally then add those groups in Exclude Groups field.

Step 5: SSO Settings

a. Sign In Settings

Set Enable SSO for Bamboo Server to allow SSO for Bamboo 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.

SAML Single Sign On (SSO) into Bamboo Service Provider, SSO Sign In Settings

b. Custom Login Template

SAML Single Sign On (SSO) into Bamboo Service Provider, Custom Login Template

c. Sign Out Settings

Logout URL

Logout Template

SAML Single Sign On (SSO) into Bamboo Service Provider, Sign Out Template

d. SSO Error Settings

SAML Single Sign On (SSO) into Bamboo Service Provider, Custom Error message template

e. Advance SSO Settings

Allow Users to Change Password: Disable if you don't want user to change their local bamboo credential.
Remember me cookies: If enabled, user stays logged in until user explicitly logs out.
Validate IDP's SAML Response: Configure time difference(in minute) here In case Bamboo server time is not in sync with your IDP's time.

SAML Single Sign On (SSO) into Bamboo Service Provider, Advanced SSO Settings