Hello there!

Need Help? We are right here!

support
miniOrange Email 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

Single Sign On (SSO) for Magento

miniOrange provides a ready to use solution for Magento. This solution ensures that you are ready to roll out secure access to your Magento site within minutes.

Magento

miniOrange provides secure access to Magento for enterprises and full control over access of applications, Single Sign On (SSO) into Magento with one set of login credentials.
miniOrange SAML Single Sign on (SSO) plugin acts as a SAML Service Provider which can be configured to establish the trust between the plugin and a SAML capable Identity Providers to securely authenticate the user to the Magento site.
If you want Magento to acts as a SAML Identity Provider and single sign on into various SAML supported Service Providers to securely authenticate the user using the Magento site then you need to use Magento as IDP plugin.


miniOrange Supports the following Usecases for Magento


Use Magento as Identity Provider / User Store


If you have an existing Magento site where all the users are registered, you can use it as Identity Provider to authenticate users and SSO into some other application.


Use Magento as Service Provider.


Use Magento as an Service Provider when you already have an existing User Store / Identity Provider.



Magento as Identity Provider

Magento is mostly used as a Service Provider (SP), but we can also use Magento as Identity Source. It is a Learning Management System, so it has all the user credentials, who have registered with the Magento. People (Admin / Site administrator) now want to let these users log into another website/application using the Magento credentials. In simple words, Magento users should be able to Single Sign-On into another application using Magento credentials.


register Magento sso plugin

Workflow

1. User wants to access a service provided by some other application other than Magento.

2. The Application which is configured knows where to authenticate users. It sends the authentication request to miniOrange.

3. miniOrange checks the Magento database for the user credentials, whether the user is valid or not.

4. User credentials are fetched from the database.

5. Depending on the fetched result, miniOrange authenticates the user or denies the request.

6. User gets access to respective Service/Application.

Magento as Service Provider

Magento is a Learning Management System. So, users usually login to the Magento site and do their work. But in some cases, they want to SSO into the Magento site.
To perform Single Sign On (SSO), the Service Provider and the Identity Provider has to adhere to some kind of protocols like SAML, OAuth etc. In case of SAML, Service Provider is the site which user wants to access. Identity Provider is the site (kind of) where user's credentials are present. Here, the site which has user credentials is Identity Provider and the site where they want to login to is Service provider.
In this case, we will configure our Magento site as Service Provider (SP) using miniOrange Plugin. We will use SAML protocol. Here, miniOrange will be the Identity Provider (IdP).


register Magento sso plugin

Workflow

1. User wants to access a Magento Site.

2. Magento Site sends the authentication request to miniOrange. miniOrange checks the user credentials, whether the user is valid or not.

3. miniOrange Authenticates the user.

4. User gets access to the Magento Site.

miniOrange Identity Management Features

miniOrange supports both IdP (Identity Provider) and SP (Service Provider) initiated Single Sign On (SSO)

We can connect with any External IDP/Directory

miniOrange provides user authentication from external directories like ADFS, Microsoft Active Directory, Azure AD, OpenLDAP, Google, AWS Cognito etc. It also provides user authentication with other IDPs like Shibboleth, PING, Okta, OneLogin, KeyCloak and many more.

Can't find your IDP ? Contact us on idpsupport@xecurify.com. We'll help you set it up in no time.


Follow the Steps given below to Setup Single Sign On between miniOrange and Magento (miniOrange as IdP and Magento as SP)

Step 1: Download the plugin from here and Install it in Magento

  • Login as administrator in Magento.
  • Go to magento root directory. Create the new directories MiniOrange/SP inside the app/code directory.
  • Unzip all contents of the zip inside the MiniOrange/SP directory.
  • Run the the command on command prompt to enable the plugin - php bin/magento setup:upgrade.
  • After the installation if you see the blank page on the admin menu, follow the below steps-
    • Take a backup of global.php file under the path - {magento-directory}/generarted/metadata/global.php
    • Remove the global.php file.

