SAML Single Sign-On into Joomla using OpenAM
Overview
miniOrange Joomla SAML SP SSO plugin helps you to integrate your Joomla site to OpenAM using SAML 2.0 protocol. Our
user-friendly plugin simplifies the process of setting up Single Sign-on (SSO) with OpenAM in Joomla, ensuring a
secure login experience. This enables users to access various Joomla sites effortlessly using their OpenAM IDP
credentials.
Our plugin is designed to be compatible with Joomla 3, 4 as well as 5 and works seamlessly with all SAML 2.0
compliant Identity Providers. For a detailed overview of the comprehensive features offered by the Joomla SAML SP
plugin, please visit our page here. Below, we provide a step-by-step guide on configuring SAML SSO login between
your Joomla site and OpenAM, with OpenAM serving as the Identity Provider (IDP) and Joomla as the Service Provider
(SP).
Configuration Steps
In this setup, OpenAM serves as the repository for storing users i.e. it will act as the IDP while Joomla is where users will log in using their credentials from OpenAM where Joomla SAML SP SSO Plugin will be installed.
Step 1: Install Joomla SAML SP Plugin
- Login into your Joomla site’s Administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Now click on Or Browse for file button to locate and install the plugin file downloaded earlier.
- Installation of plugin is successful. Now click on Get Started!
- Go to the Service Provider Metadata tab and scroll down to copy the SP-EntityID and the ACS URL.
Step 2: Configure OpenAM as IDP (Identity Provider)
Create OpenAm as a Hosted Identity Provider:
Note: You can skip this step and navigate to Configure Remote Service Provider if you have already configured OpenAm hosted IDP.
- Login to the OpenAM admin console.
- From the REALMS, select realms, under which you want to create hosted IDP. You will be redirected to the Realm overview page.
- Click on Create SAMLv2 Providers in the Realm Overview page.
- Click on Create Hosted Identity Provider. You will be redirected to the configuration page.
- Configure SAML IDP as given below:
- Name: Name of the SAML IDP.
- Signing Key: Select the Signing key from the dropdown.
- New Circle of Trust: Provide a name of the groups of IDP and SP that trust each other.
- Attribute Mapping: Configure user profile attributes to be sent to the Service Provider application.
- Click on the Configure button on the top right corner.
- Verify the configuration from the Federation tab of OpenAM.
Configure Remote Service Provider:
- Login to the OpenAM admin console.
- From the REALMS, select realms, under which you want to create hosted IDP. You will be redirected to the Realm overview page.
- Click on Create SAMLv2 Providers in the Realm Overview page.
- Click on Register Remote Service Provider. You will be redirected to the configuration page.
- Configure the Service Provider as given below:
- Where does the metadata file reside: URL.
- URL of metadata: Configure miniOrange plugin’s SAML Metadata here.
- Circle of Trust: Add to existing.
- Existing Circle of Trust: Select the Circle of Trust (group) in which your hosted IDP is located.
- Attribute Mapping: Configure user profile attributes for mapping.
- Click on the Configure button on the top right corner.
- Verify the configuration from the Federation tab of OpenAm.
- Provide OpenAm SAML Metadata to Service Provider application(miniOrange plugin) and you can download the
OpenAm metadata using the URL given below.
[OpenAm ServerURL] /saml2/jsp/exportmetadata.jsp
In case if you have multiple realms and hosted identity Provider configured then use the URL given below.
[OpenAm ServerURL] /saml2/jsp/exportmetadata.jsp ?entityid= [IdPentityID]&realm=/ realmname
Step 3: Configure Joomla as SP (Service Provider)
In Joomla SAML plugin, go to Service Provider Setup tab. There are three ways to configure the plugin:
A. By uploading IDP metadata:
- In Joomla SAML plugin, go to Service Provider Setup tab, then click on Upload IdP Metadata.
B. By Metadata URL:
- Enter Metadata URL (Copy from IDP app) and click on Fetch button.
C. Manual Configuration:
- Copy SAML Entity ID, SAML Single-Sign-On Endpoint URL and X.509 certificate from Federation Metadata document and paste it in Idp Entity ID or Issuer, Single Sign-on URL, X.509 Certificate fields respectively in the plugin.
| IdP Entity ID or Issuer | SAML Entity ID in the Federation Metadata document |
| Single Sign-On URL | SAML Single-Sign-On Endpoint URL in the Federation Metadata document |
| X.509 Certificate Value | X.509 Certificate in the Federation Metadata document |
Step 4: Attribute Mapping - Premium Feature
- Attributes are user details that are stored in your Identity Provider.
- Attribute Mapping helps you to get user attributes from your Identity Provider (IDP) and map them to Joomla user attributes like firstname, lastname, address, phone etc.
- While auto registering the users in your Joomla site these attributes will automatically get mapped to your Joomla user details.
- Go to Attribute Mapping tab and fill in all the fields.
| Username: | Name of the username attribute from IdP (Keep NameID by default) |
| Email: | Name of the email attribute from IdP (Keep NameID by default) |
| Name: | Name of the name attribute from IdP |
- You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.
Note: You can see how Attribute Mapping works here.
Step 5: Group Mapping - Premium Feature
- Group/Role mapping helps you to assign specific roles to users of a certain group in your Identity Provider (IdP).
- While auto registering, the users are assigned roles based on the group they are mapped to.
- Group/Role mapping helps you to assign specific roles to users of a certain group in your Identity Provider (IdP).
- While auto registering, the users are assigned roles based on the group they are mapped to.
Note: You can see how Group/Role Mapping works here.
Step 6: Redirection & SSO Links
- Go to Login Settings tab. You can add login Url to Perform SAML SSO in your Joomla site by following the steps below.
- There are multiple features available in this tab like Auto redirect the user to Identity Provider and Enable Backend Login for Super Users. To use these features, click on the respective checkboxes.
- Click on the Upgrade tab to check out our complete list of features and various licensing plans. OR you can click here to check features and licensing plans.
- In case, you are facing some issue or have any question in mind, you can reach out to us by sending us your query through the Support button in the plugin or by sending us a mail at joomlasupport@xecurify.com.
