Sun Java System Access Manager Policy Agent 2.2 Guide for Apache Tomcat 5.5 Servlet/JSP Container

Previous: Launching the Installation Program of Agent for Apache Tomcat Servlet/JSP Container
Next: Chapter 4 Post-Installation Tasks of Policy Agent 2.2 for Apache Tomcat Servlet/JSP Container

Using the Installation Program of Agent for Apache Tomcat Servlet/JSP Container

After you issue the agentadmin command and accept the license agreement (if necessary) the installation program appears, prompting you for information.

The steps in the installation program are displayed in this section in an example interaction. Your answers to prompts can differ slightly or greatly from this example depending upon your specific deployment. In the example, most of the defaults have been accepted. This example is provided for your reference and does not necessarily indicate the precise information you should enter.

The following bulleted list provides key points about the installation program.

Each step in the installation program includes an explanation that is followed by a more succinct prompt.
For most of the steps you can type any of the following characters to get the results described:

?

Type the question mark to display Help information for that specific step.

<

Type the left arrow symbol to go back to the previous interaction.

!

Type the exclamation point to exit the program.
Most of the steps provide a default value that can be accepted or replaced. If a default value is correct for your site, accept it. If it is not correct, enter the correct value.

About Installation Prompts in Agent for Apache Tomcat Servlet/JSP Container

The following list provides information about specific prompts in the installation. Often the prompt is self explanatory. However, at other times you might find the extra information presented here to be very helpful. This extra information is often not obvious. Study this section carefully before issuing the agentadmin --install command.

The Deployment URI for the Agent Application

The deployment URI for the agent application is required for the agent to perform necessary housekeeping tasks such as registering policy and session notifications, legacy browser support, and CDSSO support. Accept /agentapp as the default value for this interaction. Once the installation is completed, browse the directory PolicyAgent-base/etc. Use the agentapp.war file to deploy the agent application in the application container. Please note that the deployment URI for agent application during install time should match the deployment URI for the same application when deployed in the J2EE container.

The Encryption Key

This key is used to encrypt sensitive information such the passwords. The key should be at least 12 characters long. A key is generated randomly and provided as the default. You can accept the random key generated by the installer or create your own using the .agentadmin --getEncryptKey command.

For information about creating a new encryption key, see agentadmin --getEncryptKey.

The Agent Profile Name

An agent profile should have been created as a pre-installation step. The creation of the agent profile is mentioned in that section. For the pre-installation steps, see Preparing to Install Agent for Apache Tomcat Servlet/JSP Container. For the actual information on creating an agent profile, see Creating a J2EE Agent Profile.

In summary, the J2EE agent communicates with Access Manager with a specific ID and password created through an agent profile using Access Manager Console. For J2EE agents, the creation of an agent profile is mandatory. Access Manager uses the agent profile to authenticate an agent. This is part of the security infrastructure.

The J2EE Password File

The J2EE password file should have been created as a pre-installation step. For the pre-installation steps, see Preparing to Install Agent for Apache Tomcat Servlet/JSP Container.

When the installation program prompts you for the password for the agent, enter the fully qualified path to this password file.

After you have completed all the steps, a summary of your responses appears followed by options that allow you to navigate through those responses to accept or reject them.

When the summary appears, note the agent instance name, such as agent-001. You might be prompted for this name during the configuration process.

About the options, the default option is 1, Continue with Installation.

If you are satisfied with the summary, choose 1 (the default).
If you want to edit input from the last interaction, choose 2.
If you want to edit input starting at the beginning of the installation program, choose 3.
If you want to exit the installation program without installing, choose 4.

You can edit your responses as necessary, return to the options list, and choose option 1 to finally process your responses.

Example of Installation Program Interaction in Agent for Apache Tomcat Servlet/JSP Container

The following example is a sample installation snapshot of Policy Agent 2.2 for Apache Tomcat Servlet/JSP Container. By no means does this sample represent a real deployment scenario.

