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

Pre-requisites : Download And Installation

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

• Login to http://portal.miniorange.com/ and navigate to the Downloads tab. From there, locate your purchased plugin and click on Download Plugin to download the plugin zip file.

• Extract the Downloaded zip file in your machine and place the nuget package file (.nupkg file) in a some folder like "C:\miniOrangePackages"
• Run the following command in your VS terminal to add it as a package source:

dotnet nuget add source C:\miniOrangePackages--name miniOrangePackage


• Open your Project in the terminal:

cd C:\Path\To\YourProject


• Install the Package in your project using the below command:

dotnet add package miniOrange.SAML.SSO --source miniOrangePackage


OR

• After placing the NuGet package (.nupkg file) in a local folder, instead of using the terminal, you can also install it using Visual Studio by following the steps below:
• Open your .NET application in Visual Studio, click on Tools in the top navigation bar, and navigate to NuGet Package Manager → Manage NuGet Packages for Solution.

• A new window will open; click on the gear icon next to the Package source dropdown.

• A pop-up window will open; select Package Sources from the left navigation panel, click on the plus (+) icon, enter a name for the package source, provide the path of the folder where you placed the NuGet package in the Source field, then click Update and finally click OK to save the changes, as shown in the image.

• After closing the pop-up window, select the newly added package source from the Package source dropdown.

• Now click on the Browse tab, search for miniOrange.SAML.SSO, select the package from the results, and click Install.

• 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.
  Include only the highlighted section below in the Program.cs file of your application.

  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();


• Login to http://portal.miniorange.com/ and navigate to the Downloads tab. From there, locate your purchased plugin and click on Download Plugin to download the plugin zip file.

• Extract the Downloaded zip file in your machine and place the nuget package file (.nupkg file) in a some folder like "C:\miniOrangePackages"
• Run the following command in your VS terminal to add it as a package source:

dotnet nuget add source C:\miniOrangePackages--name miniOrangePackage


• Open your Project in the terminal:

cd C:\Path\To\YourProject


• Install the Package in your project using the below command:

dotnet add package miniOrange.SAML.SSO --source miniOrangePackage


OR

• After placing the NuGet package (.nupkg file) in a local folder, instead of using the terminal, you can also install it using Visual Studio by following the steps below:
• Open your .NET application in Visual Studio, click on Tools in the top navigation bar, and navigate to NuGet Package Manager → Manage NuGet Packages for Solution.

• A new window will open; click on the gear icon next to the Package source dropdown.

• A pop-up window will open; select Package Sources from the left navigation panel, click on the plus (+) icon, enter a name for the package source, provide the path of the folder where you placed the NuGet package in the Source field, then click Update and finally click OK to save the changes, as shown in the image.

• After closing the pop-up window, select the newly added package source from the Package source dropdown.

• Now click on the Browse tab, search for miniOrange.SAML.SSO, select the package from the results, and click Install.

• 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.
  Include only the highlighted section below in the Program.cs file of your application.

  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();
      });
    }
  }


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

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

• Log in with your licensed miniOrange account to configure the middleware.
• After logging in, the Account Setup dashboard will open. Enter the license key to activate the plugin, which you will receive after logging in to portal.miniorange.com and navigating to Manage License → License Keys.

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

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.
• ou can also download the SP Certificate by clicking on Download SP Cert and provide it to your Identity Provider if required.
• Under the Encryption Certificate section, select the appropriate certificate type as per your requirement.
• After completing the above steps, click on Save to apply the configuration.

• You may refer to the screenshot below:

Register the Identity Experience Framework application

• Log into Azure B2C Portal.
• From the Azure AD B2C tenant, select App registrations, and then select New registration.

• For Name, enter IdentityExperienceFramework.
• Under Supported account types, select Accounts in this organizational directory only.

• Under Redirect URI, select Web, and then enter "https://your-tenant-name.b2clogin.com/your-tenant-name.onmicrosoft.com", where your-tenant-name is your Azure AD B2C tenant domain name.

• Under Permissions, select the Grant admin consent to openid and offline_access permissions check box.
• Click on Register.

• Record the Application (client) ID for use in a later step.

Register the Identity Experience Framework application

• Under Manage, select Expose an API.
• Select Add a scope, then select Save and continue to accept the default application ID URI.

