Guide for OpenAM as IdP with Joomla

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.

 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.
  
  
• Click on Create Hosted Identity Provider. You will be redirected to the configuration page.
  
  
• 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.
    
    
  • Click on the Configure button on the top right corner.
  • Verify the configuration from the Federation tab of OpenAM.

 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.
  
  
• Click on Register Remote Service Provider. You will be redirected to the configuration page.
  
  
• 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.
    
    
• 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 Joomla as Service Provider (SP)

• In miniOrange SAML plugin, go to Service Provider Setup Tab. There are two ways to configure the plugin with your IDP:

I. By Uploading IDP Metadata.xml file(Recommended):

1. Click on Upload IDP Metadata to upload your IDP metadata.

2. Choose metadata file and click on Upload.



II. Manual Configuration :

• In miniOrange SAML plugin, go to Service Provider Setup Tab. Enter the following values:

  IDP Entity ID	Identity Provider Issuer from IDP Setup Instructions
  Single Sign-On Service URL	Identity Provider Single Sign-On URL from idp Setup Instructions
  X.509 Certificate	X.509 Certifiacate from IDP Setup Instructions

III. Add a button on your site login page with the following URL:

Step 3: Attribute Mapping (It is Optional to fill this). This is Premium feature.

• Attributes are user details that are stored in your Identity Provider.
• Attribute Mapping helps you to get user attributes from your Identity Provider and map them to Joomla user attributes like firstname, lastname etc.
• While auto registering the users in your Joomla site these attributes will automatically get mapped to your Joomla user details.
• In miniOrange SAML plugin, go to Attribute Mapping tab and fill in all the fields.

  Username:	Name of the username attribute from IdP (Keep NameID by default)
  Email:	Name of the email attribute from IdP (Keep NameID by default)
  Group/Role:	Name of the Role attribute from your Identity Provider


• You can check the Test Configuration Results under Service Provider Setup tab to get a better idea of which values to map here.

Step 4: Group Mapping (It is Optional to fill this). This is Premium feature.

• Joomla uses a concept of Roles, designed to give the site owner the ability to control what users can and cannot do within the site.
• Role mapping helps you to assign specific roles to users of a certain group in your Identity Provider.
• While auto registering, the users are assigned roles based on the group they are mapped to.

Step 5: Redirection & SSO Links.

• Go to Login Settings tab. There are multiple features availabe in this tab like Auto redirect the user to Identity Provider and Enable Backed Login for Super Users.To use these features, click on the respective checkboxes.

Additional Resources

• What is Single Sign-On (SSO)
• What is SAML
• Frequently Asked Questions (FAQs)