Extension Installation

composer req miniorange/keycloak_sso

Using zip file:

Download the zip file of the Keycloak SSO 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.

Pre-requirements Before Configuring Extension

You must have atleast two pages before configuring the extension.

• Navigate to the Pages section and create new standard page with name feoidc and add feoidc plugin to it.
• Similarly create a page named response and and response plugin to it.
• You can refer to the below screenshots for the same.

Extension Configurations

• Once the extension is installed successfully, navigate to the OpenID Connect Client tab of the plugin and fill in all the required fields as below:

- OAuth/ OpenID Provider Name: {Name of your provider (e.g., Keycloak)}

• Application type: OAuth/OpenID Connect
• Frontend Redirect/Callback Url : {Response Plugin Page URL which you created in earlier steps} (You will need to provide this URL to your OAuth/OIDC provider i.e., Keycloak)
• feoidc page URL: {feoidc Plugin Page URL which you created in earlier steps}
• Client ID : {You will get it from your provider, i.e., keycloak}
• Client Secret : {You will get it from your provider, i.e., keycloak}
• Scope : openid profile email
• Authorization Endpoint : <Keycloak base URL>/realms/{realm-name}/protocol/openid-connect/auth
• Token Endpoint : <Keycloak base URL>/realms/{realm-name}/protocol/openid-connect/token
• User Info Endpoint : <Keycloak base URL>/realms/{realm-name}/protocol/openid-connect
• Set client credentials in : Header/Body

• Provide the redirect/callback URL in your Keyclaok application by copying it from Frontend Redirect/Callback Url field in OpenID Connect Client tab.

• Once you are done with the configurations on both ends (i.e., Typo3 and Keycloak), click on the Test Configuration button in the OpenID Connect Client tab of the plugin and check if you are able to test it successfully.

• Navigate to the Attribute Mapping tab and map the Username attribute to the keycloak attribute using which you want to identify the users in Typo3 (you can find all the attributes received from keycloak in the test configuration).

• Navigate to the Group Mapping tab of the plugin and save the Group Mapping for Frontend Users by selecting the Default Usergroup.

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

You can refer to the below guide link for more information: https://plugins.miniorange.com/keycloak-single-sign-on-typo3-sso-oauth-openid-connect

Installation

• How should the extension be installed?
• Are they dependencies to resolve?
• Is it a static template file to be included?

To install the extension, perform the following steps:

1. Go to the Extension Manager
2. Install the extension
3. Load the static template
4. ...

For a list of configuration options, using a definition list is recommended:

Some Configuration

This option enables...

Other configuration

This other option is for all the rest...

Configuration

• Where and how the extension should be configured? TypoScript? PHP?
• Are there other prerequisite to full fill beforehand? For example, configure a setting in a special way somewhere.

FAQ

Possible subsection: FAQ

What does it do?

This chapter should give a brief overview of the extension. What does it do? What problems does it solve? Who is interested in this? Basically, this section includes everything people need to know to decide whether they should go on with this extension or not.

Screenshots

This chapter should help people figure how the extension works. Remove it if not relevant.