SAML Single Sign On (SSO) Into Jenkins Using Okta

SAML Single Sign On (SSO) into Jenkins using Okta 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 Okta. By the end of this guide, Okta users should be able to log in and register to Jenkins.

Step 1: Setup Okta as Identity Provider

Follow the steps below to configure Okta as an Identity Provider

SAML Single Sign On (SSO) using Okta Identity Provider,Okta SSO Login Configuring Okta as IdP

Log into Okta Admin Console. For developer account, switch to Classic UI to configure app, and then Application.
Click on Add Applications.

SAML Single Sign On (SSO) using Okta Identity Provider, Okta SSO Login,Add New Application into Okta

Click on Create New App.
Select SAML 2.0 as Sign on method.
Click on Create.

SAML Single Sign On (SSO) using Okta Identity Provider, Okta SSO Login,Create New SAML 2.0 Application

In General Settings, enter App Name and click on Next.
In SAML Settings, enter the following:

SAML Single Sign On (SSO) using Okta Identity Provider, Okta SSO Login,Fill Service Providers Details

Single Sign On URL	Enter ACS (AssertionConsumerService) URL from the Service Provider info tab of the module.
Audience URI (SP Entity ID)	Enter SP Entity ID / Issuer from the Service Provider info tab of the module.
Default Relay State	Enter Relay State from the Service Provider info tab of the module.
Name ID Format	Select E-Mail Address as a Name Id from dropdown list.
Application Username	Okta username.

Configure Attribute Statements and Group Attribute Statement (Optional).

For Name, enter "firstName" and select user.firstName from the value dropdown.

For Name, enter "lastName" and select user.lastName from the value dropdown.

For Name, enter "Email" and select user.email from the value dropdown.

For Name, enter "groups" and select Matches regex from the Filter dropdown and enter ".*"

SAML Single Sign On (SSO) using Okta Identity Provider,Okta SSO Login, Attribute And Group Mapping

SAML Single Sign On (SSO) using Okta Identity Provider, Okta SSO Login, Assigning Groups/People

After creating and configuring the app go to the Assignment Tab in Okta.
Here we select the peoples and groups you want to give access to log in through this app. Assign this to the people/group you would to give access to.

SAML Single Sign On (SSO) using Okta Identity Provider,Okta SSO Login, Assign App to People and Groups

After assigning the people/groups to your app, go to Sign On tab.
Click on View Setup Instructions to get the SAML Login URL (Single Sign on URL), Single Logout URL, IDP Entity ID and X.509 Certificate. You will need this to configure the Service Provider.

SAML Single Sign On (SSO) using Okta Identity Provider, Okta SSO Login,IDP Metadata Link

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 Okta 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