The section following this example, Implications of Specific Deployment Scenarios in Agent for Apache Tomcat Servlet/JSP Container, provides a short explanation about installing a J2EE agent on multiple Apache Tomcat Servlet/JSP Container instances. If your deployment includes multiple instances of the deployment container, you might want to review that section before proceeding with the agent installation. See Installing a J2EE Agent on Multiple Apache Tomcat Servlet/JSP Container Instances.

************************************************************************
 Welcome to the Access Manager Policy Agent for Apache Tomcat 5.5 Servlet/JSP Container
************************************************************************
Enter the complete path to the directory which is used by Tomcat Server to
store its configuration Files. This directory uniquely identifies the
Tomcat Server instance that is secured by this Agent.
[ ? : Help, ! : Exit ]

Enter the Tomcat Server Config Directory Path
[/opt/jakarta-tomcat-5.5.9/conf]:

Enter the fully qualified host name of the server where Access Manager
Services are installed.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Host: accessmanager.example.com

Enter the port number of the Server that runs Access Manager Services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services port [80]: 8880

Enter http/https to specify the protocol used by the Server that runs Access
Manager services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Protocol [http]:

Enter the Deployment URI for Access Manager Services.
[ ? : Help, < : Back, ! : Exit ]
Access Manager Services Deployment URI [/amserver]:

Enter the fully qualified host name on which the Application Server
protected by the agent is installed.
[ ? : Help, < : Back, ! : Exit ]

Enter the Agent Host name: mycomputer.example.com
$CATALINA_HOME environment variable is the root of the tomcat
installation.
[ ? : Help, < : Back, ! : Exit ]

Enter the $CATALINA_HOME environment variable: /opt/jakarta-tomcat-5.5.9/
Choose yes to deploy the policy agent in the global web.xml file.
[ ? : Help, < : Back, ! : Exit ]
Install agent filter in global web.xml ? [true]:

Enter the preferred port number on which the application server provides its
services.
[ ? : Help, < : Back, ! : Exit ]

Enter the port number for Application Server instance [80]: 8080
Select http or https to specify the protocol used by the Application server
instance that will be protected by Access Manager Policy Agent.
[ ? : Help, < : Back, ! : Exit ]

Enter the Preferred Protocol for Application Server instance [http]:

Enter the deployment URI for the Agent Application. This Application is used
by the agent for internal housekeeping.
[ ? : Help, < : Back, ! : Exit ]

Enter the Deployment URI for the Agent Application [/agentapp]:

Enter a valid Encryption Key.
[ ? : Help, < : Back, ! : Exit ]

Enter the Encryption Key [/gyU5SVWPY/B4TxWhC9m36Bz7pYdcXMS]:

Enter a valid Agent profile name. The agent profile name is used to identify
the agent in Access Manager.
[ ? : Help, < : Back, ! : Exit ]

Enter the Agent Profile name: j2ee

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: /opt/test

-----------------------------------------------
SUMMARY OF YOUR RESPONSES
-----------------------------------------------
Tomcat Server Config Directory : /opt/jakarta-tomcat-5.5.9/conf
Access Manager Services Host : accessmanager.example.com
Access Manager Services Port : 8880
Access Manager Services Protocol : http
Access Manager Services Deployment URI : /amserver
Agent Host name : mycomputer.example.com
$CATALINA_HOME environment variable : /opt/jakarta-tomcat-5.5.9/
Tomcat global web.xml filter install : true
Application Server Instance Port number : 8080
Protocol for Application Server instance : http
Deployment URI for the Agent Application : /agentapp
Encryption Key : /gyU5SVWPY/B4TxWhC9m36Bz7pYdcXMS
Agent Profile name : j2ee
Agent Profile Password file name : /opt/test
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]: 1

Updating the /opt/jakarta-tomcat-5.5.9/bin/setclasspath.sh script
with the Agent classpathDONE.

Creating directory layout and configuring AMAgent.properties file for
agent_001 instance ...DONE.

Reading data from file /opt/test and encrypting it ...DONE.
Generating audit log file name ...DONE.

