SAML Single Sign On (SSO) into SonarQube using KeyClock
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.
Pre-requisites
You'll require SP metadata for IDP configuration.
You can find it under Administration >>Configuration >>miniOrange SAML Support >> SP Metadata tab.
The SP metadata can be used manually or using 2 Different Format options Text or File.
You can refer the steps from the video or documentation below to configure your IDP with SonarQube.
Step 1: Setup Jboss Keycloak as Identity Provider
Follow the steps below to configure Jboss Keycloak as an Identity Provider.You can use 2 ways to configure the JBoss Keycloak as 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.
Click Import File button.
Upload plugin metadata. (To obtain it, go to the Service Provider Info tab of the plugin, and click on Download Metadata button or You can copy the SP Entity ID and ACS URL from the plugin.
Now, click on Select file from the Add Client tab of keycloak and browse the downloaded metadata file.)
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].