miniorange/miniorange-saml

Typo3 SAML Single Sign-On (SSO) extension allows your users to login to your Typo3 site by authenticating with their SAML 2.0 IdP (Identity Providers). SAML Authentication extension for Typo3 extension allows SSO with Azure AD, Azure AD B2C, Keycloak, ADFS, Okta, Shibboleth, Salesforce, GSuite / Goo

5.5.0 2024-08-21 12:19 UTC

Requires

• typo3/cms-core: ^10 || ^11 || ^12 || ^13

GPL-2.0-or-later

• miniOrange

README

This is a Typo3 extension from miniOrange Inc. for SAML Single Sign On SSO (Backend + Frontend). Feel free to point out any bugs or issues. For any query or to enable premium features, contact us through the support form in the extension itself. Also, you can email [e-mail] or visit https://www.miniorange.com/contact.

Installation Instructions:

1. Composer Installation:     Run the below command to install the extension:     - composer require miniorange/miniorange-saml

            OR

1. Manual Installation:     - Unzip the plugin zip into the typo3conf/ext folder, rename the plugin folder to sp and activate the extension from the Extensions section in Typo3.

Pre-requirements Before Configuring SP-Configurations

You must have atleast two pages before configuring the extension.

.. tip:: Pages can be created by the following steps:-

1. Navigate to the Pages section and create new standard page with name fesaml and add fesaml plugin to it.
2. Similarly create a page named response and and response plugin to it.
3. Create SSO Login button in your Typo3 Frontend Site and embed the fesaml page URL to it in order to initiate the SSO.

Service Provider Metadata Configurations

1. Once the extension is installed successfully, navigate to the SP settings tab and configure the fields as below:

   • Fesaml plugin page URL: {URL of the Fesaml standard page created in earlier steps}
   • Response plugin page URL: {URL of the Response standard page created in earlier steps}
   • Base URL: {Base URL of your Typo3 site}
   • ACS URL: {URL of the Response standard page created in earlier steps}
   • Issuer/Entity ID: {Base URL of your Typo3 site}

2. Once you save the above details, you can download the SP XML Metadata or you can use XML Metadata URL to upload it in your Identity Provider or you can upload it manually.

3. You can choose the setup guide specific to your Identity Provider from below link: https://plugins.miniorange.com/typo3-saml-sso-setup-guides

Identity Provider Metadata Configurations (Using XML Metadata)

1. Either download the IDP Metadata file or copy the IDP Metadata URL from your Identity Provider
2. Navigate to the IDP Settings tab of the plugin and click on Upload IDP Metadata button
3. Add the name of your Identity Provider.
4. add the downloaded IDP Metadata file or paste the IDP Metadata URL copied from your Identity Provider and save it.
5. Once you save the settings all the Metadata details will be fetched automatically.

OR

Identity Provider Metadata Configurations (Manually)

1. Identity Provider Name: {Add your Identity Provider Name}
2. IDP Entity ID: {Add your Identity Provider Entity ID}
3. SAML Login URL: {Add your Identity Provider Single Sign On Service URL}
4. SAML x509 Certificate: {Add your Identity Provider x509 certificate}
5. Once you configure both Identity Provider and Service Provider Metadata, click the Test Configuration button to check if the configurations are made correctly.

Default Group Mapping

1. Navigate to the Group Mapping tab of the plugin, select the default group to be assigned to the new users in Typo3 and save the settings.

2. Once you have done all the above steps, you are ready to test the SSO. You can use your Fesaml Page URL in order to initiate the SSO.

• If you are looking for anything which you cannot find, please drop us an email on [e-mail]