Umbraco SAML Single Sign-On (SSO) with 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
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.
- Register or log in with your account by clicking the Register button to configure the plugin
- 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.
- Register or log in with your account by clicking the Register button to configure the plugin
-
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.
- Register or log in with your account by clicking the Register button to configure the module.
1. Configure Umbraco Single Sign-On (SSO) using 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:
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 ADFS as your identity provider from the list shown below:
- There are two ways detailed below with which you can get the SAML SP metadata to configure onto your identity provider end.
- 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:
- 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:
A] Using SAML metadata URL or metadata file:
B] Uploading metadata manually:
- On ADFS, search for ADFS Management application.
- In AD FS 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.
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 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:
- 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.
- You have successfully configured ADFS for Windows Authentication.
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
Set-AdfsProperties -WIASupportedUserAgents ((Get-ADFSProperties | Select -ExpandProperty WIASupportedUserAgents) + "Chrome")
Get-AdfsProperties | Select -ExpandProperty WIASupportedUserAgents;
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
- 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.
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.
- 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.
- 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
A] Upload metadata using the Upload IDP Metadata button:
B] Configure the identity provider metadata manually:
- There are two ways detailed below with which you can configure your SAML identity provider metadata in the plugin.
- 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.
- 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
A] Upload metadata using the Upload IDP Metadata button:
B] Configure the identity provider metadata manually:
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.
- 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.
- 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.
- 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
- DNN SAML Single Sign-On (SSO)
- Umbraco SAML Single Sign-On (SSO)
- ASP.NET SAML Single Sign-On (SSO)
- nopCommerce SAML Single Sign-On (SSO)
- DNN REST API Authentication
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.
×
![ADFS_sso]()
Trending searches:
Hello there!
Need Help? We are right here!
