SAML Single Sign On (SSO) into SonarQube using Google Apps/G Suite
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.
You can refer the steps from the video or documentation below to configure your IDP with SonarQube.
Step 1: Setup Google Apps/G Suite as Identity Provider
Follow the following steps to set up Google Apps / G Suite as an Identity Provider
Navigate to the Apps tab in the left menu and click on Web and mobile apps.
Add a SAML app
Click on the Add App button, then in the dropdown select Add Custom SAML app tab to create a new saml app.
Enter details for your custom SAML app and click on Continue button.
IDP Information
Click on Download Metadata button. This will be used for configuring your Service Provider.
You can also copy G Suite details like SSO URL, entity ID and Certificate to configure the Service Provider manually and then click on Continue button.
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 on Continue button.
Attribute Mapping
Click on Add Mapping button.
Add and select user fields in Google Directory, then map them to Service Provider attributes and Click on Finish button.
Turn on
Go to SAML Apps again and click on OFF for everyone .
Then, select ON for everyone to activate SSO.
Note: All the users will be asked to SSO to access G Suite Apps and they will not be able to login normally using a username and password.
Step 2: Configure 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.
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 Logs.
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.
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:
Login Attribute is a unique name assigned to the user to identify them uniquely within the SonarQube system. It's a required attribute.
Name Attribute is the full name of the user, to be mapped from the IdP to the SonarQube. It's a required attribute.
Email Attribute is an optional attribute and represents an email address of the user, to be mapped from the IdP to the SonarQube.
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 [Refer with above image].