SAML Single Sign On (SSO) into Jenkins using ADFS 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 ADFS. By the end of this guide, ADFS 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



  • Login to your Jenkins Admin Account.
    • 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 ADFS as Identity Provider

      1. On ADFS, search for ADFS Management application.
        2. SAML Single Sign On (SSO) using ADFS Identity Provider, Management Application
      2. After opening the AD FS Management, select Relying Party Trust & then click on Add Relying Party Trust.
        3. SAML Single Sign On (SSO) using ADFS Identity Provider,Add Relying Party Trust
      3. Click the Start button from the Relying Party Trust Wizard pop up. But before that please make sure Claims Aware is selected.
        4. SAML Single Sign On (SSO) using ADFS Identity Provider,Claims Aware
      4. Select the options for adding a relying party trust.

          5. SAML Single Sign On (SSO) using ADFS Identity Provider Using Metadata URL

          • In Select Data Source: Import data about the relying party published online or on the local network option & then add URL in Federation metadata address.
            • SAML Single Sign On (SSO) using ADFS Identity Provider, Import metadata through URL
          • Skip step-5 to step-8 & start configuring from step-9. Navigate to Service Provider Info tab from the plugin for getting SP Meatadata URL.

          SAML Single Sign On (SSO) using ADFS Identity Provider Using Metadata XML file

          • In Select Data Source: Import data about the relying party from a file option & then browse the metadata file.
            • SAML Single Sign On (SSO) using ADFS Identity Provider, Import Metadata through XML file
          • Skip step-5 to step-8 & start configuring from step-9.

          SAML Single Sign On (SSO) using ADFS Identity Provider Using Manual configuration

          • In Select Data Source: Enter Data about the relying party manually & Click on Next.
            • SAML Single Sign On (SSO) using ADFS Identity Provider, Manual configuration of metadata
      5. Enter Display Name & Click Next.
      6. Upload the certificate & click next. Download the certificate from plugin & use the same certificate to upload on ADFS.
      7. Select Enable support for the SAML 2.0 WebSSO protocol & Enter ACS URL from the plugins Service Provider Info Tab. Click Next.
        8. SAML Single Sign On (SSO) using ADFS Identity Provider,support for the SAML 2.0 WebSSO protocol
      8. Add Entity ID from plugins Service Provider Info Tab as Relying party trust identifier then click Add button & then click Next.
        9. SAML Single Sign On (SSO) using ADFS Identity Provider, Relying party trust identifier
      9. Also download the Signing certificate from Service Provider Info Tab from the plugin.
      10. Select Permit everyone as an Access Control Policy & click on Next.
        11.  SAML Single Sign On (SSO) using ADFS Identity Provider, Access Control Policy
      11. Click the Next button from Ready to Add Trust & click Close.
      12. It will show you the list of Relying Party Trusts. Select the respective application & click on Edit Claim Issuance Policy.
        13. SAML Single Sign On (SSO) using ADFS Identity Provider, Edit Claim Issuance Policy
      13. Click on Add Rule button.
        14. SAML Single Sign On (SSO) using ADFS Identity Provider, add rule
      14. Select Send LDAP Attributes as Claims & click on Next.
        15. SAML Single Sign On (SSO) using ADFS Identity Provider, Send LDAP Attributes as Claims
      15. Enter the following details & click on Finish.
        16. Claim rule name: Attributes
        Attribute Store: Active Directory
        LDAP Attribute: E-Mail-Addresses
        Outgoing Claim Type: Name ID
        SAML Single Sign On (SSO) using ADFS Identity Provider, Add Transform claim rule wizard
      16. Click Apply Ok.
      17. Select property of the application & add the certificate downloaded from the add-on.
        18. SAML Single Sign On (SSO) using ADFS Identity Provider, Add certificate

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.
    • SSO SAML Jenkins single sign on security realm, Jenkins SAML SSO

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.
    • sso saml jenkins single sign on idp Configuration Jenkins

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
    • sso saml jenkins single sign on User Profile Jenkins


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
      • 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
  • Single Logout 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.
    • sso saml jenkins single sign on idp Configuration Jenkins

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
    • sso saml jenkins single sign on User Profile Jenkins


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.
    • sso saml jenkins single sign on Advanced Configuration Jenkins




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.