Authenticate Keycloak Single Sign-On (SSO) with WordPress OAuth

Set up Single Sign-On (SSO) on your WordPress website via Keycloak WordPress SSO with the WP OAuth & OpenID Connect Single Sign-On plugin. Implementing WordPress SSO using Keycloak allows users to log into your websites and applications with a single set of credentials using the Keycloak SSO OAuth provider.

Keycloak, acts as the OAuth Provider, and WordPress act as the OAuth Client. WordPress Keycloak SSO provides smooth login between WordPress and Keycloak using login with Keycloak SSO with a single click. The WordPress SSO plugin also provides advanced Keycloak SSO features like user profile attribute mapping, role mapping, and providing site access based on organization email domains. You can also protect your complete WordPress site behind SSO. Keycloak WordPress OAuth SSO plugin secures the user’s login process and improves user authentication using Keycloak WordPress SSO. Follow the steps in the guide below to Setup Your WordPress SSO via installing this plugin.

Pre-requisites : Download And Installation

• Log into your WordPress instance as an admin.
• Go to the WordPress Dashboard -> Plugins and click on Add New.
• Search for a WordPress OAuth Single Sign-On (SSO) plugin and click on Install Now.
• Once installed click on Activate.

• First of all, Download Keycloak and install it.
• Start the keycloak server based on your keycloak version. (See table below)

Step 1: Setup Keycloak as IdP(Identity Provider)

Follow the following steps to configure Keycloak as IdP to achieve WordPress Keycloak SSO

 Configure Keycloak as IdP

• Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Add Realm option.


• Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the OAuth Client plugin. Click on CREATE to add realm.


• Create OpenID client: Click on the Clients and choose create to create a new client. Enter client id and select client protocol openeid-connect and select Save.


• Change Access type: After client is created change its access type to confidential.


• Enter Valid Redirect URIs: Copy callback URL from plugin and then click on SAVE. Ex -- https:///oauth/callback


• Get Client Secret: Now we need to get client secret. So select Clients and select credentials and copy your secret from here.


• Plugin Configuration: Enter copied Client Secret under Client secret field in the OAuth Client plugin, and enter the Client Name under the Client ID field.
• Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and choose to Add a new User.


• User Configuration: After user is created following action needs to be performed on it.
1) Setting a password for it so click on Credentials and set a new Password for the user.




NOTE : Disabling Temporary will make user password permanent.

• Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles and clicking on add selected.


• Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Add Role.



Step 1.1: Steps to fetch Keycloak Groups [Premium]

• Create groups: Click on the Groups and choose New to create a new group.


• Assign user to group: Select the user whom you want to add in group. Choose Groups option from tab and then select the group-name and click on join.


• Keycloak Group Mapper: Now to get group details we need to perform its client mapping with group membership else group details will not be fetched. So in Client section, select your client and then click on mapper->create.



• Now, select mapper type as Group Membership and enter the name and token claim name i.e the attribute name corresponding to which groups will be fetched. Turn Off the full group path, Add to ID token and Add to access token options, and click on Save.



Note: -- If full path is on group path will be fetched else group name will be fetched.

Step 1.2: Steps to fetch Keycloak Roles [Premium]

• Keycloak Role Mapper: Now to get role details we need to perform its client mapping with role membership else role details will not be fetched. So in Client section, select your client and then click on mapper->create.



• Now, select mapper type as user realm Role Membership and enter the name. and token claim name i.e the attribute name corresponding to which groups will be fetched. Add to ID token and Add to access token options, and click on Save.


• Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Create Realm option.


• Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the OAuth Client plugin. Click on CREATE to add realm.


• Create OpenID client: Click on the Clients and choose Create Client to create a new client. Enter Client id and select client protocol openeid-connect and Click Next.



• Enable the Client Authentication and Authorization toggle.


• Scroll down to the Access settings and enter your Callback/Redirect URL which you will get from your miniOrange plugin present on your Client side under the CallBack URLs text-field.


• Go to the Credentials tab, copy the Client Secret and keep it handy as we will require it later while configuring WordPress OAuth Single Sign-On plugin.


• Plugin Configuration: Enter copied Client Secret under Client secret field in the OAuth Client plugin, and enter the Client ID under the Client ID field.
• Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and Click on Create new user to Add a new User.


• User Configuration: After user is created following action needs to be performed on it.
1) Setting a password for it so click on Credentials and set a new Password for the user.




NOTE : Disabling Temporary will make user password permanent.

• Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles.


• Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Create Role.


• Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Create Realm option.


• Create realm: Enter Realm Name and keep the realm name handy as it will required later to configure the Realm under the OAuth Client plugin. Click on CREATE to add realm.


• Create OpenID client: Click on the Clients and choose Create Client to create a new client. Enter Client id and select client protocol openeid-connect and Click Next.



• Enable the Client Authentication and Authorization toggle.


• Scroll down to the Access settings and enter your Callback/Redirect URL which you will get from your miniOrange plugin present on your Client side under the CallBack URLs text-field.


• Go to the Credentials tab, copy the Client Secret and keep it handy as we will require it later while configuring WordPress OAuth Single Sign-On plugin.


• Plugin Configuration: Enter copied Client Secret under Client secret field in the OAuth Client plugin, and enter the Client ID under the Client ID field.
• Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and Click on Create new user to Add a new User.


• User Configuration: After user is created following action needs to be performed on it.
1) Setting a password for it so click on Credentials and set a new Password for the user.




NOTE : Disabling Temporary will make user password permanent.

• Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles.

Step 2: Setup WordPress as OAuth Client

• Free
• Premium

• Go to Configure OAuth tab and click Add New Application to add a new client application into your website.

• Choose your Application from the list of OAuth / OpenID Connect Providers, Here Keycloak

• After selecting the provider copy the Callback URL which needs to be configured in OAuth Provider's SSO application Configuration.
• Client Credentials like Client ID & Client Secret which you will get from the Keycloak SSO application.
• Configure Domain Name & Realm found from the Keycloak SSO application. For the Scopes & Endpoints click here.

Note: -- The domain name would be the domain of the machine where your keycloak is running followed by the port number, for e.g if your keycloak is running on localhost then the domain would be http://localhost:8080.

• Click on Next.

• Click on Finish to save the configuration.

In conclusion , You have successfully configured WordPress as OAuth Client, for achieving Keycloak Single Sign-On (SSO) with WordPress for user authentication.

• Go to Configure OAuth tab and search your application name to add a new client application into your website, Here Keycloak.

• Configure App Name, Client ID, Client Secret, Domain Name & Realm from Keycloak SSO application.

Note: -- The domain name would be the domain of the machine where your keycloak is running followed by the port number, for e.g if your keycloak is running on localhost then the domain would be http://localhost:8080.


• Choose your Grant Type from the list of options & Click on Save Settings to save the configuration..

In conclusion , You have successfully configured WordPress as OAuth Client, for achieving Keycloak Single Sign-On (SSO) with WordPress for user authentication.

Step 3: User Attribute Mapping

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration.
• You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.


• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.

Step 4: Role Mapping [Premium]

• Click on “Test Configuration” and you will get the list of Attribute Names and Attribute Values that are sent by your OAuth provider.
• From the Test Configuration window, map the Attribute Names in the Attribute Mapping section of the plugin. Refer to the screenshot for more details.


• Enable Role Mapping: To enable Role Mapping, you need to map Group Name Attribute. Select the attribute name from the list of attributes which returns the roles from your provider application.
  Eg: Role



• Assign WordPress role to the Provider role: Based on your provider application, you can allocate the WordPress role to your provider roles. It can be a student, teacher, administrator or any other depending on your application. Add the provider roles under Group Attribute Value and assign the required WordPress role in front of it under WordPress Role.
  
  For example, in the below image. Teacher has been assigned the role of Administrator & Student is assigned the role of Subscriber.


• Once you save the mapping, the provider role will be assigned the WordPress administrator role after SSO.
  Example: As per the given example, Users with role ‘teacher’ will be added as Administrator in WordPress and ‘student’ will be added as Subscriber.

Step 5: Sign In Settings

• The settings in Single Sign-On (SSO) Settings tab define the user experience for Single Sign-On (SSO). To add a Keycloak login widget on your WordPress page, you need to follow the below steps.

Sign in settings for WordPress 5.7 and before

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.



Sign in settings for WordPress 5.8

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.


• Open your WordPress page and you can see the Keycloak SSO login button there. You can test the Keycloak Single Sign-On (SSO) - Keycloak OAuth now.

Sign in settings for WordPress 5.9

• Make sure the "Show on login page" option is enabled for your application. (Refer to the below image)


• Now, go to your WordPress Login page. (Eg. https://< your-wordpress-domain >/wp-login.php)
• You will see an Keycloak SSO login button there. Once you click the login button, you will be able to test the Keycloak Single Sign-On (SSO) - Keycloak OAuth.