Step 2: Configure Magento in miniOrange

  • Login into miniOrange Admin Console.
  • Go to Apps >> Manage Apps.
  • Magento Single Sign-On (SSO) manage apps

  • Click on Add Applicaton button.
  • Magento Single Sign-On (SSO) add app

  • In Choose Application Type click on Create App button in SAML/WS-FED application type.
  • Magento Single Sign-On (SSO) choose app type

  • In the next step, search for your application from the list, if your application is not found. Search for "custom" and you can set up your app via Custom SAML App.
  • Magento Single Sign-On (SSO) manage apps

  • Enter the metadata which we get from the Magento SAML SP Plugin (Identity Provider section of the plugin)
  • Scroll down to the Add Policy section. Enter the required information
  • Click on SAVE.
  • From the list of all apps present, look out for the app which you configured. Under Action column, click on Select and choose Metadata
  • Magento single sign on (sso) saml configuration

  • You will get three sections containing Metadata. When you are using miniOrange as IdP, you need to take metadata present in first section, Named as Information Required to set miniOrange as IDP
  • Magento single sign on (sso) saml configuration

  • You need to enter this metadata in the Service Provider section of the Magento plugin
  • Magento single sign on (sso) saml configuration

  • Now, click on the the Test Configuration button. Below screenshot shows the successful result.
  • This screenshot shows the attributes that are received and are mapped by attribute mapping.

  • Magento single sign on (sso) saml configuration

Step 3: Go to Role/Attribute Mapping Tab And fill in all the fields

  • Attribute Mapping :
    • Attribute Mapping is used by the Identity Provider(IdP) and the Magento group(SP) to map user information from IdP to SP.
    • Attribute Mapping helps you to get user attributes from your IdP and map them to Magento user attributes.
    • Attributes received in successful Test configuration are used for Attribute Mapping.
    • In Attribute Mapping details like username and NameID as shown in step 3 of Test Successful are mapped to Username and Email respectively.
    • While auto registering the users in your Magento group these attributes will automatically get mapped to your Magento user details.
    Magento single sign on (sso) mapping


  • Role Mapping :
    • Magento plugin assigns roles to groups which are mapped against those groups.
    • Magento uses a concept of Groups, designed to give the site owner the ability to control what groups can and cannot do within the site.
    • In Role Attribute enter the Attribute Name given against role value of Test Configuration for the user.
    • Role mapping helps you to assign specific roles to users of a Magento group from your IdP.

Magento single sign on (sso) mapping


Step 4: Login to your Magento account with miniOrange IdP by either of the two steps:

    Using SP Initiated Login

    1. Go to your Magento URL, here you will be either asked to enter the username or click on the SSO link which will redirect you to miniOrange IdP Sign On Page.
    2. Magento Single Sign-On (SSO) login

    3. Enter your miniOrange login credential and click on Login. You will be automatically logged in to your Magento account.

    Using IDP Initiated Login

    1. Login to miniOrange IdP using admin credentials and select the User Dashboard from the right side menu.
    2. Magento Single Sign-On (SSO) user dashboard

    3. Click on Magento application which you added, to verify your SSO configuration.
    4. Magento Single Sign-On (SSO) verify configuration

Step 5: Choose Your User Directory

