SAML Single Sign-On (SSO) in RocketChat (SP) | TYPO3 – RocketChat SSO Login

RocketChat SAML Single Sign-On (SSO) with TYPO3 as SAML IdP . TYPO3 SAML IdP extenstion gives you the ability to use your TYPO3 credentials to login into RocketChat (SP). Here we will go through a step-by-step guide to configure SSO between RocketChat as SP (Service Provider) and TYPO3 as IDP (Identity Provider).

Pre-requisites: Download and Installation

1. Installing SAML IDP extension in TYPO3

• Download the zip file of the SAML IDP 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 or you can unzip the plugin zip into 'Typo3 root folder/typo3conf/ext' directory.

• Now search for the "miniOrange SAML IDP" in Installed extensions section and activate the extension by clicking on activate button.

• After installation, click on the newly installed extension "miniOrange SAML IDP extension" for TYPO3 SSO and login with your registered miniOrange credentials.
• 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.)
• 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.
• Now you are ready to configure your Service Provider. But, it's important to integrate frontend first.

2. Integrate extension with TYPO3

• Now you have to design your frontend by left clicking on the Home tab then click on New Subpage

• You need to add STANDARD page within the HOME page.
• Enter the Standard Page name as: FESAML.

• Click on FESAML Page and click on Add content. Go to plugins and add FESAML Plugin.

• Navigate to plugin tab and select FESAML plugin. Add website users in Record Storage Page and save the settings.

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

• Also, you must create at least one group as TYPO3 doesn’t allow to create users unless there’s one usergroup at least.
• To create group go to list tab from the left panel, click on Website users folder and hit the "+" button at the top of the screen.

• Now select Websiteuser group ? from the list.

• Insert Group Name in group title section and click on Save button at the top. User group will be created.

• You can also create a SSO button on login page. Click on Home, proceed to the +Content option.

• Switch to Special elements tab and select Plain HTML.

• Here what you will be doing is, you are adding SSO login button, URL in the button section will be of FESAML Standard Page.
• The code snippet to do so is mentioned in the given image. Enter the code and hit the Save button at the top.

• Now you can configure plugin in the backend.

Steps to configure RocketChat SAML Single Sign-on ( SSO ) Login into TYPO3

1. Configure TYPO3 as Identity Provider

• In the miniOrage SAML Identity Provider extension, go to SP Settings tab of the extension.
• Provide the required settings (i.e. Service provider name, SP Entity ID/Issuer, ACS URL, Relaystate) find to your Service Provider RocketChat and click on Save button to save your configuration.

2. Configure RocketChat as SP

• Go to TYPO3 IDP extension, navigateto the IDP Metadata tab. Click on Download XML Metadata button. Keep this XML file to configure your SP.

• Click on the left corner. Select Administration.



• Search for SAML under Administration tab.
• Enter the information into the corresponding fields.

Custom Provider	<name-of-your-app>
Custom Entry Point	Copy and paste the SAML Login URL from IDP Metadata tab
IDP SLO Redirect URL	Copy and paste the SAML Logout URL from IDP Metadata tab
Custom Issuer	https://<your-rocketchat-url>/_saml/metadata/<name-of-your-app>
Public Cert Contents	(a) Open the Public Cert Contents dropdown (b) Download the Certificate from IDP Metadata. Open it in notepad. Copy and paste the content here.
Signature Validation Type	Validate Either Signature
User Data Field Map	Open the User Data Field Map dropdown and enter the following attributes: {"username":"username", "email":"email", "name": "cn"}

Note: Custom Provider = <name of your app> e.g. my-app




• Once this is done, click on Enable and Save Changes.

3. SSO Testing

• Open a new browser or private incognito window and enter your RocketChat URL, which will redirect you to the TYPO3 login screen.
• Enter your TYPO3 credentials and click the log in button.
• If you are redirected to your RocketChat start page and successfully logged in, your configuration is correct.

Additional Resources

• What is Single Sign-On (SSO)?
• What is SAML?
• TYPO3 SAML Single Sign-On (SSO)
• TYPO3 OAuth Client Single Sign-On (SSO)
• Frequently Asked Questions (FAQs)

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