2 Deploying the Password Synchronization Module

This guide covers two scenarios:

• Upgrading an existing instance of the password synchronization module to the current version

  To implement this option, follow the instructions provided in Chapter 3.

• Deploying the password synchronization module

  To implement this option, follow the instructions provided in this chapter.

Deploying the password synchronization module involves performing the following general procedures:

• Step 1: Preparing to Install the Password Synchronization Module

• Step 2: Enabling Password Policies for Active Directory

• Step 3: Installing the Password Synchronization Module

• Step 4: Performing Postinstallation Steps for the Password Synchronization Module

• Step 5: Configuring the Password Synchronization Module

Step 1: Preparing to Install the Password Synchronization Module

To prepare for installation, first verify that the following deployment requirements are addressed:

• An instance of Oracle Identity Manager release 8.5.3.1 or later is installed, running, and visible to the computer hosting the Active Directory domain controller on which you want to install the password synchronization module.

  
  

  See Also: Depending on the application server that you use, refer to one of the following guides: Oracle Identity Manager Installation and Upgrade Guide for JBoss Oracle Identity Manager Installation and Upgrade Guide for WebLogic Oracle Identity Manager Installation and Upgrade Guide for WebSphere Oracle Identity Manager Installation and Upgrade Guide for Oracle Containers for J2EE

  
  

• Suppose you use IBM WebSphere to host your Oracle Identity Manager installation. Then on the computer where you are installing the password synchronization module, you must install an instance of the IBM WebSphere Application Client that is compatible with the installed version of IBM WebSphere.

  
  

  Note: This step does not apply if the application server hosting the Oracle Identity Manager server to which Active Directory will connect is either JBoss Application Server or BEA WebLogic.

  
  

• The computer on which you are installing the password synchronization module meets the requirements listed in the following table.

Item	Requirement
Microsoft Active Directory	Active Directory Server
Host operating system	Any one of the following: Microsoft Windows 2000 with Service Pack 4 or later Microsoft Windows Server 2003

Note: You must install a separate instance of the password synchronization module on each Active Directory domain controller for which you require password synchronization to the user account stores managed by Oracle Identity Manager.

The installation files for the password synchronization module are compressed in the following ZIP file on the installation media:

Directory Servers\Microsoft Active Directory\Microsoft Active Directory Password Sync Rev 4.5.0.zip

After verifying the deployment requirements, copy the ZIP file to a directory on the Oracle Identity Manager server. Extract the contents of the ZIP file into this directory.

See Also: The "Files and Directories That Comprise the Password Synchronization Module" section for more information about the files in the installation media ZIP file

Step 2: Enabling Password Policies for Active Directory

To enable password policies for Active Directory:

1. On the Microsoft Windows computer hosting the Active Directory domain controller on which you are installing the password synchronization module, start the Domain Security Policy application.

   To do this, on the Microsoft Windows computer, click the Start menu, Programs, Administrative Tools, and Domain Security Policy.

2. If you are using Microsoft Active Directory 2003, then directly proceed to the next step.

   If you are using Microsoft Active Directory 2000, then select Window Settings on the left pane of the Domain Security Policy application window and then proceed to the next step.

3. Select Security Settings, expand Account Policies, and then click Password Policy.

4. Double-click Passwords must meet complexity requirements. The Password Must Meet Complexity Requirements Properties dialog box is displayed.

5. In the dialog box, select Define this policy setting, select Enabled, and then click OK.

Step 3: Installing the Password Synchronization Module

To install the password synchronization module:

1. On the computer hosting the Active Directory domain controller where you are installing the password synchronization module:

   1. Open Microsoft Windows Explorer.

   2. Navigate to the temporary directory into which you extract the contents of the installation media ZIP file.

   3. Double-click the setup_ad.exe file to start the installer.

   4. Specify a language.

2. Click Next.

3. On the Target Directory page, you can either accept the default installation directory or specify the path to the directory in which you want install the module. For example, you can specify a path similar to the following:

   C:\OracleProvisioningAD

   Alternatively, you can use the Browse button to navigate to the installation directory.

4. Click Next.

   The installer creates a directory named adsynch inside the installation directory that you specify. Then, it copies the password synchronization module components into the adsynch directory and creates certain directories inside the adsynch directory.

   
   

   Note: From this point onward, this guide refers to the directory user_specified_install_directory\adsynch as ADSYNC_HOME.

   
   

