Using Shibboleth as the SAML Identity Provider

You can use Shibboleth as the public SAML IdP with a tested Cloudpath configuration.

Shibboleth allows users to securely send trusted information about themselves to remote resources. This information can used for authentication, authorization, content personalization, and enabling single sign-on from many different providers.

Basic Tasks for Using Shibboleth

Configure SAML using Shibboleth as the IdP by performing the following tasks sequentially:

  1. Adding a SAML Step To Your Workflow
  2. Adding the Shibboleth SAML Authentication Server to the Workflow
  3. Downloading the Shibboleth SAML Metadata
  4. Adding the Metadata to Your Shibboleth Identity Service Provider
  5. Publishing the Workflow for SAML Shibboleth
  6. Testing the User Experience for SAML Shibboleth

Adding a SAML Step To Your Workflow

A SAML authentication server may be added to the workflow in place of a traditional Active Directory or LDAP server for authenticating users.

Determine in which branch and in which step to add a SAML authentication server plug-in to the workflow. For example, in the default workflow, you might create a split for Guests and Employees, and you could then use a SAML authentication server instead of the Active Directory authentication server, as shown below.

  1. Log in to the Cloudpath user interface.
  2. Go to Configuration > Workflows.
  3. Click on a workflow (or create a new one) for which you want to configure SAML as the authentication server.
  4. Highlight the tab in the workflow where you want to add the SAML authentication-server step. In this example below, it is the Employees tab.

    Adding a SAML Step To Your Workflow

  5. With the Employees branch of the workflow highlighted, click the blue arrow to insert a step below the Guests/Employees split.

Adding the Shibboleth SAML Authentication Server to the Workflow

  1. Once you click the arrow to insert the SAML step, you receive the following prompt:
    "Which Type Of Step Should Be Added?"
  2. Select the button to authenticate to a traditional authentication server, as shown in the following screen:

    Authenticate to a Traditional Authentication Server

  3. Click Next.
  4. If you have already defined an authentication server, you will get a prompt asking whether you want to reuse an existing authentication server or define a new authentication server. Choose the radio button to define a new authentication server, then click Next.
  5. On the Authentication Server Configuration screen, select the Connect to SAML radio button:

    Authentication Sever Configuration Screen

  6. Complete the configuration. An example configuration screen is shown below, and descriptions of the fields follow the screen.
    Note: You can click the "i" icons next to the field names to obtain the information required for each field.

    SAML Configuration Fields for Shibboleth

    • Required SAML Configuration section:
      • IdP Metadata Type: Use the URL option.
      • IdP Metadata URL and IdP EntityID: These URLs should be in a format similar to: idp.<customer_ shibboleth_ server>.org
      • SP EntityID: Enter the string urn:testsaml:cloudpath:followed by your first name. For example: urn:testsaml:cloudpath:Jeff
    • SAML Attribute to Enrollment Mappings - Required fields:
      • Username Attribute: Must be uid
      • Common Name Attribute: Must be eduPersonPrincipal_Name
      • Affiliation/Group Attribute: Must be eduPersonAffiliation
      • Email Attribute: Must be eduPersonPrincipal_Name
      • First Name Attribute: Must be givenName
      • Last Name Attribute: Must be sn
      • Distinguished Name Attribute: Must be cn
      Note: You can use defaults for the remaining fields.
    • SAML Options (not shown in the screen shot above): Use all default settings.
  7. Click Next.
    The Server Certificate Information screen appears:

    Pin or Upload the Current Server Certificate

  8. You can leave the Pin the Current Server Certificate radio button selected, or you can select the other radio button and upload the CA certificate for the SAML server (if you have that certificate). Whichever method you choose, click Next when you are done.
    You are returned to the workflow screen, as shown in the example below:

    Workflow After SAML Has Been Configured as Authentication Server

Downloading the Shibboleth SAML Metadata

  1. In the workflow, click the arrow (circled in red in the figure below) to download the SAML metadata:

    Download Icon in Workflow for SAML Metadata

  2. Save the XML metadata to a local file in the following format: testsaml_cloudpath_<your_first_name>.xml. Example: testsaml_cloudpath_jeff.xml

Adding the Metadata to Your Shibboleth Identity Service Provider

  1. In a browser, go to the URL of your Shibboleth server.
  2. On the Shibboleth site, click the Choose File button at the bottom of the screen.
  3. Browse to select the metadata file that you previously downloaded, then click the Upload File button.
    You should receive a message on the next screen that indicates that your metadata was uploaded successfully.

Publishing the Workflow for SAML Shibboleth

  1. Return to the workflow on your Cloudpath system by navigating to the Configuration > Workflows screen.
  2. Complete the workflow by adding a device configuration. Refer to Adding a Device Configuration to Your Workflow.
  3. Publish the workflow by clicking the Publish icon to the left of the workflow name.

Testing the User Experience for SAML Shibboleth

  1. Test the enrollment process by clicking on the enrollment portal URL for the workflow at the top of the Configuration > Workflows screen.
  2. When are you presented with the with the Welcome screen, click Start.
  3. When you are presented with various branches of your workflow, navigate down a branch that uses the SAML authentication server you just configured.
    You are directed to the Shibboleth login page, such as the one shown in the following example:

    Shibboleth Login During Enrollment

  4. Enter your credentials for your Shibboleth server, then click LogIn.
  5. If the SAML authentication is successful, you are returned to the Cloudpath system, where you can continue with the enrollment.