Drupal SAML Single Sign On using CA Identity as Identity Provider

Overview

The Drupal SAML integration using the miniOrange SAML SP module establishes seamless SSO between CA Identity and the Drupal site. The users will be able to log in to the Drupal site using their CA Identity credentials. This document will walk you through the steps to configure Single Sign-On - SSO between Drupal as a Service Provider (SP) and CA Identity as an Identity Provider (IdP). The module is compatible with Drupal 7, Drupal 8, Drupal 9, Drupal 10, and Drupal 11.

Installation Steps

• Using Composer
• Using Drush
• Manual Installation

• Download the module:

  Composer require 'drupal/miniorange_saml'

• Navigate to Extend menu on your Drupal admin console and search for miniOrange SAML Service Provider using the search box.
• Enable the module by checking the checkbox and click on install button.
• Configure the module at

  {BaseURL}/admin/config/people/miniorange_saml/idp_setup

• Install the module:

  drush en drupal/miniorange_saml

• Clear the cache:

   drush cr

• Configure the module at

  {BaseURL}/admin/config/people/miniorange_saml/idp_setup

• Navigate to Extend menu on your Drupal admin console and click on Install new module button.
• Install the Drupal SAML SP 2.0 Single Sign On (SSO) - SAML Service Provider module either by downloading the zip or from the URL of the package (tar/zip).
• Click on Enable newly added modules.
• Enable this module by checking the checkbox and click on install button.
• Configure the module at

  {BaseURL}/admin/config/people/miniorange_saml/idp_setup

Configuration Steps

Drupal SAML SP Metadata

• Go to Configuration → People → SAML Login Configuration in the Administration menu. (/admin/config/people/miniorange_saml/idp_setup)

• Under the Service Provider Metadata tab, click the Download XML Metadata button and download the metadata file. This SP metadata is required to configure CA Identity as Identity Provider (IdP).

Configure CA Identity as a Identity Provider

• Log in to your CA SSO portal as a CA Single Sign-On administrator.
• Click on Federation tab.
• Now go to Partnership Federation → Entities.

• Click on Create Entity.

• To create a local entity, configure the following:

  Entity Location	Local
  Entity Type	SAML2 IDP
  Entity ID	Enter an ID for your local identity provider for identification.
  Entity Name	Create a name for your local identity provider.
  Base URL	Enter the fully-qualified domain name for the host service CA SSO Federation Web Services.
  Signed Authentication Requests Required	No
  Supported NameID format	urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified

• Click on Import Metadata and upload the downloaded XML metadata file from Drupal.

• For Import As, select Remote Entity.
• Provide a name for the Remote Service Provider Entity.

• To create partnership between SP and IDP, follow the below details:

  Add Partnership Name	Enter a name for your partnership.
  (Optional) Description	Enter a relevant description for your partnership.
  Local IDP ID	Enter the Local Identity Provider ID created while adding a Local Entity.
  Remote SP ID	Enter the Remote Service Provider ID created while adding a Remote Entity.
  Base URL	This field will be pre-populated.
  Skew Time	Enter any skew time required by your environment.
  User Directories and Search Order	Select the required directories in the required search order.

• On the Federation Users page, add the users you want to include in the partnership.
• In the Assertion Configuration section, configure following:
  • Name ID Format: Email Address
  • Name ID Type: User Attribute
  • Value: mail
  • (Optional) Assertion Attributes: Specify any application or group attributes that you want to map to users

• In the SSO and SLO section, perform the following steps:
  • SSO Binding: HTTP-POST
  • Transactions Allowed: Both IDP and SP initiated

• In the Signature and Encryption section, select Post Signature as Sign Both.
• In the Federation Partnership List, expand the Action dropdown for your partnership and click Activate.
• To get the IDP metadata, Click the Action button and click Export Metadata. This data will be used to configure the module.

Configure Drupal as SAML Service Provider:

• Go to your Drupal site. Navigate to the Service Provider Setup tab of the module and click on the Upload IDP Metadata.

• Upload the previously downloaded Metadata file from CA Identity into the Upload Metadata File text field and click on the Upload File button.

• Click on the Test link to test the connection between Drupal and CA Identity.

• On a Test Configuration popup sign in using CA Identity credentials (if an active session is not present). After successful authentication, a list of attributes that are received from CA Identity will be displayed. Click on the Done.

Congratulations! you have successfully configure CA Identity as SAML Identity Provider (IdP) and Drupal as SAML Service Provider.

How does SAML SSO login work?

• Open a new browser/private window and navigate to the Drupal site login page.
• Click the Login using Identity Provider (CA Identity) link.
• You will be redirected to the CA Identity login page. Enter the CA Identity credentials. After successful authentication, the user will be redirected back to the Drupal site.