SAML Single Sign-On (SSO) into October CMS Using OpenAM

SAML Single Sign-On (SSO) into October CMS Using OpenAM


October CMS Single Sign-On ( SSO ) plugin gives the ability to enable SAML Single Sign-On (SSO) for your October CMS sites. Our October CMS SSO plugin is compatible with all the SAML compliant Identity providers. Here we will go through a step-by-step guide to configure SAML SSO between October CMS site and your Identity Provider.

Pre-requisites

To integrate your Identity Provider(IDP) with October CMS, you need the following items:

  • October CMS should be installed and configured.
  • Download any Front-end user management plugins - RainLab/Buddies.

Download and Installation

  • Login to your October CMS site’s backend: https://example.com/backend.
  • From the admin dashboard, go to Settings from the main navigation bar and select Updates & Plugins.
  • Click on Install plugins and in the search bar type “SAML SSO”.
  • Click on the SAML SP Single Sign-On - SSO search result and the plugin will start installing.
  • October CMS SAML SSO, October as SP

Step 1 : Setup OpenAM as Identity Provider

All the information required to configure in the OpenAM i.e. plugin’s metadata is given in the Service Provider Info tab of the miniOrange SAML plugin.


SAML Single Sign On (SSO) using OpenAM Identity Provider,OpenAM SSO Login  Create OpenAM as a Hosted Identity Provider

Note: – You can skip this step and navigate to Configure Remote Service Provider if you have already configured OpenAM hosted IDP.


  • Login to the OpenAM admin console.
  • From the REALMS, select realms, under which you want to create hosted IDP. You will be redirected to the Realm overview page.
  • Click on Create SAMLv2 Providers in the Realm Overview page.

    SAML Single Sign On (SSO) using OpenAM Identity Provider, Select Identity Provider Profile
  • Click on Create Hosted Identity Provider. You will be redirected to the configuration page.

    SAML Single Sign On (SSO) using OpenAM Identity Provider, Register IDP
  • Configure SAML IDP as given below.

    • Name: Name of the SAML IDP
    • Signing Key: Select the signing key from the dropdown.
    • New Circle of Trust: Provide a name of the groups of IDP and SP that trust each other.
    • Attribute Mapping: Configure user profile attributes to be sent to the Service Provider application.

      SAML Single Sign On (SSO) using OpenAM Identity Provider, Configure Identity Provider
    • Click on the Configure button on the top right corner.
    • Verify the configuration from the Federation tab of OpenAM.
