Guide to Configure Keycloak as IDP and WordPress as SP

WordPress SAML SP Single Sign-On plugin gives the ability to enable SAML Single Sign-On for your Wordpress sites. Our plugin is compatible with all the SAML compliant Identity providers. Here we will go through a step-by-step guide to configure SSO between Wordpress site and Keycloak by considering Keycloak as IdP.

miniorange img Pre-requisites : Download And Installation

To configure Keycloak with Wordpress, you will need to install the miniOrange WP SAML SP SSO plugin:

Step-by-step Video to Setup SSO between WordPress and Keycloak

Step 1: Configure Keycloak as IDP

Follow the steps below to configure Keyclock as an Identity Provider

miniorange img Setup IDP

In the miniOrange SAML SP SSO plugin, navigate to Service Provider Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the Identity Provider.

In your Keycloak admin console, select the realm that you want to use.
Click on Clients from the left menu and then click on Create button to create a new client/application.

Enter Client ID as the SP-EntityID / Issuer from the Service Provider Metadata and select SAML as the Client Protocol.

Now click on Save.
Configure the following in Keycloak:

Client ID	The SP-EntityID / Issuer from the plugin's Service Provider Metadata tab
Name	Provide a name for this client
Description	Provide a description
Name ID Format	Email
Root URL	Leave empty or Base URL of Service Provider
Valid Redirect URIs	The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab

Under Fine Grain SAML Endpoint Configuration, configure the following:

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

Click on Save.

Add Mappers

Go to Mappers tab and click on Add Builtin button.

Check the boxes of X500 givenName, X500 surname and X500 email attributes.

Click on Add Selected button. You will see the mappings as shown in the photo below.

miniorange img Download setup file

Go to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as endpoints in the General Tab.

Note the URL and keep it handy. Here you can find the information which will be used to configure the plugin.

Step 2: Configuring WordPress as SP

We will go through the steps to setup WordPress as a Service Provider. Here, we will be adding the IdP metadata to configure the plugin.

Free

In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

Click on Upload IDP metadata button.
Enter the Identity Provider Name
You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.

B.Manual Configuration:

Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.

Step 3: Attribute Mapping

In the free plugin, only NameID is supported for Email and Username attributes of the WordPress user.
When a user performs SSO, the NameID value sent by the IDP will get mapped to the email and username of the WordPress user.

Step 4: Role Mapping

In the free plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.
Go to Attribute/Role mapping tab and navigate to Role Mapping section.
Select the Default Role and click on the Save button.

Step 5: SSO settings

In the free plugin you can add a login widget to enable SP-Initiated SSO on your site.
Navigate to Redirection and SSO links tab and follow the given steps given under Option 1: Use a Widget to add a login widget on your site.

Standard

In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

Click on Upload IDP metadata button.
Enter the Identity Provider Name
You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.

B.Manual Configuration:

Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.

Step 3: Attribute Mapping

Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at WordPress.
In WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.

NOTE: If you click on Test Configuration button in Service Provider Setup tab and authenticate with your IDP, you can see a list of attributes sent by the IDP in the Attribute/Role mapping tab. This information can be used to provide the above mapping.

Step 4: Role Mapping

In the standard plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.

Go to Attribute/Role mapping tab and navigate to Role Mapping section.
Select the Default Role and click on the Save button.

Step 5: SSO settings

In the Standard plugin you can enable SP-initiated SSO using the following options.

Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication, they will be redirected back to the same page on your site which they were trying to access.

Steps:

Option 1: Auto- Redirection from site

Redirect to IdP if user not logged in [PROTECT COMPLETE SITE]

Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.

Steps:

Option 2: Auto- Redirection from WordPress Login

Redirect to IdP from WordPress Login Page

NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP.

SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Redirection and SSO Links tab > Option 3: SSO Links section of the plugin

Premium

In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

Click on Upload IDP metadata button.
Enter the Identity Provider Name
You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
In the Premium plugin, you can enable auto-sync for the metadata URL which will auto-update the plugin configuration as per the IDP metadata after a set interval of time

B.Manual Configuration:

Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.
In the Premium Plugin, you can provide the SAML Logout URL to achieve Single Logout on your WordPress site.

Step 3: Attribute Mapping

Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at WordPress.
In WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.

Custom Attribute Mapping: This feature allows you to map any attribute sent by the IDP to the usermeta table of WordPress.

Step 4: Role Mapping

This feature allows you to assign and manage roles of the users when they perform SSO. Along with the default WordPress roles, this is compatible with any custom roles as well.

From the Attribute Mapping section of the plugin, provide a mapping for the field named Group/Role. This attribute will contain the role related information sent by the IDP and will be used for Role Mapping.
Navigate to role mapping section and provide the mappings for the highlighted roles.

For example, If you want a user whose Group/Role attribute value is wp-editor to be assigned as an Editor in WordPress, just provide the mapping as wp-editor in the Editor field of Role Mapping section.

Step 5: SSO settings

In the Premium plugin you can enable SP-initiated SSO using the following options.

Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication they will be redirected back to the same page on your site which they were trying to access.

Steps:

Option 1 : Auto-Redirection from site

Redirect to IdP if user not logged in [PROTECT COMPLETE SITE]

Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.

Steps:

Option 2: Auto- Redirection from WordPress Login

Redirect to IdP from WordPress Login Page

NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP login.

Login Button: You can add a customized login button anywhere on your site or WordPress login page by navigating to Option 3: Login Button section of Redirection and SSO Links tab.

SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Option 4: SSO Links section of Redirection and SSO Links tab.

PrerequisiteDownload And Installation
Step 1Configure Keycloak as IdP
Step 2Setup WordPress as SP
Step 3Attribute Mapping
Step 4Role Mapping
Step 5SSO Settings

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

SAML Single Sign-On (SSO) for WordPress using Keycloak as IDP | Keycloak SSO

Step 1: Configure Keycloak as IDP

Step 2: Configuring WordPress as SP

Free

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO settings

Standard

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO settings

Steps:

Steps:

Premium

Step 3: Attribute Mapping

Step 4: Role Mapping

Step 5: SSO settings

Steps:

Steps:

Contents

STAY CONNECTED

Product

Solutions

Why miniorange

Company