• Enter the following values to create a scope that allows custom policy execution in your Azure AD B2C tenant:
• Scope name: user_impersonation
• Admin consent display name: Access IdentityExperienceFramework
• Admin consent description: Allow the application to access IdentityExperienceFramework on behalf of the signed-in user.

• Select Add scope.

Register the ProxyIdentityExperienceFramework application

• Select App registrations, and then select New registration.
• For Name, enter ProxyIdentityExperienceFramework.
• Under Supported account types, select Accounts in this organizational directory only.

• Under Redirect URI, use the drop-down to select Public client/native (mobile & desktop).
• For Redirect URI, enter myapp://auth.
• Under Permissions, select the Grant admin consent to openid and offline_access permissions check box.
• Select Register.

• Record the Application (client) ID for use in a later step.

Next, specify that the application should be treated as a public client

• Under Manage, select Authentication.
• Under Advanced settings, enable Allow public client flows (select Yes).
• Select Save.

Now, grant permissions to the API scope you exposed earlier in the IdentityExperienceFramework registration

• Under Manage, select API permissions.
• Under Configured permissions, select Add a permission.

• Select the My APIs tab, then select the IdentityExperienceFramework application.

• Under Permission, select the user_impersonation scope that you defined earlier.
• Select Add permissions. As directed, wait a few minutes before proceeding to the next step.

• Select Grant admin consent for (your tenant name).

• Select your currently signed-in administrator account, or sign in with an account in your Azure AD B2C tenant that's been assigned at least the Cloud application administrator role.
• Select Yes.
• Select Refresh, and then verify that "Granted for ..." appears under Status for the scopes - offline_access, openid and user_impersonation. It might take a few minutes for the permissions to propagate.

Register the ASP.NET Application

• Select App registrations, and then select New registration.
• Enter a Name for the application such as: WP-app.
• Under Supported account types, select Accounts in any organizational directory or any identity provider. For authenticating users with Azure AD B2C.

• Under Redirect URI, select Web, and then enter the ACS URL from the Service Provider Settings tab of the miniOrange ASP.NET SAML plugin, as mentioned in Step 2B above.
• Select Register.

• Under Manage, click on Expose an API.
• Click on Set for the Application ID URI and then click on Save, accepting the default value.

• Once saved, copy the Application ID URI and navigate to the Service Provider Metadata tab of the plugin.
• Paste the copied value under the SP Entity ID / Issuer field provided in this tab.
• Click on Save.

Generate SSO Policies

• From our Azure B2C portal, navigate to the Overview section of your B2C tenant and record your tenant name.
  NOTE: If your B2C domain is b2ctest.onmicrosoft.com, then your tenant name is b2ctest.

• Enter your Azure B2C tenant name below, along with the application ID for IdentityExperienceFramework and ProxyIdentityExperienceFramework apps as registered in the above steps.

• Click on the Generate Azure B2C Policies button to download the SSO policies.
• Extract the downloaded zip file. It contains the policy files and certificate (.pfx), which you will require in the following steps.

Setup and upload Certificates

• Sign in to the Azure portal and browse to your Azure AD B2C tenant.

• Under Policies, select Identity Experience Framework and then Policy keys.

• Select Add, and then select Options > Upload.
• Enter the Name as SamlIdpCert. The prefix B2C_1A_ is automatically added to the name of your key.

• Using the upload file control, upload your certificate that was generated in the above steps along with the SSO policies (tenantname-cert.pfx).
• Enter the certificate's password as your tenant name and click on Create. For example, if your tenant name is xyzb2c.onmicrosoft.com, enter the password as xyzb2c.
• You should be able to see a new policy key with the name B2C_1A_SamlIdpCert.

Create the signing key

• On the overview page of your Azure AD B2C tenant, under Policies, select Identity Experience Framework.
• Select Policy Keys and then select Add.
• For Options, choose Generate.
• In Name, enter TokenSigningKeyContainer.
• For Key type, select RSA.
• For Key usage, select Signature.

• Select Create.

Create the encryption key

• On the overview page of your Azure AD B2C tenant, under Policies, select Identity Experience Framework.
• Select Policy Keys and then select Add.
• For Options, choose Generate.
• In Name, enter TokenEncryptionKeyContainer.
• For Key type, select RSA.
• For Key usage, select Encryption.

• Select Create.

Upload the policies

• Select the Identity Experience Framework menu item in your B2C tenant in the Azure portal.

• Select Upload custom policy.

