Sun OpenSSO Enterprise Policy Agent 3.0 Guide for Sun Java System Web Proxy Server 4.0.x

Installing the Web Proxy Server 4.0.x Agent

Gathering Information to Install the Web Proxy Server 4.0.x Agent

The following table describes the information you will need to provide when you run the agentadmin program to install Web Proxy Server 4.0.x agent. For some agentadmin prompts, you can accept the default value displayed by the program, if you prefer.

Table 1 Information Required to Install the Web Proxy Server 4.0.x Agent


Prompt Request	Description
Sun Java System Proxy Server Config Directory	Path to the Web Proxy Server configuration files. For example: `/opt/sun/proxyserver40/proxy-server1/config`
OpenSSO Enterprise URL	For example: `http://opensso-host.example.com:8080/opensso`
Agent URL	For example: `http://agent-host.example.com:8090`
Agent Profile Name	A policy agent communicates with OpenSSO Enterprise server using the name and password in the agent profile. For information, see Creating an Agent Profile. For example: `WPS4Agent`
Agent Profile Password File	ASCII text file with only one line specifying the agent profile password. You create the agent profile password file as a pre-installation step. For information, see Creating a Password File. For example: `/tmp/wps4agentpw`
Option to create the agent profile The `agentadmin` program displays the following prompt if the agent profile previously specified for the Agent Profile Name prompt does not already exist in OpenSSO Enterprise: `Enter true if the Agent Profile is being created into OpenSSO Enterprise by the installer. Enter false if it will be not be created by installer.`	To have the installation program create the agent profile, enter `true`. The program then prompts you for: Agent administrator who can create, update, or delete the agent profile. For example: `agentadmin` Important: To use this option, the agent administrator must already exist in OpenSSO Enterprise and must have agent administrative privileges. For information see, Creating an Agent Administrator. If you prefer, you can also specify `amadmin` as this user. Path to the agent administrator password file. For information, see Creating a Password File.

Installing the Web Proxy Server 4.0.x Agent Using the `agentadmin` Program

Before you install the Web Proxy Server 4.0.x agent:

The Web Proxy Server 4.0.x instance must be installed and configured on the server where you plan to install the agent. For installation information, see http://docs.sun.com/app/docs/coll/1311.10.
An OpenSSO Enterprise server instance must be installed and running. To check the server, specify the server URL. For example: http://opensso-host.example.com:8080/opensso
You must have downloaded and unzipped the agent distribution file, as described in Downloading and Unzipping the Agent Distribution File.

To Install the Web Proxy Server 4.0.x Agent Using the `agentadmin` Program

Log in to the server where you want to install the agent.

Important: To install the agent, you must have write permission to the files and directories for the Web Proxy Server 4.0.x instance.

Stop the Web Proxy Server 4.0.x instance.

Change to the PolicyAgent-base/bin directory. For example:

/opt/web_agents/proxy40_agent/bin

Start the agent installation. For example:

# ./agentadmin --custom-install

On Windows systems, run the agentadmin.bat program.

Enter information as requested by the agentadmin program, or accept the default values displayed by the program.

After you have made your choices, the agentadmin program displays a summary of your responses. For example:

-----------------------------------------------
SUMMARY OF YOUR RESPONSES
-----------------------------------------------
Sun Java System Proxy Server Config Directory :
/opt/sun/proxyserver40/proxy-server1/config 
OpenSSO server URL : http://opensso-host.example.com:8080/opensso 
Agent URL : http://agent-host.example.com:8090 
Agent Profile name : WPS4Agent 
Agent Profile Password file name : /tmp/wps4agentpw 

Verify your settings above and decide from the choices below.
1. Continue with Installation
2. Back to the last interaction
3. Start Over
4. Exit
Please make your selection [1]:

Verify your choices and either continue with the installation (selection 1, the default) , or make any necessary changes.

If you continue, the program installs the agent and displays a summary of the installation. For example:

SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: Agent_001
Agent Bootstrap file location:
/opt/web_agents/proxy40_agent/Agent_001/config/OpenSSOAgentBootstrap.properties
Agent Configuration Tag file location
/opt/web_agents/proxy40_agent/Agent_001/config/OpenSSOAgentConfiguration.properties
Agent Audit directory location:
/opt/web_agents/proxy40_agent/Agent_001/logs/audit
Agent Debug directory location:
/opt/web_agents/proxy40_agent/Agent_001/logs/debug

After the installation finishes successfully, if you wish, check the installation log file in the PolicyAgent-base/installer-logs/audit directory:

Restart the Web Proxy Server 4.0.x instance that is being protected by the policy agent.

