SAML Single Sign On (SSO) into SonarQube using Centrify

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 Centrify. By the end of this guide, Centrify users should be able to log in and register to the SonarQube Server.

Step 1: Setup Centrify as Identity Provider

Follow the steps below to configure Centrify as an Identity Provider

miniorange img  Login as Administrator

  • Log into Centrify as an Administrator and go to Apps from the NavBar.
  • Click on Add Web Apps

miniorange img  Configure SAML App

  • In the pop-up, click on Custom tab and then click on the Add button next to SAML.
  • In the new SAML App that you created under Application Settings section enter ACS URL as provided in the Step 1 of the plugin under SP Info tab.
  • Centrify sso-1
  • Under User Access section select roles that can access this app
  • Under Advanced section pass the following parameters to the functions in the code:
  • setAudience() SP-EntityID / Issuer from Step1 of the plugin under SP Info Tab. E.g: setAudience('httpss://example.com')
    setRecipient() Recipient URL from Step1 of the plugin under SP Info Tab. E.g: setRecipient('httpss://example.com/plugins/servlet/saml/auth')
    sethttpsDestination() Destination URL from Step1 of the plugin under SP Info Tab. E.g: sethttpsDestination('httpss://example.com/plugins/servlet/saml/auth')
    NOTE: Please do NOT change any other function calls. Centrify sso-2

Step 2: Configure SonarQube as Service Provider.

    miniorange img  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. 1. IdP Entity ID
        2. Login URL
        3. X.509 Certificate

    • Save all the details.
    • sonarqube saml single sign on (sso) plugin - idp_details

    miniorange img  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.
      sonarqube saml single sign on (sso) plugin - test_configuration

    miniorange img  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 button in the plugin.
    • 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 [Refer with above image].
    • sonarqube saml single sign on (sso) plugin - attribute_mapping

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.