Search Results :

×
Meet us at WordCamp Europe | ShopTalk | DrupalCon Conferences to explore our solutions. Know More

JBoss Keycloak SAML Single Sign-On (SSO) into Joomla

miniOrange Joomla SAML SP SSO plugin helps you to integrate your Joomla site to Keycloak using SAML 2.0 protocol. Our user-friendly plugin simplifies the process of setting up Single Sign-on (SSO) with Keycloak in Joomla, ensuring a secure login experience. This enables users to access various Joomla sites effortlessly using their Keycloak 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 Keycloak, with Keycloak 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. For example, after users log in to your Joomla site, they can automatically access all resources of the Joomla site. 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.
In this context, the system responsible for authenticating users is referred to as the Identity Provider (IDP), while the system relying on the Identity Provider for authentication is known as the Service Provider (SP). When a user initiates a login attempt, the Service Provider sends a SAML request to the Identity Provider. Upon successful IDP authentication, SAML assertions containing user information are transmitted back to the Service Provider. Subsequently, the Service Provider receives the assertion, verifies it based on the Identity Provider configuration, and grants the user access to your Joomla website.

Pre-requisites: Download And Installation

Download

Download Plugin

Setup Video

Setup Video

Free Trial

Free Demo Trial

Steps to Integrate Keycloak Single Sign-On (SSO) with Joomla SAML SP

1. Setup Joomla SAML SP plugin

  • Download the zip file for the miniOrange SAML SP plugin for Joomla.
  • 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.
    • Install the SAML SP Plugin from your computer
  • Installation of plugin is successful. Now click on Get Started!
    • 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 Jboss Keycloak as IdP


  • In your Keycloak admin console, select the realm that you want to use.
    • Keycloak SAML Single Sign-On into Joomla | Login using Jboss keycloak , Joomla Jboss Keycloak configuration
  • Click on the Clients from the left navigation bar.
  • Click on create client and enter the following values to create a client.
    Client ID SP-EntityID/Issuer from Service Provider Metadata
    • Jboss Keycloak SSO , Joomla Jboss Keycloak new client application Keycloak SAML Single Sign-On into Joomla, new client/application Jboss Keycloak SSO , Joomla Jboss Keycloak new client application
  • Click on Save.
  • Configure the following:
    Client ID The SP-EntityID / Issuer from Service Provider Metadata
    NameProvide a name for this client (Eg. Joomla)
    Description (optional)Provide a description
    EnabledON
    Consent RequiredOFF
    Client ProtocolSAML
    Include AuthnStatementNO
    Sign DocumentsNO
    Optimize Redirect signing key lookupOFF
    Sign AssertionsNO
    Signature AlgorithmRSA_SHA256
    Encrypt AssertionOFF
    Client Signature RequiredOFF
    Client Signature RequiredEXCLUSIVE
    Force Name ID FormatNO
    Name ID FormatEmail
    Root URLLeave empty or Base URL of Service Provider
    Valid Redirect URIsThe ACS (Assertion Consumer Service) URL from Service Provider Metadata
  • Under Advanced -> Fine Grain SAML Endpoint Configuration, configure the following:
    Assertion Consumer Service POST Binding URLThe ACS (Assertion Consumer Service) URL from Service Provider Metadata
    Logout Service Redirect Binding URLThe Single Logout URL from Service Provider Metadata
    Keycloak SAML Single Sign-On into Joomla, Jboss Keycloak user tab
  • Click on Save.

keycloak, Joomla Jboss Keycloak Saml Endpoint Add Mappers

  • Go to the Mappers tab, and click on Add predefined mapper.
    • https://plugins.miniorange.com/wp-content/uploads/2023/02/keycloak-mappers.webp

miniorange  Add User

  • Click on the Users from the left nav bar.
  • Add a crteate New users.
    • Keycloak SAML Single Sign-On into Joomla, Jboss Keycloak user tab
  • Enter the username, valid email address and check on User Enabled then enter First name & Last name.
  • Click on Create button.
    • Keycloak SAML Single Sign-On into Joomla, Joomla Jboss Keycloak User Enabled
  • Click on the Realm Settings from the left nav bar and open SAML 2.0 Identity Provider Metadata.
    • keycloak single-sign-on-sso,Jboss keycloak Realm Setting

    OR

  • Go to, https://<YOUR_DOMAIN>/auth/realms/{YOUR_REALM}/protocol/saml/descriptor.These will open an XML in the browser.
    • Keycloak SAML Single Sign-On into Joomla, Jboss keycloak XML browser
  • In miniOrange’s Joomla SAML SP plugin, go to Service Provider Setup Tab. Enter the following values:
    • Identity Provider Name Provide an Identity Provider name (For Example: Keycloak).
    IdP Entity ID or IssuerSearch for the entityID from IDP Metadata.Enter the Value in the Entity ID textbox.
    SAML Login URLSearch for SingleSignOnService Binding ”urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect” from IDP Metadata.Enter the location value in the SAML Login URL textbox.
    SAML Logout URL (Optional)Search for SingleLogoutService Binding”urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect” from IDP Metadata.Enter the location value in the SAML Login URL textbox.
    X.509 Certificate (Optional)Search for the X.509 Certificate from IDP Metadata.Enter the tag value in Certificate textbox.
    Enable login with SAMLChecked
    Signed SSO and SLO RequestsUnchecked

  • In your Keycloak admin console, select the realm that you want to use.
    • Azure AD user sync with Joomla - Home Screen
  • Click on Clients from the left menu and then click on Import client .
    • Setup ldap guide on window server - Directory-service
  • Go to service provider Metadata tab and Download the XML File.
    • Setup ldap guide on window server - default-setting
  • Click on Browse tab,then Enter Name description (as per your choice)then click on save button.
    • Setup ldap guide on window server - default-setting
  • Go to Client scope and recently added Client scope .
    • Setup ldap guide on window server - NetBIOS Domain
  • Go to the Mappers tab, and click on Add predefined mapper.
    • Setup ldap guide on window server - AD-Ds-database
  • Click the mappers as shown in click on Add Button.
    • Setup ldap guide on window server - ldap server
  • Click on Realm setting from the left menu and then click on Saml 2.0 Identity Provider Metadata.
    • Setup ldap guide on window server - again-install
  • Copy The URL,and Navigate back to miniorange SAML Plugin and go to service Provider setup tab,then click on Upload Metadata file and paste on enter metadata Url and Click on Fetch Metadata.
    • Setup ldap guide on window server - again-install

3. 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 Uploading Metadata File:

  • In Joomla SAML plugin, go to Service Provider Setup tab, then click on Upload IDP metadata.
    • Upload IDP Metadata

SAML SSO Single-Sign-On By Metadata URL:

  • Enter Metadata URL (Copy from IDP app) 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 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
  • Once the test configuration is successful you will get the following window.
    • Test configuration
  • Congratulations we have successfully configured Joomla SAML Service Provider.

4. Attribute Mapping - 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, 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

    Joomla SAML Attribute Mapping
  • You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.

Step 5. Group Mapping - This is 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.
    • Joomla SAML SSO Group Mapping

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 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.
    • Joomla Single Sign On SSO SAML SP Signin Settings
  • Click on the Upgrade Plans tab to check out our complete list of features and various licensing plans. OR you can click here to check features and licensing plans.
  • If you want to purchase any of the paid version of the plugin, you have to register/login with us in Account Setup tab. OR you can register/login here.
  • 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.

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.

Trending searches:
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