Example 1 Sample Installation Run for the Web Proxy Server 4.0.x Agent

************************************************************************
Welcome to the OpenSSO Policy Agent for Sun Java System Proxy Server.
************************************************************************

Enter the complete path to the directory which is used by Sun Java System Proxy
Server to store its configuration Files. This directory uniquely
identifies the Sun Java System Proxy Server instance that is secured by this
Agent.
[ ? : Help, ! : Exit ]
Enter the Sun Java System Proxy Server Config Directory Path
[/opt/sun/proxyserver40/proxy-server1/config]: 

Enter the URL where the OpenSSO server is running. Please include the
deployment URI also as shown below:
(http://opensso.sample.com:58080/opensso)
[ ? : Help, < : Back, ! : Exit ]
OpenSSO server URL: http://opensso-host.example.com:8080/opensso

Enter the Agent URL as shown below: (http://agent1.sample.com:1234)
[ ? : Help, < : Back, ! : Exit ]
Agent URL: http://agent-host.example.com:8090

Enter the Agent profile name
[ ? : Help, < : Back, ! : Exit ]
Enter the Agent Profile name: WPS4Agent

Enter the path to a file that contains the password to be used for identifying
the Agent.
[ ? : Help, < : Back, ! : Exit ]
Enter the path to the password file: /tmp/wps4agentpw

-----------------------------------------------
SUMMARY OF YOUR RESPONSES
-----------------------------------------------
Sun Java System Proxy Server Config Directory :
/opt/sun/proxyserver40/proxy-server1/config 
OpenSSO server URL : http://opensso-host.example.com:8080/opensso 
Agent URL : http://agent-host.example.com:8090 
Agent Profile name : WPS4Agent 
Agent Profile Password file name : /tmp/wps4agentpw 

Verify your settings above and decide from the choices below.
1. Continue with Installation
2. Back to the last interaction
3. Start Over
4. Exit
Please make your selection [1]: 

Creating directory layout and configuring Agent file for Agent_001
instance ...DONE.

Reading data from file /tmp/wps4agentpw and encrypting it ...DONE.

Generating audit log file name ...DONE.

Creating tag swapped OpenSSOAgentBootstrap.properties file for instance
Agent_001 ...DONE.

Creating a backup for file
/opt/sun/proxyserver40/proxy-server1/config/obj.conf ...DONE.

Adding Agent parameters to
/opt/sun/proxyserver40/proxy-server1/config/obj.conf file ...DONE.


SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: Agent_001
Agent Bootstrap file location:
/opt/web_agents/proxy40_agent/Agent_001/config/
    OpenSSOAgentBootstrap.properties
Agent Configuration Tag file location
/opt/web_agents/proxy40_agent/Agent_001/config/
    OpenSSOAgentConfiguration.properties
Agent Audit directory location:
/opt/web_agents/proxy40_agent/Agent_001/logs/audit
Agent Debug directory location:
/opt/web_agents/proxy40_agent/Agent_001/logs/debug

Install log file location:
/opt/web_agents/proxy40_agent/installer-logs/audit/install.log

Thank you for using OpenSSO Policy Agent. INSTALL NOTE: Installer modifies
obj.conf file in the config directory you specified. UNINSTALL NOTE:
Uninstall removes agent settings from obj.conf file in the config directory
you specified. If there are multiple obj.conf files configured manually in
the same config directory, then please remove them manually. For more
information, please refer agent documentation.

After You Finish the Install

Agent Instance Directory: The installation program creates the following directory for each Web Proxy Server 4.0.x agent instance:

PolicyAgent-base/Agent_nnn

where nnn identifies the agent instance as Agent_001, Agent_002, and so on for each additional agent instance.

Each agent instance directory contains the following subdirectories:

/config contains the configuration files for the agent instance, including OpenSSOAgentBootstrap.properties and OpenSSOAgentConfiguration.properties.
/logs contains the following subdirectories
- /audit contains local audit trail for the agent instance.
- /debug contains the debug files for the agent instance when the agent runs in debug mode.

Considering Specific Deployment Scenarios for the Web Proxy Server 4.0.x Agent

Configuring the Web Proxy Server 4.0.x Agent on Multiple Web Proxy Server 4.0.x Instances

After you install the Web Proxy Server 4.0.x agent for a specific Web Proxy Server 4.0.x instance, you can install the agent on another Web Proxy Server 4.0.x instance by running the agentadmin program again for that instance.

Installing Web Proxy Server 4.0.x Agent on the OpenSSO Enterprise Host Server

Installing the Web Proxy Server 4.0.x agent on the OpenSSO Enterprise host server is not supported.