| Oracle® Identity Manager Connector Guide for Microsoft Active Directory Release 9.0.2 Part Number B32157-01 |
|
|
View PDF |
| Oracle® Identity Manager Connector Guide for Microsoft Active Directory Release 9.0.2 Part Number B32157-01 |
|
|
View PDF |
Deploying the connector involves the following steps:
If you want to configure the connector for multiple installations of Microsoft Active Directory, then perform the following procedure:
The following table lists the deployment requirements for the connector.
| Item | Requirement |
|---|---|
| Oracle Identity Manager | Oracle Identity Manager release 8.5.3 or later |
| Target systems | Microsoft Active Directory Server (Microsoft Windows 2000 or 2003) |
| Target system host platforms | The target system host platform can be any one of the following:
|
| Other software | Certificate Services |
| External code | JNDI LDAP Booster package (ldapsdk-4.1.jar) |
| Target system user account | Microsoft Windows 2000/2003 Server (Domain Controller) administrator
You provide the credentials of this user account while performing the procedure in the "Defining IT Resources" section. |
You must ensure that the parent organization exists in the target server installation. The parent organization is specified as the value of the Root Context parameter in the relevant IT resource. Refer to the "Defining IT Resources" section for more information about this parameter.
The connector files and external code files to be copied and the directories to which you must copy them are given in the following table.
|
Note: The directory paths given in the first column of this table correspond to the location of the connector files in the following ZIP file on the installation media:Directory Servers\Microsoft Active Directory\Microsoft Active Directory Rev 4.5.0.zip Refer to the "Files and Directories That Comprise the Connector" section for more information about these files. |
| File in the Installation Media Directory | Destination Directory |
|---|---|
Files in the xml directory |
OIM_home\xellerate\XLIntegrations\ActiveDirectory\xml
|
lib\xliActiveDirectory.jar |
OIM_home\xellerate\JavaTasks OIM_home\xellerate\ScheduleTask |
lib\xliADRecon.jar |
OIM_home\xellerate\JavaTasks OIM_home\xellerate\ScheduleTask |
ext\ldapsdk-4.1.jar |
OIM_home\xellerate\ThirdParty
|
Files in the scripts directory |
OIM_home\xellerate\scripts
After you copy the install.bat (or install.sh) file, use a text editor to open the file and specify the actual location of the JDK directory in the file. |
Files in the resources directory |
OIM_home\xellerate\connectorResources
|
Directories and files in the test directory |
OIM_home\xellerate\test
|
docs\B32157_01.pdf |
OIM_home\xellerate\docs\ActiveDirectory
|
|
Note: While installing Oracle Identity Manager in a clustered environment, you copy the contents of the installation directory to each node of the cluster. Similarly, you must copy theconnectorResources directory and the JAR files to the corresponding directories on each node of the cluster. |
Configuring the Oracle Identity Manager server involves the following procedures:
|
Note: In a clustered environment, you must perform this step on each node of the cluster. |
Changing to the required input locale involves installing the required fonts and setting the required input locale.
To set the required input locale:
|
Note: Depending on the operating system used, you may need to perform this procedure differently. |
Open Control Panel.
Double-click Regional Options.
On the Input Locales tab of the Regional Options dialog box, add the input locale that you want to use and then switch to the input locale.
Whenever you add a new resource bundle file in the OIM_home\xellerate\connectorResources directory or make a change in an existing resource bundle file, you must clear content related to connector resource bundles from the server cache.
To clear content related to connector resource bundles from the server cache:
In a command window, change to the OIM_home\xellerate\bin directory.
Enter one of the following commands:
|
Note: You must perform Step 1 before you perform this step. If you run the command as follows, then an exception is thrown:OIM_home\xellerate\bin\batch_file_name |
On Microsoft Windows:
PurgeCache.bat ConnectorResourceBundle
On UNIX:
PurgeCache.sh ConnectorResourceBundle
In this command, ConnectorResourceBundle is one of the content categories that you can remove from the server cache. Refer to the following file for information about the other content categories:
OIM_home\xellerate\config\xlConfig.xml
|
Note: You can ignore the exception that is thrown when you perform Step 2. |
You must import the connector XML files in the following sequence:
xliADOrganizationObject_DM.xml
xliADGroupObject_DM.xml
xliADUserObject_DM.xml
XliActiveDirectoryScheduleTask_DM.xml
|
Caution: If you do not import the connector files in the specified sequence, then the connector may not work. |
To import the connector XML files into Oracle Identity Manager:
Open the Oracle Identity Manager Administrative and User Console.
Click the Deployment Management link on the left navigation bar.
Click the Import link under Deployment Management. A dialog box for locating files is displayed.
Locate and open the xliADOrganizationObject_DM.xml file, which is in the OIM_home\xellerate\XLIntegrations\ActiveDirectory\xml directory. Details of this XML file are shown on the File Preview page.
Click Add File. The Substitutions page is displayed.
Click Next. The Confirmation page is displayed.
Click Next. The Provide IT Resource Instance Data page for the AD Server IT resource is displayed.
Specify values for the parameters of the AD Server IT resource. Depending on whether the operating system is Microsoft Windows 2000 or Microsoft Windows 2003, refer to the appropriate table in the "Defining IT Resources" section for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the AD Server IT resource type is displayed.
Click Skip to specify that you do not want to define another IT resource. The Confirmation page is displayed.
|
See Also: If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions. |
Click View Selections.
The contents of the XML file are displayed on the Import page. You may see a cross-shaped icon along with some nodes. Remove these nodes by right-clicking each node and then selecting Remove.
Click Import. The connector file is imported into Oracle Identity Manager.
Perform the same procedure to import the remaining connector XML files, in the specified order.
|
Note: The IT resources that you need to define are the same, regardless of the XML file that you import. Therefore, you only need to define the IT resources for the first XML file that you import. |
After you import the connector XML file, proceed to the "Step 6: Configuring Reconciliation" section.
This section provides IT resource parameter values for the following operating systems:
The following table provides values for the parameters of the AD Server IT resource, for Microsoft Windows 2000.
| Parameter | Description |
|---|---|
Admin FQDN |
Fully qualified domain name corresponding to the administrator
Format: Sample value: |
Admin Login |
User ID of the administrator account that is used to create the OU/user |
Admin Password |
Password of the administrator account that is used to create the OU/user |
Root Context |
This is the fully qualified domain name of the parent or root organization.
For example, the root suffix. Value: Sample value: |
Server Address |
Host name or IP address of the target Microsoft Windows 2000 computer on which Microsoft Active Directory is installed
Sample value: |
Last Modified Time Stamp |
Date and time at which the last AD User reconciliation run was completed
The reconciliation engine automatically fills a value in this attribute each time it runs the AD User reconciliation. Default value: |
Last Modified Time Stamp Group |
Date and time at which the last AD Group reconciliation run was completed
The reconciliation engine automatically fills a value in this attribute each time it runs AD Group reconciliation. Default value: |
Use SSL |
Specifies whether or not to use SSL to secure communication between Oracle Identity Manager and Microsoft Active Directory
Default value: |
SSL Port Number |
Port at which SSL is running on the Microsoft Active Directory server
Default value: |
AtMap ADUser |
Attribute map name for the Microsoft Active Directory user
Default value: |
AtMap Group |
Attribute map name for the Microsoft Active Directory group
Default value: |
Target Locale: Country |
Country code
Default value: Note: You must specify the value in uppercase. |
Target Locale: Language |
Language code
Default value: Note: You must specify the value in lowercase. |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
The following table provides values for the parameters of the AD Server IT resource, for Microsoft Windows 2003.
| Parameter | Description |
|---|---|
Admin FQDN |
Fully qualified domain name corresponding to the administrator
Format: Sample value: |
Admin Login |
User ID of the administrator account that is used to create the OU/user |
Admin Password |
Password of the administrator account that is used to create the OU/user |
Root Context |
Usually, this is the fully qualified domain name of the parent or root organization.
For example, the root suffix. Format: Sample value: |
Server Address |
Host name or IP address of the target Microsoft Windows 2000 computer on which Microsoft Active Directory is installed
Sample value: |
Last Modified Time Stamp |
Date and time at which the last AD User reconciliation run was completed
The reconciliation engine automatically fills a value in this attribute each time it runs the AD User reconciliation. Default value: |
Last Modified Time Stamp Group |
Date and time at which the last AD Group reconciliation run was completed
The reconciliation engine automatically fills a value in this attribute each time it runs AD Group reconciliation. Default value: |
Use SSL |
Specifies whether or not to use SSL to secure communication between Oracle Identity Manager and Microsoft Active Directory
Default value: |
SSL Port Number |
Port at which SSL is running on the Microsoft Active Directory server
Default value: |
AtMap ADUser |
Attribute map name for the Microsoft Active Directory user
Default value: |
AtMap Group |
Attribute map name for the Microsoft Active Directory group
Default value: |
Country |
Country code
Default value: Note: You must specify the value in uppercase. |
| Language | Language code
Default value: Note: You must specify the value in lowercase. |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
The scheduled tasks for reconciliation are created when you import the XliActiveDirectoryScheduleTask_DM.xml file as part of the procedure described in the "Step 5: Importing the Connector XML Files" section.
Additional tasks that you need to perform to configure reconciliation are described in the following sections:
If you are using Oracle Identity Manager release 9.0.1, then you must perform the following procedure to enable reconciliation:
You can select the fields that must be reconciled. To do this:
Open the Oracle Identity Manager Design Console.
Expand the Xellerate Administration folder.
Double-click Lookup Definition.
Search for the Lookup.ADReconciliation.FieldMap lookup definition by entering the name in the Code field and then clicking the Query icon.
To open the Lookup.ADReconciliation.FieldMap field map, double-click Lookup.ADReconciliation.FieldMap.
Add the required fields to the Lookup.ADReconciliation.FieldMap field map.
The following fields are provided by default in the Lookup.ADReconciliation.FieldMap field map:
memberOf
instanceType
Organization
givenName
sAMAccountName
IT Resource
objectGUID
name
sn
cn
whenChanged
distinguishedName
initials
displayName
|
Note: ThewhenChanged field is a mandatory field, which means that it must be present in the field map. |
|
Note: Perform this step of the procedure only if you want to configure trusted source reconciliation. Only one connector can be configured for trusted source reconciliation. If you configure trusted source reconciliation for this connector while you have another trusted source configured, then both connector reconciliations would stop working.Refer to Oracle Identity Manager Connector Framework Guide for conceptual information about reconciliation configurations. |
Use the Oracle Identity Manager Design Console to configure trusted source reconciliation as follows:
In the Resource Objects form, select the fields that you want to reconcile as follows:
Expand the Resource Management folder.
Double-click Resource Objects.
Enter Xellerate User in the Name field and then click the Query icon.
Double-click Xellerate User in the list that is displayed.
On the Object Reconciliation tab, add reconciliation fields as required. You must add all the reconciliation fields that are required to provide input for mandatory fields on the Xellerate User form, for example, fields such as User Login and First Name. However, you need not specify a value in the Password field, although it is a mandatory field.
In the Process Definition form, create reconciliation field mappings as follows:
Expand the Process Management folder.
Double-click Process Definition.
Enter Xellerate User in the Name field and then click the Query icon.
On the Reconciliation Field Mappings tab, add reconciliation field mappings as required. All the mandatory fields of the User Defined process form must be mapped.
In the Reconciliation Rules form, create a rule for the Xellerate User object as follows:
Expand the Development Tools folder.
Double-click Reconciliation Rules.
Create a rule for the Xellerate User object, with a rule element as required.
|
See: Oracle Identity Manager Design Console Guide for instructions |
Select the Active check box to enable the rule.
To create the reconciliation scheduled tasks:
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled tasks are displayed on two different tabs.
For the first scheduled task, enter a number in the Max Retries field. This number represents the number of times Oracle Identity Manager must attempt to complete the task before assigning the ERROR status to the task.
Ensure that the Disabled and Stop Execution check boxes are not selected.
In the Start region, double-click the Start Time field. From the date-time editor that is displayed, select the date and time at which you want the task to run.
In the Interval region, set the following schedule parameters:
To set the task to run on a recurring basis, select the Daily, Weekly, Recurring Intervals, Monthly, or Yearly option.
If you select the Recurring Intervals option, then you must also specify the time interval at which you want the task to run on a recurring basis.
To set the task to run only once, select the Once option.
Provide values for the attributes of the scheduled task. Refer to the "Specifying Values for the Scheduled Task Attributes" section for information about the values to be specified.
|
See Also: Oracle Identity Manager Design Console Guide for information about adding and removing task attributes |
Click Save. The scheduled task is created. The INACTIVE status is displayed in the Status field, because the task is not currently running. The task is run at the date and time that you set in Step 7.
Repeat Steps 5 through 10 to define the second scheduled task.
After you define both scheduled tasks, proceed to the "Enabling Reconciliation in Oracle Identity Manager Release 9.0.1" section.
This section provides information about the attribute values to be specified for the following scheduled tasks:
You must specify values for the following attributes of the lookup fields reconciliation scheduled task.
|
Note: Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change. |
After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
You must specify values for the following attributes of the user reconciliation scheduled task.
|
Note: Attribute values are predefined in the connector XML file that you import. Specify values only for those attributes that you want to change. Refer to Appendix A for more information about these attributes. |
After you specify values for these scheduled task attributes, proceed to Step 10 of the procedure to create scheduled tasks.
If you are using Oracle Identity Manager release 9.0.1, then you must perform the following procedure to enable reconciliation:
|
See Also: Oracle Identity Manager Design Console Guide |
Open the Process Definition form for the AD User. This form is in the Process Management folder.
Click the Reconciliation Field Mappings tab.
For each field that is of the IT resource type:
Double-click the field to open the Edit Reconciliation Field Mapping window for that field.
Deselect Key Field for Reconciliation Matching.
The following adapters are imported into Oracle Identity Manager when you import the connector XML file:
Chk Process Parent Org
AD Move OU
AD Get USNChanged
AD Get OU USNCR
Update AD Group Details
Get Group ObjectGUID Created
AD Delete Group
AD Create Group
Prepopulate AD Group Display Name
Prepopulate AD Group Name
check process organization
AD Set User Password
AD Set User CN Standard
AD Set Account Exp Date
AD remove User From Group
AD Pwd Never Expires
AD Must Change PWD
AD Move User New
AD Move User
AD Get ObjectGUID
AD Enable User
AD Disable User
AD Delete User
AD Create User
AD Change Attribute
AD Add User To Group
AD Prepopulate User Last Name
AD Prepopulate User Login
AD Prepopulate User Full Name
AD Prepopulate User Middle Name
AD Prepopulate User First Name
You must compile these adapters before you can use them to provision accounts on the target system.
To compile adapters by using the Adapter Manager form:
Open the Adapter Manager form.
To compile all the adapters that you import into the current database, select Compile All.
To compile multiple (but not all) adapters, select the adapters you want to compile. Then, select Compile Selected.
|
Note: Click Compile Previously Failed to recompile only those adapters that were not compiled successfully. Such adapters do not have anOK compilation status. |
Click Start. Oracle Identity Manager compiles the selected adapters.
If Oracle Identity Manager is installed in a clustered environment, then copy the compiled adapters from the OIM_home\xellerate\Adapter directory to the same directory on each of the other nodes of the cluster. If required, overwrite the adapter files on the other nodes. Then, restart each node.
To view detailed information about an adapter:
Highlight the adapter in the Adapter Manager form.
Double-click the row header of the adapter, or right-click the adapter.
Select Launch Adapter from the shortcut menu that is displayed. Details of the adapter are displayed.
|
Note: This is an optional step of the deployment procedure. |
To configure SSL connectivity between Oracle Identity Manager and the target Microsoft Active Directory server, you must perform the following tasks:
The connector requires Certificate Services to be running on the host computer. To install Certificate Services:
Insert the operating system installation media into the CD-ROM or DVD drive.
Click Start, Settings, and Control Panel.
Double-click Add/Remove Programs.
Click Add/Remove Windows Components.
Select Certificate Services.
Follow the instructions to start Certificate Services.
The target server must have LDAP over SSL (LDAPS) enabled. To enable LDAPS, generate a certificate as follows:
|
Note: Use the Enterprise CA option when you perform the following steps. |
On the Active Directory Users and Computers console, right-click the domain node, and select Properties.
Click the Group Policy tab.
Select Default Domain Policy.
Click Edit.
Click Computer Configuration, Windows Settings, Security Settings, and Public Key Policies.
Right-click Automatic Certificate Request Settings, and then select New and Automatic Certificate Request. A wizard is started.
Use the wizard to add a policy with the Domain Controller template.
At the end of this procedure, the certificate is created and LDAP is enabled using SSL on port 636.
If the Microsoft Active Directory certificate is not issued or certified by a certification authority (CA), then set it up as a trusted certificate. To do this, you first export the certificate and then import it into the keystore of the Oracle Identity Manager server as a trusted CA certificate.
To export the Microsoft Active Directory certificate:
Click Start, Programs, Administrative Tools, and Certification Authority.
Right-click the Certification Authority that you create, and then select Properties.
On the General tab, click View Certificate.
On the Details tab, click Copy To File.
Use the wizard to create a certificate (.cer) file using base-64 encoding.
To import the Microsoft Active Directory certificate into the certificate store of the Oracle Identity Manager server:
|
Note: In a clustered environment, you must perform this procedure on all the nodes of the cluster. |
Copy the certificate to the Oracle Identity Manager server.
Change to the directory where you copy the certificate file, and then enter a command similar to the following:
keytool -import -alias alias -file cer_file -keystore my_cacerts -storepass password
In this command:
alias is the alias for the certificate (for example, the server name)
cer_file is the full path and name of the certificate (.cer) file
my_cacerts is the full path and name of the certificate store (the default is cacerts)
The path of the certificate store depends on the application server as shown in the following table.
| Application Server | Certificate Store Location |
|---|---|
| JBoss Application Server |
JAVA_HOME\jre\lib\security\cacerts
|
| BEA WebLogic |
BEA_HOME\java\jre\lib\security\cacerts
|
| IBM WebSphere |
WS_HOME\java\jre\lib\security\cacerts WS_HOME\etc\DummyServerTrustFile.jks |
|
Note: For IBM WebSphere, you must also copy thejnet.jar, jsse.jar, and jcert.jar files to the WS_HOME\java\jre\lib\ext directory. You can download these JAR files from the Sun Web site at
|
password is the keystore password (the default is changeit)
For example:
keytool -import -alias thorADCert -file c:\thor\ActiveDir.cer -keystore C:\mydir\java\jre\lib\security\cacerts -storepass changeit
|
Note: changeit is the default password for the cacerts file stored in the Sun JVM. This may change depending on the JVM that you are using. |
In the command prompt window, when you are prompted to specify whether or not you want to trust this certificate, enter YES.
To confirm whether or not the certificate has been imported successfully, enter a command similar to the following:
keytool -list -alias alias -keystore mycacerts -storepass password
In the example given in Step 2, to confirm that the certificate has been successfully imported, use the following command and look for the certificate name, thorADCert, that you provide while importing the certificate into the keystore:
keytool -list -alias thorADCert -keystore C:\mydir\java\jre\lib\security\cacerts -storepass changeit
Perform this step only if you are registering the certificate file in a new certificate store.
Add the following line in the jre\lib\security\java.security file:
security.provider.N=com.sun.net.ssl.internal.ssl.Provider
In this line, N is a number that is not in use in the file.
Restart the Oracle Identity Manager server and the application server.
|
Note: The user password cannot be set unless 128-bit SSL is being used. In addition, the computer on which Microsoft Active Directory is installed must have Microsoft Windows 2000 Service Pack 2 or Microsoft Windows 2003 running on it. |
|
Note: Perform this procedure only if you want to configure the connector for multiple installations of Microsoft Active Directory. Refer to Oracle Identity Manager Design Console Guide for detailed instructions on performing each step of this procedure. |
To configure the connector for multiple installations of the target system:
Create and configure one IT resource for each target system installation.
The IT Resources form is in the Resource Management folder. An IT resource is created when you import the connector XML file. You can use this IT resource as the template for creating the remaining IT resources, of the same resource type.
Configure reconciliation for each target system installation. Refer to the "Step 6: Configuring Reconciliation" section for instructions. Note that you only need to modify the attributes that are used to specify the IT resource and to specify whether or not the target system installation is to be set up as a trusted source.
You can designate either a single or multiple installations of Microsoft Active Directory as the trusted source.
If required, modify the fields to be reconciled for the Xellerate User resource object.
When you use the Administrative and User Console to perform provisioning, you can specify the IT resource corresponding to the Microsoft Active Directory installation to which you want to provision the user.
