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

DotNetNuke SAML SP Single Sign-On (SSO) module gives the ability to enable SAML Single Sign-On for your DotNetNuke applications. Using Single Sign-On you can use only one password to access your DotNetNuke application and services. Our module is compatible with all the SAML compliant identity providers. Here we will go through a step-by-step guide to configure Single Sign-On (SSO) between DotNetNuke and Keycloak considering Keycloak as IdP.

Pre-requisites : Download And Installation

  • Download the package for DNN SAML Single Sign-On (SSO) module.
  • Upload the installation package dnn-saml-single-sign-on_xxx_Install by going in Settings > Extension > Install Extension.

Steps to configure DNN Single Sign-On (SSO) using Keycloak as IDP

1. Add module on DNN page

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

  • DNN SAML SSO - Add Module
  • Search for DNNSAMLSSO and click on the DNNSAMLSSO. Drag and drop the module on the page where you want.

  • DNN SAML SSO - Search Module
  • You have finished with the Installation of the module on your DNN site.
  • 2. Setup Keycloak as Identity Provider

    • Select your identity provider Keycloak from the list shown below.
    • DNN SAML SSO - Search Module
    • There are two ways detailed below with which you can get the SAML SP metadata to configure onto your identity provider end.
    • A] Using SAML metadata URL or metadata file:
      • Under Service Provider Settings, you can find the metadata URL as well as the option to download the SAML metadata.
      • Copy metadata URL or download the metadata file to configure the same on your identity provider end.
      • You may refer to the screenshot below:
      • DNN SAML SSO - Copy Downloaded Metadata
      B] Uploading metadata manually:
      • Under the Service Provider Settings section, you can manually copy the service provider metadata like Base URL, SP Entity ID, ACS URL and share it with your identity provider for configuration.
      • You may refer to the screenshot below:
      • DNN SAML SSO - Manual Metadata
    • 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.
    • DNN SAML SSO - Creating an App
    • Enter SP-EntityID / Issuer as the Client ID from the "Service Provider Metadata" Tab and select SAML as the Client Protocol.
    • DNN SAML SSO - Add Client
    • Now click on Save.
    • Configure Keycloak by providing the required details:
    • 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
      Client Signature Required OFF
      Force POST Binding OFF
      Force Name ID Format OFF
      Name ID Format Email
      Root URL Leave empty or Provide Base URL from Service Provider Metadata tab
      Valid Redirect URIs The ACS (Assertion Consumer Service) URL from the plugin's Service Provider Metadata tab
      DNN SAML SSO - Keycloak Login Settings DNN SAML SSO - Keycloak Login Settings
    • Under Fine Grain SAML Endpoint Configuration, Enter the following details:
    • 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
      DNN SAML SSO - Login SAML Endpoint Configuration
    • Click on Save.

    DNN SAML SSO - miniorange logo  Add Mappers

    • Navigate to Mappers tab and click on Add Builtin button.
    • DNN SAML SSO - Keycloak Login - Mappers Tab
    • Select the checkboxes of X500 givenName, X500 surname and X500 email attributes.
    • DNN SAML SSO - Keycloak Login - Add built-in Protocol Mapper
    • Click on Add Selected button. You will see the mappings that are added below.
    • DNN SAML SSO - Keycloak Login - Add Selected

    DNN SAML SSO - miniorange logo Download setup file

    • Navigate to Realm Settings, click on SAML 2.0 Identity Provider Metadata mentioned as Endpoints in the General Tab.
    • DNN SAML SSO - Keycloak Metadata
    • Note the URL and keep it handy. That will provide you with the Endpoints required to configure the plugin.
    • You have successfully configured Keycloak as SAML IdP (Identity Provider) for achieving Keycloak login / Keycloak SSO / Keycloak Single Sign-On (SSO), ensuring secure Login into DotNetNuke (DNN) Site.

    3. Configure DotNetNuke SAML Module as Service Provider

    There are two ways detailed below with which you can configure your SAML identity provider metadata in the module.

    A] Upload metadata using the Upload IDP Metadata button:
    • If your identity provider has provided you with the metadata URL or metadata file (.xml format only), then you can simply configure the identity provider metadata in the module using the Upload IDP Metadata option.
    • You may refer to the screenshot below:
    • DNN SAML SSO - Upload Metadata Manually
    • You can choose any one of the options according to the metadata format you have available.
    B] Configure the identity provider metadata manually:
    • After configuring your Identity Provider, it will provide you with IDP Entity ID, IDP Single Sign On URL and SAML X509 Certificate fields respectively.
    • Click Update to save your IDP details.
    • DNN SAML SSO - Upload Metadata

    4. Test Configuration

    • Click the Test Configuration button to verify if you have configured the plugin correctly.
    • On successful configuration, you will get Attribute Name and Attribute Values in the Test Configuration window.
    • DNN SAML SSO - Keycloak test result

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

    • DNN SAML SSO - Attribute Mapping

    6. Adding Login/SSO Widget on DNN Page

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

    • DNN SAML SSO -  Add Login Button
    • Add Button name and click on Save.

    • DNN SAML SSO -  Save Login Button
    • 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.

    • DNN SAML SSO - Module Settings
      DNN SAML SSO - Display Module on Multipages
    • 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.

    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.
    • DNN SAML SSO - Role Mapping

    You can configure the DotNetNuke SAML 2.0 Single Sign-On (SSO) module with any Identity Provider such as ADFS, Azure AD, Bitium, centrify, G Suite, JBoss, Auth0, Okta, OneLogin, Salesforce, AWS Cognito, OpenAM, Oracle, PingFederate, PingOne, RSA SecureID, Shibboleth-2, Shibboleth-3, SimpleSAML, WSO2 or even with your own custom identity provider.

Additional Resources

Need Help?

Not able to find your identity provider? Mail us on dnnsupport@xecurify.com and we'll help you set up SSO with your IDP and for quick guidance (via email/meeting) on your requirement and our team will help you to select the best suitable solution/plan as per your requirement.

Hello there!

Need Help? We are right here!

Contact miniOrange Support

Thanks for your inquiry.

If you dont hear from us within 24 hours, please feel free to send a follow up email to info@xecurify.com