• As per the following order, upload the policy files downloaded in the above steps:
• TrustFrameworkBase.xml
• TrustFrameworkExtensions.xml
• SignUpOrSignin.xml
• ProfileEdit.xml
• PasswordReset.xml
• SignUpOrSigninSAML.xml

• As you upload the files, Azure adds the prefix B2C_1A_ to each.

You have successfully configured Azure B2C as SAML IDP (Identity Provider) for achieving ASP.NET Single Sign-On (SSO).

• Click on the Add new IDP button to configure a new Identity Provider.

• Under the Plugin Settings tab, select AzureB2C as your identity provider from the list shown.

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.

• 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 test result. Please click on click here to complete the remaining SSO integration steps.

• If you are experiencing any error on the middleware end, click on the Troubleshooting button.

• To troubleshoot the error, you can follow the below steps:
• Under the Troubleshoot tab, enable the toggle to receive the plugin logs and reproduce the issue.
• Download the log file by clicking on the Download Log File button 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.

• 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.
• Map the required IdP attributes (such as Username, Email, Firstname, and Lastname) received in the SAML Response to their corresponding fields.

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

Custom Attribute Mapping

• If you want to pass additional attributes from your IdP, enter the Attribute Name and corresponding Attribute Value under Custom Attribute Mapping.
• From the Attribute Value (Claim) dropdown, select one of the claims you received in the Test Configuration results. For example: NameID.
• These claims correspond to the attributes sent by your Identity Provider (IdP).

• These claims correspond to the attributes sent by your Identity Provider (IdP).

• In the Attribute Name field, enter the name of the attribute as you want it to appear or be used in your .NET application.
• You can add multiple mappings if your application requires multiple attributes by clicking on the + button.
• After defining all the required mappings, click on Save Attribute Mapping to store the configuration.

• The plugin will now translate the incoming SSO claims from your Identity Provider (IdP) into the custom attribute names defined here.

Role Mapping

• In the Role Mapping section , enter the Group Attribute Name exactly as configured in your Identity Provider to fetch the user group information.
• Enter the Role Name received from the Identity Provider and map it to the appropriate Role Vaue field. In the Role Value field, enter the roles defined in your .NET application.
• For example: Map the IdP group Group1 or Group10 received under the UserGroups attribute to the corresponding role configured in your .NET application.
• After adding the required mappings, click on Save Role Mapping to save the configuration successfully.

Domain Restriction

• This feature can be used to restrict user access to the site based on the domain of their mapped “Email“ Attribute.
• In the Email Attribute field, enter the attribute name that contains the user's email address as received from your Identity Provider (IdP).

• In the Domain Name field, enter the domain(s) you want to allow or restrict, separated by commas if adding multiple domains.
• Enable the Restrict toggle based on your requirement to configure blacklist or whitelist access.
• After completing the configuration, click on Save Domains to save the settings successfully.

• These steps allow you to retrieve the SSO user information in your application in the form of user claims.
• Simply copy and paste the code snippet wherever you want to access the user attributes.

• You can also copy the integration code from below:

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

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

• For example, you can use it as:

Advanced Settings

If you want to apply Advanced Settings, navigate to the Advanced Settings tab.

Auto Redirect to IdP

• Enable the Auto Redirect to IdP toggle button to automatically redirect users to the configured Identity Provider during login.
• Select the IDP where you want to redirect the users from the specific Url in the Default IDP dropdown.
• Choose the Type of Redirection as Restricted or Public based on your requirement.
• If required, enter the URLs that should be excluded from redirection in the Exclude URLs field, separated by commas.
• Click on Save to store the configuration successfully.

Disable Admin Dashboard

• Enable the Disable Admin Dashboard toggle to hide the miniOrange Admin Dashboard, and click on Save to apply the changes.

Certificate Information

• Navigate to the Certificate Information section and select the required Certificate Type (Signing Certificate or Encryption Certificate).
• Click on Regenerate Certificate if you want to generate a new certificate.

• Then click on Apply New Certificate to apply the updated certificate.

Upload Custom Certificate

• Navigate to the Upload Custom Certificate section and select the required Certificate Type (Signing Certificate or Encryption Certificate).
• Click on Choose File to upload the Public Key (.crt) and Private Key (.pfx) files, and enter the Private Key Password in the provided field.
• After providing the required details, click on Save to upload and apply the custom certificate successfully.