5.1: Setup AD as User Directory

  1. Login to miniOrange dashboard from the Admin Console.
  2. From the left side menu, click on User Stores >> Add User Store.
  3. Magento Single Sign-On (SSO) configure user store

  4. Select User Store type as AD/LDAP.
  5. MagentoSingle Sign-On (SSO)Select AD/LDAP as user store

    1. STORE LDAP CONFIGURATION IN MINIORANGE: Choose this option if you want to keep your configuration in miniOrange. If active directory is behind a firewall, you will need to open the firewall to allow incoming requests to your AD.
    2. STORE LDAP CONFIGURATION ON PREMISE: Choose this option if you want to keep your configuration in your premise and only allow access to AD inside premises. You will have to download and install miniOrange gateway in your premise.
    3. Magento Single Sign-On (SSO) select ad/ldap user store type

  6. Enter LDAP Display Name and LDAP Identifier name.
  7. Select Directory Type as Active Directory.
  8. Enter the LDAP Server URL or IP Address against LDAP Server URL field.
  9. Click on Test Connection button to verify if you have made a successful connection with your LDAP server.
  10. Magento  Single Sign-On (SSO)configure LDAP server URL Connection

  11. In Active Directory, go to the properties of user containers/OU's and search for Distinguished Name attribute.
  12. Magento  Single Sign-On (SS0)configure user bind account domain name

  13. Enter the valid Bind account Password.
  14. Click on Test Bind Account Credentials button to verify your LDAP Bind credentials for LDAP connection.
  15. Magento  Single Sign-On (SS0)check bind account credentials

  16. Search Base is the location in the directory where the search for a user begins. You will get this from the same place you got your Distinguished name.
  17. Magento  Single Sign-On (SSO) configure user search base

  18. Select a suitable Search filter from the drop down menu. To use custom Search Filter select "Custom Search Filter" option and customize it accordingly.
  19. Magento Single Sign-On (SSO)select user search filter

  20. You can also configure following options while setting up AD. Enable Activate LDAP in order to authenticate users from AD/LDAP. Click on the Save button to add user store.
  21. Magento Single Sign-On (SSO) Activate ldap options

    Here's the list of the attributes and what it does when we enable it. You can enable/disable accordingly.

    Attribute Description
    Activate LDAP All user authentications will be done with LDAP credentials if you Activate it
    Sync users in miniOrange Users will be created in miniOrange after authentication with LDAP
    Backup Authentication If LDAP credentials fail then user will be authenticated through miniOrange
    Allow users to change password This allows your users to change their password. It updates the new credentials in your LDAP server
    Enable administrator login On enabling this, your miniOrange Administrator login authenticates using your LDAP server
    Show IdP to users If you enable this option, this IdP will be visible to users
    Send Configured Attributes If you enable this option, then only the attributes configured below will be sent in attributes at the time of login

  22. Click on Save. After this, it will show you the list of User stores. Click on Test Configuration to check whether you have enter valid details. For that, it will ask for username and password.
  23. Magento Single Sign-On (SSO)test AD/Ldap connection

  24. On Successful connection with LDAP Server, a success message is shown.
  25. Click on Test Attribute Mapping.
  26. Magento Single Sign-On (SSO) LDAP successful connection

  27. Enter a valid Username. Then, click on Test. Mapped Attributes corresponding to the user are fetched.
  28. Magento Single Sign-On (SSO)Fetch mapped attributes for user

  29. After successful Attribute Mapping Configuration, go back to the ldap configuration and enable Activate LDAP in order to authenticate users from AD/LDAP.
  30. Refer our guide to setup LDAPS on windows server.


5.2: Setup miniOrange as a User Store

  1. Log in to miniOrange Admin Console.
  2. There are 3 ways to setup miniOrange as an Identity Source

    5.2.1 Create User in miniOrange

    • Click on Users >> Add User.
    • Magento Single Sign-On (SSO)add user in miniOrange

    • Here, fill the user details without the password and then click on the Create User button.
    • MagentoSingle Sign-On (SSO) add user details

    • After successful user creation a notification message "An end user is added successfully" will be displayed at the top of the dashboard.
    • MagentoSingle Sign-On (SSO) add user details

    • Click on On Boarding Status tab. Check the email, with the registered e-mail id and select action Send Activation Mail with Password Reset Link from Select Action dropdown list and then click on Apply button.
    • Magento Single Sign-On (SSO) email action

    • Now, Open your email id. Open the mail you get from miniOrange and then click on the link to set your account password.
    • On the next screen, enter the password and confirm password and then click on the Single Sign-On (SSO) reset password button.
    • Magento reset user password
    • Now, you can log in into miniOrange account by entering your credentials.

    5.2.2 Bulk Upload Users in miniOrange via Uploading CSV File.

    • Navigate to Users >> User List. Click on Add User button.
    • Magento Single Sign-On (SSO)add user via bulk upload

    • In Bulk User Registration Download sample csv format from our console and edit this csv file according to the instructions.
    • Magento Single Sign-On (SSO) download sample csv file

    • To bulk upload users, choose the file make sure it is in comma separated .csv file format then click on Upload.
    • Magento Single Sign-On (SSO) bulk upload user

    • After uploading the csv file successfully, you will see a success message with a link.
    • Click on that link you will see list of users to send activation mail. Select users to send activation mail and click on Send Activation Mail. An activation mail will be sent to the selected users.

    5.2.3 Self User Registration

    • miniOrange self user registration allows end users to register themselves using customized registration form. miniOrange admin users can customize the registration form by adding more custom fields according to their choice. Follow the miniOrange guide to customize user self registration page.

