SAML Single Sign On (SSO) into SonarQube using Google Apps/G Suite 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 GoolgeApps/G Suite. By the end of this guide, GoogleApps/G Suite 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 Google Apps as Identity Provider

Follow these steps to set up Google Apps/GSuite as an Identity Provider:

Single Sign On using Google Apps/G-Suite, Google Apps/G-Suite SSO Login

1.1 Login as Administrator

Go to Google Admin Console and log in with your G Suite administrator account.
Navigate to the Apps tab in the left menu and click on Web and mobile apps.

Web and mobile apps tab inside Google Admin Console

1.2 Add a SAML app

Click on the Add App, then select Add Custom SAML app from the dropdown to create a new SAML app.

Option to add a custom SAML app in Google Admin Console

Enter the details for your custom SAML app and click Continue.

App details tab inside the Add Custom SAML app wizard

1.3 IDP Information

On the next screen, click on Download Metadata to retrieve data needed to configure your Service Provider.

Alternatively, you can copy GSuite details like SSO URL, Entity ID and Certificate to configure the Service Provider manually.

Google Admin Console details to configure the Service Provider manually

Click Continue once you’re done.

1.4 Service Provider Details

Enter details from the Service Provider Metadata tab in the SAML SP plugin.

ACS URL	Copy and paste the ACS URL from the plugin.
Entity ID	Copy and paste the SP Entity ID/ Issuer from the plugin.
Signed Response	Check Signed Response ✓
Name ID Format	EMAIL

Click Continue once you’re done entering the details.

Google Apps SSO Login, Service provider details

Single Sign On into Google Apps/G-Suite, Google Apps/G-Suite SSO Login

1.5 Attribute Mapping

Click on Add Mapping to add and select user fields in Google Directory.

Provision for attribute mapping in Google Admin Console

Next, map them to Service Provider attributes and click Finish once done.

Google Admin Console user and group attribute mapping options

1.6 Turn On SSO

Go to SAML Apps again and click on OFF for everyone .

Then, select ON for everyone to activate SSO.

SAML App's service status with ON for everyone option enabled

Note: After activating SSO, you can specify which users it applies to. For instance, if you choose organizational units, all users within that unit will be required to use SSO to access G Suite Apps. Likewise, you can choose to enforce SSO for specific groups or all users in the account.

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?