SAML Single Sign On (SSO) Into Jenkins Using Centrify

SAML Single Sign On (SSO) into Jenkins using Centrify as IDP

Jenkins SAML app gives the ability to enable SAML Single Sign-On for Jenkins. Here we will go through a guide to configure SSO between Jenkins and Centrify. By the end of this guide, Centrify users should be able to log in and register to Jenkins.

Step 1: Setup Centrify as Identity Provider

Follow the steps below to configure Centrify as an Identity Provider

Single Sign On (SSO) using Centrify, Centrify SSO Login Login as Administrator

Log into Centrify as an Administrator and go to Apps from the NavBar.
Click on Add Web Apps

Single Sign On (SSO) using Centrify, Centrify SSO Login Configure SAML App

In the pop-up, click on Custom tab and then click on the Add button next to SAML.
In the new SAML App that you created under Application Settings section enter ACS URL as provided in the Step 1 of the plugin under SP Info tab.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Application settings

Under User Access section select roles that can access this app
Under Advanced section pass the following parameters to the functions in the code:

setAudience()	SP-EntityID / Issuer from Step1 of the plugin under SP Info Tab. E.g: setAudience('https://example.com')
setRecipient()	Recipient URL from Step1 of the plugin under SP Info Tab. E.g: setRecipient('https://example.com/plugins/servlet/saml/auth')
sethttpsDestination()	Destination URL from Step1 of the plugin under SP Info Tab. E.g: sethttpsDestination('https://example.com/plugins/servlet/saml/auth')

NOTE: Please do NOT change any other function calls.

Single Sign On (SSO) using Centrify, Centrify SSO Login, Advanced settings

Click on Save button.

Step 2: Download and install the plugin in Jenkins.

sso saml jenkins single sign on manage jenkins-1

Go to Manage Jenkins option from the left pane, and open Manage Plugins tab.

sso saml jenkins single sign onmanage plugins-2

Go to the advanced tab and upload the hpi file.

sso saml jenkins single sign onupload plugin-3

Follow the instructions shown on screen and restart the Jenkins.

sso saml jenkins single sign on install plugins-4

Step 3: Activate the plugin

Open Manage Jenkins and select Configure Global Security.

sso saml jenkins single sign on configure security-5

Set the Security Realm as miniorange SAML 2.0.

sso saml jenkins single sign on security realm-6

Make sure that Enable Security checkbox is checked.

Free
Premium

Free

SP Configurations
You can configure SP settings in IDP in 2 ways:

By uploading Metadata XML file
Manual Configuration

A. By uploading Metadata XML file

Click on Service Provider Metadata in SP Configuration section.
Metadata xml file will be downloaded.
Use this file to setup IDP.

B. Manual Configuration

To Configure SP Settings at IDP copy below URL and paste in respective fields at IDP end.

SP Entity ID: https://your-jenkins-domain
Audience URI: https://your-jenkins-domain
ACS URL: https://your-jenkins-domain/securityRealm/moSamlAuth

sso saml jenkins single sign on SP Configuration Jenkins

IDP Configuration

To Configure IDP enter the following details and press apply and save the settings.

IDP Entity ID
Single Sign On URL
Name ID Format
X.509 Certificate

sso saml jenkins single sign on idp metadata -6

User Profile Configuration

Select Username or Email for Login Jenkins account by:
Enter the attribute name from IDP which corresponds to Username in Username Attribute textbox.
Enter the attribute name from IDP which corresponds to Email in Email Attribute textbox.
Select the checkbox Apply regex Pattern to the UserNameif the userID returned from SAML is not same as username of Jenkins.
Enter the regular expression in REGEX Pattern textbox. It will be applied on user ID from SAML Response and will convert it into the username same as Jenkins. For example, you can use regular expression ^.*?(?=@) to extract demo from username demo@example.com

Advanced Configurations

Select the Do you want to create a new users? to allow user creation through SAML.

sso saml jenkins single sign on Advanced Configuration Jenkins

Premium

SP Configurations
You can configure SP settings in IDP in 2 ways:

By uploading Metadata XML file
Manual Configuration

A. By uploading Metadata XML file

Click on Service Provider Metadata in SP Configuration section.
Metadata xml file will be downloaded.
Use this file to setup IDP.

B. Manual Configuration

To Configure SP Settings at IDP copy below URL and paste in respective fields at IDP end.

SP Entity ID: https://your-jenkins-domain
Audience URI: https://your-jenkins-domain
ACS URL: https://your-jenkins-domain/securityRealm/moSamlAuth

IDP Configuration

To Configure IDP enter the following details and press apply and save the settings.

IDP Entity ID
Single Sign On URL
Single Logout URL
Name ID Format
X.509 Certificate

sso saml jenkins single sign on idp Configuration Jenkins

User Profile Configuration

Select Username or Email for Login Jenkins account by:
Enter the attribute name from IDP which corresponds to Username in Username Attribute textbox.
Enter the attribute name from IDP which corresponds to Email in Email Attribute textbox.
Enter the attribute name from IDP which corresponds to full name in Full Name Attribute.
Select the checkbox Apply regex Pattern to the UserNameif the userID returned from SAML is not same as username of Jenkins.
Enter the regular expression in REGEX Pattern textbox. It will be applied on user ID from SAML Response and will convert it into the username same as Jenkins. For example, you can use regular expression ^.*?(?=@) to extract demo from username demo@example.com

Advanced Configurations

Select the Do you want signed requests? to send signed login and logout requests. Requests will be signed using public certificate from option Download SP Certificate in SP Configuration section.
Select the Do you want to create a new users? to allow user creation through SAML.
Select the Do you want to update Attributes of Existing Users? to update attributes of existing user's each time they sign in Jenkins through SSO.
To Add custom AttributeS select Add option.

Set Attribute Name as the one set in IDP eg. lname
Set display name in user proprties as one you want it appear in jenkins user's config.xml file and in user's configure tab.

To assign default group to users created through SSO add group name in Assign group to new Users option. Multiple groups can be added using ,(Comma) separater
If Do you want to disable Default login option is enabled, any unauthenticated user trying to access the default Jenkins login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the Jenkins base URL.
Copy backdoor URL and save it for emergency.

Step 1: Setup Centrify as IdP
Step 2: Setup Jenkins as SP

If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com