Search Results :

×
Sign Up Contact Us

Keycloak SAML SSO into TYPO3 (Single Sign-On) | TYPO3 Keycloak SSO | Login using Keycloak

Keycloak SAML Single Sign-On (SSO) login for TYPO3 can be achieved by using our Typo3 SAML SP Single Sign-On (SSO) extension. Typo3 will be configurd as a SAML 2.0 compliant Service Provider as a result of our SSO solution, which will build trust between the Typo3 site and Keycloak SAML in order to securely authenticate and login users to the Typo3 site. Our Typo3 Single Sign-On (SSO) solution helps to secure Typo3 sites behind the SSO login so that users are authenticated using their Keycloak login credentials. Seamless support for advanced SSO features like Attribute / Custom Mapping, Role Mapping etc.

Here we will go through a guide to configure SAML Single Sign-On SSO login between Typo3 site and Keycloak SAML by considering Keycloak SAML as IdP (Identity Provider) and Typo3 as SP (Service Provider). Our Typo3 SAML extension SSO provides Unlimited user authentications from Keycloak SAML. To know more about other features we provide in you Typo3 SAML Single Sign-On (SSO) extension, you can click here.

Pre-requisites : Download And Installation

miniorange img Installing SAML extension in TYPO3


  • Use the below command to install the extension using composer:
    composer req miniorange/miniorange-saml
  • Now search for the "miniOrange SAML" in Installed extensions section and activate the extension by clicking on activate button.
    • Typo3 SAML SSO create frontend
  • After installation, click on the newly installed extension "miniOrange SAML SP extension" for TYPO3 SSO and login with your registered miniOrange credentials.
    • Typo3 miniorange OpenIDCconnect settings
  • After entering username and password you will require license key to proceed further if you are a premium customer. (You will get this key from the miniOrange team. After entering license key, you can activate the license and proceed further.)
    • miniorange license SAML login
  • If you are not a premium customer you can direcly login submitting miniOrange credentials.
  • After successful login, you can see the details related to your account.
    • Typo3 saml SSO create frontend
  • Now you are ready to configure your IdP. But, it's important to integrate frontend first.
  • Download the zip file of the SAML SP extension from TYPO3 marketplace
  • Go to your TYPO3 backend, and click on Extensions section at the left side of your screen.
  • Upload the zip file,as represented in the below image.
    • Typo3 SAML SSO setup guide upload plugin
  • Now search for the "miniOrange SAML" in Installed extensions section and activate the extension by clicking on activate button.
    • Typo3 SAML SSO create frontend
  • After installation, click on the newly installed extension "miniOrange SAML SP extension" for TYPO3 SSO and login with your registered miniOrange credentials.
    • Typo3 miniorange OpenIDCconnect settings
  • After entering username and password you will require license key to proceed further if you are a premium customer. (You will get this key from the miniOrange team. After entering license key, you can activate the license and proceed further.)
    • miniorange license SAML login
  • If you are not a premium customer you can direcly login submitting miniOrange credentials.
  • After successful login, you can see the details related to your account.
    • Typo3 saml SSO create frontend
  • Now you are ready to configure your IdP. But, it's important to integrate frontend first.

miniorange img Integrate extension with TYPO3

  • Click on the Pages from the left navigation.
  • Then you need to create a folder to store the frontend users in it by right clicking on the Home page and select New subpage.
    • Typo3 saml SSO create frontend
  • Select Folder type from the dropdown. Name the folder as Website Users.
    • Typo3 saml SSO create frontend
  • Go to the Behaviour tab and add Website Users (fe_users) and click on Save.
    • Typo3 saml SSO create frontend
  • If you see a hyphen sign in red on the created folder, it means that the folder is not enabled. You can then enable it by right clicking on that folder and clicking Enable.
  • You need to add two STANDARD pages within the HOME page. If you are using Premium Plugin you can create three pages.
  • Here we will consider Page Names as: FESAML, RESPONSE, LOGOUT (Logout is optional for premium customers).
  • To create a FESAML page, right click on Home page then select New subpage and select STANDARD type from dropdown.
    • Typo3 saml SSO create frontend
  • Add Page Title as FESAML and click Save.
    • Typo3 saml SSO create frontend
  • Then again Click on FESAML Page and click on Add content. Go to plugins and add FESAML Plugin and click on the Save.
    • Typo3 saml SSO create frontend
  • Navigate to plugin tab and select FESAML plugin. Add website users in Record Storage Page and save the settings.
    • Typo3 login add website users Typo3 login add website users
  • You can enable the FESAML page by right clicking and selecting Enable option.
    • Typo3 saml SSO create frontend
  • If you need to make changes in URL segment, which will also be your initial SSO URL, right click on FESAML page, select edit and click on "toggle URL" button to set URL according to your way.
  • Follow the same steps to create and configure Standard pages of Response.
  • Ensure you will be selecting Response Plugin for Response page.
  • Keep the FESAML and RESPONSE page urls handy as you will need them while configuring the SAML SP.

