SAML Single Sign On (SSO) into SonarQube using OpenAM as IDP

SonarQube SAML plugin gives the ability to enable SAML Single Sign On for the SonarQube. Here we will go through a guide to configure SSO between SonarQube and OpenAM. By the end of this guide, OpenAM users should be able to log in and register to the SonarQube Server.

Try it for free

Video Setup Guide

You can refer the steps from the video or documentation below to configure your IDP with SonarQube.

Step 1: Set Up OpenAM as Identity Provider

All the information required to configure in the OpenAM i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange plugin.

SAML Single Sign On (SSO) using OpenAM Identity Provider,OpenAM SSO Login

Create OpenAM as a Hosted Identity Provider

Note: – You can skip this step and navigate to Configure Remote Service Provider if you have already configured OpenAM hosted IDP.

Login to the OpenAM admin console.
From the REALMS, select realms, under which you want to create hosted IDP. You will be redirected to the Realm overview page.
Click on Create SAMLv2 Providers in the Realm Overview page.
Click on Create Hosted Identity Provider. You will be redirected to the configuration page.
Configure IDP as given below.
- Name: Name of the IDP
- Signing Key: Select the signing key from the dropdown.
- New Circle of Trust: Provide a name of the groups of IDP and SP that trust each other.
- Attribute Mapping: Configure user profile attributes to be sent to the Service Provider application.
- Click on the Configure button on the top right corner.
- Verify the configuration from the Federation tab of OpenAM.

Configure Remote Service Provider.

Login to the OpenAM admin console.
From the REALMS, select realms, under which you want to configure your application. You will be redirected to the Realm overview page.
Click on Create SAMLv2 Providers.
Click on Register Remote Service Provider. You will be redirected to the configuration page.

Configure the Service Provider as given below.
- Where does the metadata file reside: URL.
- URL of metadata: Configure miniOrange plugin's metadata here.
- Circle of Trust: Add to existing.
- Existing Circle of Trust: Select the Circle of Trust (group) in which your hosted IDP is located.
- Attribute Mapping: Configure user profile attributes for mapping.
Click on the Configure button on the top right corner.
Verify the configuration from the Federation tab of OpenAM.
Provide OpenAM SAML metadata to Service Provider application(miniOrange SAML plugin).
You can download the OpenAM metadata using the URL given below.
[OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp
In case if you have multiple realms and hosted identity Provider configured then use the URL given below.
[OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp?entityid=[IdPentityID]&realm=/realmname

Step 2: Set Up SonarQube as Service Provider

Fetch the Identity Provider (IdP) Details

After configuring the IdP, get its metadata to configure SonarQube as a Service Provider(SP).
Copy the following details from the IdP metadata and paste them into the corresponding text fields in the SonarQube plugin.
1. IdP Entity ID
2. Login URL
3. X.509 Certificate
Save all the details.

sonarqube saml single sign on (sso) plugin - idp_details

Test Configuration

Once you have filled all the IdP details, go to Administration >>Configuration >>miniOrange SAML Support and then click on the Test Configuration tab.
It will show you the IdP login page. Enter your IdP credentials and log in.
If all the configurations are correct, it will show you the user details received from the IdP.
If the test fails, check if you have missed out any steps or try to debug through SonarQube .

To be able to troubleshoot through logs, first you'll have to set a higher log level in your SonarQube application.
To do so, go to the SonarQube Dashboard >> Administration >> System.
Under the system settings, you'll find an option to change the log's level. Select DEBUG and save it. Now try to configure the plugin.
If you face any problem during configuration, go to %SONARQUBE_HOME% / logs directory.
Find and open the web.log file. Go through the logs recorded.
You'll find the stacktrace of performed actions, along with date and time information.

sonarqube saml single sign on (sso) plugin - test_configuration

Attribute & Group Mapping

In order to map attributes from the Identity Provider to the application, the attribute names received in the SAML response need to be entered in their corresponding fields.
To view these attribute names, click on the Test Configuration tab in the plugin support page.
Attributes used in SonarQube Application are described briefly as below:
1. Login Attribute is a unique name assigned to the user to identify them uniquely within the SonarQube system. It's a required attribute.
2. Name Attribute is the full name of the user, to be mapped from the IdP to the SonarQube. It's a required attribute.
3. Email Attribute is an optional attribute and represents an email address of the user, to be mapped from the IdP to the SonarQube.
4. Group Attribute mapping requires the group names, in the application, to be same as the group names in the Identity Provider. Otherwise, the default SonarQube Group is assigned to the user.
Eg. To map group value Everyone from SAML response we have to paste groupName in Group Attribute field.

sonarqube saml single sign on (sso) plugin - attribute_mapping

Additional Resources

SAML 2.0

Did this page help you?