SAML Single Sign-On (SSO Login) into Joomla using Shibboleth2
miniOrange Joomla SAML SP SSO plugin helps you to integrate your Joomla site to Shibboleth2 using SAML 2.0 protocol. The miniOrange Joomla SAML SP Single Sign-on (SSO) plugin is simple to set up Shibboleth2 SSO into Joomla and enable secure login into Joomla. As a result, users can access multiple Joomla applications with one login after authenticating with their Shibboleth2 IDP credentials.
Our plugin is compatible with Joomla 4 as well as with all the SAML 2.0 compliant Identity Providers. Here we will go through a step-by-step guide to configure SAML SSO login between the Joomla site and Shibboleth2 by considering Shibboleth2 as IDP (Identity Provider) & Joomla as SP (Service Provider).
What is SSO ?
Your SP then sends a SAML request to IDP when a user attempts to log in. Upon IDP authentication, it sends SAML assertions to the SP that provide information about the user. The assertion is received by SP, which then verifies it in accordance with the Identity Provider configuration and grants the user access to your Joomla website.
Download of Plugin
Joomla SAML Handbook
This detailed Handbook for the Joomla SAML SP Single Sign On plugin gives an in-depth explanation of the features of the plugin.
Free Configuration Support and Trial
If you want any assistance or support while configuring a plugin or integrating Shibboleth2 with Joomla, then click on the Free Configuration Setup button.
We provide a 7-day full feature trial of our license version of the plugin where you can thoroughly test out all the features of the plugin on your site. Click on the Free Business Trial button if you want us to set up the trial for you.
Steps to Integrate Shibboleth2 Single Sign-On (SSO) with Joomla SAML SP
1. Download and setup Joomla SAML SP Plugin
- Download the zip file for the miniOrange SAML SP plugin for Joomla from the link here.
- Login into your Joomla site’s Administrator console.
- From left toggle menu, click on System, then under Install section click on Extensions.
- Here click on Browse for file button to locate and install the plugin file downloaded earlier.
- Installation of plugin is successful. Now click on Start Using miniOrange SAML SP plugin.
2. Configure Shibboleth2 as Identity Provider
- In conf/relying-party.xml, configure Service Provider like this
- Make sure your Shibboleth server is sending Email Address of the user in Name ID. In attribute-resolver.xml, get the email attribute as Name ID:
- In attribute-filter.xml, release the email attribute:
- Restart the Shibboleth Server.
- You need to configure these endpoints in the Service Provider.
<MetadataProviderxsi:type="InlineMetadataProvider" xmlns="urn:mace:shibboleth:2.0:metadata" id="MyInlineMetadata">
<EntitiesDescriptorxmlns="urn:oasis:names:tc:SAML:2.0:metadata">
<md:EntityDescriptorxmlns:md="urn:oasis:names:tc:SAML:2.0:metadata" entityID="<ENTITY_ID_FROM_PLUGIN>">
<md:SPSSODescriptorAuthnRequestsSigned="false" WantAssertionsSigned="true" protocolSupportEnumeration=
"urn:oasis:names:tc:SAML:2.0:protocol">
<urn:oasis:names:tc:SAML:1.1:nameidformat:emailAddress</md:NameIDFormat>
<md:AssertionConsumerService Binding="urn:oasis:names:tc:SAML:2.0:bindings:https-POST"
Location="<ACS_URL_FROM_PLUGIN>" index="1"/>
</md:SPSSODescriptor>
</md:EntityDescriptor>
</EntitiesDescriptor>
</MetadataProvider>
<resolver:AttributeDefinitionxsi:type="ad:Simple" id="email" sourceAttributeID="mail">
<resolver:Dependency ref="ldapConnector" />
<resolver:AttributeEncoderxsi:type="enc:SAML2StringNameID" nameFormat="urn:oasis:names:tc:SAML:1.1:
nameid-format:emailAddress"/>
</resolver:AttributeDefinition>
<afp:AttributeFilterPolicy id="releaseTransientIdToAnyone">
<afp:PolicyRequirementRulexsi:type="basic:ANY"/>
<afp:AttributeRuleattributeID="email">
<afp:PermitValueRulexsi:type="basic:ANY"/>
</afp:AttributeRule>
</afp:AttributeFilterPolicy>
| IDP Entity ID | https://<your_domain>/idp/shibboleth |
| Single Login URL | https://<your_domain>/idp/profile/SAML2/Redirect/SSO |
| X.509 Certificate | The public key certificate of your Shibboleth server |
3. Configure Shibboleth2 Identity Provider with Joomla SAML Service Provider
In Joomla SAML plugin, go to Service Provider Setup Tab. There are three ways to configure the plugin:
- Click on Upload IDP Metadata.
- Enter Metadata URL (Copied from Shibboleth2) and click on Fetch Metadata.
- Click on choose metadata file and click on Upload.
- 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 Service
URL, X.509 Certificate fields respectively in the plugin.
- Click on Test Configuration.
- Congratulaions we have successfully configured Joomla SAML Service Provider with Shibboleth2 as Identity Provider.
By Metadata URL :
By Uploading Metadata
File:
Manual Configuration :
| Idp Entity ID or Issuer | SAML Entity ID in the Federation Metadata document |
| Single Sign-On Service URL | SAML Single-Sign-On Endpoint URL in the Federation Metadata document |
| X.509 Certificate | X.509 Certificate in the Federation Metadata document |
4. Attribute Mapping - Premium Feature (Included with Business Trial)
- 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 etc.
- While auto registering the users in your Joomla site these attributes will automatically get mapped to your Joomla user details.
- In Joomla SAML plugin, 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) First Name: Name of the first name attribute from IDP Last Name: Name of the last 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.
5. Group Mapping - Premium Feature (Included with Business Trial)
- Group mapping helps you to assign specific Group to users of a certain group in your Identity Provider (IDP).
- While auto registering, the users are assigned Group based on the group they are mapped to.
6. Redirection & SSO Links - Premium Feature (Included with Business Trial)
- Go to Login Settings tab. There are multiple features availabe in this tab like Auto redirect the user to Identity Provider and Enable Backed Login for Super Users. To use these features, click on the respective checkboxes.
You have successfully completed your miniOrange SAML 2.0 SP configurations. Still, if you are facing any difficulty please mail us on joomlasupport@xecurify.com .
Additional Resources.
- What is Single Sign-On (SSO)
- How to configure SSO with Okta
- How to configure SSO with Google Apps
- Frequently Asked Questions (FAQs)
miniorange Joomla SAML Single sign-on(web SSO) supports multiple known IDPs like ADFS, Azure AD, Auth0,
Shibboleth, Pingfederate, Okta,
SimpleSamlPhp, Google apps, Bitium, OpenAM, miniorange IDP, Centrify and many more.
Business Trial
If you want Business Trial for FREE Click Here
If you don't find what you are looking for, please contact us at joomlasupport@xecurify.com or call us at +1 978 658 9387.
Need Help? We are right here!
