SAML Single Sign-On (SSO) For ASP.NET Web Applications Using Keycloak As IdP

SAML Single Sign-On (SSO) For ASP.NET Web Applications Using Keycloak As IdP


ASP.NET SAML SP Single Sign-On (SSO) module gives the ability to enable SAML Single Sign-On for your ASP.NET applications. Using Single Sign-On you can use only one password to access your ASP.NET 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 ASP.NET and Keycloak considering Keycloak as IdP.

Pre-requisites : Download And Installation

  • Download miniOrange ASP.NET SAML 2.0 Module.
  • To set up the module, extract the file asp.net-saml-sso-module-xxx.zip. You will find a DLL named miniorange-saml-sso.dll, a configuration file named saml.config and an integration.md file which contains steps for adding the module into your application.
  • Add miniorange-saml-sso.dll into your bin folder (where other DLL files for your application exist).
  • Register minorangesamlsso module in your application according to the steps provided in the file named integration.md.
  • Add the provided configuration file saml.config in the root directory of your application.
  • After integration, open your browser and browse the connector dashboard with the URL below:
    https://<your-application-base-url>/?ssoaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange SAML SSO connector to your application.
  • saml dll register
  • Register or log in with your account by clicking the Register button to configure the module.

Steps to configure Keycloak Single Sign-On (SSO) Login into ASP.NET

1. Add Keycloak in ASP.NET SAML Module

  • Go to Plugin settings section and Choose Keycloak from the list.
  • Keycloak SAML SSO , search idp
  • You will see the Service Provider Settings option, where you will get the service provider metadata. You can have three options to provide the metadata to your IDP. Keep the metadata handy as it will be required later to configure step 2.
  •  Keycloak SAML SSO find metadata

2. Configure Keycloak as Identity Provider

Follow the steps below to configure Keycloak as IdP

  • 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.
  • Creating an APP - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login
  • Enter Client ID as the SP-EntityID / Issuer from the Service Provider Metadata and select SAML as the Client Protocol.
  • Add Client - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login
  • 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
    Keycloak Login - Settings - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login
  • 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
    Login SAML Endpoint Configuration - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login
  • Click on Save.

 Add Mappers

  • Go to Mappers tab and click on Add Builtin button.
  • Keycloak Login - Mappers Tab - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login
  • Check the boxes of X500 givenName, X500 surname and X500 email attributes.
  • Keycloak Login - Add built-in protocol mapper - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login
  • Click on Add Selected button. You will see the mappings as shown in the photo below.
  • Keycloak Login - Add Selected - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login

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 URLs and keep it handy. Here you can find the information which will be used to configure the plugin.
  • JBoss Keycloak SSO-7 - Keycloak SAML Single Sign-On(SSO) for WordPress - Keycloak SSO Login

3. Configure ASP.NET SAML Module as Service Provider

  • Go to the miniOrange ASP.NET SAML 2.0 SSO module and click on Upload IDP Metadata button.
  • Keycloack SAML SSO with Office 365 as IDP, go to module
  • In the Metadata URL option, Paste the Metadata URL which you have copied from your IDP and click on Fetch Metadata button.
  • Keycloack  SAML SSO with Office 365 as IDP,: metadata url
  • Click Save to save your IDP details.
  • Keycloack  SAML SSO with Office 365 as IDP, : save button

4. User Attribute Mapping

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

  • Click on the Test Configuration button to test whether the SAML Configuration you’ve done is correct. On successful test configuration, you will get the different user attributes returned by your identity Provider in a test configuration table.
  • asp.net saml sso Keycloack  : test configuration settings
    asp.net saml sso Keycloack  : test configuration settings
  • Once you see all the values in test configuration table, click on Configure Attribute Mapping button.
  • asp.net saml sso Keycloack : attribute mapping
  • You will be redirected to the Attribute Mapping section where you can see that the user attribute as an autofield.
  • Note: All the mapped attributes will be stored in the session so that you can access them in your application.
  • Click on Save Attribute Mapping button.
  • asp.net saml sso Keycloack  : attribute mapping

6. Integration Code

  • You can also find the Integration code in the Integration Code tab in the module. Just copy-paste that code snippet wherever you want to access the user attributes.
  • Note: All the mapped attributes will be stored in the session so that you can access them in your application.
  • asp.net saml sso Keycloack : integration code

7. Login Settings

  • Use the following URL as a link in your application from where you want to perform SSO:
  • https://<your-application-base-url>/?ssoaction=login
  • For example you can use it as:
  • <a href="https://<your-application-base-url>/?ssoaction=login">Login</a>

8. Logout Settings

  • Use the following URL as a link in your application from where you want to perform SLO:
  • https://<your-application-base-url>/?ssoaction=logout
  • For example you can use it as:
  • <a href="https://<your-application-base-url>/?ssoaction=logout">Logout</a>

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 Keycloak, 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.


If you are looking to Single Sign-On into your sites with any SAML compliant Identity Provider then we have a separate solution for that. We do provide SSO solutions for the following:

Application LINK
SAML SSO into DotNetNuke (DNN) site Click here
SAML SSO into SiteFinity site Click here
SAML SSO into Umbraco site Click here

Additional Resources

Hello there!

Need Help? We are right here!

support
Contact miniOrange Support
success

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