Guide for OpenAM as IdP with Drupal

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 Drupal as Service Provider (SP)

• In miniOrange SAML Module, go to Service Provider Setup tab. There are three ways to configure the Module:

 By OpenAM Metadata URL :

• Click on Upload IDP Metadata.
• Enter Metadata URL and click on Fetch Metadata.

 By Uploading OpenAM Metadata File:

• Click on Upload IDP Metadata.
• Upload metadata file and click on Upload.

 Manual Configuration :

• Copy SAML Entity ID, SAML Single-Sign-On Endpoint URL and X.509 certificate from Federation Metadata document and paste it in IdP Entity ID or Issuer, SAML Login URL, X.509 Certificate fields respectively in the Module.

Identity Provider Name	For Example:OpenAM
IdP Entity ID or Issuer	SAML Entity ID in the Federation Metadata document
SAML Login URL	SAML Single-Sign-On Endpoint URL in the Federation Metadata document
X.509 Certificate	x.509 Certificate in the Federation Metadata document

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 (IdP) and map them to Drupal user attributes like firstname, lastname etc.
• While auto registering the users in your Drupal site these attributes will automatically get mapped to your Drupal user details.
• In miniOrange SAML Module, go to 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 Key:	Name of the Role attribute from Identity Provider (IdP)


• 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: Role mapping. (It is Optional to fill this.) This is Premium feature.

• Drupal 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 (IdP).
• While auto registering, the users are assigned roles based on the group they are mapped to.

Step 5: Sign In Setting. This is Premium feature.

• Go to SIGNIN Settings tab. There are multiple features availabe in this tab like Protect your whole site, Auto redirect the user to Identity Provider,auto-create user and Backdoor Login. To use these features, click on the respective checkboxes.