SAML Single Sign On (SSO) Into Fisheye/Crucible Using Ping Federate

Download

Fisheye/Crucible SAML app gives the ability to enable SAML Single Sign On for Fisheye/Crucible Software. Fisheye/Crucible Software is compatible with all SAML Identity Providers. Here we will go through a guide to configure SSO between Fisheye/Crucible and Ping Federate. By the end of this guide, Ping Federate users should be able to login and register to Fisheye/Crucible Software.

Step 1:Setup PingFederate as Identity Provider

All the information required to configure the Ping Federate as SAML IDP i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange plugin.


  • Login to your Ping Federate User Admin dashboard.
  • Click on the Identity Provider in the left navigation menu.
  • Under SP CONNECTION, click on Create New button.

    ping federate sso-1
  • Select the Browser SSO Profiles connection template on the Connection Type tab and click Next.

    ping federate sso-2
  • Select Browser SSO on the Connection Options tab and click Next.

    ping federate sso-3
  • Select File as the method for importing metadata and click Choose file to choose the miniOrange SSO plugin’s metadata on the Import Metadata tab. Click Next.

    ping federate sso-4
  • Review the information on the Metadata Summary tab and click Next.
  • In the General Info tab ensure that the Service Provider’s Entity ID, Connection Name, and Base URL fields pre-populate based on the metadata. Click Next.
  • Navigate to the Browser SSO tab and click on the Configure Browser SSO. You will be redirected to Browser SSO Setup wizard.

      1) Select the IdP-Initiated SSO and SP-Initiated SSO options on the SAML Profiles tab and click     Next.

      ping federate sso-5 2) Enter your desired assertion validity time from on the Assertion Lifetime tab and click Next.     By default, it is configured 5 minutes for both.

      3) Navigate to the Assertion Creation and click on the Configure Assertion Creation. You will be     redirected to the assertion creation setup wizard.

        I. In the Identity Mapping tab select STANDARD and click Next.

        II. Select a Subject Name Format for the SAML_SUBJECT on the Attribute Contract tab and     click Next.

        III. Click Map New Adapter Instance on the Authentication Source Mapping.

        ping federate sso-6 IV. Select an Adapter Instance and click Next. The adapter must include the user’s email     address.

        ping federate sso-7 V. Select the Use only the adapter contract values in the SAML assertion option on the     Mapping Method tab and click Next.

        VI. Select your adapter instance as the Source and the email as the Value on the Attribute     Contract Fulfilment tab and click Next.

        ping federate sso-8 VII. (Optional) Select any authorization conditions you would like on the Issuance Criteria        tab and click Next.

        VIII. Click Done on the Summary.

        IX. Click Next on the Authentication Source Mapping tab.

        X. Click Done on the Summary tab.

        XI. Click Next on the Assertion Creation

    1. Navigate to the Protocol Settings tab of the Browser SSO wizard and click on the Configure Protocol settings.

        1) Select POST for Binding and specify the single sign-on endpoint URL in the Endpoint     URL field on the Assertion Consumer Service URL Click Next.

        ping federate sso-9 2) Select POST on the Allowable SAML Bindings tab and click Next.

        3) Select your desired signature policies for assertions on the Signature Policy tab and     click Next.

        ping federate sso-10 4) Select your desired encryption policy for assertions on the Encryption Policy tab and     click Next.

        5) Click Done on the Protocol Settings Summary tab.

        6) Click Done on the Browser SSO Summary.

  • Navigate to the Credentials and click on the Configure Credentials. You will be redirected to the Credentials setup wizard.
      1) Select the Signing Certificate to use with the Single Sign-On service and select Include the certificate in the signature element in the Digital Signature Settings tab. Click Done.

      ping federate sso-11 2) Click Done on the Summary.

      3) Click Next on the Credentials.

  • Select Active for the Connection Status on the Activation & Summary tab and click Save.
  • Now, navigate to the Ping Federate User Admin dashboardè Identity Provide.
  • Click Manage All under SP Connections.
  • Click Export Metadata for the desired service provider connection.
  • Click Export on the Export & Summary tab and click Done.