5. On the Application Server page, specify the application server that hosts the Oracle Identity Manager server to which the Active Directory domain controller will connect. Then, click Next.

   
   

   Note: If you specify IBM WebSphere as the application server, then perform the next step. Otherwise, directly proceed to Step 7.

   
   

6. On the WebSphere Directory page, specify the path to the directory where the IBM WebSphere Application Client is installed, on the computer where you are installing the module. Then, click Next.

7. On the JRE page, specify the JRE option that you want to use with the module. The following choices are available:

   • JRE bundled with Oracle Identity Manager

   • An existing JRE 1.4.2 installation on the computer where you are installing the password synchronization module. The following table lists the appropriate JRE version for the supported application servers.

   Application Server	Required JRE	Comments
   JBoss Application Server	Sun JRE 1.4.2_09 or later	However, all versions of Sun JRE 1.5 are not supported.
   BEA WebLogic	Sun JRE 1.4.2_09 or later	However, all versions of Sun JRE 1.5 are not supported.
   IBM WebSphere	IBM JRE 1.4.2_x	Available as part of the IBM WebSphere Application Client installation that is compatible with IBM WebSphere on the server on which Oracle Identity Manager is installed

   
   

   For an existing JRE installation, you must specify the path to the installation. Then, click Next.

8. On the System Administration page, specify the account name and password required to log in to the Oracle Identity Manager server.

   The default account for login is xelsysadm.

   After specifying the required information, click Next.

9. On the Application Server Configuration page, specify the following:

   • The host name or IP address of the application server hosting Oracle Identity Manager

   • The naming port associated with the application server. The following table lists the default naming ports for the supported application servers.

     Application Server	Default Naming Port
     JBoss Application Server	1099
     BEA WebLogic	7001
     IBM WebSphere	2809

     
     

   If the application server for Oracle Identity Manager uses a nondefault naming port, then use that port number and consult your system administrator for additional guidance.

   After you specify the required information, click Next.

10. On the Summary page, verify that the installation directory for the module, which you specify on the Target Directory page, is correctly displayed.

    If you need to change the installation directory, click Back until you reach the Target Directory page, make the required changes, and then proceed through the installation sequence again.

    When the installation directory is displayed correctly, click Install.

11. The Complete page displays a message indicating successful installation.

    Click Finish to close the installer.

12. Restart the computer.

Files Copied During Password Synchronization Module Installation

The following table lists the installation locations for the key components of the password synchronization module.

File	Description
Windows_System32_Directory\Adsync.dll	This file is registered as a listener for password changes to the Active Directory Domain controller. Whenever an Active Directory password is changed, this file calls the Change Password script named ChangePassword.cmd.
ADSYNC_HOME\config\xlconfig.xml	This file contains all the user-configurable settings for the password synchronization module. Users can edit this file after installing the module. For details, refer to the "Step 5: Configuring the Password Synchronization Module" section.
ADSYNC_HOME\lib\xliADSync.jar	This JAR file contains the class files required by the Change Password script.
ADSYNC_HOME\ChangePassword.cmd	This script, which is called by adsync.dll in response to a password change, uses the required classpath and command-line parameters to call the ChangePassword class, which is in the xliADSync.jar file.
ADSYNC_HOME\wsChangePassowrd.cmd	This is the version of the Change Password script that is used by IBM WebSphere.
ADSYNC_HOME\lib\xliADSync.ear	This file contains the class files required by the version of the Change Password script used by IBM WebSphere.

Step 4: Performing Postinstallation Steps for the Password Synchronization Module

Perform the following postinstallation steps:

1. Copy the following files from the OIM_home\ext directory to the ADSYNC_HOME\ext directory on the computer where you installed the password synchronization module:

   • javagroups-all.jar or jgroups-all.jar

   • oscache-2.0.2-22Jan04.jar or oscache.jar

2. Depending on the application server that is used, copy one of the following files to the ADSYNC_HOME\ext directory:

   • JBoss_home\client\jbossall-client.jar (for JBoss Application Server)

   • BEAWebLogic_home\weblogic81\server\lib\weblogic.jar (for BEA WebLogic)

3. Copy all the JAR files from the OIM_Design_Console_installation_dir\lib directory on the computer hosting the Oracle Identity Manager Design Console to the ADSYNC_HOME\lib directory on the computer where you install the password synchronization module.

