SAML Single Sign On (SSO) into SonarQube using AuthAnvil

SAML Single Sign On (SSO) into SonarQube using AuthAnvil as IDP

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

    Try it for free

Video Setup Guide

You can refer the steps from the video or documentation below to configure your IDP with SonarQube.

Step 1: Set Up AuthAnvil as Identity Provider

    AuthAnvil SAML SSOPrerequisites:
    • Copy these values from the Service Provider Info tab of the SAML plugin.
          1. SP Entity ID
          2. ACS URL
    AuthAnvil SAML SSO Instructions:
      1. Login to Authanvil and Go to SSO Manager +(add icon) and select Custom Application.
        2. SAML Single Sign On (SSO) using AuthAnvil Identity Provider, Add new application
      2. Enter the Application Name.
        3. SAML Single Sign On (SSO) using AuthAnvil Identity Provider, App Configuration
      3. Go to Protocol Type and Enter following info:
        4. Protocol Type SP-INIT
        Assertion Consumer Service URL ACS URL copied from the plugin
        Allow Multiple Audiences Unchecked
        Identity issuer SP Entity ID copied from the plugin
        Service Entity ID SP Entity ID copied from the plugin

        SAML Single Sign On (SSO) using AuthAnvil Identity Provider, Application configuration
      4. Enter Advanced Settings.
        5. Include All Audience URIs Checked
        Sign Token Response Checked
        Sign Assertion Unchecked
        Signing Algorithm SHA1

        SAML Single Sign On (SSO) using AuthAnvil Identity Provider, Advanced Settings
      5. Go to Attribute Transformation Tab and select Specify custom attribute transform. Add the NameID attribute and click on Add. Then add the name attribute as given in the image.
        6. SAML Single Sign On (SSO) using AuthAnvil Identity Provider, Attribute Transformation
      6. Click on Add Application .
      7. Go to Permissions tab and add Groups to which you want to give access to this application.
        8. SAML Single Sign On (SSO) using AuthAnvil Identity Provider, Group Access
      8. Click on Save Changes.
      9. Open the app. Click on View Federation Metadata in Protocol Type Tab and save the generated metadata xml file. This metadata file will be required to configure the plugin.
        10. SAML Single Sign On (SSO) using AuthAnvil Identity Provider, View Federation Metadata

Step 2: Set Up SonarQube as Service Provider

SAML SSO for jira using Okta Identity Provider, Okta SSO Login, 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. IdP Entity ID
    2. Login URL
    3. X.509 Certificate
  • Save all the details.
    • sonarqube saml single sign on (sso) plugin - idp_details

SAML SSO for jira using Okta Identity Provider, Okta SSO Login, Test Configuration

  • Once you have filled all the IdP details, go to Administration >>Configuration >>miniOrange SAML Support and then click on the Test Configuration tab.
  • It will show you 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 .
    1. To be able to troubleshoot through logs, first you'll have to set a higher log level in your SonarQube application.
    2. To do so, go to the SonarQube Dashboard >> Administration >> System.
    3. Under the system settings, you'll find an option to change the log's level. Select DEBUG and save it. Now try to configure the plugin.
    4. If you face any problem during configuration, go to %SONARQUBE_HOME% / logs directory.
    5. Find and open the web.log file. Go through the logs recorded.
    6. You'll find the stacktrace of performed actions, along with date and time information.
    sonarqube saml single sign on (sso) plugin - test_configuration

SAML SSO for jira using Okta Identity Provider, Okta SSO Login, 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 tab in the plugin support page.
  • 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.
    • sonarqube saml single sign on (sso) plugin - attribute_mapping

Did this page help you?

miniOrange Atlassian Contact Us

Book a Free Consultation with
Our Experts Today!

Schedule a call now!


Contact Us