SAML Single Sign On (SSO) into SonarQube using ADFS 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 ADFS. By the end of this guide, ADFS users should be able to login 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 ADFS as Identity Provider

On ADFS, search for ADFS Management application.

SAML Single Sign On (SSO) using ADFS Identity Provider, Management Application

After opening the AD FS Management, select Relying Party Trust & then click on Add Relying Party Trust.

SAML Single Sign On (SSO) using ADFS Identity Provider,Add Relying Party Trust

Click the Start button from the Relying Party Trust Wizard pop up. But before that please make sure Claims Aware is selected.

SAML Single Sign On (SSO) using ADFS Identity Provider,Claims Aware

Select the options for adding a relying party trust.

SAML Single Sign On (SSO) using ADFS Identity Provider Using Metadata URL

In Select Data Source: Import data about the relying party published online or on the local network option & then add URL in Federation metadata address.

SAML Single Sign On (SSO) using ADFS Identity Provider, Import metadata through URL

Skip step-5 to step-8 & start configuring from step-9. Navigate to Service Provider Info tab from the plugin for getting SP Meatadata URL.

SAML Single Sign On (SSO) using ADFS Identity Provider Using Metadata XML file

In Select Data Source: Import data about the relying party from a file option & then browse the metadata file.

SAML Single Sign On (SSO) using ADFS Identity Provider, Import Metadata through XML file

Skip step-5 to step-8 & start configuring from step-9.

SAML Single Sign On (SSO) using ADFS Identity Provider Using Manual configuration

In Select Data Source: Enter Data about the relying party manually & Click on Next.

SAML Single Sign On (SSO) using ADFS Identity Provider, Manual configuration of metadata

Enter Display Name & Click Next.
Upload the certificate & click next. Download the certificate from plugin & use the same certificate to upload on ADFS.
Select Enable support for the SAML 2.0 WebSSO protocol & Enter ACS URL from the plugins Service Provider Info Tab. Click Next.

SAML Single Sign On (SSO) using ADFS Identity Provider,support for the SAML 2.0 WebSSO protocol

Add Entity ID from plugins Service Provider Info Tab as Relying party trust identifier then click Add button & then click Next.

SAML Single Sign On (SSO) using ADFS Identity Provider, Relying party trust identifier

Also download the Signing certificate from Service Provider Info Tab from the plugin.

Select Permit everyone as an Access Control Policy & click on Next.

SAML Single Sign On (SSO) using ADFS Identity Provider, Access Control Policy

Click the Next button from Ready to Add Trust & click Close.
It will show you the list of Relying Party Trusts. Select the respective application & click on Edit Claim Issuance Policy.

SAML Single Sign On (SSO) using ADFS Identity Provider, Edit Claim Issuance Policy

Click on Add Rule button.

SAML Single Sign On (SSO) using ADFS Identity Provider, add rule

Select Send LDAP Attributes as Claims & click on Next.

SAML Single Sign On (SSO) using ADFS Identity Provider, Send LDAP Attributes as Claims

Enter the following details & click on Finish.

Claim rule name:	Attributes
Attribute Store:	Active Directory
LDAP Attribute:	E-Mail-Addresses
Outgoing Claim Type:	Name ID

SAML Single Sign On (SSO) using ADFS Identity Provider, Add Transform claim rule wizard

Click Apply Ok.
Select property of the application & add the certificate downloaded from the add-on.

SAML Single Sign On (SSO) using ADFS Identity Provider, Add certificate

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?