nopCommerce SAML Single Sign-On (SSO) with Google as IDP

Overview

nopCommerce SAML Single Sign-On (SSO) plugin gives the ability to enable SAML Single Sign-On for your nopCommerce store. Using Single Sign-On you can use only one password to access your nopCommerce store 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 nopCommerce and Google considering Google as IdP.

Pre-requisites : Download And Installation

• Download the nopCommerce SAML Single Sign-On (SSO) module.
• To install the plugin, login as admin into your nopCommerce store. In the admin dashboard, navigate to Configuration Tab >> Local plugins.

• Click on the Upload plugin or theme button at the top right corner, then in the popup window, click Choose File, select the downloaded plugin ZIP file, and click Upload plugin or theme to proceed.

• After uploading the plugin, click on Restart Application to apply the changes. Once the application restarts, you will see the plugin listed below. Click on the Install button to install it, and then click Restart Application again to apply the changes.

Configuration Steps

Step by Step guide for nopCommerce SAML SSO using Google as Identity Provider.

• After successful installation, locate the plugin in the list and click on the Configure button to proceed with the setup.

1. Activate the SAML Plugin using License Key

• On clicking Configure, you will be redirected to the license activation page, and you will receive a trial license key on your registered email.
• If you have not received the license key on your provided email, use the Download License Key button in the plugin to download the license file.

• To activate the plugin, you can either:
  • Enter the license key received via email in the provided input field.

  OR

  • Upload the license file that you downloaded using the button mentioned above.

• Then, check the box "I have read the above conditions and I want to activate the middleware", and click Activate License button.

2. Provide nopCommerce store Metadata to Google Identity Provider

• After successful license activation, the plugin dashboard will open as shown below.
• In the plugin dashboard, click on the Service Provider Metadata button from the top menu. This will open the Service Provider Metadata page.

You can obtain the SAML SP metadata using either of the two methods described below to configure it on your Identity Provider end.

A] Using SAML metadata URL or metadata file

• On this page, you can find the Metadata URL as well as the option to download the SAML metadata XML file.
• Copy the 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

• On this page, you can manually copy the service provider metadata such as SP Entity ID, ACS URL, Base URL and share it with your Identity Provider for configuration.
• You may refer to the screenshot below:

• Go to https://admin.google.com and login with your G Suite administrator account.

• Navigate to the Apps tab in the left menu and click on Web and mobile apps.

• Click on the Add App button, then in the dropdown select Add Custom SAML app tab to create a new saml app.

• Enter details for your custom SAML app and click on Continue button.

• Click on Download Metadata button. Keep the metadata url handy it will require later to configure.

• You can also copy G Suite details like SSO URL, entity ID and Certificate to configure the Service Provider manually and then click on Continue button.

• Enter the details from the Service Provider Metadata tab of the nopCommerce plugin, which you will get from Step 2B.

• Click on Continue button.

• Click on Add Mapping button.

• Add and select user fields in Google Directory, then map them to Service Provider attributes and Click on Finish button.

• Go to SAML Apps again and click on OFF for everyone.

• Then, select ON for everyone to activate SSO.
  

• You have successfully configured G Suite / Google Apps as SAML IdP (Identity Provider) for achieving G Suite / Google Apps SSO login into your nopCommerce application.

3. Configure Google Identity Provider Metadata in nopCommerce store

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

• Under the Plugin Settings tab, select Google as your identity provider from the list shown.

• After selecting your IdP from the list, the Identity Provider Configuration page will open. On this page, click on the Upload IdP Metadata button.

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:

• Enter the IdP Name, then either provide the metadata URL in the Fetch Metadata section and click Fetch Metadata to retrieve the configuration automatically, or upload the metadata XML file using the Upload Metadata option to configure the IdP.
• You may refer to the screenshot below:

B] Configure the identity provider metadata manually:

• Alternatively, under the Identity Provider Settings tab, you can manually fill in the mandatory fields like IDP Name, IDP Entity ID and Single Sign-On URL and click Save Settings.

4. Testing SAML SSO

• After uploading the metadata details, navigate back to the Dashboard. Click on the three dots (⋮) next to the configured Identity Provider and select Test Configuration.

• On successful configuration, you will get attributes name and attribute values in the test configuration window.

• If you are experiencing any error, you can troubleshoot it using the steps below:
• Click on the Troubleshoot SSO button and enable the required log levels.
• Download the log file using the Download Logs button to identify what went wrong.
• You can share the log file with us at nopcommercesupport@xecurify.com and our team will reach out to you to resolve your issue.

5. Adding SSO link for your nopCommerce store

• Click on the three dots (⋮) next to the configured Identity Provider and select SSO Link.
• A “Copy to Clipboard” pop-up will appear. Click OK to copy the SSO link to your clipboard.

Related Articles

• nopCommerce Oauth SSO
• nopCommerce Two Factor Authentication
• nopCommerce SAML SSO with Azure AD as IDP