1. Installing WebGates for Oracle Access Manager
  2. Installing and Configuring Apache WebGate for OAM

4 Installing and Configuring Apache WebGate for OAM

This chapter describes how to install and configure Apache WebGate for Oracle Access Manager. For an introduction to WebGates and an overview of installing WebGates, see About WebGates for Oracle Access Manager.

This chapter contains the following sections:

Installation Overview of Apache WebGate

Installing Apache WebGate for Oracle Access Manager includes the following steps:

  1. Installing the Apache web server
  2. Installing Apache WebGate for Oracle Access Manager
  3. Completing the post-installation configuration steps
  4. Verifying the Apache WebGate installation
  5. Registering the new WebGate agent

Prerequisites for Apache WebGate

This section discusses the following topics:

Oracle Fusion Middleware Certification

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.

See Oracle Fusion Middleware Supported System Configurations document at http://www.oracle.com/technetwork/middleware/ias/downloads/fusion-certification-100350.html.

Installing JRE

You must have a 64-bit Java runtime environment (JRE) 17 or higher installed.

You can download the latest JRE from the following download site:

http://www.oracle.com/technetwork/java/javase/downloads/index.html

Installing and Configuring Apache 2.4

For information about installing and configuring Apache 2.4, see the Apache product documentation.

Installing and Configuring OAM

For information about installing Oracle Access Manager (OAM), see Installing and Configuring Oracle Identity and Access Management Software 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 Management in Oracle Fusion Middleware Installation Guide for Oracle Identity and Access Management.

For information about configuring Oracle Access Manager in Open or Cert mode, see Securing Communication in Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager .

Installing Apache WebGate

This section includes the following topics:

Obtaining the Software

For information about obtaining the Apache software, see Oracle Fusion Middleware Download, Installation, and Configuration ReadMe.

Starting the Apache WebGate Installer

To start the installation wizard, do the following:

  1. Go to the directory in which you extracted the contents of the Installer.
  2. Run the following command:

    (UNIX) ./fmw_14.1.2.0.0_apachewebgate_linux64.bin

    (Windows) fmw_14.1.2.0.0_apachewebgate_win64.bat

After the Installer starts, the Welcome screen appears. Continue by referring to the section Installation Flow and Procedure of Apache 14c WebGate for installing Apache WebGate for Oracle Access Manager.

Installation Flow and Procedure of Apache 14c WebGate

To install Apache WebGate for Oracle Access Manager, follow the instructions in Table 4-1.

If you need additional help with any of the installation screens, click Help to access the online help.

Table 4-1 Installation Flow of Apache WebGate

No. Screen Description and Action Required

1

Welcome Screen

Click Next to continue.

2

Specify Installation Location Screen

Specify the Middleware home and Oracle home locations.

For more information about these directories, see Understanding Your Installation Starting Point in Planning an Installation of Oracle Fusion Middleware.

Oracle home in case of Apache WebGate is any valid directory, not necessarily in the Middleware home. So, if you do not provide a Middleware home or if you provide an invalid Middleware home, the Installer proceeds without any error.

Click Next to continue.

3

Prerequisite Checks Screen

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.

Post-Installation Steps for Apache WebGate

This section includes the following topics:

Deploying the Apache WebGate Instance

Create an Apache instance by using the deployWebGateInstance.sh tool from the Webgate Oracle home directory.

To deploy the WebGate instance, do the following:

  1. Go to the WebGate_Oracle_Home/webgate/apache/tools/deployWebGate directory by running the following command:

    cd WebGate_Oracle_Home/webgate/apache/tools/deployWebGate

  2. Run the following command:

    ./deployWebGateInstance -w WebGate_Instancedir -oh WebGate_Oracle_Home -ws apache

    In this command:

    • WebGate_Instancedir is the directory in which the new WebGate instances should be created.

    • WebGate_Oracle_Home is the WebGate Oracle home directory you specified while installing Apache WebGate.

    • Web server is Apache.

Setting the Environment Variable

