Search Results :

×

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. Our user-friendly plugin simplifies the process of setting up Single Sign-on (SSO) with Shibboleth2 in Joomla, ensuring a secure login experience. This enables users to access various Joomla sites effortlessly using their Shibboleth2 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 Shibboleth2, with Shibboleth2 serving as the Identity Provider (IDP) and Joomla as the Service Provider (SP).

What is SSO ?


  • Single sign-on (SSO) is an authentication method that enables users to access multiple applications with one-click login and one set of credentials. Users can automatically access all resources of the Joomla site once they are login using SSO.
  • The implementation of SSO involves configuring one system to trust another for user authentication, removing the need for users to log in separately to each system. The system that authenticates users is called an Identity Provider. The system that trusts the Identity Provider for authentication is called the Service Provider.
  • When a user initiates a login attempt, the Service Provider sends a SAML request to the Identity Provider. Upon successful IDP authentication, a SAML response containing user information is transmitted back to the Service Provider. Subsequently, the Service Provider verifies SAML response based on the Identity Provider configuration, and grants the user access to your Joomla website.

Pre-requisites: Download And Installation

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.
  • Log in to your Joomla site's Administrator console.
  • In the left-hand toggle menu, go to System and then click on Extensions under the Install section.
  • Click on the "Or Browse for file" button to browse and locate the plugin file that you downloaded earlier, then proceed to install it.
  • Install the SAML SP Plugin from your computer
  • The plugin installation has been successfully completed. Next, click on "Get Started!" to proceed.
  • Start Using miniOrange SAML SP plugin
  • Go to the Service Provider Metadata tab and scroll down to copy the SP EntityID and the ACS URL.
  • Copy SP-EntityID and ACS URL

2. Configure Shibboleth2 as Identity Provider

  • In conf/relying-party.xml, configure Service Provider like this
  • <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>
  • 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:
  • <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>
  • In attribute-filter.xml, release the email attribute:
  • <afp:AttributeFilterPolicy id="releaseTransientIdToAnyone">
    <afp:PolicyRequirementRulexsi:type="basic:ANY"/>
      <afp:AttributeRuleattributeID="email">
        <afp:PermitValueRulexsi:type="basic:ANY"/>
      </afp:AttributeRule>
    </afp:AttributeFilterPolicy>
  • Restart the Shibboleth Server.
  • You need to configure these endpoints in the Service Provider.
  • 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 with Joomla

In Joomla SAML plugin, go to Service Provider Setup tab. Here are the ways to configure the plugin:

SAML SSO Single-Sign-On By Metadata URL:

  • Enter Metadata URL (Copied from Shibboleth2) and click on Fetch Metadata.
  • Upload IDP Metadata

SAML SSO Single-Sign-On 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 value 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

    manual Configuration
  • Click on Save button and then Test Configuration button.
  • Save configuration
  • Congratulations! We have successfully configured Joomla SAML Service Provider with Shibboleth2 as Identity Provider.

4. How does SAML SSO login work?

  • Copy the SSO URL from the Service Provider Setup tab.
  • Shibboleth2 SAML Single Sign-On SSO into Joomla | Login Using Shibboleth2
  • Open a new browser/private window and enter the copied SSO URL.
  • You will be redirected to the Shibboleth2 login page. Enter the Shibboleth2 credentials. After successful authentication, the user will be redirected back to the Joomla site.

5. Attribute Mapping - Licensed feature.

  • Attributes are user details that are stored in your Identity Provider. To learn more about Attribute Mapping, click here.
  • 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.
  • 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.
  • Attribute Mapping

Step 6. Group Mapping - Licensed feature.

  • Group/Role mapping helps you to assign specific roles to users of a certain group in your Identity Provider (IdP). To learn more about Group Mapping, click here.
  • While performing SSO, the users are assigned roles based on the group they are mapped to.
  • Group Mapping

Step 7. Redirection & SSO Links.

  • Go to the Login Settings tab. You can add a SSO URL to Perform SAML SSO in your Joomla site by following the steps mentioned.
  • Joomla Single Sign On SSO SAML SP Signin Settings
  • There are multiple features availabe 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.

    Congratulations, you have successfully configured the miniOrange SAML SP plugin with your Shibboleth2 as IDP.

    Navigate to the Upgrade Plans tab to explore our comprehensive range of features and different licensing options. Alternatively, you can click here to view the features and licensing plans.

    If you encounter any problems or have questions, feel free to contact us. You can send your query via the Support button within the plugin or email us at joomlasupport@xecurify.com.

Additional Resources.

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.

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com