SAML Single Sign On (SSO) into SonarQube using Oracle Enterprise Manager

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

Step 1: Setup Oracle Enterprise Manager as Identity Provider

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

    • Login to your Oracle Enterprise Manager (OEM) Console. From Side Menu Go to Identity and AccessOracle Identity Federation (OIF).
    • Select the Oracle Identity Federation dropdown from top. Go to AdministrationService  Provider.

    • Oracle Enterprise Manager SSO-1
    • In the Service Provider Section, Select the SAML 2.0 tab.
    • Check Map User via NameID.
    • Under Protocol Settings, check Enable SAML 2.0 Protocol.
    • Configure the additional SAML settings.
    • Oracle Enterprise Manager SSO-2 Oracle Enterprise Manager SSO-3
    • Now, Select the Oracle Identity Federation dropdown from top. Go to Administration  Security and Trust.
    • Navigate to the Provider Metadata tab.
    • Select Identity Provider in Provider Type dropdown and click generate button to download Idp metadata.
    • Oracle Enterprise Manager SSO-4
    • Provide the downloaded metadata to the Service Provider application.

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.