Step 6: Adaptive Authentication with Magento

6.1: Restricting access to Magento with IP Blocking

    You can use adaptive authentication with Magento Single Sign-On (SSO) to improve the security and functionality of Single Sign-On. You can allow a IP Address in certain range for SSO or you can deny it based your requirements and you can also challenge the user to verify his authenticity. Adaptive authentication manages the user authentication bases on different factors such as Device ID, Location, Time of Access, IP Address and many more.

    You can configure Adaptive Authentication with IP Blocking in following way:
  • Login to Self Service Console >> Adaptive Authentication.
  • Add a Policy Name for your Adaptive Authentication Policy.
  • Magento Single Sign-On (SSO) Restrict Access adaptive authnetication policy

  • Select your Action for behaviour Change and Challenge Type for user from the Action for behaviour Change Section.
  • Magento Single Sign-On (SSO) Restrict Access adaptive authentication behaviour change


    Action for behaviour Change Options :


    Attribute Description
    Allow Allow user to authenticate and use services if Adaptive authentication condition is true.
    Challenge Challenege users with one of the three methods mentioned below for verifying user authenticity.
    Deny Deny user authentications and access to services if Adaptive authentication condition is true.

    Challenge Type Options :

    Attribute Description
    User second Factor The User needs to authenticate using the second factor he has opted or assigned for such as
  • OTP over SMS
  • PUSH Notofication
  • OTP over Email
  • And 12 more methods.
  • KBA (Knowledge-based authentication) The System will ask user for 2 of 3 questions he has configured in his Self Service Console. Only after right answer to both questions user is allowed to proceed further.
    OTP over Alternate Email User will recieve a OTP on the alternate email he has configured threw Self Service Conolse. Once user provides the correct OTP he is allowed to proceed further.

  • Now Enable Enable IP Restriction option from the IP RESTRICTION CONFIGURATION section to configure custom IP range.
  • Magento Single Sign-On (SSO) Restrict Access adaptive authentication ip blocking

  • Select the Action you want to perform if the IP address is out of the range. i.e Allow, Challenge & Deny.
  • Specify the IP Address range for which you want above setting to reflect. You can add more than one IP Address ranges by clicking on following button +.
  • Scroll to the end and click on save.


6.2: Adaptive Authentication with Limiting number of devices.

    Using Adaptive Authentication you can also restrict the number of devices the end user can access the Services on. You can allow end users to access services on a fixed no. of devices. The end users wii be able to access services provided by us on this fixed no. of devices.

    You can cofigure Adaptive Authentication with Device Restriction in follwing way

  • Login to Self Service Console >> Adaptive Authentication.
  • Add a Policy Name for your Adaptive Authentication Policy.
  • Select your Action for behaviour Change and Challenge Type for user from the Action for behaviour Change Section.
  • Magento Single Sign-On (SSO) Restrict Access adaptive authentication behaviour and challenge type


  • Scroll down to Device Configuration section and enable Allow User to Register Device option to allow users to register their devices.
  • Enter the Number of Devices which are allowed to register in field next to Number of Device Registrations Allowed
  • Choose Action if number of devices exceeded (This will override your setting for Action for Behaviour Change.)
    1. Challenge: The user needs to verify himself using any of the three methods mentioned in table in step 6.1
    2. Deny : Deny users access to the system
  • Enable option Send email alerts to Users if number of Device registrations exceeded allowed count if you want to alert the user about no of devices exceeding the limit. Save the configuration.
  • Magento Single Sign-On (SSO) Restrict Access adaptive authentication enable device restriction


6.3: Add Adaptive Authentication policy to Magento.

  • Login to Self Service Console >> Policies.
  • Click on Edit option for predefined SAML app policy.
  • Magento Single Sign-On (sso) edit device restriction policy

  • Set your application name in the Application and select password as Login Method.
  • Enable Adaptive Authentication on Policy page and select the required restriction method as an option.
  • From Select Login Policy dropdown select the policy we created in last step and click on save.
  • Magento Single Sign-On (SSO) Restrict Access save device restriction policy

    How to add a trusted Device
    1. When End-user log in to the self service console after the policy for device restriction is on, he is provided the option to add the current device as a trusted device.