Guide to Configure ASP.NET Core SAML SSO using ADFS as IDP

Pre-requisites : Download And Installation

• Version .NET 5 & Above
• Version .NET Core 2.1 & .NET Core 3.1
• .NET Framework

NuGet Package

.NET CLI

PM> NuGet\Install-Package miniOrange.SAML.SSO

> dotnet add package miniOrange.SAML.SSO

Note: To integrate the miniOrange ASP.NET SAML SSO middleware in your application, you will be required to add the below namespaces, services and middleware in your project, below is a sample implementation for reference.

  using miniOrange.saml;
  using System.Reflection
  var builder=WebApplication.CreateBuilder(args);

  // Add services to the container.
  builder.Services.AddRazorPages();
  builder.Services.AddminiOrangeServices(Assembly.GetExecutingAssembly());

  var app = builder.Build();
        if(!app.Environment.IsDevelopment())
  {
    app.UseExceptionHandler("/Error");
    app.UseHsts();
  }

  app.UseHttpsRedirection();
  app.UseRouting();
  app.UseAuthorization();
  app.MapRazorPages();

  app.UseCookiePolicy();
  app.UseAuthentication();

  #if NET9_0_OR_GREATER
  app.MapStaticAssets();
  #else
  app.UseStaticFiles();
  #endif

  app.UseminiOrangeSAMLSSOMiddleware();
  app.Run();


NuGet Packege

.NET CLI

PM> NuGet\Install-Package miniOrange.SAML.SSO

> dotnet add package miniOrange.SAML.SSO

Note: To integrate the miniOrange ASP.NET SAML SSO middleware in your application, you will be required to add the below namespaces, services and middleware in your project, below here is a sample .

  using miniOrange.saml;
  using System.Reflection;

  public class Startup
  {

    public Startup(IConfiguration configuration)
    {
      Configuration = configuration;
    }
    public IConfiguration Configuration { get; }

    // This method gets called by the runtime. Use this method to add services to the container.
    public void ConfigureServices(IServiceCollection services)
    {
      services.AddRazorPages();
      services.AddminiOrangeServices(Assembly.GetExecutingAssembly());
    }

    // This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
    public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
    {
      if (env.IsDevelopment())
      {
        app.UseDeveloperExceptionPage();
      }
      else
      {
        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.UseCookiePolicy();
      app.UseAuthentication();

      #if NET9_0_OR_GREATER
      app.MapStaticAssets();
      #else
      app.UseStaticFiles();
      #endif

      app.UseminiOrangeSAMLSSOMiddleware();

      app.UseRouting();
      app.UseAuthorization();
      app.UseEndpoints(endpoints =>
      {
        endpoints.MapRazorPages();
      });
    }
  }


1. Access the .NET SAML Plugin Dashboard

• After integration, open your browser and browse the connector dashboard with the URL below:
  

 http(s)<your-dotnet-application-base-url>?ssoaction=config


• If the registration page or login page pops up, you have successfully added the miniOrange SAML SSO middleware in your application.

• Register or log in with your account by clicking the Register button to configure the middleware.

• After successful registration, you will receive a trial license key on your registered email address.

• To activate the middleware, you can either:
• Enter the license key received via email in the provided input field.

OR

• Upload the license file that you downloaded by clicking on the Click Here button.

• Then, check the box "I have read the above conditions and I want to activate the middleware", and click the Activate License button.

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:

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:

There are two ways detailed below with which you can configure your SAML Identity Provider metadata in the middleware.

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 middleware using the Upload IDP Metadata option.

• Copy metadata URL or download the metadata file to configure the same on your identity provider end.

• You may refer to the screenshot below:

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

4. Testing SAML SSO

• After uploading the metadata details, navigate to the Identity Provider Settings section. Hover over the Select Actions dropdown and click on Test Configuration.

• The screenshot below shows a successful result. Click on SSO Integration to further continue with the SSO Integration.

• If you are experiencing any error on the middleware end you’ll be shown with the window similar to below.

• To troubleshoot the error you can follow the below steps:

• Under Troubleshoot tab, enable the toggle to receive the plugin 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.

• From the left-hand menu of the miniOrange ASP.NET SAML SSO Middleware, click on Attribute/Role Mapping tab as shown in the image.

• If you want to pass additional attributes from your IdP, enter the Attribute Name and corresponding Attribute Value under Custom Attribute Mapping.

• Note: All the mapped attributes will be stored in the session so that you can access them in your application.

• Once the attributes are mapped, click Save Attribute Mapping to apply changes.

6. Integration Code

• This steps allow you to retrieve the SSO user information in your application in the form of user claims.

• You can also look the setup tour to understand how the SSO integration would work in your asp.net middleware application.

• Just copy-paste that code snippet wherever you want to access the user attributes.

• Note: With the trial middleware the authenticated user details are stored in user claims using the default .NET Cookie Authentication. Support of setting user claims using Header-based, Session-based, JWT-based authentication is available in our premium plugin.

• You can also copy the integration code from below:

7. Login Settings

• Hover on Select Actions and click on Copy SSO Link.

• Use the following URL as a link in the application from where you want to perform SSO:

• For example, you can use it as:

8. Logout Settings

• Use the following URL as a link to your application from where you want to perform SLO:

• For example, you can use it as: