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

Single Sign On(SSO) using Auth0, Auth0 SSO Login-1 1.1 Prerequisites:

Ensure you have these values from the Service Provider Info tab of the SAML plugin:

SP Entity ID
ACS URL
Single Logout URL (to log users out from Auth0 when logged out from Atlassian)

Single Sign On(SSO) using Auth0, Auth0 SSO Login-2 1.2 Instructions:

Log in to your Auth0 dashboard.
Navigate to Applications and click on Create Application.

SAML Single Sign On (SSO), Create Application option inside Auth0 dashboard

Next, assign a name to the application, choose Regular Web App, and click Create.

SAML Single Sign On (SSO), Create application dialog box for assigning app name and type before creation

In the Addons tab, enable the SAML2 option to configure it.

SAML Single Sign On (SSO), Addons section of the new app

Configure the Application Callback URL, Audience, Recipient, and other settings using the SP Entity ID and ACS URL from the SAML plugin.

SAML Single Sign On (SSO), Provision for configuring the SAML2 Web App

Once you’re done configuring the settings, scroll down and click Enable.

SAML Single Sign On (SSO), Option to enable the SAML2 Web App

Go to the Usage tab and download the Identity Provider Metadata XML file.

SAML Single Sign On (SSO), Auth0 provision for downloading Identity Provider Metadata

Single Sign On(SSO) using Auth0, Auth0 SSO Login-2 1.3 Create User in Auth0:

Navigate to Users & Roles → Users and click on Create User.

SAML Single Sign On (SSO), Auth0 User Management section with provision for creating user

Next, provide the email address and password for the new user and click Create.

SAML Single Sign On (SSO), Provision for providing an email address and password to the new user

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?