SAML Single Sign On (SSO) using OpenAM Identity Provider,OpenAM SSO Login  Configure Remote Service Provider.

  • Login to the OpenAM admin console.
  • From the REALMS, select realms, under which you want to configure your application. You will be redirected to the Realm overview page.
  • Click on Create SAMLv2 Providers.

    SAML Single Sign On (SSO) using OpenAM Identity Provider, Select Service Provider Profile
  • Click on Register Remote Service Provider. You will be redirected to the configuration page.

    SAML Single Sign On (SSO) using OpenAM Identity Provider, Register SAML Service Provider
  • Configure the Service Provider as given below.

    • Where does the metadata file reside: URL.
    • URL of metadata: Configure miniOrange SAML plugin's metadata here.
    • Circle of Trust: Add to existing.
    • Existing Circle of Trust: Select the Circle of Trust (group) in which your hosted IDP is located.
    • Attribute Mapping: Configure user profile attributes for mapping.

      SAML Single Sign On (SSO) using OpenAM Identity Provider, Configure Service Provider details
  • Click on the Configure button on the top right corner.
  • Verify the configuration from the Federation tab of OpenAM.
  • Provide OpenAM SAML metadata to Service Provider application(miniOrange SAML plugin).
  • You can download the OpenAM metadata using the URL given below.
    [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp
  • In case if you have multiple realms and hosted identity Provider configured then use the URL given below.
    [OpenAM ServerURL]/saml2/jsp/exportmetadata.jsp?entityid=[IdPentityID]&realm=/realmname

Steps 2 : October CMS as SP


  • Click on Single Sign On menu option from the main navigation bar at the top of your page.
  • You will see the Plugin Settings page. We will first configure the IdP Settings.
  • Fill out the required fields according to the information provided by your Identity Provider. You can refer to the example given below.
  • For Example:
  • IdP Name:myIDP
    IdP Entity Id:https://login.xecurify.com/moas/
    SAML Login URL:https://login.xecurify.com/moas/idp/samlsso
    SAML x509 Certificate:Certificate provided by your IdP.
  • Click on Save button.
  • October CMS SAML SSO, October as SP
  • The SP Settings tab has the data that you will need to provide to your IdP.
  • October CMS SAML SSO, October as SP
  • Click on the Test Configuration button and the user details will be fetched. Test configuration will show the attributes that are received and are mapped by attribute mapping.
  • October CMS SAML SSO, October as SP

Step 3: Attribute Mapping

  • Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at October CMS.
  • Go to Attribute Mapping menu option from the main navigation bar at the top of your page.
  • It provides the Custom Atrribute Mapping feature in Premium plugin.
  • October CMS SAML SSO, October as SP

  • Click on Single Sign On menu option from the main navigation bar at the top of your page.
  • You will see the Plugin Settings page. We will first configure the IdP Settings.
  • Fill out the required fields according to the information provided by your Identity Provider. You can refer to the example given below.
  • For Example:
  • IdP Name:myIDP
    IdP Entity Id:https://login.xecurify.com/moas/
    SAML Login URL:https://login.xecurify.com/moas/idp/samlsso
    SAML Logout URL:https://login.xecurify.com/moas/idp/samllogout/
    SAML x509 Certificate:Certificate provided by your IdP.
  • Click on Save button.
  • October CMS SAML SSO, October as SP
  • The SP Settings tab has the data that you will need to provide to your IdP.
  • October CMS SAML SSO, October as SP
  • Click on the Test Configuration button and the user details will be fetched. Test configuration will show the attributes that are received and are mapped by attribute mapping.
  • October CMS SAML SSO, October as SP

Step 3: Attribute Mapping

  • Attribute Mapping feature allows you to map the user attributes sent by the IDP during SSO to the user attributes at October CMS.
  • Go to Attribute Mapping menu option from the main navigation bar at the top of your page.
  • It also provide Custom Attribute mapping feature, which allows you to map any attribute sent by the IDP to the October CMS.
  • You can map the attribute names received in Test Configuration to the user credentials of your October CMS users.
  • October CMS SAML SSO, October as SP

Step 4: SSO Button Component

  • Click on CMS from the main navigation and select the page that you want to place the button on from the Pages menu on the left-hand side.
  • Click on Components and click on SAML 2.0 SP to reveal the SSO Button component.
  • Drag and drop the component on to your selected page. Hit save and preview.
  • Click on the Single Sign-On (SSO) button to start the authentication flow for frontend users.
  • October CMS SAML SSO, October as SP
  • The button for Backend login screen is generated automatically.

Step 5: SSO Options

  • In the IDP Settings tab, you can configure Force Authentication to force login screen at IdP every time your users are redirected for SSO.
  • You can configure the Login Binding type to choose the method of sending the SAML request.
  • You can configure the Single Logout URL to send a logout request to the IdP when a user logs out of your OctoberCMS site.
  • October CMS SAML SSO, October as SP
  • In the SP Settings tab, you can configure Auto-Redirect to redirect users to IdP when they land on your site.
  • You can configure the Post-Login and Post-Logout URLs to redirect users after they SSO and Single Logout.
  • October CMS SAML SSO, October as SP
  • You can access the documentation for more details by going to Settings > Updates & Plugins > SAML 2.0 SP.

If you are looking for anything which you cannot find, please drop us an email on info@xecurify.com