Search
START TYPING AND PRESS ENTER TO SEARCH

SAML Single Sign-On into Joomla using Shibboleth2 | Shibboleth2 SSO | Login using Shibboleth2

Shibboleth2 SAML Single sign-on (SSO) is an authentication method that enables Shibboleth2 users to access multiple Joomla applications with one login and one set of 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 Joomla site and Shibboleth2 by considering Shibboleth2 as IdP (Identity Provider) and Joomla as SP (Service Provider).

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. For example, after users log in to your org, they can automatically access all apps from the App Launcher. When you set up SSO, you configure one system to trust another to authenticate users , eliminating users' need to log in to each system separately. The system that authenticates users is called an Identity provider. The system that trusts the identity provider for authentication is called the Service provider.

SAML allows exchanging of information between Service Provider and Identity provider, SAML is integration between SP and IDP. When a user tries to log in, your identity provider sends SAML assertions containing facts about the user to Identity Provider. Identity Provider receives the assertion, validates it against your Identity Provider configuration, and allows the user to access your org.

Shibboleth2 Single Sign On (SSO) for Joomla miniOrange provides a ready to use solution for Joomla. This solution ensures that you are ready to roll out secure access to your Joomla site using Shibboleth2 within minutes.
Joomla SAML app gives the ability to enable SAML Single Sign-On for Joomla Site. Joomla site is compatible with all SAML Identity Providers. Here we will go through a guide to configure SAML SSO between Joomla and your Identity Provider. By the end of this guide, users from your Identity Provider should be able to login and register to Joomla site.

Download of Plugin


Get this plugin
Joomla SAML Single Sign-On (SSO) SP

Configuration Support and Free Trial

If you want support in configuring the plugin, or to integrate Shibboleth2 with Joomla, click on Free Configuration Setup button.

We provide a 7 day full feature trial wherein you can fully test out all the features of the plugin, click on Free Business Trial button.

Free Configuration Setup
Free Business Trial

Steps to Integration Shibboleth2 Single Sign-On (SSO) with Joomla SAML SP

1. 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

2. Configure Joomla as Service Provider


  • In Joomla SAML plugin, go to Service Provider Setup Tab. There are three ways to configure the plugin:

      SAML SSO Single-Sign-On By Metadata URL :

      • Click on Upload IDP Metadata.
        • Joomla Single Sign On SSO SAML SP, Upload Metadata
      • Enter Metadata URL (Copy from IDP app) and click on Fetch Metadata.
        • Joomla Single Sign On SSO SAML SP, Upload Metadata URL

      SAML SSO Single-Sign-On By Uploading Metadata File:

      • Click on Upload IDP Metadata.
      • Choose metadata file and click on Upload.
        • Joomla Single Sign On SSO SAML SP, Upload Metadata file

      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 Service 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 Service URL SAML Single-Sign-On Endpoint URL in the Federation Metadata document
        X.509 Certificate x.509 Certificate in the Federation Metadata document

      SAML SSO Single-Sign-On Add a button on your site login page with the following URL:

        Joomla Single Sign On SSO SAML SP, Signin Settings
  • In Joomla SAML plugin, go to Service Provider Setup Tab. There are three ways to configure the plugin:

      Azure_As_Idp By Metadata URL :

      • Click on Upload IDP Metadata.
        • Joomla Single Sign On SSO SAML SP, Upload Metadata
      • Enter Metadata URL (Copy from IDP app) and click on Fetch Metadata.
        • Joomla Single Sign On SSO SAML SP, Upload Metadata URL

      Azure_As_Idp By Uploading Metadata File:

      • Click on Upload IDP Metadata.
      • Choose metadata file and click on Upload.
        • Joomla Single Sign On SSO SAML SP, Upload Metadata file

      Azure_As_Idp 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 Service 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 Service URL SAML Single-Sign-On Endpoint URL in the Federation Metadata document
        X.509 Certificate x.509 Certificate in the Federation Metadata document

      Azure_As_Idp Add a button on your site login page with the following URL:

      Joomla Single Sign On SSO SAML SP, Signin Settings

3. Attribute Mapping (It is Optional to fill this). This is 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 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)
    Group/Role: Name of the Role attribute from Identity Provider(IdP)
  • You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.

4. Group Mapping (It is Optional to fill this). This is Premium feature.

  • 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.

5. Redirection & SSO Links

  • 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.
    • Joomla Single Sign On SSO SAML SP Signin Settings

    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 .

Recommended Add-Ons

User Sync SCIM Provisioning

Synchronize users, groups & directory with SCIM & REST APIs for Server.




Know More

Page Restriction

Page Restriction plugin restricts Joomla pages (Articles) based on User Roles and User's Login Status.



Know More

Integrate with Community Builder Customer

Using this Add-on you would be mapping the user details into the CB's comprofilers fields table which contains the values.


Know More

Additional Resources.

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.

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