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

Pre-requisites : Download And Installation

A] NuGet Installation:

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

• Open your Project in the terminal:

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

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.

B] Manual Installation:

• Extract the downloaded package from the miniOrange portal. It contains a Manual Installation folder with miniorange-saml-sso.dll and other DLL files which are required to be placed in your application's bin folder.
• Place the saml.config file and the miniOrangeContent folder in the root directory of your application.
• Register the miniOrange module in your web.config by following the steps in the integration.md.

Access the Module Dashboard

• After Installation, open your browser and browse the module dashboard with the URL below:
  

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


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

• Log in with your licensed miniOrange account to configure the module.
• 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.
• You 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:

Steps to Configure ADFS IdP

• First, search for ADFS Management application on your ADFS server.

• In ADFS Management, select Relying Party Trust and click on Add Relying Party Trust.

• Select Claims aware from the Relying Party Trust Wizard and click on Start button.

Select Data Source

• In Select Data Source, select the data source for adding a relying party trust.

• Metadata URL
• Metadata XML file
• Manual Configuration

• Navigate to Service Provider Metadata section from the ASP.NET SAML module and copy the Metadata URL.
• Select Import data about the relying party published online or on the local network option, and add the metadata URL (from Step 1a) in the Federation metadata address field.
• Click on Next.

• Navigate to Service Provider Metadata section from the ASP.NET SAML module and click on the Download XML metadata button to download the plugin metadata file.
• Select Import data about the relying party from a file option and upload the metadata file downloaded from Step 1a
• Click on Next.

• Navigate to the Service Provider Metadata section of the ASP.NET SAML module (as detailed in Step 1B) to get the endpoints needed to configure the Service Provider manually.
• In Add Relying Party Trust Wizard select option Enter data about the relying party manually and click on Next.

Specify Display Name

• Enter Display Name and Click Next.

Configure Certificate (Premium feature)

• Download the certificate from Service Provider Metadata Tab.
• Upload the certificate and click on Next.

Configure URL

• Select Enable support for the SAML 2.0 WebSSO protocol option and enter ACS URL from the plugin's Service Provider Metadata Tab.
• Click on Next.

Configure Identifiers

• In the Relying party trust identifier, add the SP-EntityID / Issuer from the plugin's Service Provider Metadata tab.

Choose Access Control Policy

• Select Permit everyone as an Access Control Policy and click on Next.

Ready to Add Trust

• In Ready to Add Trust click on Next and then Close.

Edit Claim Issuance Policy

• In the list of Relying Party Trust, select the application you created and click on Edit Claim Issuance Policy.

• In Issuance Transform Rule tab click on Add Rule button.

Choose Rule Type

• Select Send LDAP Attributes as Claims and click on Next.

Configure Claim Rule

• Add a Claim Rule Name and select the Attribute Store as required from the dropdown.
• Under Mapping of LDAP Attributes to outgoing claim types, Select LDAP Attribute as E-Mail-Addresses and Outgoing Claim Type as Name ID.

• Once you have configured the attributes, click on Finish.
• After configuring ADFS as IDP, you will need the Federation Metadata to configure your Service Provider.
• To get the ADFS Federation Metadata, you can use this URL
  https://< ADFS_Server_Name >/federationmetadata/2007-06/federationmetadata.xml
• You have successfully configured ADFS as SAML IdP (Identity Provider) for achieving ADFS Single Sign-On (SSO) Login

Windows SSO (Optional)

Follow the steps below to configure Windows SSO

• Steps to configure ADFS for Windows Authentication
  • Open elevated Command Prompt on the ADFS Server and execute the following command on it:
    setspn -a HTTP/##ADFS Server FQDN## ##Domain Service Account##
  • FQDN is Fully Qualified Domain Name (Example : adfs4.example.com)
  • Domain Service Account is the username of the account in AD.
  • Example : setspn -a HTTP/adfs.example.com username/domain.

• Open AD FS Management Console, click on Services and go to the Authentication Methods section. On the right, click on Edit Primary Authentication Methods. Check Windows Authentication in Intranet zone.

• Open Internet Explorer. Navigate to Security tab in Internet Options.
• Add the FQDN of AD FS to the list of sites in Local Intranet and restart the browser.
• Select Custom Level for the Security Zone. In the list of options, select Automatic Logon only in Intranet Zone.

• Open the powershell and execute following two commands to enable windows authentication in Chrome browser.

 Set-AdfsProperties -WIASupportedUserAgents ((Get-ADFSProperties | Select -ExpandProperty  WIASupportedUserAgents) + "Chrome")
 Get-AdfsProperties | Select -ExpandProperty WIASupportedUserAgents;


• You have successfully configured ADFS for Windows Authentication.

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

• Under the Plugin Settings tab, select ADFS 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 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.

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

• 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 Module, 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 module 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 Value 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 session.
• You can also look the setup tour to understand how the SSO integration would work in your asp.net module application.
• Just copy-paste that code snippet wherever you want to access the user attributes.

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