4. If you plan to run Oracle Identity Manager on a clustered application server, then:

   1. Establish a trust relationship between the computer hosting Oracle Identity Manager and the computer hosting the Active Directory domain controller on which you install the password synchronization module.

   2. Add the host name of the computer hosting Oracle Identity Manager to the hosts file of the computer hosting the Active Directory domain controller on which you install the password synchronization module.

   3. Edit the xlconfig.xml file associated with the password synchronization module you install. This file is located in the ADSYNC_HOME\config directory.

      In the xlconfig.xml file, change the <java.naming.provider.url> tag to the value stored in the tag in the xlconfig.xml file associated with the instance of the Design Console that you previously installed as part of the Oracle Identity Manager deployment.

      Each instance of the xlconfig.xml file is in the config directory. This directory is in the root installation directory for the component with which the configuration file is associated. For example, the path of the xlconfig.xml file associated with the password synchronization module is as follows:

      ADSYNC_HOME\config
      
      

      After you update the value of the <java.naming.provider.url> tag in the xlconfig.xml file associated with the password synchronization module, save and close the file.

Step 5: Configuring the Password Synchronization Module

After you complete installation of the password synchronization module, you can configure it by editing the xlconfig.xml file, which is located in the ADSYNC_HOME\config directory.

To configure the parameters in the xlconfig.xml file, first open the file by using any text editor. The following table lists the elements you can configure within the <ADsync> tag in the xlconfig.xml file.

Tag Within the <ADSync> Tag	Description
<UserMatch> </UserMatch>	The MatchingMethod parameter specifies how Oracle Identity Manager matches an Oracle Identity Manager user to the Active Directory ID passed to the adsync.dll file. The first of the following three options is the default. Use it when all the login IDs in Oracle Identity Manager match all the Active Directory user IDs. When the login IDs in Oracle Identity Manager and the Active Directory IDs do not match, then use one of the remaining options. UserID: The Active Directory user ID matches the Oracle Identity Manager user login. UDF: The Active Directory user ID matches the UDF specified in the <FieldName> attribute. ResourceField: The Active Directory user ID matches the <FieldName> attribute in the process form of the Oracle Identity Manager user to whom a resource object specified by the <ResourceObject> attribute is provisioned.
<Result> </Result>	This optional configuration element specifies where the result of the password change operation must be logged (apart from the adsync.log file). Values for the following parameters are provided as tags within the <Result> tag: UpdateUDF: Set to True or False to update a status field in the Users form. FieldName: Specify a field name when the UpdateUDF tag is set to True. For example, FieldName can be USR_UDF_STATUS. FailureValue: This string goes into the status field if the password reset operation fails. SuccessValue: This string goes into the status field if the password reset operation succeeds. AppendTimeStamp: Set this to True or False to append a timestamp to the string in the status field.

The following sample XML code provides a listing of the original (default) contents of the <ADSync> tag:

<ADSync>
  <!-- 
  The Login section provides information about how the utility is authenticated.
  If UseSignature is true, then the username is used for authentication, using the
  signature-based login. The key in the "PrivateKey" alias is used.
  If UseSignature is false, then the username and password are used for
  authentication.
  -->
  <Login>
   <UseSignature>false</UseSignature>
   <Username>xelsysadm</Username>
   <Password encrypted="true">tPzEM127PIQxO64w2g7wgw==</Password>
  </Login>
  <!-- 
  The Active Directory name should match an Oracle Identity Manager username.
  If the MatchingMethod is UserID, the Active Directory username is assumed to be
  the Oracle Identity Manager user name.
  For UDF, FieldName must contain the name of the User Defined field that
  contains the active directory user ID.
  For ResourceField, process forms of the users who have ResourceObject
  specified are searched to find the required user. This can be used if
  Active Directory is provisioned as an account, but not a trusted source.
  -->
  <UserMatch>
   <!-- UserID, UDF and ResourceField -->
   <MatchingMethod>UserID</MatchingMethod>
   <FieldName>UD_ADUSER_LOGIN</FieldName>
   <ResourceObject>AD User</ResourceObject>
  </UserMatch>
  <!-- 
  If required, a UDF field can be updated with the result of the operation and
  Timestamp so that additional workflow can be started.
  -->
  <Result>
   <UpdateUDF>false</UpdateUDF>
   <FieldName>USR_UDF_ADPWDRES</FieldName>
   <SuccessValue>SUCCESS</SuccessValue>
   <FailureValue>FAIL</FailureValue>
   <AppendTimeStamp>true</AppendTimeStamp>
  </Result>
</ADSync>

After you make the required changes to the user-configurable tags in the xlconfig.xml file, save and close the file.