Last updated December 22, 2009
The Apache HTTP Server 2.0.x policy agent is a version 3.0 web agent that functions with Sun OpenSSO Enterprise to protect resources on Apache HTTP Server 2.0.x.
Contents
Supported Platforms, Compatibility, and Coexistence for the Apache HTTP Server 2.0.x Agent
Pre-Installation Tasks for the Apache HTTP Server 2.0.x Agent
Post-Installation Tasks for the Apache HTTP Server 2.0.x Agent
For general information about web policy agents, including the new features for version 3.0 agents, see Sun OpenSSO Enterprise Policy Agent 3.0 User’s Guide for Web Agents.
A version 2.2 web agent also exists for Apache HTTP Server 2.0.x. However, to use the new version 3.0 agent features, you must deploy the version 3.0 agent described in this guide.
Access Manager 7.1 and Access Manager 7 2005Q4 are compatible with version 3.0 policy agents. However, because Access Manager 7.1 and Access Manager 7 2005Q4 do not support centralized agent configuration, a version 3.0 agent deployed with Access Manager must store its configuration data locally in the OpenSSOAgentBootstrap.properties and OpenSSOAgentConfiguration.properties files. The OpenSSOAgentBootstrap.properties file contains the information required for the agent to start and initialize itself.
OpenSSO Enterprise supports both version 3.0 and version 2.2 agents in the same deployment. The version 2.2 agents, however, must continue to store their configuration data locally in the AMAgent.properties file. And because the version 2.2 agent configuration data is local to the agent, OpenSSO Enterprise centralized agent configuration is not supported for version 2.2 agents. To configure a version 2.2 agent, you must continue to edit the agent's AMAgent.properties file.
For documentation about version 2.2 agents, see http://docs.sun.com/coll/1322.1.
The Apache HTTP Server 2.0.x agent does not support the following features:
The Apache HTTP Server 2.0.x agent does not support log file rotation, because the multi-process environment impairs the agent's capability to obtain the correct size of the log file. Without the correct log file size, the agent cannot rotate the file as intended.
Therefore, do not enable log rotation for the Apache HTTP Server 2.0.x agent, either in the OpenSSO Administration Console or by setting the com.sun.am.policy.agents.config.local.log.rotate property to true. Enabling log rotation can cause inconsistent and unpredictable results for the agent.
The Apache HTTP Server 2.0.x agent does not support notifications, so maintaining the agent's SSO, policy, and configuration caches through a notification mechanism is not available.
Therefore, do not enable notifications for the Apache HTTP Server 2.0.x agent, either in the OpenSSO Administration Console or by setting the com.sun.identity.agents.config.notification.enable property to true. Enabling notifications can cause unpredictable behavior for the agent.
The Apache HTTP Server 2.0.x agent does not support POST data preservation, where POST data is submitted to the server through HTML forms before users log in to OpenSSO Enterprise.
The agent installation program requires the Java Runtime Environment (JRE) 1.5 or later. Before you install the agent , set your JAVA_HOME environment variable to point to the JDK installation directory for the JDK version you are using. If you have not set this variable (or if you set it incorrectly), the program will prompt you for the correct path.
Login into the server where you want to install the agent.
Create a directory to unzip the agent distribution file.
Download and unzip the agent distribution file, depending on your platform:
Platform |
Distribution File |
---|---|
Solaris SPARC systems, 64–bit |
apache_v20_SunOS_sparc_64_agent_3.zip |
Solaris SPARC systems, 32–bit |
apache_v20_SunOS_sparc_agent_3.zip |
Solaris x86 systems, 64–bit |
apache_v20_SunOS_x86_64_agent_3.zip |
Solaris x86 systems, 32–bit |
apache_v20_SunOS_x86_agent_3.zip |
Linux systems, 64–bit |
apache_v20_Linux_64_agent_3.zip |
Linux systems, 32–bit |
apache_v20_Linux_agent_3.zip |
Windows systems |
apache_v20_WINNT_agent_3.zip |
IBM AIX systems |
apache_v20_AIX_agent_3.zip |
HP-UX systems |
apache_v20_HP-UX_agent_3.zip |
These distribution files are available from the following sites:
Sun Downloads under View by Category, Identity Management, and Policy Agents: http://www.sun.com/download/index.jsp
OpenSSO project: https://opensso.dev.java.net/public/use/index.html
The following table shows the files and directories after you unzip the agent distribution file. These files are in the following directory:
AgentHome/web_agents/apache_agent, where AgentHome is where you unzipped the agent distribution file.
For example: /opt/web_agents/apache_agent
A web agent uses an agent profile to communicate with OpenSSO Enterprise server. A version 2.2 web agent can use the default agent profile (UrlAccessAgent). For a version 3.0 agent, however, you must create an agent profile using any of these three methods:
Use the OpenSSO Enterprise Console, as described in Creating an Agent Profile.
Use the ssoadm command-line utility with the create-agent subcommand. For more information about the ssoadm command, see the Sun OpenSSO Enterprise 8.0 Administration Reference.
Choose the “Option to create the agent profile in the server during installation” when you run the agentadmin program.
Login into the OpenSSO Enterprise Administration Console as amAdmin.
Click Access Control, realm-name, Agents, and Web.
Under Agent, click New.
In the Name field, enter the name for the new agent profile.
Enter and confirm the Password.
Important: This password must be the same password that you enter in the agent profile password file that you specify when you run the agentadmin program to install the agent.
In the Configuration field, check the location where the agent configuration properties are stored:
Local: In the OpenSSOAgentConfiguration.properties file on the server where the agent is installed.
Centralized: In the OpenSSO Enterprise server central configuration data repository.
In the Server URL field, enter the OpenSSO Enterprise server URL.
For example: http://openssohost.example.com:8080/opensso
In the Agent URL field, enter the URL for the agent.
For example: http://agenthost.example.com:8090/
Click Create.
The console creates the agent profile and displays the WebAgent page again with a link to the new agent profile.
To do additional configuration for the agent, click this link to display the Edit agent page. For information about the agent configuration fields, see the Console online Help.
If you prefer, you can also use the ssoadm command-line utility to edit the agent profile. For more information, see the Sun OpenSSO Enterprise 8.0 Administration Reference.
A password file is an ASCII text file with only one line specifying the password in clear text. By using a password file, you are not forced to expose a password at the command line during the agent installation. When you install the Apache HTTP Server agent using the agentadmin program, you are prompted to specify paths to following password files:
An agent profile password file is required for both the agentadmin default and custom installation options.
An agent administrator password file is required if you use the custom installation option and have the agentadmin program automatically create the agent profile in OpenSSO Enterprise server during the installation. If you prefer, you can use amadmin as the agent administrator
Create an ASCII text file for the password file. For example: /tmp/apache2agentpw
If you want the agentadmin program to automatically create the agent profile in OpenSSO Enterprise server during the installation, create another password file for the agent administrator. For example: /tmp/agentadminpw
Using a text editor, enter the appropriate password in clear text on the first line in each file.
Secure each password file appropriately, depending on the requirements for your deployment.
Perform this task only if you are installing the Apache HTTP Server 2.0.x agent on an IBM AIX system and you are using the IBM JDK/JRE.
After you download and unzip the Apache HTTP Server 2.0.x agent distribution file for AIX, locate the agentadmin script in the following directory:
AgentHome/web_agents/apache_agent/bin, where AgentHome is where you unzipped the agent distribution file.
In the agentadmin script, comment out the following line, which sets the regular JDK/JRE classpath:
$JAVA_VM -classpath "$AGENT_CLASSPATH" com.sun.identity.install.tools.launch.AdminToolLauncher $*
In the agentadmin script, uncomment the following line at the end of the file, which sets the IBM JDK/JRE classpath:
#$JAVA_VM -DamKeyGenDescriptor.provider=IBMJCE -DamCryptoDescriptor.provider=IBMJCE -DamRandomGenProvider=IBMJCE -classpath "$AGENT_CLASSPATH" com.sun.identity.install.tools.launch.AdminToolLauncher $*
Save your changes.
Creating an agent administrator is optional. An agent administrator can manage agents in OpenSSO Enterprise, including:
Agent management: Use the agent administrator to manage agents either in the OpenSSO Enterprise Console or by executing the ssoadm utility.
Agent installation: If you install the agent using the custom installation option (agentadmin --custom-install) and want to have the installation program create the agent profile, specify the agent administrator (and password file) when you are prompted.
Login to OpenSSO Enterprise Console as amadmin.
Create a new agents administrator group:
Create a new agent administrator user and add the agent administrator user to the agents administrator group:
Click Access Control, realm-name, Subjects, and then User.
Click New and provide the following values:
ID: Name of the agent administrator. For example: agentadminuser
This is the name you will use to login to the OpenSSO Enterprise Console .
First Name (optional), Last Name, and Full Name.
For simplicity, use the same name for each of these values that you specified in the previous step for ID.
Password (and confirmation)
User Status: Active
Click OK.
Click the new agent administrator name.
On the Edit User page, click Group.
Add the agents administrator group from Available to Selected.
Click Save.
Assign read and write access to the agents administrator group:
Login into the OpenSSO Enterprise Console as the new agent administrator. The only available top-level tab is Access Control. Under realm-name, you will see only the Agents tab and sub tabs.
Gathering Information to Install the Apache HTTP Server 2.0.x Agent
Installing the Apache HTTP Server 2.0.x Agent Using the agentadmin Program
Considering Specific Deployment Scenarios for the Apache HTTP Server 2.0.x Agent
The following table describes the information you will need to provide when you run the agentadmin program to install Apache HTTP Server 2.0.x agent. For some agentadmin prompts, you can accept the default value displayed by the program, if you prefer.
Table 2 Information Required to Install the Apache HTTP Server 2.0.x Agent
Prompt Request |
Description |
---|---|
Apache Server Config Directory Path |
Path to the configuration directory used by the Apache HTTP Server instance. For example: /opt/apache-2.0.63/conf |
OpenSSO server URL |
URL for OpenSSO Enterprise server. For example: http://openssohost.example.com:8080/opensso |
Agent URL |
URL for the Apache HTTP Server 2.0.x agent. For example: http://agenthost.example.com:8090 |
Agent Profile Name |
Name of the agent profile. For example: Apache2Agent For information, see Creating an Agent Profile. |
Agent Profile Password File |
Path to the agent profile password file. For example: /tmp/apache2agentpw For information, see Creating a Password File. |
Option for the installer 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 server 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:
|
Before you install the Apache HTTP Server 2.0.x agent, your deployment must meet these requirements:
An Apache HTTP Server 2.0.x instance must be installed and configured on the platform where you plan to install the agent.
An OpenSSO Enterprise server instance must be installed and accessible to the Apache HTTP Server 2.0.x instance.
You must have downloaded and unzipped the agent distribution file, as described in Downloading and Unzipping the Agent Distribution File.
Login into 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 Apache HTTP Server instance.
Stop the Apache HTTP Server instance.
Change to the PolicyAgent-base/bin directory. For example:
# cd /opt/web_agents/apache_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 ----------------------------------------------- Apache Server Config Directory : /opt/apache-2.0.63/conf OpenSSO server URL : http://opensshost.example.com:8080/opensso Agent URL : http://agenthost.example.com:8090 Agent Profile name : Apache2Agent Agent Profile Password file name : /tmp/apache2agentpw 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
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/apache_agent/Agent_001/config/OpenSSOAgentBootstrap.properties Agent Configuration Tag file location /opt/web_agents/apache_agent/Agent_001/config/OpenSSOAgentConfiguration.propertie s Agent Audit directory location: /opt/web_agents/apache_agent/Agent_001/logs/audit Agent Debug directory location: /opt/web_agents/apache_agent/Agent_001/logs/debug Install log file location: /opt/web_agents/apache_agent/installer-logs/audit/install.log
After the installation finishes successfully, if you wish, check the installation log file in the /installer-logs/audit directory
Restart the Apache HTTP Server instance for the agent.
The agent installation program performs these functions:
Creates the OpenSSOAgentBootstrap.properties and OpenSSOAgentConfiguration.properties configuration files from the respective template files.
Creates the file dsame.conf file from the template file.
Modifies the httpd.conf file to include the path for the dsame.conf file.
Creates the agent instance directory as PolicyAgent-base/Agent_nnn, where nnn identifies the agent instance as Agent_001, Agent_002, and so on for each additional agent instance.
For example: /opt/web_agents/apache_agent/Agent_001
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.
Installing the Apache HTTP Server 2.0.x Agent on Multiple Apache HTTP Server Instances
Installing Apache HTTP Server 2.0.x Agent on the OpenSSO Enterprise Host Server
After you install the Apache HTTP Server 2.0.x agent on a specific Apache HTTP Server instance, you can install the agent on another Apache HTTP Server instance by executing the agentadmin program again for that instance.
OpenSSO Enterprise is not supported on the Apache HTTP Server 2.0.x web container. Therefore, installing the Apache HTTP Server 2.0.x agent and OpenSSO Enterprise on the same server instance is not supported.
Using SSL With the Apache HTTP Server 2.0.x Agent (Optional)
Configuring the Apache HTTP Server 2.0.x Agent on IBM AIX Systems
Setting the SHLIB_PATH Environment Variable on HP-UX Systems
If you specify the HTTPS protocol during the Apache HTTP Server 2.0.x agent installation, the agent is automatically configured and ready to communicate over Secure Sockets Layer (SSL). Before continuing with the tasks in this section, however, ensure that the Apache HTTP Server instance is configured for SSL. For information, see the Apache HTTP Server 2.0 documentation:http://httpd.apache.org/docs/2.0/.
Disabling the Trust Behavior of the Apache HTTP Server Agent
Installing the OpenSSO Enterprise Root CA Certificate on the Apache HTTP Server Instance
By default, the Apache HTTP Server 2.0.x agent installed on a remote Apache HTTP Server instance trusts any server certificate presented over SSL by the OpenSSO Enterprise host server. For the Apache HTTP Server 2.0.x agent to perform certificate checking, you must disable this behavior.
Find the Apache HTTP Server 2.0.x agent's OpenSSOAgentBootstrap.properties file in the agent's /config directory. For example:
/opt/web_agents/apache_agent/Agent_001/config/OpenSSOAgentBootstrap.properties
In the OpenSSOAgentBootstrap.properties file, set the SSL-related properties, depending on your specific deployment.
Note: These properties have new names for version 3.0 web agents.
Disable the option to trust the server certificate sent over SSL by the OpenSSO Enterprise host server:
com.sun.identity.agents.config.trust.server.certs = false
Specify the certificate database directory. For example:
com.sun.identity.agents.config.sslcert.dir = /opt/apache-2.0.63/conf/certdb
If the certificate database directory has multiple certificate databases, set the following property to the prefix of the database you want to use. For example:
com.sun.identity.agents.config.certdb.prefix = prefix-
Specify the certificate database password:
com.sun.identity.agents.config.certdb.password = password
Specify the certificate database alias:
com.sun.identity.agents.config.certificate.alias = alias-name
Save the changes to the OpenSSOAgentBootstrap.properties file.
The agent uses information in the OpenSSOAgentBootstrap.properties file to start and initialize itself and to communicate with OpenSSO Enterprise server.
The root CA certificate that you install on the Apache HTTP Server instance must be the same certificate that is installed on the OpenSSO Enterprise host server.
Sun provides the Certificate Database Tool, certutil, in the Apache HTTP Server agent distribution file, to manage the root CA certificate and the certificate database.
For information about using certutil, see http://www.mozilla.org/projects/security/pki/nss/tools/certutil.html.
Obtain the root CA certificate file that is installed on the OpenSSO Enterprise host server.
On the Apache HTTP Server instance, locate the certutil utility.
After you unzip the Apache HTTP Server agent distribution file, certutil is available in the PolicyAgent-base/bin directory.
For example: /opt/web_agents/apache_agent/bin/certutil
Before you use certutil, set the LD_LIBRARY_PATH environment variable to the location of the certutil library files.
After you unzip the Apache HTTP Server agent distribution file, these library files are available in the PolicyAgent-base/lib directory.
For example: /opt/web_agents/apache_agent/lib
If necessary, create the certificate database using certutil. For example:
# cd /opt/web_agents/apache_agent/bin # mkdir /opt/apache-2.0.63/conf/certdb # ./certutil -N -d /opt/apache-2.0.63/conf/certdb
Install the OpenSSO Enterprise root CA certificate using certutil. For example:
# ./certutil -A -n cert-name -t "C,C,C" -d /opt/apache-2.0.63/conf/certdb -i cert-request-file
where:
cert-name is the name of the OpenSSO Enterprise root CA certificate.
cert-request-file is the binary root CA certificate request file.
To verify that the root CA certificate is installed correctly, use certutil with the -L option. For example:
# ./certutil -L -d /opt/apache-2.0.63/conf/certdb
You should see the name of the root CA certificate.
Restart the Apache HTTP Server instance.
This task is optional. After you install the agent, you can change the agent profile password, if required for your deployment.
On the OpenSSO Enterprise server:
On the server where the Apache HTTP Server 2.0.x agent is installed:
In the agent profile password file, replace the old password with the new unencrypted password.
Change to the PolicyAgent-base/bin directory. For example:
# cd /opt/web_agents/apache_agent/bin
Encrypt the new password using the agentadmin program. For example:
#./agentadmin --encrypt Agent_001 /tmp/apache2agentpw
Agent_001 is the agent instance whose password you want to encrypt.
passwd is the password file in the /tmp directory.
The agentadmin program returns the new encrypted password. For example:
The encrypted value is: /54GwN432q+MEnfh/AHLMA==
In the agent-instance/config/OpenSSOAgentBootstrap.properties file, set the following property to the new encrypted password from the previous step. For example:
com.sun.identity.agents.config.password=/54GwN432q+MEnfh/AHLMA==
Restart the Apache HTTP Server instance that is being protected by the policy agent.
Perform this task only if you are installing the Apache HTTP Server 2.0.x agent on an IBM AIX system.
Set the LIBPATH variable to the agent's lib directory. For example:
setenv LIBPATH /opt/web_agents/apache_agent/lib:/usr/lib:/lib
As required, modify the libxml2.so.2 library file to libxml2.so in the agent's lib directory, which is in the following directory:
AgentHome/web_agents/apache_agent/lib, where AgentHome is where you unzipped the agent distribution file.
Before you start the Apache HTTP Server 2.0.x server, set the SHLIB_PATH environment variable to the agent's lib directory. For example:
setenv SHLIB_PATH /opt/web_agents/apache_agent/lib:/usr/lib:/lib
OpenSSO Enterprise stores version 3.0 policy agent configuration data (as well as server configuration data) in a centralized data repository. You manage this configuration data using these options:
OpenSSO Enterprise Administration Console
You can manage both version 3.0 J2EE and web agents from the OpenSSO Enterprise Console. Tasks that you can perform include creating, deleting, updating, listing, and displaying agent configurations. Using the Console, you can set properties for an agent that you previously set by editing the agent's AMAgent.properties file.
For more information, refer to the Administration Console online Help.
ssoadm command-line utility
The ssoadm utility is the command-line interface to OpenSSO Enterprise server and is available after you install the tools and utilities in the openssoAdminTools.zip file. The ssoadm utility includes subcommands to manage policy agents, including:
Creating, deleting, updating, listing, and displaying agent configurations
Creating deleting, listing, and displaying agent groups
Adding and removing an agent to and from a group
For information about the ssoadm utility, including the syntax for each subcommand, see the Sun OpenSSO Enterprise 8.0 Administration Reference.
In some scenarios, you might need to deploy a version 3.0 agent using a local configuration. For example, if you deploy the agent with Access Manager 7.1 or Access Manager 7 2005Q4, which do not support centralized agent configuration, local configuration is used by default.
The following property in the OpenSSO Enterprise server Agent Service schema (AgentService.xml file) indicates that the configuration is local:
com.sun.identity.agents.config.repository.location=local
In this scenario, you must manage the version 3.0 agent by editing properties in the agent's local OpenSSOAgentConfiguration.properties file (in the same manner that you edit the AMAgent.properties file for version 2.2 agents).
A version 3.0 agent also stores configuration information in the local OpenSSOAgentBootstrap.properties file. The agent uses information in the bootstrap file to start and initialize itself and to communicate with OpenSSO Enterprise server. In most cases, you won't need to edit the bootstrap file; however, if you do edit the file, be very careful, or the agent might not function properly.
Undeploy any applications protected by the Apache HTTP Server 2.0.x agent.
Stop the Apache HTTP Server instance, if it is running.
Change to the PolicyAgent-base/bin directory. For example:
For example: cd /opt/web_agents/apache_agent/bin
Issue one of the following commands:
# ./agentadmin --uninstall
or
# ./agentadmin --uninstallAll
The --uninstall option removes only one instance of the agent, while the --uninstallAll option prompts you to remove all configured instances of the agent.
The uninstall program prompts you for the Apache HTTP Server configuration directory path.
For example: /opt/apache-2.0.63/conf
The uninstall program displays the path and then asks if you want to continue:
To continue with the uninstallation, select 1 (the default).
The uninstall program uninstalls the agent (or all configured instances, if specified).
/opt/web_agents/apache_agent/installer-logs/audit/uninstall.log
The /config directory is removed from the agent instance directory, but the /installer-logs directory still exists.
The uninstall program creates the uninstall.log file in the PolicyAgent-base/installer-logs/audit directory. For example:
/opt/web_agents/apache_agent/installer-logs/audit/uninstall.log
The agent instance directory is not automatically removed. For example, if you uninstall the agent for Agent_001, a subsequent agent installation creates the Agent_002 instance directory. To remove an agent instance directory, you must manually remove the directory.
The version 3.0 agentadmin program includes the new --migrate option to migrate a version 2.2 agent to version 3.0. After you migrate a version 2.2 agent, the agent can use the new version 3.0 agent features.
The migration process migrates the agent's binary files, updates the agent's deployment container configuration, and converts the agent's AMAgent.properties file to the new version 3.0 OpenSSOAgentBootstrap.properties and OpenSSOAgentConfiguration.properties files.
Migrating a version 2.2 agent involves these general steps:
On the server where the version 2.2 agent is installed, run the version 3.0 agentadmin program with the --migrate option.
To get the version 3.0 agentadmin program, you must download the version 3.0 agent that corresponds to the version 2.2 agent you are migrating. For example, if you are migrating the version 2.2 Apache HTTP Server agent, download the version 3.0 Apache HTTP Server 2.0.x agent.
On the OpenSSO Enterprise server, run the ssoadm utility to create the new version 3.0 agent configuration in the centralized agent configuration repository.
Therefore, the ssoadm utility must be installed from the openssoAdminTools.zip file on the OpenSSO Enterprise server. For information, see Chapter 6, Installing the OpenSSO Enterprise Utilities and Scripts, in Sun OpenSSO Enterprise 8.0 Installation and Configuration Guide.
The agentadmin program creates a new deployment directory for the migrated agent, starting with Agent_001. The program does not modify the version 2.2 agent deployment directory files, in case you need these files after you migrate.
The following procedure, the migrated version 3.0 agent instance uses a new agent profile name, which is Apache2.0.xv3Agent in the examples. The old version 2.2 and new version 3.0 agent profile passwords are the same. If you need to change the password for the new version 3.0 agent profile, see Changing the Password for an Agent Profile (Optional).
Login to the server where the version 2.2 agent is installed.
To migrate the agent, you must have write permission to the version 2.2 agent's deployment container files and directories.
Stop the Apache HTTP Server instance for the version 2.2 agent.
Create a directory to download and unzip the version 3.0 agent. For example: v30agent
Download and unzip the version 3.0 agent that corresponds to the version 2.2 agent you are migrating.
The version 3.0 agents are available from the OpenSSO project site: https://opensso.dev.java.net/public/use/index.html
Change to the version 3.0 agent's /bin directory.
For example, if you downloaded and unzipped the version 3.0 Apache HTTP Server 2.0.x agent in the v30agent directory:
cd /v30agent/web_agents/apache_agent/bin
Run the version 3.0 agentadmin program with the --migrate option. For example:
./agentadmin --migrate
When the agentadmin program prompts you, enter the path to the version 2.2 agent's deployment directory. For example:
/opt/v22/web_agents/apache_agent
In this example, /opt/v22 is the directory where you downloaded and unzipped the version 2.2 agent.
The agentadmin program migrates the version 2.2 agent.
Copy the Agent_nnn/config/OpenSSOAgentConfiguration.properties file to the /bin directory where ssoadm is installed on the OpenSSO Enterprise server.
In OpenSSOAgentConfiguration.properties, add the un-encrypted version 2.2 agent profile password at the end of the file, as follows:
userpassword=v2.2–agent-profile-password
On OpenSSO Enterprise server, create a password file for the OpenSSO Enterprise administrator (amadmin).
This password file is an ASCII text file with only one line specifying the amadmin password in plain text. For example: /tmp/amadminpw
On OpenSSO Enterprise server, run ssoadm to create a new agent configuration in the OpenSSO Enterprise centralized agent configuration repository. For example:
cd tools_zip_root/opensso/bin ./ssoadm create-agent -b Apache2.0.xv3Agent -t WebAgent -u amadmin -f /tmp/amadminpw -D ./OpenSSOAgentConfiguration.properties
In this example:
tools_zip_root is the directory where you unzipped openssoAdminTools.zip.
Apache2.0.xv3Agent is the version 3.0 agent profile name.
WebAgent is the agent type for web agents.
/tmp/amadminpw is the path to the amadmin password file.
Caution: After you run ssoadm, you might want to delete OpenSSOAgentConfiguration.properties from the /bin directory. This file contains sensitive information, including as the agent profile password, and the original file is maintained on the server where the agent is installed.
Restart the Apache HTTP Server instance for the migrated agent.
After you migrate the agent, you can manage the new 3.0 agent configuration using the OpenSSO Enterprise Administration Console or the ssoadm utility, as described in Managing the Apache HTTP Server 2.0.x Agent.
You can find additional useful information and resources at the following locations:
Sun Services: http://www.sun.com/service/consulting/
Sun Software Products: http://wwws.sun.com/software/
Sun Support Resources http://sunsolve.sun.com/
Sun Developer Network (SDN): http://developers.sun.com/
Sun Developer Services: http://www.sun.com/developers/support/
To obtain accessibility features that have been released since the publishing of this media, consult Section 508 product assessments available from Sun upon request to determine which versions are best suited for deploying accessible solutions.
For information about Sun's commitment to accessibility, visit http://sun.com/access.
Third-party URLs are referenced in this document and provide additional, related information.
Sun is not responsible for the availability of third-party Web sites mentioned in this document. Sun does not endorse and is not responsible or liable for any content, advertising, products, or other materials that are available on or through such sites or resources. Sun will not be responsible or liable for any actual or alleged damage or loss caused by or in connection with the use of or reliance on any such content, goods, or services that are available on or through such sites or resources.
If you have questions or issues with OpenSSO Enterprise, contact Sun as follows:
Sun Support Resources (SunSolve) services at http://sunsolve.sun.com/.
This site has links to the Knowledge Base, Online Support Center, and ProductTracker, as well as to maintenance programs and support contact numbers.
The telephone dispatch number associated with your maintenance contract
So that we can best assist you in resolving problems, please have the following information available when you contact support:
If you are requesting help for a problem, please include the following information:
Description of the problem, including when the problem occurs and its impact on your operation
Machine type, operating system version, web container and version, JDK version, and OpenSSO Enterprise version, including any patches or other software that might be affecting the problem
Steps to reproduce the problem
Any error logs or core dumps
Sun is interested in improving its documentation and welcomes your comments and suggestions. To share your comments, go to http://docs.sun.com/ and click Feedback. In the online form, provide the full document title and part number. The part number is a 7-digit or 9-digit number that can be found on the title page or in the document's URL. For example, the title of this guide is Sun OpenSSO Enterprise Policy Agent 3.0 Guide for Apache HTTP Server 2.0.x, and the part number is 820-7584.
Part Number |
Date |
Description |
---|---|---|
820-7584–12 |
December 22, 2009 |
Added support for HP-UX systems. |
820-7584–11 |
November 10, 2009 |
Added support for IBM AIX systems. |
820-7584–10 |
June 26, 2009 |
Initial release. |