SAML Single Sign On (SSO) into SonarQube using Shibboleth2

SAML Single Sign On (SSO) into SonarQube using Shibboleth2 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 Shibboleth2. By the end of this guide, Shibboleth2 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 Shibboleth2 as Identity Provider

  • In conf/relying-party.xml, configure Service Provider like this
    • <MetadataProviderxsi:type="InlineMetadataProvider" xmlns="urn:mace:shibboleth:2.0:metadata" id="MyInlineMetadata">
      <EntitiesDescriptorxmlns="urn:oasis:names:tc:SAML:2.0:metadata">
        <md:EntityDescriptorxmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="<ENTITY_ID_FROM_PLUGIN>">
          <md:SPSSODescriptorAuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration=
              "urn:oasis:names:tc:SAML:2.0:protocol">
            <urn:oasis:names:tc:SAML:1.1:nameidformat:emailAddress</md:NameIDFormat>
            <md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:https-POST"
              Location="<ACS_URL_FROM_PLUGIN>" index="1"/>
          </md:SPSSODescriptor>
        </md:EntityDescriptor>
      </EntitiesDescriptor>
    </MetadataProvider>


  • Make sure your Shibboleth server is sending Email Address of the user in Name ID. In attribute-resolver.xml, get the email attribute as Name ID:
    • <resolver:AttributeDefinitionxsi:type="ad:Simple" id="email" sourceAttributeID="mail">
       <resolver:Dependency ref="ldapConnector" />
       <resolver:AttributeEncoderxsi:type="enc:SAML2StringNameID" nameFormat="urn:oasis:names:tc:SAML:1.1:
        nameid-format:emailAddress"/>
    </resolver:AttributeDefinition>

  • In attribute-filter.xml, release the email attribute:
    • <afp:AttributeFilterPolicy id="releaseTransientIdToAnyone">
    <afp:PolicyRequirementRulexsi:type="basic:ANY"/>
      <afp:AttributeRuleattributeID="email">
        <afp:PermitValueRulexsi:type="basic:ANY"/>
      </afp:AttributeRule>
    </afp:AttributeFilterPolicy>

  • Restart the Shibboleth server.
  • You need to configure these endpoints in miniOrange plugin.
    • IDP Entity ID https://<your_domain>/idp/shibboleth
    Single Login URL https://<your_domain>/idp/profile/SAML2/Redirect/SSO
    X.509 Certificate The public key certificate of your Shibboleth server

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