Creating tag swapped AMAgent.properties file for instance agent_001 ...DONE.

Creating a backup for file /opt/jakarta-tomcat-5.5.9/conf/server.xml
...DONE.

Creating a backup for file /opt/jakarta-tomcat-5.5.9/conf/web.xml ...DONE.

Adding SJS Tomcat Agent Realm to Server XML file :
/opt/jakarta-tomcat-5.5.9/conf/server.xmlDONE.

Adding filter to Global deployment descriptor file :
/opt/jakarta-tomcat-5.5.9/conf/web.xmlDONE.

Adding SJS Tomcat Agent Filter and Form login authentication to selected Web
applicationsDONE.

Implications of Specific Deployment Scenarios in Agent for Apache Tomcat Servlet/JSP Container

The following section refers to a specific deployment scenario involving Policy Agent 2.2 for Apache Tomcat Servlet/JSP Container.

Installing a J2EE Agent on Multiple Apache Tomcat Servlet/JSP Container Instances

Once a J2EE agent is installed for a particular Apache Tomcat Servlet/JSP Container instance, you can install the agent on another instance on the same machine by running the agentadmin --install command. Once prompted to enter the appropriate server instance name, enter the server configuration directory and unique instance name that will enable the agent to distinguish the first instance from consecutive instances.

Summary of a J2EE Agent Installation in Policy Agent 2.2

At the end of the installation process, the installation program prints the status of the installation along with the installed J2EE agent information. The information that the program displays can be very useful. For example, the program displays the agent instance name, which is needed when configuring a remote instance. The program also displays the location of specific files, which can be of great importance. In fact, you might want to view the installation log file once the installation is complete, before performing the post-installation steps as described in Chapter 4, Post-Installation Tasks of Policy Agent 2.2 for Apache Tomcat Servlet/JSP Container.

The location of directories displayed by the installer are specific. However, throughout this guide and specifically in Summary of Agent Installation shown in this section, PolicyAgent-base is used to describe the directory where the distribution files are stored for a specific J2EE agent.

The following example serves as a quick description of the location of the J2EE agent base directory (PolicyAgent-base) of Policy Agent 2.2 for Apache Tomcat Servlet/JSP Container.

Example 3–5 Policy Agent Base Directory of Agent for Apache Tomcat Servlet/JSP Container

The following directory represents PolicyAgent-base of Agent for Apache Tomcat Servlet/JSP Container:

Agent-HomeDirectory/j2ee_agents/am_tomcat_agent

where Agent-HomeDirectory is the directory you choose in which to unpack the J2EE agent binaries.

Information regarding the location of the J2EE agent base directory is explained in detail in Location of the J2EE Agent Base Directory in Policy Agent 2.2.

The following type of information is printed by the installer:

SUMMARY OF AGENT INSTALLATION
-----------------------------
Agent instance name: agent_001
Agent Configuration file location:
PolicyAgent-base/agent_001/config/AMAgent.properties
Agent Audit directory location:
PolicyAgent-base/agent_001/logs/audit
Agent Debug directory location:
PolicyAgent-base/agent_001/logs/debug

Install log file location:
PolicyAgent-base/logs/audit/install.log

Thank you for using Access Manager Policy Agent

Once the agent is installed, the directories shown in the preceding example are created in the agent_00x directory, which for this example is specifically agent_001. Those directories and files are briefly described in the following paragraphs.

PolicyAgent-base/agent_001/config/AMAgent.properties

Location of the J2EE agent AMAgent.properties configuration file for the agent instance. Every instance of a J2EE agent has a unique copy of this file. You can configure this file to meet your site's requirements. For more information, see the following sections:

PolicyAgent-base/agent_001/logs/audit

Location of the J2EE agent local audit trail.

PolicyAgent-base/agent_001/logs/debug

Location of all debug files required to debug an agent installation or configuration issue.

PolicyAgent-base/logs/audit/install.log

Location of the file that has the agent install file location. If the installation failed for any reason, you can look at this file to diagnose the issue.