Configure Drupal SAML SP Module with any custome IdP

Overview

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

Confugure Identity Provider:

After installing the module on your Drupal site, in the Administration menu, navigate to Configuration → People → miniOrange SAML Login Configuration. (/admin/config/people/miniorange_saml/idp_setup)

Configuration-Drupal-Select-miniOrange-SAML-Login-Configuration

Provide the metadata from this tab to your IDP. You can use any of the 3 ways listed below:

Using Metadata URL:

Using XML Metadata file:

Drupal-SAML-Single-Sign-On-Click-on-Download-XML-Metadata-button

Manually uploading the Metadata:

Under the Service Provider Metadata tab scroll down to find the SP Metadata.
Copy the Metadata and provide it to the Identity Provider.

SP Entity ID/Issuer	Copy the SP Entity ID / Issuer from the Drupal site and paste it into the IDP.
SP ACS URL	Copy the SP ACS URL from the Drupal site and paste it into the IDP.

Configure Drupal as SAML Service Provider:

To complete the setup, you will have to provide metadata from IDP to the Drupal site. You can use any of the following ways:
Using IDP Metadata file:

Navigate to the Drupal site and switch to the Service Provider Setup tab.
Expand the Upload IDP Metadata section.
Upload the IDP Metadata file and click on the Upload File button.

Using IDP Metadata URL:

Paste the previously copied Metadata Url into the Upload Metadata URL text field.
Click on the Fetch Metadata button.

Drupal-SAML-Paste-the-Federation-Metadata-URL-into-the-Upload-Metadata-URL

Manually uploading the IDP Metadata:

Navigate to the Drupal site.
Under the Identity Provider Name enter the IDP name.
Provide the following mandatory values from the IDP Metadata.

IdP Entity ID/Issuer	Copy the Entity ID / Issuer from the IdP and paste it into IDP Entity ID/Issuer text field.
SAML Login URL	Copy the Single Sign-On URL from IDP and paste it.

Click on the Save Configuration button.

Click on the Test Configuratin button to test the connection between Drupal site and Identity Provider.

On a Test Configuration popup, you will be prompted to sign in to your IdP if you don't have an active session in the same browser. After successfully logging in to IdP, you will be provided with a list of attributes received from Identity Provider. Click on the Done.

drupal saml Single Sign On as SP - click on Done button

Congratulations! you have successfully configure 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 link.
You will be redirected to the IdP login page. Enter the IdP credentials. After successful authentication, the user will be redirected back to the Drupal site.