Contents

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

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

Pre-requisites

To integrate your Identity Provider (IDP) with Jenkins, you need the following items:

Jenkins should be installed and configured.
Jenkins Server is https enabled (optional).
Admin credentials are set up in Jenkins.

Download And Installation

SSO SAML Jenkins single sign on manage jenkins, Jenkins SAML SSO

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

SSO SAML Jenkins single sign onmanage plugins, Jenkins SAML SSO

Search for Miniorange saml in the available tab.

SSO SAML Jenkins single sign onupload plugin, Jenkins SAML SSO

Download and install with a restart.

SSO SAML Jenkins single sign on install plugins, Jenkins SAML SSO

Step 1: Setup miniOrange as Identity Provider

Single Sign On using miniorange, miniorange SSO Login

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.

Click on Add Applicaton button.

In Choose Application Type click on Create App button in SAML/WS-FED application type.

miniOrange-SAML-SSO-Search-Application-Name

In the next step, search for your application from the list, if your application is not found. Search for "custom" and you can set up your app via Custom SAML App.
Method 1: Manual Configuration

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

Method 2: Import SP Metadata:
- You can also import SP metadata to configure your app.
- Click on Import SP Metadata button.
- Enter your Custom Application Name in App Name text box.
- Upload plugin metadata in form of text, File or URL and Click Import.
Name ID Setup And Attribute Mapping :

Enter the attribute name with which you want to log in your application in NameID field.. eg.Username, Email etc.
Enter name ID format such as emailAddress, nameid etc. in Name ID Format.
Attributes can be mapped using Add Attribute tab.
Add attributes such as first name, last name, group Name, etc.with its corresponding value as per shown in image.
Multiple attributes can be added using icon

SAML Single Sign On (SSO) using miniOrange Identity Provider, miniorange SSO Login, Attribute Mapping

Select Default from the Group Name dropdown.
Enter Policy Name you would like to provide.
Select Password from the Login Method Dropdown.
Click on Save to add the App.

SAML Single Sign On (SSO) using miniOrange Identity Provider, miniorange SSO Login, Add policy for SP application

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.
You can also provide Metadata URL in plugin settings.

SAML Single Sign On (SSO) using miniOrange Identity Provider, miniorange SSO Login, Download IDP Metadata

Step 2: Setup Jenkins as Service Provider

Open Manage Jenkins and select Configure Global Security.

SSO SAML Jenkins single sign on configure security, Jenkins SAML SSO

Set the Security Realm as miniorange SAML 2.0 and click on save button.

SSO SAML Jenkins single sign on security realm, Jenkins SAML SSO

Make sure that Enable Security checkbox is checked.
Choose miniorange SAML SSO from the manage Jenkins tab.

Free
Premium

Free

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

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 Configuration Jenkins

You can either enter the metadata URL or the metadata file path.

User Profile Configuration

Select Username Case Conversion.
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 SSO Binding Type.
Select the Create new user after SSO? to allow user creation through SAML.
Select Force Authentication.
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.

sso saml jenkins single sign on Advanced Configuration Jenkins

Premium

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

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

You can either enter the metadata URL or the metadata file path.

User Profile Configuration

Select Username or Email for Login Jenkins account by:
Select Username Case Conversion.
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 SSO Binding Type.
Select the SLO Binding Type.
Select the Send Signed Request ? 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 Create new user after SSO? to allow user creation through SAML.
Select Force Authentication.
Select the 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
You can assign groups from IDP to users created through SSO by adding the name of the group attribute that contains the IDP groups in the SAML response in the Group Attribute field in the plugin configuration. You can find out the group attribute name by performing the test configuration from the test configuration button under the I will do manual configuration tab.
If 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.

Additional Resources

Free Trial

If you don't find what you are looking for, please contact us at support-atlassian@miniorange.atlassian.net or raise a support ticket here.