SAML Single Sign On (SSO) Into Bamboo Using Jboss Keyclock

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

Step 1: Setup Jboss Keyclock as Identity Provider

Follow the steps below to configure Jboss Keyclock as an Identity Provider

miniorange img Setup IDP

  • In your Keycloak admin console, select the realm that you want to use.
  • Click on the Clients from the left nav bar.
  • Create a new client/application.
  • Configure the following:
    • Client ID The SP-EntityID / Issuer from the step 1 of the plugin under Configure IDP tab.
    Name Provide a name for this client
    Description Provide a description
    Enabled ON
    Consent Required OFF
    Client Protocol SAML
    Include AuthnStatement ON
    Sign Documents ON
    Optimize Redirect signing key lookup OFF
    Sign Assertions ON
    Signature Algorithm RSA_SHA256
    Encrypt Assertion OFF
    Client Signature Required OFF
    Canonicalization Method EXCLUSIVE
    Force Name ID Format ON
    Name ID Format Email
    Root URL Leave empty or Base URL of Service Provider
    Valid Redirect URIs The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under configure IDP tab.
  • Under Fine Grain SAML Endpoint Configuration, configure the following:
    • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under Configure IDP tab.
    Logout Service Redirect Binding URL The Single Logout URL from the step 1 of the plugin under Configure IDP tab.
  • Click on Save.
    • JBoss Keycloak SSO-1

 Add Mappers

  • Add the following attributes in the Mappers tab.
  • Click on Add Built-in and add the following option.
    • JBoss Keycloak SSO-2

miniorange img Download setup file

  • In the Installation Tab, choose SAML Metadata SPSSODescriptor as Format option.
  • Download it and keep it handy. It will be used to configure the plugin.

Step 2: Setup Bamboo as Service Provider

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

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.
jira sso-20

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.

jira sso-21
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.

jira sso-22
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.

jira sso-23

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.

jira sso-23
This is how the login screen would appear after enabling domain mapping.

Step 3: Setting up Bamboo user profile attributes

    We will be setting up user profile attributes for Bamboo. 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.

    jira sso-14

    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
    When the user logs into Bamboo, one of the user's data/attribute coming in from the IDP is used to search the user in Bamboo. This is used to detect the user in bamboo and log in the user to the same account.
  • 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

    We will be setting up user group attributes for Bamboo. 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. 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
  • At the bottom of the page, all groups in Bamboo are shown. You can map groups in IDP which correspond to bamboo groups.
  • If you want user mapping to work for only limited groups in Bamboo, check the option Update User Groups

    • b. Setting default group
  • Select Default Group to assign SSO users. Recommended to set up the groups needed to access the application.
  • You can enable default groups for all users or new user using the option. Select None if you don't want to assign any default group to SSO users.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 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

    • b. Custom Login Template
    Design your own login template that will be used to intitate SSO.

    jira sso-17
    c. Sign Out Settings
    Set Logout URL or Logout Template to redirect users after logout action.

    jira sso-18
    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.

    jira sso-19
    e. Advance SSO Settings
  • Allow Users to Change Password: Disable if you don't want user to chnage their local bamboo credential.
  • Remember me cokies: 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.

    • jira sso-19

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