4 Installing and Configuring Apache 12c WebGate for OAM
This chapter contains the following sections:
- Installation Overview of Apache 12c WebGate
- Prerequisites for Apache 12c WebGate
- Installing Apache 12c WebGate
- Post-Installation Steps for Apache 12c WebGate
- Verifying the Installation and Configuration of Apache 12c WebGate
- Getting Started with a New Apache 12c WebGate
- Deinstalling Apache 12c WebGate
- Silent Installation for Apache 12c WebGate
Installation Overview of Apache 12c WebGate
Installing Apache 12c WebGate for Oracle Access Manager includes the following steps:
- Installing the Apache web server
- Installing Apache 12c WebGate for Oracle Access Manager
- Completing the post-installation configuration steps
- Verifying the Apache 12c WebGate installation
- Registering the new WebGate agent
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
Prerequisites for Apache 12c WebGate
This section discusses the following topics:
- Oracle Fusion Middleware Certification
- Installing JRE
- Installing and Configuring Apache 2.4
- Installing and Configuring OAM 12c
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
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 12c.
See Oracle Fusion Middleware Supported System Configurations document at http://www.oracle.com/technetwork/middleware/ias/downloads/fusion-certification-100350.html.
Parent topic: Prerequisites for Apache 12c WebGate
Installing JRE
You must have a 64-bit Java runtime environment (JRE) 11 or higher installed.
Parent topic: Prerequisites for Apache 12c WebGate
Installing and Configuring Apache 2.4
For information about installing and configuring Apache 2.4, see the Apache product documentation.
Parent topic: Prerequisites for Apache 12c WebGate
Installing and Configuring OAM 12c
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, Simple, or Cert mode, see Securing Communication in Oracle Fusion Middleware Administrator's Guide for Oracle Access Manager .
Parent topic: Prerequisites for Apache 12c WebGate
Installing Apache 12c WebGate
This section includes the following topics:
- Obtaining the Software
- Starting the Apache 12c WebGate Installer
- Installation Flow and Procedure of Apache 12c WebGate
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
Obtaining the Software
For information about obtaining the Apache 12c software, see Oracle Fusion Middleware Download, Installation, and Configuration ReadMe.
Parent topic: Installing Apache 12c WebGate
Starting the Apache 12c WebGate Installer
To start the installation wizard, do the following:
After the Installer starts, the Welcome screen appears. Continue by referring to the section Installation Flow and Procedure of Apache 12c WebGate for installing Apache 12c WebGate for Oracle Access Manager.
Parent topic: Installing Apache 12c WebGate
Installation Flow and Procedure of Apache 12c WebGate
To install Apache 12c 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. |
Parent topic: Installing Apache 12c WebGate
Post-Installation Steps for Apache 12c WebGate
This section includes the following topics:
- Deploying the Apache WebGate Instance
- Setting the Environment Variable
- Running the EditHttpConf Tool
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
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:
Parent topic: Post-Installation Steps for Apache 12c WebGate
Setting the Environment Variable
For Apache webgate, set the environment variable:
-
On Linux:
export LD_LIBRARY_PATH=<Apache24_install_dir>/lib:<webgate_oracle_home>/Oracle_OAMWebGate1/webgate/apache/lib
Parent topic: Post-Installation Steps for Apache 12c WebGate
Running the EditHttpConf Tool
To run the EditHttpConf
tool, do the following:
Parent topic: Post-Installation Steps for Apache 12c WebGate
Verifying the Installation and Configuration of Apache 12c WebGate
After installing Apache 12c 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
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
Getting Started with a New Apache 12c WebGate
Before you can use the new Apache 12c WebGate for Oracle Access Manager, you must complete the following tasks:
- Registering the New WebGate Agent for Apache 12c 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. - Copying Generated Artifacts to the Apache 12c WebGate Instance Location
- Deleting the previous version files
After installing the newer version of the Apache Webgate, you must manually delete the older files in the configuration folder. - Restarting the Apache Instance
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
Registering the New WebGate Agent for Apache 12c 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
- Updating the Standard Properties in the OAM12cRequest.xml File
- Running the RREG Tool
- Files and Artifacts Generated by RREG
Parent topic: Getting Started with a New Apache 12c WebGate
Locating and Preparing the RREG Tool
To set up the RREG tool, complete the following steps:
-
Log in to one of the Oracle Access Manager hosts in the Application tier.
-
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. -
Unzip the
RREG.tar.gz
file to the required directory. -
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.
-
Parent topic: Registering the New WebGate Agent for Apache 12c WebGate
Updating the Standard Properties in the OAM12cRequest.xml File
Before you can register the Webgate agent with Oracle Access Manager, you must update some required properties in the OAM12cRequest.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 (OAM12cRequest_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:
-
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.
-
Make a copy of the
OAM12cRequest.xml
file template with an environment-specific name.cp OAM12cRequest.xml OAM12cRequest_edg.xml
-
Review the properties listed in the file, and then update your copy of the
OAM12cRequest.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. This will be one of three modes: open, simple, or certificate. Note: For an enterprise deployment, Oracle recommends simple mode, unless additional requirements exist to implement custom security certificates for the encryption of authentication and authorization traffic. 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 12c (12.2.1.4.0) WebGates are installed. For example: |
virtualHost |
Set to true when protecting more than the |
hostPortVariationsList
|
Add For example: |
Parent topic: Registering the New WebGate Agent for Apache 12c WebGate
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
- Running the RREG Tool in In-Band Mode
- Running the RREG Tool in Out-Of-Band Mode
Parent topic: Registering the New WebGate Agent for Apache 12c WebGate
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:
-
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 OAM12cRequest.xml File.
-
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. -
Use the instructions in Updating the Standard Properties in the OAM12cRequest.xml File to update the
OAM12cRequest.xml
file, and send the completedOAM12cRequest.xml
file to the Oracle Access Manager server administrator. -
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. -
The Oracle Access Manager server administrator sends the
AgentID_response.xml
file to you. -
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.
Parent topic: Running the RREG Tool
Running the RREG Tool in In-Band Mode
To run the RREG Tool in in-band mode:
-
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.
-
In the RREG home directory, navigate to the bin directory:
cd RREG_HOME/bin/
-
Set the permissions of the
oamreg.sh
command so you can execute the file:chmod +x oamreg.sh
-
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 theRREG_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.
Parent topic: Running the RREG Tool
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 theRREG_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 theOAM12cRequest.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/
Parent topic: Running the RREG Tool
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 |
|
ObAccessClient.xml |
RREG_HOME/output/Agent_ID/ |
The following table lists the additional files that are created if you are using the SIMPLE security level for Oracle Access Manager:
File | Location |
---|---|
aaa_key.pem |
RREG_HOME/output/Agent_ID/ |
aaa_cert.pem |
RREG_HOME/output/Agent_ID/ |
password.xml |
RREG_HOME/output/Agent_ID/ |
Note:
- The
password.xml
file is a common file for both the SIMPLE and CERT security levels, which is generated by the RREG tool. - The
password.xml
file 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.
You can use the 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 existing aaa_cert.pem
and aaa_chain.pem
files along with password.xml
and aaa_key.pem
.
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 |
---|---|
aaa_key.pem |
RREG_HOME/output/Agent_ID/ |
aaa_cert.pem |
RREG_HOME/output/Agent_ID/ |
aaa_chain.pem |
RREG_HOME/output/Agent_ID/ |
Parent topic: Registering the New WebGate Agent for Apache 12c WebGate
Copying Generated Artifacts to the Apache 12c 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, SIMPLE, 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.
Note:
For an enterprise deployment, Oracle recommends simple mode, unless additional requirements exist to implement custom security certificates for the encryption of authentication and authorization traffic. The information about using open or certification mode is provided here as a convenience.
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 Administrator's Guide for Oracle Access Management.
File | Location When Using OPEN Mode | Location When Using SIMPLE Mode | Location When Using CERT Mode |
---|---|---|---|
wallet/cwallet.sso |
APACHE_CONFIG_DIR/webgate/config/wallet |
APACHE_CONFIG_DIR/webgate/config/wallet/ |
APACHE_CONFIG_DIR/webgate/config/wallet/ |
ObAccessClient.xml |
APACHE_CONFIG_DIR/webgate/config |
APACHE_CONFIG_DIR/webgate/config/ |
APACHE_CONFIG_DIR/webgate/config/ |
password.xml |
N/A | APACHE_CONFIG_DIR/webgate/config/ |
APACHE_CONFIG_DIR/webgate/config/ |
aaa_key.pem |
N/A | APACHE_CONFIG_DIR/webgate/config/simple/ |
APACHE_CONFIG_DIR/webgate/config/ |
aaa_cert.pem |
N/A | APACHE_CONFIG_DIR/webgate/config/simple/ |
APACHE_CONFIG_DIR/webgate/config/ |
aaa_chain.pem |
N/A | N/A | APACHE_CONFIG_DIR/webgate/config/ |
Note:
aaa_chain.pem
is generated when certificates are created for CERT mode.
Parent topic: Getting Started with a New Apache 12c WebGate
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, the password.xml
file generated by RREG does 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_instanceDirectory
/webgate/config
directory. -
Copy the following certificates to the
webgate_instanceDirectory
/webgate/config
directory:-
aaa_key.pem
-
aaa_cert.pem
-
aaa_chain.pem
-
Deleting the previous version files
After installing the newer version of the Apache Webgate, you must manually delete the older files in the configuration folder.
Complete the following steps:
- Go to the
{Oracle_OAMWebGate1}/webgate/apache/config
directory. - Delete the
np{previous_rel}_wg.txt
file.Where, {previous_rel} is the version number of the previous release from which you have upgraded from.
Parent topic: Getting Started with a New Apache 12c WebGate
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.
Parent topic: Getting Started with a New Apache 12c WebGate
Deinstalling Apache 12c WebGate
You should always use the instructions provided in this section for removing the Apache 12c 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:
After the deinstaller starts, the Welcome screen is displayed. Proceed with the deinstallation by referring to Deinstallation Screens and Instructions.
Parent topic: Installing and Configuring Apache 12c WebGate for OAM
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. |
Parent topic: Deinstalling Apache 12c WebGate
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
Parent topic: Deinstalling Apache 12c WebGate
Silent Installation for Apache 12c WebGate
To run the Apache 12c WebGate in silent mode, complete the following steps:
Parent topic: Installing and Configuring Apache 12c WebGate for OAM