Umbraco SAML Single Sign-On (SSO) using ADFS as IDP


Umbraco SAML Single Sign-On (SSO) plugin gives the ability to enable SAML Single Sign-On for your Umbraco applications. Using Single Sign-On you can use only one password to access your Umbraco application and services. Our plugin 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 Umbraco and ADFS considering ADFS as IdP. To know more about the features we provide for Umbraco SSO, click here.

Select your umbraco version to configure SSO with:

Pre-requisites : Download And Installation

  • Download Umbraco SAML Single Sign-On (SSO) module.
  • For Setting up the module, extract the umbraco-saml-sso-connector.zip, you will find a DLL file miniorange-saml-sso.dll, a configuration file saml.config and a integration.md file which contain the steps for adding the module into your application.

1. Add module in Umbraco Application

  • Add miniorange-saml-sso.dll in the bin folder (where your other DLL files exist) for your Umbraco site.
  • Register miniorangesamlsso module for your umbraco SSO according to the provided steps in the integration.md file.
  • Add the provided configuration file saml.config in the root directory for your umbraco site.
  • After integration open browser and browse the module dashboard with URL below:
    https://<umbraco-base-url>/?ssoaction=config
  • If it pops up the registration page or login page, you have successfully added the miniOrange saml sso module for your application.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Login Page
  • Register or Login for configuring the module.
  • Add the reference miniorange-saml-sso.dll file in your Umbraco application:
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Add miniOrange DLL file
  • Add the miniOrange-sso-configuration file in your Umbraco application.
  • In the Startup.cs file:
    • Add the namespace miniOrange.samlusing miniOrange.saml;
    • Update the Umbraco middleware snippet lines in Startup.Configure method as below:
    • app.UseUmbraco()
          .WithMiddleware(u => {
              u.UseBackOffice();
              u.UseWebsite();
              u.AppBuilder.UseminiOrangeSAMLSSOMiddleware();
          })
          .WithEndpoints(u => {
              u.UseInstallerEndpoints();
              u.UseBackOfficeEndpoints();
              u.UseWebsiteEndpoints();
          });
  • Run the application when the configuration is done.
  • After integration, open your browser and browse the plugin dashboard with the URL below:
  • https://<umbraco-application-base-url>/?ssoaction=config
  • If the registration page or login page pops up, you have successfully added the miniOrange Umbraco SAML middleware in your Umbraco application.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - ASP.NET login page
  • Register or log in with your account by clicking the Register button to configure the plugin

2. Configure ADFS as IDP

There are below two ways with which you can get the SAML SP metadata to configure on your ADFS end.

A] Using SAML metadata URL or metadata file:
  • Under the Service Provider Settings section, you can find the metadata URL as well as the option to download the SAML metadata
  • Copy metadata URL or download metadata file to configure the same on your ADFS end.
  • You can refer to the below screenshot:

    Umbraco Single Sign-On (SSO) using ADFS as IDP - Service provider metadata
B] Uploading metadata manually:
  • From the Service Provider Settings section, you can copy the service provider metadata manually like SP Entity ID, ACS Url, Single Logout Url, and provide it to your identity provider for configuration.
  • You can refer to the below screenshot:

    Umbraco Single Sign-On (SSO) using ADFS as IDP - Service provider metadata
  • Under the Plugin Settings tab, select ADFS as your identity provider from the list shown below:
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Select your IDP
  • 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:
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Download SP 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:
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Copy SP Metadata
  • On ADFS, search for ADFS Management application.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Admin_Dashboard
  • In AD FS Management, select Relying Party Trust and click on Add Relying Party Trust.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Add Relying Party Trust
  • Select Claims aware from the Relying Party Trust Wizard and click on Start button.
  •  Umbraco Single Sign-On (SSO) using ADFS as IDP - Claims Aware
Select Data Source
  • In Select Data Source, select the data source for adding a relying party trust.

Choose Access Control Policy
  • Select Permit everyone as an Access Control Policy and click on Next.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - for SAML 2.0 Wizard Multi-Factor
Ready to Add Trust
  • In Ready to Add Trust click on Next and then Close.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - SAML 2.0 Wizard Edit Claim
Edit Claim Issuance Policy
  • In the list of Relying Party Trust, select the application you created and click on Edit Claim Issuance Policy.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - SAML 2.0 Wizard Edit Claim
  • In Issuance Transform Rule tab click on Add Rule button.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - for SAML 2.0 Wizard Claim Rule
Choose Rule Type
  • Select Send LDAP Attributes as Claims and click on Next.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - for SAML 2.0 Configure_LDAP Attributes
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.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - for the SAML 2.0 Add Transform Claim Rule
  • 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 Umbraco Single Sign-On (SSO).

Windows SSO (Optional)

Steps to configure ADFS for Windows Authentication
  • Open elevated Command Prompt on the ADFS Server and execute the following command on it:
    • miniorange img setspn -a HTTP/##ADFS Server FQDN## ##Domain Service Account##

      miniorange img FQDN is Fully Qualified Domain Name (Example : adfs4.example.com)

      miniorange img Domain Service Account is the username of the account in AD.

      miniorange img 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.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Primary Authentication Umbraco Single Sign-On (SSO) using ADFS as IDP - Management Application
  • 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.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - for the SAML 2.0 Wizard_Enable SAML
  • 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.

3. Configure Umbraco as SP

There are below two ways 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 simply configure the identity provider metadata in the module using the Upload IdP Metadata option.
  • You can refer to the below screenshot

    Umbraco Single Sign-On (SSO) using ADFS as IDP - Upload Metadata
  • You can choose any one of the options according to the metadata format you are available with.
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 x.509 Certificate. Configure these values under IDP Entity ID, Single Sign-On Url and SAML X509 Certificate fields respectively.
  • Click Save to save your IDP details.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - test configuration
  • There are two ways detailed below with which you can configure your SAML identity provider metadata in the plugin.
  • 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 plugin using the Upload IDP Metadata option. You may refer to the screenshot below:
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Upload IDP 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.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Enter IDP metadata manually
  • Click Save to save your IDP details

4. Test Configuration

  • Click on Test Configuration button to test whether the SAML configuration you’ve done is correct or not.
  • The below screenshot shows a successful result.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - saml dll testconfig
  • 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.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - successful test configuration
  • If you are experiencing any error on the plugin end you’ll be shown with the window similar to below.
  • To troubleshoot the error you can follow the below steps:
    • Under the Troubleshoot tab, enable the toggle to receive the plugin logs.
    • Umbraco Single Sign-On (SSO) using ADFS as IDP - Troubleshooting
    • Once enabled, you will be able to retrieve plugin logs by navigating to the 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 umbracosupport@xecurify.com and our team will reach out to you to resolve your issue.

5. Attribute Mapping

  • Map your umbraco attributes with the Identity Provider (IdP) attributes.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - attribute mapping
  • Click on Save Attribute Mapping button to save the settings.

6. Login Type

The Umbraco platform supports two different ways of login:



  • Under the Login Setup tab, select Member login as your preferred form of login and then click Save.
  • Umbraco Single Sign-On (SSO) using ADFS as IDP - Umbraco Member login

7. Login Settings

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

8. Logout Settings

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

You can configure the Umbraco SAML 2.0 Single Sign-On (SSO) module with any Identity Providers such as ADFS, ADFS, 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.

9. Additional Resources

Need Help?

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