This chapter describes how to install and configure Lotus Domino 11g Release 2 WebGate for Oracle Access Manager.
This chapter contains the following sections:
Installing Lotus Domino 11g WebGate for Oracle Access Manager involves the following steps:
Installing the Lotus Domino web server
Installing Lotus Domino 11g WebGate for Oracle Access Manager
Completing the post-installation configuration steps
Verifying the Lotus Domino 11g WebGate installation
Registering the new WebGate agent
This section contains the following topics:
The Oracle Fusion Middleware Supported System Configurations document provides certification information for Oracle Fusion Middleware, including supported installation types, platforms, operating systems, databases, JDKs, and third-party products related to Oracle Identity and Access Management 11g Release 2 (11.1.2.1.0).
You can access the Oracle Fusion Middleware Supported System Configurations document by searching the Oracle Technology Network (OTN) web site:
http://www.oracle.com/technetwork/middleware/ias/downloads/fusion-certification-100350.html
You must have Java runtime environment (JRE) 1.7 or higher installed.
You can download the Installer from the Oracle Technology Network (OTN):
http://docs.oracle.com/cd/E23104_01/download_readme.htm
Alternatively, you can download the latest Oracle Fusion Middleware 11g software from the following website:
http://edelivery.oracle.com/
For information about installing and configuring Oracle HTTP Server 11g (11.1.1.7.0), see Oracle Fusion Middleware Installation Guide for Oracle Web Tier.
For information about installing Oracle Access Manager (OAM), see "Installing and Configuring Oracle Identity and Access Management (11.1.2.2.0)" in Oracle Fusion Middleware Installation Guide for Oracle Identity and Access Management.
For information about configuring Oracle Access Manager in a new or existing WebLogic administration domain, see "Configuring Oracle Access Manager" in Oracle Fusion Middleware Installation Guide for Oracle Identity and Access Management.
In addition, see "Securing Communication" in Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager for information about configuring Oracle Access Manager in Open, Simple, or Cert mode.
This section discusses the following topics:
For information about obtaining the Lotus Domino 11.1.2.2.0 WebGate software, see Oracle Fusion Middleware Download, Installation, and Configuration ReadMe.
To start the installation wizard, perform the following steps:
Go to the directory in which you extracted the contents of the Installer.
Go to the following location:
cd Disk1
Run the following command:
On Windows:
setup.exe -jreLoc <location_of_jre>
Provide the jre location when the Oracle Universal Installer (OUI) prompts for it.
After the Installer starts, the Welcome screen is displayed. Proceed with the installation by referring to Section 6.3.3.
To install Lotus Domino 11g WebGate for Oracle Access Manager, follow the instructions in Table 6-1.
If you need additional help with any of the installation screens, then click Help to access the online help.
| No. | Screen | Description and Action Required |
|---|---|---|
|
1. |
Welcome Screen |
Click Next to continue. |
|
2. |
Prerequisite Checks Screen |
Click Next to continue. |
|
3. |
Specify Installation Location Screen |
Specify the Oracle home location. For more information about these directories, see "Understanding Oracle Fusion Middleware Concepts and Directory Structure" in Oracle Fusion Middleware Installation Planning Guide for Oracle Identity and Access Management. Click Next to continue. |
|
4. |
Installation Summary Screen |
Verify the information on this screen. Click Install to begin the installation. |
|
5. |
Installation Progress Screen |
Click Next to continue. |
|
6. |
Installation Complete Screen |
Click Finish to dismiss the installer. |
You must complete the following steps after installing Oracle HTTP Server 11g WebGate for Oracle Access Manager:
Move to the following directory under your Oracle home for WebGate:
WebGate_Home\webgate\domino85\tools\deployWebGate
Run the following command to copy the required bits of agent from the WebGate_Home directory to the WebGate_Instance location:
/deployWebGateInstance -w <WebGate Instancedir> -oh <WebGate Oracle Home> -ws <Web Server>
where <Web Server> value is domino in case of domino9 Server
<Web Server> value is domino85 in case of domino8.5.X Server.
Note:
Make sure that Domino Server is not running.Run the configureDominoWebGate.bat tool for updating Domino Webserver configuration. This will update the Domino notes.ini file with WebGate specific configuration.
ConfigureDominoWebGate -w <WebGate Instancedir> -oh <WebGate Oracle Home> -ws <Web Server> -notes <path to notes.ini>
WebGate_Instance_Dir is the directory in which the new WebGate instances are created.
WebGate_Oracle_Home is the full path to the WebGate Oracle home.
Path to notes.ini is the full path of the notes.ini configuration file of Domino8.x/9.x server.
Register the WebGate.dll as DSAPI filter from Domino console.
Go to Domino Admin console and select Internet Protocols and configure the complete path to webgate.dll in DSAPI filters.
Restart the WebServer to enforce the new changes.
Set the environment variable LD_LIBRARY_PATH, to WebGate_Oracle_Home/lib.
Example:
export LD_LIBRARY_PATH=/home/Oracle_OAMWebGate1/lib
On Windows, we do not set LD_LIBRARY_PATH, instead update the path variable:
set PATH=<Oracle_OAMWebGate1/webgate/domino/lib>;%PATH%
i.e., Add a semicolon (;) followed by this path at the end of the entry for the path environment variable.
After installing Lotus Domino 11g WebGate for Oracle Access Manager and completing the post-installation steps, you can examine the installDATE-TIME_STAMP.out log file to verify the installation. The default location of the log are as follows:
WebGate_Home/oraInst.loc
Before you can use the new Lotus Domino 11g WebGate agent for Oracle Access Manager, you must complete the following tasks:
You can register the new WebGate agent with Oracle Access Manager by using the Oracle Access Manager Administration console. For more information, see "Registering an OAM Agent Using the Console" in Oracle Fusion Middleware Administrator's Guide for Oracle Access Management.
Alternatively, you can use the RREG command-line tool to register a new WebGate agent. You can use the tool to run in two modes: In-Band and Out-Of-Band.
This section contains the following topics:
To set up the RREG tool, complete the following steps:
After installing and configuring Oracle Access Manager, go to the following location:
Oracle_IDM2\oam\server\rreg\client
Extract the contents of the RREG.tar.zip file to a destination of your choice.
The tool for registering the agent is located at:
RREG_Home\bin\oamreg.bat
Note:
RREG_Home is the directory in which you extracted the contents of RREG.tar.gz/rreg.Set the following environment variables in the oamreg.bat script:
OAM_REG_HOME
Set this variable to the absolute path to the directory in which you extracted the contents of RREG.tar/rreg.
JDK_HOME
Set this variable to the absolute path to the directory in which Java or JDK is installed on your machine.
You must update the agent parameters, such as agentName, in the OAM11GRequest.xml file in the RREG_Home\input directory.
Note:
TheOAM11GRequest.xml file or the short version OAM11GRequest_short.xml is used as a template. You can copy this template file and use it.Modify the following required parameters in the OAM11GRequest.xml file or in the OAM11GRequest_short.xml file:
serverAddress
Specify the host and the port of the OAM Administration Server.
agentName
Specify any custom name for the agent.
agentBaseUrl
Specify the host and the port of the machine on which Lotus Domino 11g WebGate is installed.
preferredHost
Specify the host and the port of the machine on which Lotus Domino 11g WebGate is installed.
security
Specify the security mode, such as open, based on the WebGate installed.
primaryServerList
Specify the host and the port of Managed Server for the Oracle Access Manager proxy, under a Server container element.
After modifying the file, save and close it.
Note:
You need to add <Webgate Oracle Home>\webgate\dominoXX\lib folder in Path variable in case of Windows Operating system.If you run the RREG tool once after updating the WebGate parameters in the OAM11GRequest.xml file, then the files and artifacts required by WebGate are generated in the following directory:
RREG_Home\output\agent_name
Note:
You can run RREG either on a client machine or on the server. If you are running it on the server, then you must manually copy the artifacts back to the client.Complete the following steps:
Open the OAM11GRequest.xml file, which is in the input directory at RREG_Home\input. RREG_Home is the directory on where you extracted the contents of RREG.tar.gz/rreg.
Edit the XML file and specify parameters for the new Lotus Domino Server WebGate for Oracle Access Manager.
Run the following command:
RREG_Home\bin\oamreg.bat inband input\OAM11GRequest.xml
If you are an end user with no access to the server, then you can email your updated OAM11GRequest.xml file to the system administrator, who can run RREG in the out-of-band mode. You can collect the generated AgentID_Response.xml file from the system administrator and run RREG on this file to obtain the WebGate files and artifacts you require.
After you receive the generated AgentID_Response.xml file from the administrator, you must manually copy the file to the input directory on your machine.
Complete the following steps:
If you are an end user with no access to the server, then open the OAM11GRequest.xml file, which is in RREG_Home\input\ directory.
RREG_Home is the directory in which you extracted the contents of RREG.tar.gz/rreg. Edit this XML file, specify parameters for the new Lotus Domino WebGate for Oracle Access Manager, and send the updated file to your system administrator.
If you are an administrator, copy the updated OAM11GRequest.xml file, which is in RREG_Home\input\. This is the file you received from the end user. Go to your (administrator's) RREG_Home directory and run the following command:
RREG_Home\bin\oamreg.bat outofband input\OAM11GRequest.xml
An Agent_ID_Response.xml file is generated on the administrator's machine in the RREG_Home\output\ directory. Send this file to the end user who sent you the updated OAM11GRequest.xml file.
If you are an end user, copy the generated Agent_ID_Response.xml file, which is in RREG_Home\input\. This is the file you received from the administrator. Go to your (client's) RREG home directory and run the following command:
RREG_Home\bin\oamreg.bat outofband input\Agent_ID_Response.xml
Note:
If you register the WebGate agent by using the Oracle Access Manager Administration Console, as described in "Registering an OAM Agent Using the Console" in the Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager, then you must manually copy the files and artifacts generated after the registration from the server (the machine on which the Oracle Access Manager Administration Console is running) to the client machine. The files and artifacts are generated in theMW_HOME/user_projects/domains/name_of_the_WebLogic_domain_for_OAM/output/Agent_ID directory.Regardless of the method or mode you use to register the new WebGate agent, the following files and artifacts are generated in the RREG_Home/output/Agent_ID directory:
cwallet.sso
ObAccessClient.xml
In SIMPLE mode, RREG generates:
password.xml, which contains the obfuscated global passphrase to encrypt the private key used in SSL. This passphrase can be the same as the passphrase used on the server.
aaa_key.pem
aaa_cert.pem
In CERT mode, RREG generates password.xml, which contains the obfuscated global passphrase to encrypt the private key used in SSL. This passphrase can be different than the passphrase used on the server.
Note:
You can use these files generated by RREG to generate a certificate request and get it signed by a third-party Certification Authority. To install an existing certificate, you must use the existingaaa_cert.pem and aaa_chain.pem files along with password.xml and aaa_key.pem.After RREG generates these files and artifacts, you must manually copy them, based on the security mode you are using, from the RREG_Home/output/Agent_ID directory to the WebGate_Instance_Home directory.
Do the following according to the security mode you are using:
In OPEN mode, copy the following files from the RREG_Home/output/Agent_ID directory to the WebGate_Instance_Home/webgate/config directory:
ObAccessClient.xml
cwallet.sso
In SIMPLE mode, copy the following files from the RREG_Home/output/Agent_ID directory to the WebGate_Instance_Home/webgate/config directory:
ObAccessClient.xml
cwallet.sso
password.xml
In addition, copy the following files from the RREG_Home/output/Agent_ID directory to the WebGate_Instance_Home/webgate/config/simple directory:
aaa_key.pem
aaa_cert.pem
In CERT mode, copy the following files from the RREG_Home/output/Agent_ID directory to the WebGate_Instance_Home/webgate/config directory:
ObAccessClient.xml
cwallet.sso
password.xml
From the openssl or any other tool you can generate a new certificate.
Copy the following generated certificates to the WebGate_Instance_Home/webgate/config directory:
aaa_key.pem
aaa_cert.pem
cacert.pem located in the simpleCA directory
Note:
After copying thecacert.pem file, you must rename the file to aaa_chain.pem.Migrating an Existing Certificate
If you want to migrate an existing certificate (aaa_key.pem, aaa_cert.pem, and aaa_chain.pem), ensure that you use the same passphrase that you used to encrypt aaa_key.pem. You must enter the same passphrase during the RREG registration process. If you do not use the same passphrase, then the password.xml file generated by RREG will not match the passphrase used to encrypt the key.
If you enter the same passphrase, you can copy these certificates as follows:
Go to the WebGate_Instance_Home/webgate/config directory.
Copy the following certificates to the WebGate_Instance_Home/webgate/config directory:
aaa_key.pem
aaa_cert.pem
aaa_chain.pem
For setting up the Domino WebGate as DCC WebGate, you need to configure the path to WebGate login files in Domino Webserver.
Login to Domino Admin Console.
On the left side pane, expand Web > Web Server Configurations, open the Domino Server.
In the Domino Server configuration, select Create Web > URL Mapping/Redirection.
/oamsso-bin -> <WebGateHome>\webgate\domino\oamsso-bin
/oamsso -> <WebGateHome>\webgate\domino\oamsso
Permissions to be provided for each mapping from the Domino console:
For /oamsso-bin: Execute
For /oamsso: Read
You should always use the instructions provided in this section for removing the Lotus Domino 11.1.2.2.0 WebGates for Oracle Access Manager. If you try to remove the software manually, then you may experience problems when you try to reinstall the software again at a later time. Following the procedures in this section will ensure that the software is properly removed.
To deinstall the WebGate agent, do the following:
Go to the MW_HOME\WebgGate_home\oui\bin.
Run the following command:
setup.exe -deinstall -jreLoc JRE_LOCATION
Ensure that you specify the absolute path to your JRE_LOCATION; relative paths are not supported.
After the deinstaller starts, the Welcome screen is displayed. Proceed with the deinstallation by referring to Section 6.8.1.
Follow the instructions in Table 6-2 to complete the deinstallation.
If you need additional help with any of the deinstallation screens, then click Help to access the online help.
| Sl. No. | Screen | Description | Action Required |
|---|---|---|---|
|
1. |
Welcome |
Each time the deinstaller starts, the Welcome screen is displayed. |
Click Next. |
|
2. |
Deinstall Oracle Home |
The Deinstall Oracle Home screen shows the Oracle home you are about to deinstall. |
Verify the Oracle home you are about to deinstall. Click Deinstall. On the Warning screen, select whether or not you want the deinstaller to remove the Oracle home directory in addition to removing the software. Click Yes to have the deinstaller remove the software and Oracle home, No to remove only the software, or Cancel to return to the previous screen. If you select No, go to Section 6.8.2 for instructions on how to manually remove your Oracle home directory. |
|
3. |
Deinstallation progress |
The Deinstallation Progress screen shows the progress and status of the deinstallation. |
Wait until the Deinstallation Complete screen appears. |
|
4. |
Deinstallation Complete |
The Deinstallation Complete screen appears when the deinstallation is complete. |
Click Finish to dismiss the screen. |
If you have selected No on the warning screen during deinstallation, then you must manually remove your WebGate_Home directory and any sub-directories. For example: if your Oracle WebGate home directory was /home/Oracle/Middleware/Oracle_OAMWebGate1, run the following command:
cd /home/Oracle/Middleware/
rm -rf Oracle_OAMWebGate1
If your Oracle Common home directory was C:\Oracle\Middleware\Oracle_OAMWebGate1, then use a file manager window, go to the C:\Oracle\Middleware directory, right-click on the Oracle_OAMWebGate1 folder, and then select Delete.
To run the Lotus Domino 11g WebGate in silent mode, complete the following steps:
Set the contents of the silent.rsp file. For example:
[ENGINE] #DO NOT CHANGE THIS. Response File Version=1.0.0.0.0 [GENERIC] ORACLE_HOME=/home/MW_HOME/domino_WebGate_home MIDDLEWARE_HOME=/home/MW_HOME [SYSTEM] [APPLICATIONS] [RELATIONSHIPS]
In the preceding file, the parameters are as follows:
ORACLE_HOME: Provide the Oracle Home location. This is the directory in which you want to install the new Lotus Domino WebGate. The location must be an immediate child folder under the specified Middleware Home location. The Oracle Home directory name can contain only alphanumeric, hyphen (-), dot (.), and underscore (_) characters, and must begin with an alphanumeric character. The total length has to be less than or equal to 128 characters. For example, home/middleware/domino_webgate.
MIDDLEWARE_HOME: Specify the full path to your Middleware home directory.
Extract the contents of the installer to a directory.
Run the following command:
WebGate_Installer_Directory/Disk1/runInstaller -jreLoc jre_location -invPtrLoc Absolute_Path_Of_the_oraInst.loc_file -silent -response Absolute_Path_Of_the_silent.rsp_file
In the preceding command:
WebGate_Installer_Directory is the absolute path to the directory in which you have extracted the contents of the WebGate installer.
jre_location is the absolute path to the JRE directory.
Absolute_Path_Of_the_oraInst.loc_file is the absolute path to the oraInst.loc file.
Absolute_Path_Of_the_ silent.rsp_file is the absolute path to the silent.rsp file you created.