SAML Single Sign On (SSO) into SonarQube using Centrify 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 Centrify. By the end of this guide, Centrify 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 Centrify as Identity Provider

Single Sign On (SSO) using Centrify, Centrify SSO Login Create SAML App

Log into Centrify as an Administrator and click on Apps on the sidebar. Then Click on Web Apps.
Click on the Add Web Apps button next to the search bar.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Add web apps

Then select the Custom tab. Search for SAML and click on the Add button. Now press Yes to confirm.

Single Sign On (SSO) using Centrify, Centrify SSO Login, add custom app

Single Sign On (SSO) using Centrify, Centrify SSO Login Configure SAML App

When you create a web app, it will be listed in the Web Apps tab. Click on the newly created web app to configure.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Web Apps dashboard

The name and description of the web app can be updated from this settings tab.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Web App settings

Select the Trust tab from the sidebar. Trust tab will have metadata details for the configuration. Copy the metadata URL and save it for configuration with miniOrange.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Web Apps Metadata Details

Now scroll down until you see the Service Provider Configuration. Here you can configure the SP metadata either using the URL or manual configuration.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Metadata Manual Configuration

Single Sign On (SSO) using Centrify, Centrify SSO Login, Centrify Metadata Configuration

Enter the configuration details and click on SAVE.
Click on the SAML Response tab from the left sidebar.
Here, you can map attributes from your source directory to SAML attributes that will be returned with the response.
Also, Centrify provides a script editor under the custom logic section in the SAML Response tab to add more complex logic to map attributes.

Single Sign On (SSO) using Centrify, Centrify SSO Login, SAML Response

You will have to add below functions to the code -

setAudience()	SP-EntityID / Issuer from Step 1 of the plugin under the SP Info Tab. E.g: setAudience('https://example.com')
setRecipient()	Recipient URL from Step 1 of the plugin under the SP Info Tab. E.g: setRecipient('https://example.com/plugins/servlet/saml/auth')
sethttpsDestination()	Destination URL from Step 1 of the plugin, under the SP Info Tab. E.g: sethttpsDestination('https://example.com/plugins/servlet/saml/auth')

NOTE: Please do NOT change any other function calls.

From the left sidebar, select Permissions.
Click on the Add button. The Select User, Group, or Role dialog will appear.
Select the users, groups, or roles that will be accessing this web app. The role rules will be displayed on the User Access card.
Click on the Save button.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Centrify Web Apps Permissions

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?