Contents

Umbraco SAML Single Sign-On (SSO) with Ping Federate 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 Ping Federate considering Ping Federate 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

Install from NuGet store
Manual Installation

NuGet Package
.NET CLI

PM> NuGet\Install-Package miniOrange.Umbraco8.SAML.SSO -Version 5.4.2

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.

Download Umbraco SAML Single Sign-On (SSO) middleware.
For Setting up the middleware, you will be required to add the below namespaces, services and middleware in your startup.cs file (marked in green), below here is a sample example

                        
                    
              
                using miniorange.saml;
                using System.Reflection;
            
                namespace Application
                {
                    public class Startup
                    {
            
                // Add services to the container.
        
                public void ConfigureServices(IServiceCollection services)
                {
                  services.AddUmbraco(_env, _config)
                   .AddBackOffice()
                   .AddWebsite()
                   .AddComposers()
                   .Build();
        
                   services.AddminiOrangeServices(Assembly.GetExecutingAssembly());
               }
        
                public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
                {
        
                 if (env.IsDevelopment())
                  {
                   app.UseDeveloperExceptionPage();
                   }
                   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-middleware-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 SAML Single Sign-On (SSO) using ADFS as IDP - Umbraco login page

Download Umbraco SAML Single Sign-On (SSO) middleware.
For Setting up the middleware, you will be required to add the below namespaces, services and middleware in your program.cs file (marked in green), below here is a sample example

                        
                    
              
                using miniorange.saml;
                using System.Reflection;
                WebApplicationBuilder builder = WebApplication.CreateBuilder(args);
            
                builder.CreateUmbracoBuilder()
                    .AddBackOffice()
                    .AddWebsite()
                    .AddDeliveryApi()
                    .AddComposers()
                    .Build();
            
                // Add services to the container.
        
                builder.Services.AddminiOrangeServices(Assembly.GetExecutingAssembly());

                WebApplication app = builder.Build();

                await app.BootUmbracoAsync();

                app.UseUmbraco()
                   .WithMiddleware(u =>
                    {
                     u.UseBackOffice();
                     u.UseWebsite();
                     u.AppBuilder.UseminiOrangeSAMLSSOMiddleware();
                     })
        
                     .WithEndpoints(u =>
                     {
                    u.UseBackOfficeEndpoints();
                    u.UseWebsiteEndpoints();
                   });
               await app.RunAsync();

Run the application when the configuration is done.

After integration, open your browser and browse the plugin dashboard with the URL below: https://<umbraco-middleware-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.

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 Umbraco SAML SSO connector to your application.

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

Configure Umbraco Single Sign-On (SSO) using PingFederate as IDP

1. Configure PingFederate as IDP

There are below two ways with which you can get the SAML SP metadata to configure on your PingFederate 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 PingFederate end.
You can refer to the below screenshot

Umbraco SAML Single Sign-On (SSO) using PingFederate 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

Under the Plugin Settings tab, select PingFederate as your identity provider from the list shown below:

Umbraco Single Sign-On (SSO) using WordPress 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 WordPress 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 WordPress as IDP - Copy SP Metadata

Login to your Ping Federate User Admin dashboard.
Click on the Identity Provider in the left navigation menu.
Under SP CONNECTION, click on Create New button.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - New SP Connection

Select the Browser SSO Profiles connection template on the Connection Type tab and click Next.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - PingFederate Connection type

Select Browser SSO on the Connection Options tab and click Next.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Connection Options

Select File as the method for importing metadata and click Choose file to choose the miniOrange SSO plugin’s metadata on the Import Metadata tab. Click Next.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Import metadata

Review the information on the Metadata Summary tab and click Next.
In the General Info tab ensure that the Service Provider’s Entity ID, Connection Name, and Base URL fields pre-populate based on the metadata. Click Next.
Navigate to the Browser SSO tab and click on the Configure Browser SSO. You will be redirected to Browser SSO Setup wizard.

Select the IdP-Initiated SSO and SP-Initiated SSO options on the SAML Profiles tab and click Next.

Enter your desired assertion validity time from on the Assertion Lifetime tab and click Next. By default, it is configured 5 minutes for both.
Navigate to the Assertion Creation and click on the Configure Assertion Creation. You will be redirected to the assertion creation setup wizard.

In the Identity Mapping tab select STANDARD and click Next.
Select a Subject Name Format for the SAML_SUBJECT on the Attribute Contract tab and click Next.
Click Map New Adapter Instance on the Authentication Source Mapping.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Assertion Source Mapping

Select an Adapter Instance and click Next. The adapter must include the user’s email address.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Adapter Instance

Select the Use only the adapter contract values in the SAML assertion option on the Mapping Method tab and click Next.
Select your adapter instance as the Source and the email as the Value on the Attribute Contract Fulfilment tab and click Next.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Contact Fulfilment

(Optional): Select any authorization conditions you would like on the Issuance Criteria tab and click Next.
Click Done on the Summary.
Click Next on the Authentication Source Mapping tab.
Click Done on the Summary tab.
Click Next on the Assertion Creation.

Navigate to the Protocol Settings tab of the Browser SSO wizard and click on the Configure Protocol settings.

Select POST for Binding and specify the single sign-on endpoint URL in the Endpoint URL field on the Assertion Consumer Service URL Click Next.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Protocol Settings

Select POST on the Allowable SAML Bindings tab and click Next.
Select your desired signature policies for assertions on the Signature Policy tab and click Next.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Signature Policy

Select your desired encryption policy for assertions on the Encryption Policy tab and click Next.
Click Done on the Protocol Settings Summary tab.
Click Done on the Browser SSO Summary.

Navigate to the Credentials and click on the Configure Credentials. You will be redirected to the Credentials setup wizard.

Select the Signing Certificate to use with the Single Sign-On service and select Include the certificate in the signature element in the Digital Signature Settings tab. Click Done.

Umbraco Single Sign-On (SSO) using PingFederate as IDP - Digital Signature Settings

Click Done on the Summary.
Click Next on the Credentials.

Select Active for the Connection Status on the Activation & Summary tab and click Save.
Now, navigate to the Ping Federate User Admin dashboardè Identity Provide.
Click Manage All under SP Connections.
Click Export Metadata for the desired service provider connection.
Click Export on the Export & Summary tab and click Done.

You have successfully configured PingFederate as SAML IdP (Identity Provider) for achieving Umbraco Single Sign-On (SSO).

2. Configure Umbraco as Service Provider

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 SAML Single Sign-On (SSO) using Azure AD 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 SAML Single Sign-On (SSO) using Azure AD as IDP - Enter IDP Metadata

You have successfully configured your Umbraco application as a service provider.

There are two ways detailed below with which you can get the SAML SP metadata to configure onto your identity provider end.

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 SAML Single Sign-On (SSO) using Azure AD 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 SAML Single Sign-On (SSO) using Azure AD as IDP - Enter IDP metadata manually

Click Save to save your IDP details

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:

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

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

Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Do test SAML SSO

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

Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Error Window

To troubleshoot the error you can follow the below steps:

Under Troubleshooting tab, enable the toggle to receive the plugin logs.

Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Enable debug logs

Once enabled, you will be able to retrieve plugin logs by navigating to Identity Provider 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.

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.

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 Troubleshooting tab, enable the toggle to receive the plugin logs.

Once enabled, you will be able to retrieve plugin logs by navigating to Identity Provider 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.

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.

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 Troubleshooting tab, enable the toggle to receive the plugin logs.

Once enabled, you will be able to retrieve plugin logs by navigating to Identity Provider 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.

4. Login Settings

Go to Select Actions and click on Copy SSO Link.

Umbraco SAML Single Sign-On (SSO) using Azure AD as IDP - Copy SSO Link

Use the copied link in the application from where you want to perform SSO
For example you can use it as:
<a href="copied-sso-link”>Login</a>"

Use the following URL as a link in the application from where you want to perform SSO: https://<umbraco-middleware-base-url>/?ssoaction=login

Use the following URL as a link in the application from where you want to perform SSO: https://<umbraco-middleware-base-url>/?ssoaction=login

5. Logout Settings

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

You can even configure the nopCommerce SAML Single Sign-On (SSO) module with any identity providers 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 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.

Contents

Umbraco SAML Single Sign-On (SSO) with Ping Federate as IDP

Pre-requisites: Download And Installation