For Apache WebGate, set the environment variable:

  • On Linux: 

    export LD_LIBRARY_PATH="$APACHE_HOME:$WEBGATE_ORACLE_HOME/lib:$LD_LIBRARY_PATH"
  • On Windows: 
    set PATH=%WEBGATE_ORACLE_HOME%\bin;%PATH%

Running the EditHttpConf Tool

To run the EditHttpConf tool, do the following:

  1. Go to the WebGate_Oracle_Home/webgate/apache/tools/setup/InstallTools directory by running the following command:

    cd WebGate_Oracle_Home/webgate/apache/tools/setup/InstallTools

  2. Run the following command:

    On UNIX:

    ./EditHttpConf -f /home/webserver-apache24/conf/httpd.conf -oh /home/Webgate_Oracle_Home/ -w /home/webserver-apache24/webgate_instanceApache/ -ws apache24

    On Windows:

    \EditHttpConf.bat \home\webserver-apache24\conf\httpd.conf -oh\home\Webgate_Oracle_Home\ -w \home\webserver-apache24\webgate_instanceApache\ -ws apache24

    In the preceding command:

    • path_to_httpd.conf_file is the full path of the Apache instance httpd.conf file.

    • WebGate_Instance_Dir is the directory in which new WebGate instances are created.

    • WebGate_Oracle_Home is the full path to the WebGate Oracle home.

    • The name of the webserver is WebServer. For Apache 2.4, use apache24.

    For example:

    On Apache 2.4:

    cd /home/OAMWebGate1/webgate/apache/tools/setup/InstallTools/

    ./EditHttpConf -f /home/webserver-apache24/conf/httpd.conf -oh /home/Webgate_Oracle_Home/ -w /home/webgate_instance4Apache/ -ws apache24

Verifying the Installation and Configuration of Apache WebGate

After installing Apache WebGate for Oracle Access Manager, you can examine the installDATE-TIME_STAMP.out log file to verify the installation. The default location of the log is in the following file:

WebGate_Home/oraInst.loc

Getting Started with a New Apache WebGate

Before you can use the new Apache WebGate for Oracle Access Manager, you must complete the following tasks:

Registering the New WebGate Agent for Apache WebGate

Oracle Access Manager WebGate component utilizes a high availability environment to eliminate a single point of failure and to distribute the workload using a load balancer (LBR). OAM needs to be registered only once, the same resulting artifacts are used by all the OAM WebGates that are behind the LBR.

You can register the new WebGate agent with Oracle Access Manager using any one of the following options:

Oracle Access Manager Administration console

For complete information about registering WebGate agent using Oracle Access Manager console, see Registering an OAM Agent Using the Console in Administrator's Guide for Oracle Access Management.

RREG tool

For complete information about registering WebGate agent using RREG tool, see:

Locating and Preparing the RREG Tool

To set up the RREG tool, complete the following steps:

  1. Log in to one of the Oracle Access Manager hosts in the Application tier.

  2. Change directory to the following directory in the Oracle Access Manager Oracle home:

    Note:

    The location is required only for the out-of-band mode.

    OAM_ORACLE_HOME/oam/server/rreg/client

    In this example, OAM_ORACLE_HOME refers to the Oracle home on the system where the Oracle Access Manager software was installed.

    Note:

    If the Oracle Enterprise Deployment Guide for IDM was used, OAM_ORACLE_HOME may be /u01/oracle/products/access/iam.

    Note:

    If you do not have privileges or access to the Oracle Access Manager server, then you can use out-of-band mode to generate the required files and register the WebGate with Oracle Access Manager. See About RREG In-Band and Out-of-Band Mode.

  3. Unzip the RREG.tar.gz file to the required directory.

  4. From the unzipped directory, open the oamreg.sh file and set the following environment variables in the file, as follows:

    • Set OAM_REG_HOME to the absolute path to the directory in which you extracted the contents of RREG archive.

      Set JAVA_HOME to the absolute path of the directory in which a supported JDK is installed on your machine.

Updating the Standard Properties in the OAMRequest.xml File

Before you can register the Webgate agent with Oracle Access Manager, you must update some required properties in the OAMRequest.xml file.

Note:

