Search Results :

×

ASP.NET Core SAML Single Sign-On Setup Guides

Steps to Configure the ASP.NET SAML Core 2.0 Module

Pre-requisites: Download And Installation


PM> NuGet\Install-Package miniOrange.SAML.SSO.Middleware -Version 5.0.2

Please refer to the code below for adding SAML middleware in your application's pipeline. The code will differ as per your ASP.NET Core version

  
  
  using Microsoft.AspNetCore.Authentication.Cookies;
  using miniOrange.saml;
  
  var builder = WebApplication.CreateBuilder(args);
  
  // Add services to the container
  builder.Services.AddRazorPages();
  // Add session services
  builder.Services.AddSession();
  // Add authentication services
  builder.Services.AddAuthentication(CookieAuthenticationDefaults.AuthenticationScheme).AddCookie();
  
  var app = builder.Build();
  
  // Configure the HTTP request pipeline
  if (!app.Environment.IsDevelopment())
   {
      app.UseExceptionHandler("/Error");
  
      // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
      app.UseHsts();
   }
  
  app.UseHttpsRedirection();
  app.UseStaticFiles();
  app.UseRouting();
  app.UseAuthorization();
  app.MapRazorPages();
  
  app.UseCookiePolicy();
  app.UseSession();
  app.UseAuthentication();
  
  // Use miniOrange middleware
  app.UseminiOrangeSAMLSSOMiddleware();
  app.Run();
  
  

1. Add module on ASP.NET Core 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 ASP.NET middleware authentication SAML SSO connector to your application.
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - saml dll register
  • Register or log in with your account by clicking the Register button to configure the module.

2. Configure your identity provider

  • Under the Plugin Settings tab, select your identity provider from the list shown.
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - Select identity provider

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:
  • In the Plugin Settings menu, look for Service Provider Settings. Under that, 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:
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - Copy Downloaded Metadata
B] Uploading metadata manually:
  • From the Service Provider Settings section, you can manually copy the service provider metadata like SP Entity ID, ACS URL, Single Logout URL and share it with your identity provider for configuration.
  • You may refer to the screenshot below:
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - Manual Metadata

3. Configure ASP.NET 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:
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - Upload Metadata
  • 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 Save to save your IDP details.
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - SAML dll config

4. Testing SAML SSO

  • Click on the Test Configuration button to test whether the SAML Configuration you’ve done is correct.
  • The screenshot below shows a successful result. Click on SSO Integration to further continue with the SSO Integration.
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - SAML dll Test configuration
  • If you are experiencing any error on the module end you’ll be shown with the window similar to below.
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - Enable debug logs
  • To troubleshoot the error you can follow the below steps:
    • Under Troubleshoot tab, enable the toggle to receive the plugin logs.
    • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - Enable debug logs
    • Once enabled, you will be able to retrieve plugin logs by navigating to Plugin Settings tab and clicking on Test Configuration.
    • Download the log file from the Troubleshoot tab to see what went wrong.
    • You can share the log file with us at aspnetsupport@xecurify.com and our team will reach out to you to resolve your issue.

5. Attribute Mapping

  • After testing the configuration, Map your application attributes with the Identity Provider (IdP) attributes.
  • Note: All the mapped attributes will be stored in the session so that you can access them in your application.
  • ASP.NET Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - attribute mapping

6. Integration Code

  • You can 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 Core SAML Single Sign-On (SSO) | ASP.NET Core Authentication | ASP.NET Core SAML SSO - integration code
  • If you want some assistance regarding the integration code, get in touch with us aspnetsupport@xecurify.com

7. Login Settings

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

8. Logout Settings

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

You can configure the ASP.NET Core SAML 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. Check the list of identity providers here.

Additional Resources

Need Help?

Not able to find your identity provider? Mail us on aspnetsupport@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!

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