SAML Single Sign On (SSO) into SonarQube using miniOrange

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

Step 1: Setup miniOrange as Identity Provider

Follow the steps below to configure miniOrange as an Identity Provider

miniorange img  Creating App in miniOrange

  • Go to miniOrange Admin console https://login.xecurify.com/moas/login and login with your miniOrange credentials.
  • From the left menu, go to Apps Manage Apps.

    miniorange sso-1
  • In the right upper corner, select Configure Apps.

    miniorange sso-2
  • In the search apps textbox, type <application name> (SAML).

    miniorange sso-3
  • Select searched application and click on Add App.
  • Enter the following the textboxes:

    Custom Application Name App name you like to provide.
    SP Entity ID or Issuer Enter SP Entity ID / Issuer from Service Provider Info tab of the plugin
    ACS URL Enter ACS (Assertion Consumer Service) URL from Service Provider Info tab of the plugin
    Single Logout URL Enter Single Logout URL from Service Provider Info tab of the plugin
  • Click on Save to add the App.

    miniorange sso-4
  • Select Default from the Group Name dropdown.
  • Enter Policy Name you would like to provide.
  • Select Password from the First Factor Type dropdown.
  • Click on Save to save the policy.

    miniorange sso-5
  • Navigate to Apps Manage Apps.
  • Click on the metadata link against your app.
  • Download the Metadata XML File or note down the given information and keep it handy to configure the add-on.

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.