Meet us at WordCamp Europe | ShopTalk | DrupalCon Conferences to explore our solutions. Know More
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
PM> NuGet\Install-Package miniOrange.Umbraco8.SAML.SSO -Version
5.4.2
-
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.
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
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:
- 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:
- 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.
- Select the Browser SSO Profiles connection template on the Connection Type tab and click Next.
- Select Browser SSO on the Connection Options tab and click Next.
- 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.
- 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.
- Select an Adapter Instance and click Next. The adapter must include the user’s email address.
- 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.
- (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.
- 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.
- 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.
- 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 SP
Note: After installation of the plugin, we need to setup the trust between your Umbraco application and PingFederate. SAML metadata is shared with PingFederate so they can update their inbuilt configuration to support Single Sign-On.
2.1: Share SAML Metadata with PingFederate
- Click on Add New IDP to configure Umbraco Single Sign-On (SSO) with PingFederate.
- Under Service Provider Settings tab, you can either copy-paste the metadata URL on your IDP side or download the SP metadata as an XML file. Additionally, you have the choice to manually copy and paste Base URL, SP Entity ID, and ACS URL.
- Share SAML metadata with your identity provider.
2.2: Import PingFederate SAML metadata
- Select PingFederate from the list of identity providers shown below.
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 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
- Before testing, please ensure the following:
- The Umbraco (SP) SAML metadata has been exported to PingFederate (IDP).
- Importing the PingFederate (IDP) SAML metadata in Umbraco (SP).
- To test whether the SAML configuration you’ve done is correct, go to Select Actions then click Test Configuration.
- Note: In the trial version of the plugin, you can only configure and test one identity provider (IDP).
- The screenshot below shows a successful result. Click on Done 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 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.
- 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.
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-application-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-base-url/?ssoaction=logout -
For example you can use it as:
<a href="https://umbraco-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!
