SAML Single Sign On SSO WordPress using OpenAM

Step 1:Setup OpenAM as Identity Provider

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


miniorange img  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.


  • In the miniOrange SAML SP SSO plugin, navigate to Service Provider Metadata tab. Here, you can find the SP metadata such as SP Entity ID and ACS (AssertionConsumerService) URL which are required to configure the Identity Provider.
    • wordpress saml upload metadata
  • 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.

    OpenAM sso-1
  • Click on Create Hosted Identity Provider. You will be redirected to the configuration page.

    OpenAM sso-2
  • 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.

      OpenAM sso-3
    • Click on the Configure button on the top right corner.
    • Verify the configuration from the Federation tab of OpenAM.
miniorange img  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.

    OpenAM sso-4
  • Click on Register Remote Service Provider. You will be redirected to the configuration page.

    OpenAM sso-5
  • Configure the Service Provider as given below.

    • Where does the metadata file reside: URL.
    • URL of metadata: Configure miniOrange plugin’s SAML 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.

      OpenAM sso-6
  • 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 plugin) and 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

Step 2: Configuring WordPress as SP

Free



In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

  • Click on Upload IDP metadata button.
  • Enter the Identity Provider Name
  • You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
    • wordpress saml upload metadata

B.Manual Configuration:

  • Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.

Step 3: Attribute Mapping

  • In the free plugin, only NameID is supported for Email and Username attributes of the WordPress user.
  • When a user performs SSO, the NameID value sent by the IDP will get mapped to the email and username of the WordPress user.
    • wordpress saml attribute mapping

Step 4: Role Mapping

  • In the free plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.
  • Go to Attribute/Role mapping tab and navigate to Role Mapping section.
  • Select the Default Role and click on the Save button.
    • wordpress saml role mapping

Step 5: SSO settings

  • In the free plugin you can add a login widget to enable SP-Initiated SSO on your site.
  • Navigate to Redirection and SSO links tab and follow the given steps given under Option 1: Use a Widget to add a login widget on your site.
    • wordpress saml sso setting

Standard



In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

  • Click on Upload IDP metadata button.
  • Enter the Identity Provider Name
  • You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.

B.Manual Configuration:

  • Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.

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 WordPress.
  • In WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.
    • wordpress saml attribute mapping

    NOTE: If you click on Test Configuration button in Service Provider Setup tab and authenticate with your IDP, you can see a list of attributes sent by the IDP in the Attribute/Role mapping tab. This information can be used to provide the above mapping.

Step 4: Role Mapping

    In the standard plugin, you can choose a default role which will be assigned to all the non-admin users when they perform SSO.

  • Go to Attribute/Role mapping tab and navigate to Role Mapping section.
  • Select the Default Role and click on the Save button.
    • wordpress saml role mapping

Step 5: SSO settings

    In the Standard plugin you can enable SP-initiated SSO using the following options.

  • Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication, they will be redirected back to the same page on your site which they were trying to access.

    • Steps:

      1.  Go to Redirection and SSO Links tab of the plugin and navigate to Option 1: Auto-      Redirection from site.

      2.  Enable Redirect to IdP if user not logged in [PROTECT COMPLETE SITE] option.

      wordpress saml optin 1

  • Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.

    • Steps:

      1.  Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto-      Redirection from WordPress Login.

      2.  Enable Redirect to IdP from WordPress Login Page option.

      wordpress saml optin 2

      NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP.



  • SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Redirection and SSO Links tab > Option 3: SSO Links section of the plugin
    • wordpress saml optin 3

Premium



In miniOrange SAML plugin, go to Service Provider Setup tab of the plugin. There are two ways to configure the plugin:

A. By uploading IDP metadata:

  • Click on Upload IDP metadata button.
  • Enter the Identity Provider Name
  • You can either upload a metadata file and click on Upload button or use a metadata URL and click on Fetch Metadata.
  • In the Premium plugin, you can enable auto-sync for the metadata URL which will auto-update the plugin configuration as per the IDP metadata after a set interval of time
    • wordpress saml enableauto scan

B.Manual Configuration:

  • Provide the required settings (i.e. Identity Provider Name, IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate) as provided by your Identity Provider and click on the Save button.
  • In the Premium Plugin, you can provide the SAML Logout URL to achieve Single Logout on your WordPress site.

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 WordPress.
  • In WordPress SAML plugin, go to Attribute/Role Mapping tab and fill up the following fields in Attribute Mapping section.
    • wordpress saml attribute mapping
  • Custom Attribute Mapping: This feature allows you to map any attribute sent by the IDP to the usermeta table of WordPress.
    • wordpress saml custom attribute mapping

Step 4: Role Mapping

    This feature allows you to assign and manage roles of the users when they perform SSO. Along with the default WordPress roles, this is compatible with any custom roles as well.

  • From the Attribute Mapping section of the plugin, provide a mapping for the field named Group/Role. This attribute will contain the role related information sent by the IDP and will be used for Role Mapping.
  • Navigate to role mapping section and provide the mappings for the highlighted roles.
    • wordpress saml role mapping
  • For example, If you want a user whose Group/Role attribute value is wp-editor to be assigned as an Editor in WordPress, just provide the mapping as wp-editor in the Editor field of Role Mapping section.

Step 5: SSO settings

    In the Premium plugin you can enable SP-initiated SSO using the following options.

  • Auto-Redirection from site: If this option is enabled, any unauthenticated user trying to access your site will get redirected to the IDP login page and after successful authentication they will be redirected back to the same page on your site which they were trying to access.

    • Steps:

      1.  Go to Redirection and SSO Links tab of the plugin and navigate to Option 1 : Auto-Redirection from site.
      2.  Enable Redirect to IdP if user not logged in [PROTECT COMPLETE SITE] option.

      wordpress saml optin 1

  • Auto-Redirection from WordPress Login: If this option is enabled, any unauthenticated user trying to access the default WordPress login page will get redirected to the IDP login page for authentication. After successful authentication, they will be redirected back to the WordPress site.

    • Steps:

      1.  Go to Redirection and SSO Links tab of the plugin and navigate to Option 2: Auto-      Redirection from WordPress Login.
      2.  Enable Redirect to IdP from WordPress Login Page option.

      wordpress saml optin 2

      NOTE: Please enable the Backdoor login and note down the backdoor URL. This will allow you to access the WordPress login page in case you get locked out of the IDP login.

  • Login Button: You can add a customized login button anywhere on your site or WordPress login page by navigating to Option 3: Login Button section of Redirection and SSO Links tab.
    • wordpress saml optin 3
  • SSO Links: You can add SSO links anywhere on your site using the Shortcode and Widget provided in Option 4: SSO Links section of Redirection and SSO Links tab.
    • wordpress saml optin 4

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