SAML Single Sign On (SSO) into SonarQube using PingOne
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 PingOne. By the end of this guide, PingOne 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 Ping One as Identity Provider
Log in to PingIdentity Admin and then navigate to Administrators Section.
On your Dashboard menu, click on Connections section.
In the Connections menu, Click on Application and to create an application click on the + icon beside its name.
Provide appropriate Application Name and choose the Application Type as SAML. Click on Save button.
For the SAML configuration you need to get the Entity ID and ACS URL from miniOrange SAML Single Sign-On Plugin.
Go to miniorange SAML Single Sign-On Plugin → Service Provider Info tab → Download Metadata. Now, upload it to the Ping One.
Navigate to Import from Metadata tab, and upload downloaded Metadata file in import Metadata section.
Click on Save.
Now go to configuration tab and click on Download Metadata button to download IDP metadata. Keep it handy as it will be used in furthur steps.
Navigate to Attribute Mappings tab and map the attributes as necessary for the application.
Save your Application and on the Application Dashboard and enable the “User Access” button next to your application name.
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].
Fetch the Identity Provider (IdP) Details
