SAML Single Sign On (SSO) Into Jenkins Using SimpleSAML
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 Simple SAML. By the end of this guide, Simple SAML users should be able to log in and register to Jenkins.
Download and install the plugin in Jenkins
-
To download the miniorange saml SP plugin follow the path: Through Jenkins plugin directory.
- Login to your Jenkins.
- Go to Manage Jenkins option from the left pane, and open Manage Plugins tab.
- Search for ‘Miniorange saml’ in the available tab.
- Download and install with a restart.
-
To download the miniorange saml SP plugin follow the path: Through Manual Configuration.
- Login to your Jenkins.
- Go to Manage Jenkins option from the left pane, and open Manage Plugins tab.
- Go to the advanced tab and upload the hpi file.
- You can get the hpi file by running mvn clean package command on this code. Contact info@xecurify.com if you are facing any issue.
Activate the plugin
- Open Manage Jenkins and select Configure Global Security.
- Set the Security Realm as miniorange SAML 2.0.
- Make sure that Enable Security checkbox is checked.
Step 1: Setup SimpleSAML as Identity Provider
- In config/config.php, make sure that 'enable.saml20-idp' is true. Example: ‘enable.saml20-idp’ => true
- In metadata/saml20-idp-hosted.php, configure SimpleSAML as an Identity Provider by adding code below:
$metadata['__DYNAMIC:1__'] = array(
'host' => '__DEFAULT__',
/* X.509 key and certificate. Relative to the cert directory.*/
'privatekey' => '<YOUR_PRIVATE_KEY_FILE_NAME>',
//eg. RSA_Private_Key.pem 'certificate' => '<YOUR_PUBLIC_KEY_FILE_NAME>',
//eg. RSA_Public_Key.cer
/* Authentication source to use. Configured in 'config/authsources.php'. */
'auth' => '<YOUR_AUTH_SOURCE_NAME>',
);
- In metadata/saml20-sp-remote.php, register your Servider Provider like this:
$metadata['https://example.com/plugins/servlet/saml/metadata'] = array(
'AssertionConsumerService' => 'https://example.com/',
'SingleLogoutService' => 'https://example.com/',
'NameIDFormat' => 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress',
'simplesaml.nameidattribute' => 'mail',
'simplesaml.attributes' => true,
'attributes' => array('mail', 'givenname', 'sn', 'memberOf'),
);
Step 2: Setup Jenkins as Service Provider
SP Configurations
You can configure SP settings in IDP in 2 ways:
To Configure IDP enter the following details and press apply and save the settings.
User Profile Configuration
Advanced Configurations
You can configure SP settings in IDP in 2 ways:
- By uploading Metadata XML file
- Manual Configuration
- Click on Service Provider Metadata in SP Configuration section.
- Metadata xml file will be downloaded.
- Use this file to setup IDP.
- 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
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
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.
SP Configurations
You can configure SP settings in IDP in 2 ways:
To Configure IDP enter the following details and pressapply and save the settings.
User Profile Configuration
Advanced Configurations
You can configure SP settings in IDP in 2 ways:
- By uploading Metadata XML file
- Manual Configuration
- Click on Service Provider Metadata in SP Configuration section.
- Metadata xml file will be downloaded.
- Use this file to setup IDP.
- 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
To Configure IDP enter the following details and press
- IDP Entity ID
- Single Sign On URL
- Single Logout URL
- Name ID Format
- X.509 Certificate
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.
Additional Resources
Our Other Apps:
SAML SSO Apps
|
OAuth Apps
|
2FA Apps
|
Crowd Apps
|
REST API Apps
|
Kerberos/NTLM Apps
|
User Sync Apps
|
Bitbucket Git Authentication App | Jenkins SSO | SonarQube SSO
Bitbucket Git Authentication App | Jenkins SSO | SonarQube SSO
If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com
×
![ADFS_sso]()
Trending searches:
Hello there!
Need Help? We are right here!
