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 KeyClock. By the end of this guide, KeyClock users should be able to log in and register to the SonarQube Server.
Step 1: Setup Jboss Keyclock as Identity Provider
Follow the steps below to configure Jboss Keyclock as an Identity Provider
Setup IDP
- In your Keycloak admin console, select the realm that you want to use.
- Click on the Clients from the left nav bar.
- Create a new client/application.
- Configure the following:
Client ID |
The SP-EntityID / Issuer from the step 1 of the plugin under Configure IDP tab. |
Name |
Provide a name for this client |
Description |
Provide a description |
Enabled |
ON |
Consent Required |
OFF |
Client Protocol |
SAML |
Include AuthnStatement |
ON |
Sign Documents |
ON |
Optimize Redirect signing key lookup |
OFF |
Sign Assertions |
ON |
Signature Algorithm |
RSA_SHA256 |
Encrypt Assertion |
OFF |
Client Signature Required |
OFF |
Canonicalization Method |
EXCLUSIVE |
Force Name ID Format |
ON |
Name ID Format |
Email |
Root URL |
Leave empty or Base URL of Service Provider |
Valid Redirect URIs |
The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under configure IDP tab. |
- Under Fine Grain SAML Endpoint Configuration, configure the following:
Assertion Consumer Service POST Binding URL |
The ACS (Assertion Consumer Service) URL from the step 1 of the plugin under Configure IDP tab. |
Logout Service Redirect Binding URL |
The Single Logout URL from the step 1 of the plugin under Configure IDP tab. |
- Click on Save.
Add Mappers
- Add the following attributes in the Mappers tab.
- Click on Add Built-in and add the following option.
Download setup file
- In the Installation Tab, choose SAML Metadata SPSSODescriptor as Format option.
- Download it and keep it handy. It will be used to configure the plugin.
×
Step 2: Configure SonarQube as Service Provider.
Test Configuration
- Once you have filled all the IdP details, click on the Test Configuration button.
- It will take you to 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 either DEBUG or TRACE 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.
- To know more about the SonarQube Logs click here.
- 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].
×
×
If you don't find what you are looking for, please contact us at info@xecurify.com or call us at +1 978 658 9387.