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.

Step 1: Setup Ping One as Identity Provider

    All the information required to configure the Ping One i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange plugin.

  • Login to your Ping One environment as the administrator. Click on your ProfileAdmin.
  • Go to ApplicationsAdd ApplicationNew SAML Application.
  • Enter the application details and click Continue to Next Step. Application Name, Application Description, and Category are required fields. For logos and icons, PNG is the only supported graphics format.
  • ping one sso-1

miniorange img Provide the SAML configuration details for the application.


    1.Signing. In the dropdown list, select the signing certificate you want to use.

    2.SAML Metadata. Click Download to retrieve the SAML metadata for Ping One. This supplies the Ping    One connection information to the application.

    3.Protocol Version. Select the SAML protocol version appropriate for your application.

    4.Upload Metadata. Click Choose File to upload the application’s metadata file. The entries for ACS URL    and Entity ID will then be supplied for you. If you do not upload the application metadata, you will need    to enter this information manually. When you are manually assigning an Entity ID value, the Entity ID    must be unique, unless you are assigning the Entity ID value for a private, managed application (an    application that is supplied and configured by a PingOne for Enterprise administrator, rather than by an    SP).

    5.Single Logout Endpoint. The URL to which our service will send the SAML Single Logout (SLO) request    using the Single Logout Binding Type that you select).

    6.Single Logout Response Endpoint. The URL to which your service will send the SLO Response.

    7.Single Logout Binding Type. Select the binding type (Redirect or POST) to use for SLO.

    8.Primary Verification Certificate. Click Choose File to upload the primary public verification certificate    to use for verifying the SP signatures on SLO requests and responses.

    9.Signing Algorithm. Use the default value or select the algorithm to use from the dropdown list.

       Optional:

        I.Encrypt Assertion. If selected, the assertions PingOne sends to the SP for the application will   be encrypted.

        II.Encryption Certificate: Upload the certificate from miniOrange plugin to use to encrypt the    assertions.

        III.Encryption Algorithm: Choose the algorithm to use for encrypting the assertions. We    recommend AES_256 (the default), but you can select AES_128 instead.

        IV.Transport Algorithm: The algorithm used for securely transporting the encryption key.    Currently, RSA-OAEP is the only transport algorithm supported.

        V.Force Re-authentication. If selected, users having a current, active SSO session will be    re- authenticated by the identity bridge to establish a connection to this application.

  • Click Continue to Next Step. The SSO Attribute Mapping page is displayed.
  • ping one sso-2/>




<li>In the <strong>Attribute Mapping</strong>, Modify or add any attribute mappings as necessary for the application.</li>
<img class=
  • The summary information for the application configuration is then displayed on a new page and the new SAML application is added to your My Applications list.

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.