Oracle® Identity Manager Connector Guide for RSA Authentication Manager Release 9.0.3 Part Number B32366-01 |
|
|
View PDF |
Deploying the connector involves the following steps:
If you want to configure the connector for multiple installations of RSA Authentication Manager, 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 system | The target system can be any one of the following:
|
Target system host platforms | The target system host platform can be any one of the following:
|
Other systems |
|
Remote manager node user account | In Host mode, no credentials are required.
In Remote mode, any remote node user account would suffice. Refer to the "Defining IT Resources" section for details. |
Configuring the target system involves the following steps:
Configuring Strong Authentication Between Oracle Identity Manager and the Remote Manager
Configuring SSL Client (Oracle Identity Manager Server) Authentication
To set up the remote manager on the RSA Authentication Manager server:
Note:
For Solaris, you must create an ACE administrator as a preinstallation requirement for RSA Authentication Manager. This administrator is the file owner of the RSA Authentication Manager installation. Use this ACE administrator account to install the remote manager.Create the AuthManager
directory on the RSA Authentication Manager server.
From the installation media directory, copy the remotePackage
directory into the AuthManager
directory.
For Solaris 9
Log in to the Solaris server by using the user credentials of the RSA Authentication Manager File Owner that was created as a preinstallation requirement for RSA Authentication Manager. Then, create the directory into which you copy the remotePackage
directory.
Note:
If you copy files from Microsoft Windows to Solaris, all data transfer from the FTP client must be performed in binary mode. In addition, after copying files to the Solaris server, you must check the files for the^M
character pattern.
You must also perform required operations, such as dos2unix.
As described earlier, copy all the files while using the ACE administrator credentials.
To update the class files, copy the lib\xliACE.jar
file from the installation media directory to the xl_remote
\xlremote\JavaTasks
directory.
Note:
From this point onward in the guide, the full path of theremotePackage
directory on the RSA Authentication Manager server is referred to as xl_remote
.Update the library files as follows:
On Microsoft Windows:
Use a text editor to open the following file:
xl_remote\xlremote\remotemanager.bat
In this file, depending on the version of Authentication Manager that you are using, set one of the following as the first line of the file:
For ACE 5.0:
set PATH=authmgr_home\lib\ACE50;%PATH%
For ACE 5.2:
set PATH=authmgr_home\lib\ACE52;%PATH%
For RSA Authentication Manager 6.0:
set PATH=authmgr_home\lib\AuthMgr60;%PATH%
On Solaris 9:
For ACE 5.0:
Update the xl_remote
/xlremote/remotemanager.sh
file by adding the following lines:
AUTHMGR_HOME=authmgr_home export AUTHMGR_HOME ACE_INSTALL=ace_installation export ACE_INSTALL USR_ACE=$ACE_INSTALL/prog export USR_ACE VAR_ACE=$ACE_INSTALL/data export VAR_ACE DLC=$ACE_INSTALL/rdbms export DLC PROPATH=$ACE_INSTALL/prog/proapi/adbapi.pl:$ACE_INSTALL/prog/proapi/sdproapi.pl:$ACE_INSTALL/prog/protrig:$ACE_INSTALL/prog export PROPATH
Note:
In the third line,ace_installation
is the directory in which RSA ACE Server 5.0 is installed.For RSA ACE 5.2, add the following line:
LD_LIBRARY_PATH=$ACE_INSTALL/prog:$AUTHMGR_HOME/lib/ACE52Sol
For RSA Authentication Manager 6.0, add the following line:
LD_LIBRARY_PATH=$ACE_INSTALL/prog:$AUTHMGR_HOME/lib/AuthMgr60Sol
Then, add the following line:
export LD_LIBRARY_PATH
For RSA ACE Server 5.0, copy the ace_installation
\AuthManager\utils\toolkit\apidemon.exe
file into the xl_remote
\xlremote
directory.
Here, ace_installation
is the directory in which RSA ACE Server 5.0 is installed.
To configure strong authentication between Oracle Identity Manager and the remote manager, you must import the required certificate from the remote manager keystore to the Oracle Identity Manager server keystore as follows:
From the Oracle Identity Manager server, copy the OIM_home
\xellerate\config\xlserver.cert
file to the AuthManager_home
\scripts\config
directory on the RSA Authentication Manager server.
Use a text editor to open the authmgr_home
\scripts\AuthMgrImportXLCert.bat
file. Here, authmgr_home
is the directory in which RSA Authentication Manager is installed.
In this file, set the following parameters:
set JAVA_HOME=jdk_home set XL_REMOTE=xl_remote
For Solaris 9, set the following parameters in the authmgr_home
/scripts/AuthMgrImportXLCert.sh
file:
export XL_REMOTE=xl_remote export JAVA_HOME=jdk_home
Run the AuthMgrImportXLCert.bat
file.
For Solaris 9, run the AuthMgrImportXLCert.sh
file.
To configure SSL client (Oracle Identity Manager server) authentication:
Open the xl_remote
\xlremote\config\xlconfig.xml
file.
In the <RMSecurity>
section of this file, change the value of the <ClientAuth>
element to true.
The following is a code block from the xlconfig.xml
file:
<RMSecurity>
<RMIOverSSL>true</RMIOverSSL>
<SSLPort>12345</SSLPort>
<SSLContextAlgorithm>TLS</SSLContextAlgorithm>
<KeyManagerFactory>SunX509</KeyManagerFactory>
<BindingPort>12346</BindingPort>
<ServiceName>RManager</ServiceName>
<LoggerConfigFilePath>log.conf</LoggerConfigFilePath>
<ClientAuth>true</ClientAuth>
</RMSecurity>
Multiple Oracle Identity Manager Servers Communicating with a Single Remote Manager
If a setup involves more than one Oracle Identity Manager server communicating with a single remote manager, then you must address the considerations described in this section.
The OIM_home
\xellerate\config\xlserver.cert
certificate for any Oracle Identity Manager installation would have the same dname
value. If you import this certificate from one Oracle Identity Manager installation into the target system remote manager keystore, then you cannot directly use the same certificate from another installation for the same purpose and in the same manner.
Therefore, if one Oracle Identity Manager installation is already configured with a particular remote manager and the same is needed for another Oracle Identity Manager installation, then you must first create a certificate with a different DN for the second installation before you can use this new certificate with the remote manager.
Enter the following commands in the specified order.
Generate a new key pair by entering the following command:
jdk_home\jre\bin\keytool -genkey -alias xell2 -keyalg DSA -keysize 1024 -dname "CN=Customer1, OU=Customer, O=Customer, L=City, ST=NY, C=US" -validity 3650 -keypass xellerate -keystore OIM_home\xellerate\config\.xlkeystore -storepass xellerate -storetype jks -provider sun.security.provider.Sun
When you run this command, ensure that the dname
value specified in the preceding command, is not the same as the default value of dname,
for the existing certificates in the Oracle Identity Manager keystore:
OIM_home\xellerate\config\.xlkeystore
The default value is as follows:
CN=Customer, OU=Customer, O=Customer, L=City, ST=NY, C=US
Create a certificate request by entering the following command:
jdk_home\jre\bin\keytool -certreq -alias xell2 -file OIM_home\xellerate\config\xell1.csr -keypass xellerate -keystore OIM_home\xellerate\config\.xlkeystore -storepass xellerate -storetype jks -provider sun.security.provider.Sun
Export the certificate to a file by entering the following command:
jdk_home\jre\bin\keytool -export -alias xell2 -file OIM_home\xellerate\config\xlserver1.cert -keypass xellerate -keystore OIM_home\xellerate\config\.xlkeystore -storepass xellerate -storetype jks -provider sun.security.provider.Sun
This command creates the following security certificate:
OIM_home\xellerate\config\xlserver1.cert
This is the certificate that you must use for configuration purposes.
Import the certificate into the remote manager keystore by entering the following command:
jdk_home\jre\bin\keytool -import -trustcacerts -alias xel2trusted -noprompt -keystore OIM_home\xellerate\config\.xlkeystore -file OIM_home\xellerate\config\xlserver1.cert -storepass xellerate
For configuring strong authentication between another Oracle Identity Manager Server installation and the remote manager, use the OIM_home
\xellerate\config\xlserver1.cert
file instead of the xlserver.cert
file.
The connector 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 directory on the installation media:Security Applications\RSA Authentication Manager
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 |
---|---|
lib\xliACE.jar |
OIM_home\xellerate\JavaTasks OIM_home\xellerate\ScheduleTask |
Directories and files in the remotePackage directory |
OIM_home\xellerate\XLIntegrations\AuthManager\remotePackage
Note: You do not need to copy this directory if you already performed the procedure described in the "Setting Up the Remote Manager" section. |
Files in the resources directory |
OIM_home\xellerate\connectorResources
|
Directories and files in the scripts directory |
OIM_home\xellerate\XLIntegrations\AuthManager\scripts
|
Directories and files in the tests directory |
OIM_home\xellerate\XLIntegrations\AuthManager\tests
|
Files in the xml directory |
OIM_home\xellerate\XLIntegrations\AuthManager\xml
|
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 performing 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 (language and country setting) 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.When you enable logging, Oracle Identity Manager automatically stores in a log file information about events that occur during the course of provisioning and reconciliation operations. To specify the type of event for which you want logging to take place, you can set the log level to one of the following:
ALL
This level enables logging for all events.
DEBUG
This level enables logging of information about fine-grained events that are useful for debugging.
INFO
This level enables logging of informational messages that highlight the progress of the application at coarse-grained level.
WARN
This level enables logging of information about potentially harmful situations.
ERROR
This level enables logging of information about error events that may still allow the application to continue running.
FATAL
This level enables logging of information about very severe error events that could cause the application to stop functioning.
OFF
This level disables logging for all events.
The file in which you set the log level and the log file path depend on the application server that you use:
For JBoss Application Server
To enable logging:
In the JBoss_home
\server\default\conf\log4j.xml
file, locate the following lines:
<category name="XELLERATE">
<priority value="log_level"/>
</category>
In the second XML code line, replace log_level
with the log level that you want to set. For example:
<category name="XELLERATE"> <priority value="INFO"/> </category>
After you enable logging, log information is written to the following file:
JBoss_home\server\default\log\server.log
For IBM WebSphere:
To enable logging:
Add the following line in the OIM_home
\xellerate\config\log.properties
file:
log4j.logger.XELLERATE=log_level
In this line, replace log_level
with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO
After you enable logging, log information is written to the following file:
WebSphere_home\AppServer\logs\server_name\startServer.log
For BEA WebLogic
To enable logging:
Add the following line in the OIM_home
\xellerate\config\log.properties
file:
log4j.logger.XELLERATE=log_level
In this line, replace log_level
with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO
After you enable logging, log information is written to the following file:
WebLogic_home\user_projects\domains\domain_name\server_name\server_name.log
For OC4J
To enable logging:
Add the following line in the OIM_home
\xellerate\config\log.properties
file:
log4j.logger.XELLERATE=log_level
In this line, replace log_level
with the log level that you want to set.
For example:
log4j.logger.XELLERATE=INFO
After you enable logging, log information is written to the following file:
OC4J_home\opmn\logs\default_group~home~default_group~1.log
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 xliAuthMgrUser_DM.xml
file, which is in the OIM_home
\xellerate\XLIntegrations\AuthManager\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 ACE Remote Manager
IT resource is displayed.
Specify values for the parameters of the ACE Remote Manager
IT resource. Refer to the table in the "IT Resource: ACE Remote Manager" section for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the Remote Manager
IT resource type is displayed.
Click Skip to specify that you do not want to define another IT resource. The Provide IT Resource Instance Data page for the ACE Server Remote
IT resource is displayed.
See Also:
If you want to define another IT resource, then refer to Oracle Identity Manager Tools Reference Guide for instructions.Specify values for the parameters of the ACE Server Remote
IT resource. Refer to the table in the "IT Resource: ACE Server Remote" section for information about the values to be specified.
Click Next. The Provide IT Resource Instance Data page for a new instance of the ACE 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 XML file is imported into Oracle Identity Manager.
Perform this procedure again to import the remaining connector XML files in the following order:
Note:
The IT resources that you define while importing thexliAuthMgrUser_DM.xml
file are the same as those that you would need to define when you import the xliAuthMgrToken_DM.xml
file. Therefore, you do not need to define these IT resources again when you import the xliAuthMgrToken_DM.xml
file.xliAuthMgrToken_DM.xml xliAuthMgrScheduledTask_DM.xml
These files are in the OIM_home
\xellerate\XLIntegrations\AuthManager\xml
directory.
Note:
If you do not import the connector XML files in the specified order, then the connector may not work.After you import the connector XML files, proceed to the "Step 6: Configuring Reconciliation" section.
This section provides information about defining the following IT resources.
You must specify values for the ACE Remote Manager
IT resource parameters listed in the following table.
Parameter | Description |
---|---|
service name |
Remote manager service name
|
url |
Remote manager URL
For example: |
After you specify values for these IT resource parameters, proceed to Step 9 of the procedure to import connector XML files.
You must specify values for the ACE Server Remote
IT resource parameters listed in the following table.
Parameter | Description |
---|---|
ACEAdminMode |
Admin mode through which the connector connects to RSA Authentication Manager for provisioning and reconciliation
The value can be |
ACEAdminPassCode |
Admin passcode, which is required only when the admin mode is Remote
This value is encrypted after it is saved. Sample value: This value is encrypted after it is saved. |
ACEAdminUserId |
Admin user ID, which is required when the admin mode is either Remote or Host . |
Target Locale: Country |
Country code
Default value: Note: You must specify the value in uppercase. |
Target Locale: Language |
Language code
You can select one of the following:
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.
Configuring reconciliation involves performing the following procedures:
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 import thexliAuthMgrTrusted.xml
file 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.
To configure trusted source reconciliation, you must first import the XML file for trusted source reconciliation as follows:
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 xliAuthMgrTrusted.xml
file, which is in the OIM_home
\xellerate\XLIntegrations\AuthManager\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 Import.
In the message that is displayed, click Import to confirm that you want to import the XML file and then click OK.
Then, set the value of the IsTrusted
reconciliation scheduled task attribute to True
while performing the procedure described in the following section.
When you use this connector to run provisioning functions that are specific to software tokens, you must provide the required input parameters, such as the Token Code.
You can determine the values of these token-specific parameters only after the RSA Software Token application is installed on the Oracle Identity Manager server or on a user computer other than the Oracle Identity Manager server.
If you are using RSA SecurID software tokens, then:
Download RSA SecurID Token for Windows Desktops 3.0.5 from
Install the file on the Oracle Identity Manager server.
Copy the RSA SecurID software token file to an appropriate location on the Oracle Identity Manager server. The file to be copied is in the RSA Authentication Manager installation directory. The format of the directory path where you copy this file can be as follows:
target_dir_location\Token1File\
Note:
While assigning a software token to an ACE user, you must specify the name and complete location of this file (in thedb_file_location
\
file_name
.sdtid
format) in the Software Token File Name process form field.Import the .sdtid
file into the RSA SecurID Token software application as follows:
Click Start, and then select Programs.
Click RSA SecurID Software Token, and select the subcategory RSA SecurID Software Token.
The token screen is displayed.
Click the File menu, and then select Import Tokens. In the dialog box that is displayed, select the .sdtid
file mentioned in Step 3.
For example:
target_dir_location\Token1File\file_name.sdtid
Select the token serial number, and click Transfer Selected Tokens to Hard Drive. The software token is imported.
On the screen that is displayed, click View and then select Advanced View.
On the screen that is displayed, click View and then select Token View to view the software token number.
To create the reconciliation scheduled task:
Expand the Xellerate Administration folder.
Select Task Scheduler.
Click Find. The details of the predefined scheduled task are displayed.
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, set 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 to run the task on a recurring basis.
To set the task to run only once, select the Once option.
Provide values for the user-configurable attributes of the scheduled task. Refer to the following table for information about the values to be specified.
See Also:
Oracle Identity Manager Design Console Guide for information about adding and removing task attributesAttribute | Description | Sample Value |
---|---|---|
IsTrusted |
Specifies whether or not reconciliation must be performed in trusted mode | True or False |
Server |
Name of the IT resource | ACE Server Remote |
Target System Recon - Resource Object name |
Name of the target system resource object corresponding to the RSA Authentication Manager User | Auth Manager User |
Target System Recon - Token Resource Object name |
Name of the target system resource object corresponding to the RSA Authentication Manager User | Auth Manager Token |
Trusted Source Recon - Resource Object name |
Name of the trusted source Resource Object | Xellerate User |
IsDeleteAllowed |
Specifies whether or not the users who have been deleted in the target system should be deleted in Oracle Identity Manager | True or False |
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.
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 GuideOpen the Process Definition form for the Auth Manager 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:
ACE ASSIGN TO GROUP
ACE DELETE USER
ACE CREATE USER
ACE PrePop DefLogin
ACE PrePop FirstName
ACE PrePop GrpLogin
ACE PrePop LastName
ACE ASSIGN TOKEN
ACE REMOVE TOKEN
ACE DISABLE TOKEN
ACE SET PIN
ACE SET PIN TO NTC
ACE TRACK LOST TOKEN
ACE ENABLE TOKEN
ACE TEST LOGIN
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.
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:
Perform this procedure only if you want to configure the connector for multiple installations of RSA Authentication Manager. 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 need to modify only 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 RSA Authentication Manager 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 RSA Authentication Manager installation to which you want to provision the user.