Steps to configure Keycloak SAML SAML Single Sign-On (SSO) Login into Typo3

1. Setup Keycloak SAML as IdP (Identity Provider)

Follow the steps below to configure Keycloak SAML as IdP for Typo3

miniorange img Configure Keycloak SAML as IdP
  • Select the realm you want to use in the Keycloak Admin console.
  • To create a new client/application, go to the left menu and select Clients, then Create.
    • Creating an APP - Keycloak SAML Single Sign-On(SSO) for Typo3
  • From the "Service Provider Metadata" Tab, select SP-EntityID / Issuer as the Client ID and SAML as the Client Protocol.
    • Typo3 Keycloak SAML Single Sign-On(SSO) Add Client
  • Now click on Save.
  • Configure Keycloak by providing the required details:
    • 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
    Keycloak SAML Single Sign-On(SSO) for Typo3 Keycloak Typo3 SSO Login Keycloak Typo3 SSO Login Settings
  • Under Fine Grain SAML Endpoint Configuration, Enter the following details:
    • Assertion Consumer Service POST Binding URL The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
    Logout Service Redirect Binding URL (Optional) The Single Logout URL from the plugin's Service Provider Metadata tab
    Keycloak SAML Single Sign-On(SSO) for Typo3 - Keycloak Typo3 SSO Login
  • Click on Save.

miniorange img  Add Mappers

  • Go to the Mappers tab and press the Add Builtin button.
    • Keycloak Login - Mappers Tab Keycloak Typo3 SSO Login
  • Enable the checkboxes of X500 givenName, X500 surname and X500 email attributes.
    • SAML Keycloak Login Add built-in protocol mapper Keycloak SAML Single Sign-On(SSO) for Typo3
  • Click on Add Selected button. You will see the mappings that are added below.
    • Keycloak SSO Add Selected Keycloak SAML Single Sign-On(SSO) for Typo3

miniorange img Download setup file

  • Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.
    • JBoss Keycloak SSO Keycloak SAML Single Sign-On(SSO)
  • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.

    • You have successfully configured Keycloak as SAML IdP ( Identity Provider) for achieving Keycloak login / Keycloak SSO / Keycloak Single Sign-On (SSO), ensuring secure Login into Typo3 Site.

2. Configure Typo3 as SP (Service Provider)

  • In Typo3 SSO extension, go to the SP settings tab and enter Fesaml Plugin Page URL, Response Page URL, ACS URL, Entity ID and all other required details.
    • Typo3 SAML SSO Single Sign-On(SSO) SP settings
  • Now, go to the IdP settings tab of the extension. There are two ways to configure the Typo3 SSO extension.

    • A. By uploading IDP metadata:

  • Enter the Identity Provider Name
  • Click on Upload IDP metadata button.
  • You can either upload a metadata file and click on Upload button or use a metadata URL to fetch the metadata.
    • Typo3 SAML Single Sign-On(SSO) upload metadata

    B. 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 extension.
    • IdP Entity ID or Issuer SAML Entity ID obtained from the IdP
    Single Sign-On Service URL SAML Single-Sign-On Endpoint URL obtained from the IdP
    X.509 Certificate x.509 Certificate obtained from the IdP
  • Click on Save button to save all your settings.
    • Typo3 SAML SSO Single Sign-On(SSO) Login in Typo3 Save IdP settings
  • To check if your Typo3 as SP is configured correctly, click the Test Configuration button.
    • Test configuration for typo3 saml SSO extension

3. Attribute / Custom Mapping (Optional). *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 Typo3 user attributes like firstname, lastname and so on.
  • While auto registering the users in your Typo3 site these attributes will automatically get mapped to your Typo3 user details.
  • Only NameID can be mapped to Typo3 Email and Username characteristics with the free extension. Multiple user attributes from the IdP, on the other hand, can be mapped to Typo3 attributes in the premium version of the extension. You can map custom attributes that you've added to your IdP in addition to the default attributes.
  • When a user performs SSO, the NameID value sent by the IdP will get mapped to the email and the username of the Typo3 user.
    • Login in typo3 attribute mapping typo3 SAML SSO
  • 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 (Optional). *This is Premium feature.

  • You can specify a default Group in the free extension that will be allocated to all non-admin users when they conduct SSO.
  • Go to Group mapping tab and navigate to Group Mapping section.
  • Select the Default Group and click on the Save button.
    • Typo3 SAML SSO Single Sign-On(SSO) Login in Typo3 - Group mapping

In this Guide, you have successfully configured Keycloak SAML SAML Single Sign-On (Keycloak SAML SSO Login) choosing Keycloak SAML as IdP and Typo3 as SP using Typo3 SAML Single Sign-On (SSO) extension .This solution ensures that you are ready to roll out secure access to your Typo3 site using Keycloak SAML login credentials within minutes.

Additional Resources


If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com

Hello there!

Need Help? We are right here!

support