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 CA Identity. By the end of this guide, CA Identity users should be able to log in and register to the SonarQube Server.
Step 1: Setup CA Identity Manager as Identity Provider
Follow the steps below to configure CA Identity Manager as an Identity Provider.
Pre-requisite:
To configure CA Identity Manager as IDP, you need the metadata from SAML SSO plugin.
- Go to the Service Provider Info tab .
- Click on the link https://[application-Domain]/plugins/servlet/saml/metadata.
- choose Save As to save data in XML format on your system.
Enable SSO for Your App Using SAML
- In Display Name, enter the name of your app and click Continue.
Identity Provider Information
- Download IDP Metadata. This is necessary to configure the add-on later. Click on Continue.
Service Provider Information
- Upload SP metadata to Upload SP metadata and click Continue.
- You can also manually enter data. The data can be found in the add- on's SP Info tab.
Information to be entered in CA |
Information to copy from the add-on |
Assertion Consumer Service URL |
ACS URL |
Relay State |
- |
Entity ID |
SP Entity ID |
NameID Format |
Email Address |
Binding |
POST |
Requests Signed |
Yes |
Certificate |
Download the certificate provided in SP Info tab and upload it here |
Attribute Mapping
- Fill Attribute Mapping as per your requirement. Set Type against NameID to User Attribute and set Value as User Name or Primary Email. These attributes are used to create user in the SP.
- Click on Continue and click Finish .
Create a Rule
- You’ll be redirected to app Dashboard. Go to Rules. A Rule defines who has the access to app. Click on add rule.
- Enter the rule name. Click on Add Filter and select on which basis you want to assign app. You can select a department, type or title. You can add more filters according to your need. Click Continue.
- Select the SP app you setup in Then they should have. Click Continue.
- You can test the app by selecting a person from that department. Click Finish
×
Step 2: Configure SonarQube as Service Provider.
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 Logs.
- To be able to troubleshoot through logs, first you'll have to set a higher log level in your SonarQube application.
- To do so, go to the SonarQube Dashboard >>Administration >>System.
- 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.
- If you face any problem during configuration, go to %SONARQUBE_HOME% / logs directory.
- Find and open the web.log file. Go through the logs recorded.
- You'll find the stacktrace of performed actions, along with date and time information.
- To know more about the SonarQube Logs click here.
- Login Attribute is a unique name assigned to the user to identify them uniquely within the SonarQube system. It's a required attribute.
- Name Attribute is the full name of the user, to be mapped from the IdP to the SonarQube. It's a required attribute.
- Email Attribute is an optional attribute and represents an email address of the user, to be mapped from the IdP to the SonarQube.
- 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].
×
×
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.