Step 2: Setup Fisheye/Crucible as Service Provider

We can configure IDP settings in 3 ways:

A. By Metadata URL

  • Click on Import from Metadata in Configure IDP tab
  • Select IDP: Import From Metadata URL
  • Enter IDP metadata URL: Enter your metadata URL
  • If your IDP changes certificates at intervals, you can select Refresh metadata periodically. Select 5 minutes for the best results.
  • Click Import



B. By uploading Metadata XML file

  • Click on Import from Metadata in Configure IDP tab
  • Select IDP: Import from Metadata File
  • Upload IDP metadata file
  • Click Upload



C. Manual Configuration

Go to Configure IDP tab and enter the following details

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

Step 3: Setting up Fisheye/Crucible user profile attributes

    We will be setting up user profile attributes for Fisheye/Crucible. If your users are stored in a directory that is Read Only, please check Disable Attribute Mapping in User Profile tab.



    a. Finding correct attributes
  • Go to Configure IDP tab. Scroll down and click on Test Configuration.
  • You will see all the values returned by your IDP to Fisheye/Crucible in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your IDP to return this information.
  • Once you see all the values in Test Configuration, keep the window open and go to User Profile tab.
    • b. Setting profile attributes
  • In this tab, fill the values by matching the name of the attribute. For instance, if the Attribute Name in the Test Configuration window is NameID, enter NameID against Username
  • Setting up both Username and Email is required if you want to let users register. If you want existing users to the only login, configure the attribute using which you will match the user in Fisheye/Crucible.
    • c. Matching a User
    When the user logs into Fisheye/Crucible, one of the user's data/attribute coming in from the IDP is used to search the user in Fisheye/Crucible. This is used to detect the user in Fisheye/Crucible and log in the user to the same account.
  • Go to User Profile tab
  • Select Username or Email for Login/Search Fisheye/Crucible user account by
  • Enter the attribute name from IDP which corresponds to Username or Email using Finding Correct Attributes

Step 4: Assigning groups to users

    We will be setting up user group attributes for Fisheye. If your users are stored in a directory that is Read Only, please check Disable Group Mapping in User Groups tab and skip to Setting default group.


    a. Finding Group Attribute
  • Just like we found Attribute Name for User Profile attributes, we find group attribute.
  • Go to Configure IDP tab. Scroll down and click on Test Configuration.
  • You will see all the values returned by your IDP to Fisheye/Crucible in a table. If you don't see value with groups, make the required settings in your IDP to return group names.
  • Once you see all the values in Test Configuration, keep the window open and go to User Groups tab.
  • Enter the Attribute Name of group against Group Attribute
  • At the bottom of the page, all groups in Fisheye/Crucible are shown. You can map groups in IDP which correspond to Fisheye/Crucible groups. For example, if you want all users in dev-ops and dev groups in IDP to be added to crucible-users, you will need to enter dev-ops;dev against crucible-users
  • If you want user mapping to work for only limited groups in Fisheye/Crucible, check the option Update User Groups

    • b. Setting default group
  • Select the users' Default Group in the tab User Groups. If no group is mapped, users are added by default to this group.

Step 5: SSO Settings

    The settings in SSO Settings tab define the user experience for Single Sign On.
    a. Sign In Settings
  • Set Enable SSO for Fisheye/Crucible Software to allow SSO for Fisheye/Crucible Software users.
  • Set button text for button on login page using Login Button Text
  • Set redirect URL after login using Relay State. Keep this empty for coming back to the same page user started from
  • Enable Auto-redirect to IDP if you want to allow users to login only using IDP. Enable backdoor for emergency

    • c. Sign Out Settings
    Set Logout URL or Logout Template to redirect users after logout action.


    d. SSO Error Settings
    Set error template to redirect users to a custom error page instead of login page. Use this if you have Auto-redirect to IDP enabled.

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