SAML Single Sign-On (SSO) For DotNetNuke Sites Using Keycloak As IDP

Step 1: Add module on DNN page

• Open any of the page on your DNN site (Edit mode) and Click on Add Module.


• Search for DNNSAMLSSO and click on the DNNSAMLSSO. Drag and drop the module on the page where you want.


• You have finished with the Installation of the module on your DNN site.

Step 2: Configure Keycloak as Identity Provider

Follow the steps below to configure Keycloak as 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 in Keycloak:

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.

 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 3: Configure DotNetNuke SAML Module as Service Provider

• After configuring your Identity Provider, it will provide you with IDP Entity ID, IDP Single Sign On URL and x.509 Certificate. Configure these values under IDP Entity ID, Single Sign-On Url and SAML X509 Certificate fields respectively. (Refer to the Metadata provided by Identity Provider)
• Click Update to Save your IDP details.

Step 4: Test Configuration

• Click on the Test Configuration button to test the configuration.

Step 5: Adding Login Widget on DNN Page

• For Adding Button on the DNN page on beside the module settings click on the Add Item (Pencil Icon).


• Add Button name and Description for item and click on Save.


• You can see login button on the page after saving item. (If you are already logged in your site, you will see a "Logout" link).
• Note: If you want to Enable this button on every page of the DNN site follow below steps:
• Go to the Settings >> Module Settings >> Advanced Settings and Enable option for Display Module On All Page.



• Warning: You will lose all your configuration for the module after enabling this option. You can re-configure the module or it is better to enable this option before configuring the module.

Step 6: Attribute Mapping

• Attributes are user details that are stored in your Identity Provider.
• Attribute Mapping helps you to get user attributes from your IdP and map them to DotNetNuke user attributes like firstname, lastname etc.
• While auto registering the users in your DotNetNuke site these attributes will automatically get mapped to your DotNetNuke user details.
• Go to DNNSAMLSSO Settings >> Advanced settings >> Attribute Mapping.

Step 7: Role mapping (It is Optional to fill this)

• DotNetNuke uses a concept of Roles, designed to give the site owner the ability to control what users can and cannot do within the site.
• DotNetNuke has five pre-defined roles: Administrators, Subscribers, Registered Users, Translator (en-US) and Unverified Users.
• Role mapping helps you to assign specific roles to users of a certain group in your IdP.
• While auto registering, the users are assigned roles based on the group they are mapped to.