If you plan to use the default values for most of the parameters in the provided XML file, then you can use the shorter version (OAM14cRequest_short.xml, in which all non-listed fields will take a default value.

Note:

In the primary server list, the default names are mentioned as OAM_SERVER1 and OAM_SERVER2 for OAM servers. Rename these names in the list if the server names are changed in your environment.

To perform this task:

  1. If you are using in-band mode, then change directory to the following location on one of the OAM Servers:

    OAM_ORACLE_HOME/oam/server/rreg/input

    If you are using out-of-band mode, then change directory to the location where you unpacked the RREG archive on the WEBHOST1 server.

  2. Make a copy of the OAMRequest.xml file template with an environment-specific name.

    cp OAMRequest.xml OAMRequest_edg.xml

  3. Review the properties listed in the file, and then update your copy of the OAMRequest.xml file to make sure the properties reference the host names and other values specific to your environment.

OAM12cRequest.xml Property Set to...
serverAddress

The host and the port of the Administration Server for the Oracle Access Manager domain.
agentName

Any custom name for the agent. Typically, you use a name that identifies the Fusion Middleware product you are configuring for single sign-on.
applicationDomain

A value that identifies the Web tier host and the FMW component you are configuring for single sign-on.

security

Must be set to the security mode configured on the Oracle Access Management server to either open or certificate.

Note:

In most cases, avoid using open mode, because in open mode, traffic to and from the Oracle Access Manager server is not encrypted.

For more information using certificate mode or about Oracle Access Manager supported security modes in general, see Securing Communication Between OAM Servers and WebGates in the Administrator's Guide for Oracle Access Management.

cachePragmaHeader

private
cacheControlHeader

private
ipValidation

0

<ipValidation>0</ipValidation>
ipValidationExceptions

The IP address of the front-end load balancer. For example:

<ipValidationExceptions> <ipAddress>130.35.165.42</ipAddress> </ipValidationExceptions>
agentBaseUrl

Fully-qualified URL with the host and the port of the front-end Load Balancer VIP in front of the WEBHOSTn machines on which Oracle HTTP WebGates are installed.

For example:

 <agentBaseUrl>https://soa.example.com:443</agentBaseUrl>
virtualHost

Set to true when protecting more than the agentBaseUrl, such as SSO protection for the administrative VIP.

hostPortVariationsList

Add hostPortVariation host and port elements for each of the load-balancer URLs that will be protected by the WebGates.

For example:

<hostPortVariationsList>
  <hostPortVariations>
    <host>soainternal.example.com</host>
    <port>80</port>
  </hostPortVariations>
  <hostPortVariations>
    <host>admin.example.com</host>
    <port>80</port>
  </hostPortVariations>
  <hostPortVariations>
    <host>osb.example.com</host>
    <port>443</port>
  </hostPortVariations>
</hostPortVariationsList>
Running the RREG Tool

The following topics provide information about running the RREG tool to register your Oracle HTTP Server Webgate with Oracle Access Manager.

About RREG In-Band and Out-of-Band Mode

You can run the RREG Tool in one of two modes: in-band and out-of-band.

Use in-band mode when you have the privileges to access the Oracle Access Manager server and run the RREG tool yourself from the Oracle Access Manager Oracle home. You can then copy the generated artifacts and files to the Web server configuration directory after you run the RREG Tool.

Use out-of-band mode if you do not have privileges or access to the Oracle Access Manager server. For example, in some organizations, only the Oracle Access Manager server administrators have privileges access the server directories and perform administration tasks on the server. In out-of-band mode, the process can work as follows:

  1. The Oracle Access Manager server administrator provides you with a copy of the RREG archive file (RREG.tar.gz).

    The server administrator can find it in the location described in Updating the Standard Properties in the OAMRequest.xml File.

  2. Untar the RREG.tar.gz file that was provided to you by the server administrator.

    For example:

    gunzip RREG.tar.gz

    tar -xvf RREG.tar

    After you unpack the RREG archive, you can find the tool for registering the agent in the following location:

    RREG_HOME/bin/oamreg.sh

    In this example, RREG_Home is the directory in which you extracted the contents of RREG archive.

  3. Use the instructions in Updating the Standard Properties in the OAMRequest.xml File to update the OAM12cRequest.xml file, and send the completed OAM12cRequest.xml file to the Oracle Access Manager server administrator.

  4. The Oracle Access Manager server administrator then uses the instructions in Running the RREG Tool in Out-Of-Band Mode to run the RREG Tool and generate the AgentID_response.xml file.

  5. The Oracle Access Manager server administrator sends the AgentID_response.xml file to you.

  6. Use the instructions in Running the RREG Tool in Out-Of-Band Mode to run the RREG Tool with the AgentID_response.xml file and generate the required artifacts and files on the client system.

Running the RREG Tool in In-Band Mode

To run the RREG Tool in in-band mode:

  1. Navigate to the RREG home directory.

    If you are using in-band mode, the RREG directory is inside the Oracle Access Manager Oracle home:

    OAM_ORACLE_HOME/oam/server/rreg

    If you are using out-of-band mode, then the RREG home directory is the location where you unpacked the RREG archive.

  2. In the RREG home directory, navigate to the bin directory:

    cd RREG_HOME/bin/

  3. Set the permissions of the oamreg.sh command so you can execute the file: 

    chmod +x oamreg.sh

  4. Run the following command:

    ./oamreg.sh inband RREG_HOME/input/OAM12cRequest_edg.xml

In this example:

  • It is assumed the edited OAM12cRequest.xml file is located in the RREG_HOME/input directory.

  • The output from this command will be saved to the following directory:

    RREG_HOME/output/

The following example shows a sample RREG session:

Welcome to OAM Remote Registration Tool!
Parameters passed to the registration tool are: 
Mode: inband
Filename: /u01/oracle/products/fmw/iam_home/oam/server/rreg/client/rreg/input/OAM12cRequest_edg.xml
Enter admin username:weblogic_idm
Username: weblogic_idm
Enter admin password: 
Do you want to enter a Webgate password?(y/n):
n
Do you want to import an URIs file?(y/n):
n

----------------------------------------
Request summary:
OAM12c Agent Name:SOA12214_EDG_AGENT
Base URL: https://soa.example.com:443
URL String:null
Registering in Mode:inband
Your registration request is being sent to the Admin server at: http://host1.example.com:7001
----------------------------------------

Jul 08, 2015 7:18:13 PM oracle.security.jps.util.JpsUtil disableAudit
INFO: JpsUtil: isAuditDisabled set to true
Jul 08, 2015 7:18:14 PM oracle.security.jps.util.JpsUtil disableAudit
INFO: JpsUtil: isAuditDisabled set to true
Inband registration process completed successfully! Output artifacts are created in the output folder.
Running the RREG Tool in Out-Of-Band Mode

To run the RREG Tool in out-of-band mode on the WEBHOST server, the administrator uses the following command:

RREG_HOME/bin/oamreg.sh outofband input/OAM12cRequest.xml

In this example:

  • Replace RREG_HOME with the location where the RREG archive file was unpacked on the server.

  • The edited OAM12cRequest.xml file is located in the RREG_HOME/input directory.

  • The RREG Tool saves the output from this command (the AgentID_response.xml file) to the following directory: 

    RREG_HOME/output/

    The Oracle Access Manager server administrator can then send the AgentID_response.xml to the user who provided the OAM12cRequest.xml file.

To run the RREG Tool in out-of-band mode on the Web server client machine, use the following command:

RREG_HOME/bin/oamreg.sh outofband input/AgentID_response.xml

In this example:

  • Replace RREG_HOME with the location where you unpacked the RREG archive file on the client system.

  • The AgentID_response.xml file, which was provided by the Oracle Access Manager server administrator, is located in the RREG_HOME/input directory.

  • The RREG Tool saves the output from this command (the artifacts and files required to register the Webgate software) to the following directory on the client machine:

    RREG_HOME/output/
Files and Artifacts Generated by RREG

The files that get generated by the RREG Tool vary, depending on the security level you are using for communications between the WebGate and the Oracle Access Manager server. See Securing Communication Between OAM Servers and WebGates in Administrator's Guide for Oracle Access Management.

Note that in this topic any references to RREG_HOME should be replaced with the path to the directory where you ran the RREG tool. This is typically the following directory on the Oracle Access Manager server, or (if you are using out-of-band mode) the directory where you unpacked the RREG archive: 

OAM_ORACLE_HOME/oam/server/rreg/client

The following table lists the artifacts that are always generated by the RREG Tool, regardless of the Oracle Access Manager security level.

File Location
cwallet.sso

  • RREG_HOME/output/Agent_ID/ - For WebGate 14c (14.1.2.0.0) .

  • RREG_HOME/output/Agent_ID/wallet - For WebGate 14c (14.1.2.0.0) and OHS 14c (14.1.2.0.0).

ObAccessClient.xml RREG_HOME/output/Agent_ID/

The following table lists the additional files that an administrator has to generate, if you are using the CERT security level for Oracle Access Manager:

File Location
password.xml RREG_HOME/output/Agent_ID/

Copying Generated Artifacts to the Apache WebGate Instance Location

After the RREG Tool generates the required artifacts, manually copy the artifacts from the RREG_Home/output/agent_ID directory to the Apache configuration directory on the Web tier host.

The location of the files in the Apache configuration directory depends upon the Oracle Access Manager security mode setting (OPEN or CERT).

The following table lists the required location of each generated artifact in the Apache configuration directory, based on the security mode setting for Oracle Access Manager. In some cases, you might have to create the directories if they do not exist already. For example, the wallet directory might not exist in the configuration directory.

File Location When Using OPEN Mode Location When Using CERT Mode
wallet/cwallet.sso APACHE_CONFIG_DIR/webgate/config/wallet APACHE_CONFIG_DIR/webgate/config/wallet/
ObAccessClient.xml APACHE_CONFIG_DIR/webgate/config APACHE_CONFIG_DIR/webgate/config/

Restarting the Apache Instance

Use the startserv command to start or stopserv command to stop your Apache instance.

To stop the server, run the following command:

/home/bin/stopserv

To start the server, run the following command:

export LD_LIBRARY_PATH=/WebGate_Home/lib

/home/bin/startserv

To restart the Apache instance, stop all running instances, and then run the start command.

Deinstalling Apache WebGate

You should always use the instructions provided in this section for removing the Apache WebGate 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:

  1. Go to the MW_HOME/Webgate_Home/oui/bin directory on UNIX.
  2. Run the following command:

    On UNIX: ./runInstaller -deinstall

    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 Deinstallation Screens and Instructions.

Deinstallation Screens and Instructions

Follow the instructions in Table 4-2 to complete the deinstallation.

If you need additional help with any of the deinstallation screens, click Help to access the online help.

Table 4-2 Deinstallation Flow

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 Manually Removing the Oracle Home Directory 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.

Manually Removing the Oracle Home Directory

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:

On UNIX, if your Oracle WebGate home directory was /home/Oracle/Middleware/Oracle_OAMWebGate1, run the following command:

cd /home/Oracle/Middleware/

rm -rf Oracle_OAMWebGate1

Silent Installation for Apache WebGate

To run the Apache WebGate in silent mode, complete the following steps:

  1. 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/apache_WebGate_home
#Set this variable value to the Installation Type selected. to ApacheWebgate.
INSTALL_TYPE=ApacheWebgate
[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 Apache 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/apache_webgate.

  2. Set the contents of the oraInst.loc file. For example:
    #Oracle Installer Location File Location
inst_group=<group_name (like dba/root/oracle etc.)>
inventory_loc=<location of oraInventory like (/home/testuser/oraInventory)>
  3. Run the following command:
    WebGate_Installer_Directory/fmw_14.1.2.0.0_apachewebgate_linux64.bin -invPtrLoc Absolute_Path_Of_the_oraInst.loc_file -silent -responseFile 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.

    • Absolute_Path_Of_the_oraInst.loc_file is the absolute path to the oraInst.loc file like /home/testuser/oraInst.loc.

    • Absolute_Path_Of_the_ silent.rsp_file is the absolute path to the silent.rsp file you created like /home/testuser/silent.rsp.