Agent Installation Compared to Agent Configuration

Web Services Security Guides › CA SiteMinder WSS Agent Guide for iPlanet Web Servers › Install and Configure SiteMinder WSS Agents for iPlanet on Windows › Agent Installation Compared to Agent Configuration

Agent Installation Compared to Agent Configuration

The concepts of installation and configuration have specific meanings when used to describe CA SiteMinder® agents.

Installation means installing the CA SiteMinder® agent software on a computer system. For example, installing an agent creates directories and copies the CA SiteMinder® agent software and other settings to the computer.

Configuration occurs after installation and means the act of preparing the CA SiteMinder® agent software for a specific web server on a computer. This preparation includes registering the agent with CA SiteMinder® Policy Servers, and creating a runtime server instance for the web server that is installed on the computer.

Use the wizard-based installation and configuration programs to install and configure your agent on your first web server. The wizard-based programs create a .properties file.

Use the .properties file and the respective executable file to install or configure the agent silently on additional web servers.

Set the JRE in the Path Variable

Set the Java Runtime Environment (JRE) in the Windows path variable.

Follow these steps:

Open the Windows Control Panel.
Double-click System.
Add the location of the Java Runtime Environment bin directory to the Path system variable in the Environment Variables dialog.

Apply the Unlimited Cryptography Patch to the JRE

Patch the Java Runtime Environment (JRE) used by the Agent to support unlimited key strength in the Java Cryptography Extension (JCE) package. The patches for all supported platforms are available from the Oracle website.

The files that need to be patched are:

local_policy.jar
US_export_policy.jar

The local_policy.jar and US_export_policy.jar files can found be in the following locations:

Windows
jre_home\lib\security
UNIX
jre_home/lib/security

jre_home: Defines the location of your Java Runtime Environment installation.

Configure the JVM to Use the JSafeJCE Security Provider

The SiteMinder WSS Agent XML encryption function requires that the JVM is configured to use the JSafeJCE security provider.

Follow these steps:

Add a security provider entry for JSafeJCE (com.rsa.jsafe.provider.JsafeJCE) to the java.security file located in the following location:
- JRE_HOME\lib\security (Windows)
- JRE_HOME/lib/security (UNIX)
JRE_HOME

Is the installed location of the JRE used by the application server.

In the following example, the JSafeJCE security provider entry has been added as the second security provider:
```
security.provider.1=sun.security.provider.Sun
security.provider.2=com.rsa.jsafe.provider.JsafeJCE
security.provider.3=sun.security.rsa.SunRsaSign
security.provider.4=com.sun.net.ssl.internal.ssl.Provider
security.provider.5=com.sun.crypto.provider.SunJCE
security.provider.6=sun.security.jgss.SunProvider
security.provider.7=com.sun.security.sasl.Provider
```
Note: If using the IBM JRE, always configure the JSafeJCE security provider immediately after (that is with a security provider number one higher than) the IBMJCE security provider (com.ibm.crypto.provider.IBMJCE)
Add the following line to JRE_HOME\lib\security\java.security (Windows) or JRE_HOME/lib/security/java.security (UNIX) to set the initial FIPS mode of the JsafeJCE security provider:
```
com.rsa.cryptoj.fips140initialmode=NON_FIPS140_MODE
```
Note: The initial FIPS mode does not affect the final FIPS mode you select for the SiteMinder WSS Agent.

How to Install and Configure a SiteMinder WSS Agent for iPlanet on a Windows System

Installing CA SiteMinder® agents on the Windows operating environment requires several separate procedures. To install and configure an SiteMinder WSS Agent on Windows, use the following process:

Gather the Information for the Installation Program

Gather the following information about your web server before running the installation program for the agent:

Installation Directory

Specifies the location of the agent binary files on your web server. The web_agent_home variable is set to this location.

Limit: The product requires the name "webagent" for the bottom directory in the path

Gather Information Required for SiteMinder WSS Agent Configuration

The following information must be supplied during Trusted Host registration:

SM Admin User Name

The name of a Policy Server administrator allowed to register the host with the Policy Server.

This administrator should already be defined at the Policy Server and have the permission Register Trusted Hosts set. The default administrator is SiteMinder.

SM Admin Password

The Policy Server administrator account password.

Trusted Host Name

Specifies a unique name that represents the trusted host to the Policy Server. This name does not have to be the same as the physical client system that you are registering; it can be any unique name, for example, mytrustedhost.

Note: This name must be unique among trusted hosts and not match the name of any other Agent.

Host Configuration Object

The name of the Host Configuration Object in the Policy Server that defines the connection between the trusted host and the Policy Server. For example, to use the default, enter DefaultHostSettings. In most cases, you will have created your own Host Configuration Object.

Note: This value must match the Host Configuration Object entry preconfigured on the Policy Server.

Policy Server IP Address

The IP address, or host name, and authentication port of the Policy Server where you are registering the host. The default port is 44442. If you do not provide a port, the default is used.

You can specify a non-default port number, but if your Policy Server is configured to use a non-default port and you omit it when you register a trusted host, the following error is displayed:

Registration Failed (bad ipAddress[:port] or unable to connect to Authentication server (-1)

Note also that if you specify a non-default port, that port is used for the Policy Server’s authentication, authorization, and accounting ports; however, the unified server responds to any Agent request on any port. The entry in the SmHost.conf file will look like:

policyserver="ip_address,5555,5555,5555"

FIPS Encryption Mode

Determines whether the Agent communicates with the Policy Server using certified Federal Information Processing Standard (FIPS) 140-2 compliant cryptographic libraries.

FIPS Compatibility Mode (Default)

Specifies non-FIPS mode, which lets the Policy Server and the Agents read and write information using the existing CA SiteMinder® encryption algorithms. If your organization does not require the use of FIPS-compliant algorithms, the Policy Server and the Agents can operate in non-FIPS mode without further configuration.

FIPS Only Mode

Specifies full-FIPS mode, which requires that the Policy Server and Web Agents read and write information using only FIPS 140-2 algorithms.

Important! A CA SiteMinder® installation that is running in Full FIPS mode cannot interoperate with, or be backward compatible to, earlier versions of CA SiteMinder®, including all agents, custom software using older versions of the Agent API, and custom software using PM APIs or any other API that the Policy Server exposes. You must re-link all such software with the corresponding versions of the respective SDKs to achieve the required support for Full FIPS mode.

Run the Installer to Install a SiteMinder WSS Agent

Install the SiteMinder WSS Agent using the CA SiteMinder WSS installation media on the Technical Support site.

Follow these steps:

Exit all applications that are running.
Navigate to the installation material.
Double-click ca-sm-wss-12.51-cr-win32.exe.

cr

Specifies the cumulative release number. The base 12.51 release does not include a cumulative release number.

The CA SiteMinder WSS installation wizard starts.

Important! If you are running this wizard on Windows Server 2008, run the executable file with Administrator permissions, even if you are logged into the system as an Administrator.
Use gathered system and component information to install the SiteMinder WSS Agent. Consider the following points when running the installer:
- When prompted to select which CA SiteMinder WSS Agents to install, select CA SiteMinder WSS Agent for Web Servers.
- When prompted to select the Java version, the installer lists all Java executables present on the system. Select a supported 32-bit Java Runtime Environment (refer to the Platform Support Matrix on the Technical Support site).
- If you enter path information in the wizard by cutting and pasting, enter (and delete, if necessary) at least one character to enable the Next button.
- If the installer detects the presence of an existing CA SiteMinder® Web Agent, it displays a warning dialog stating that the install will upgrade the Web Agent. Click Continue to upgrade the Web Agent to a SiteMinder WSS Agent. If you proceed, the software upgrade occurs in the installed location of the existing Web Agent.
Review the information that is presented on the Pre-Installation Summary page, then click Install.
Note: If the installation program detects that newer versions of certain system DLLs are installed on your system, it asks if you want to overwrite these newer files with older files. Select No To All if you see this message.

The SiteMinder WSS Agent files are copied to the specified location.
On the CA SiteMinder WSS Configuration screen, click one of the following options and click Next:
- Yes. I would like to configure CA SiteMinder WSS Agents now.
- No. I will configure CA SiteMinder WSS Agents later.
If the installation program detects that there are locked Agent files, it prompts you to restart your system instead of reconfiguring it. Select whether to restart the system automatically or later on your own.
Click Done.
If you selected the option to configure SiteMinder WSS Agents now, the installation program prepares the CA SiteMinder WSS Configuration Wizard and begins the trusted host registration and configuration process. Use the information that you gathered earlier to complete the wizard.

If you did not select the option to configure SiteMinder WSS Agents now, or if you are required to reboot the system after installation, run the configuration wizard manually later.

Installation Notes:

After installation, you can review the installation log file in WSS_HOME\install_config_info. The file name is: CA_SiteMinder_Web_Services_Security_Install_install-date-and-time.log

WSS_Home

Specifies the path to where CA SiteMinder WSS is installed.

Default: C:\Program Files\CA\Web Services Security

install-date-and-time

Specifies the date and time that the SiteMinder WSS Agent was installed.
The Agent cannot communicate properly with the Policy Server until the trusted host is registered.

More information:

Gather Information for the Agent Installation Program

Copy cryptojFIPS.jar to the WebSphere JRE

Gather Information for the Agent Configuration Program for IIS Web Servers

Run the SiteMinder WSS Agent Configuration Program on Windows

After gathering the information for your agent configuration, run the agent configuration program. This program creates an agent runtime instance for the web servers running on your computer.

This configuration program is wizard or console based, depending on the option you select. Running the configuration program in the wizard or console mode once creates a properties file. Use the properties file to run unattended configurations on other computers with same operating environment in the future.

Follow these steps:

Open the following directory on your web server:
```
WSS_Home\install_config_info
```
WSS_Home

Specifies the path to where CA SiteMinder WSS is installed.

Default: C:\Program Files\CA\Web Services Security
Use one of the following configuration methods:
- For a GUI-based configuration, right-click ca-pep-config.exe, and then select Run as Administrator:
- For a console-based configuration, enter the following command from a Command Prompt window with Administrator privileges open to WSS_Home\install_config_info:
```
ca-pep-config.exe -i console
```
  Important! If you are running this wizard on Windows Server 2008, run the executable file with administrator permissions. Use these permissions even if you are logged in to the system as an administrator. For more information, see the release notes for your CA SiteMinder® component.
Use the information you gathered earlier to complete the wizard.
The agent runtime instance is created for your web servers.

(Optional) Run the Unattended or Silent Installation and Configuration Programs Subsequent SiteMinder WSS Agents on Windows

The unattended or silent installation option can help you automate the installation and configuration process. This method saves time if you have a large CA SiteMinder WSS environment that uses many agents with identical settings.

For example, suppose the Agents in your environment use the same web server version, installation directory, Agent Configuration Object and Policy Servers. Use the installation wizard or console-based installation program for your first installation. Afterwards, you could create your own script to run the installation program with the .properties file the wizard or console-based installation program created.

Follow these steps:

Run the following wizards on your first web server (in the order shown):
1. The CA SiteMinder WSS Installation wizard.
2. The CA SiteMinder WSS Configuration wizard.
Locate the following file on your first web server:
```
WSS_Home\install_config_info\ca-wss-installer.properties
```
Note: If the path contains spaces, surround it with quotes.

WSS_Home

Specifies the path to where CA SiteMinder WSS is installed.

Default: C:\Program Files\CA\Web Services Security
Perform each of the following steps on the other web servers in your environment:
Note: To automate this process, create your own customized script to execute these files on your systems. Use any scripting language that you want.
1. Create a temporary directory on the subsequent web server.
2. Copy the following files from your first web server (from Steps 1 and 2) to the temporary directory on your subsequent web server:
  - The SiteMinder WSS Agent Installation executable file.
  - The ca-pepconfig-installer.properties file.
3. Open a Command Prompt window with Administrative privileges in the temporary directory.
4. Run the following command:
```
ca-sm-wss-12.51-cr-win32.exe -f properties_file -i silent.
```
  cr
  
  Specifies the cumulative release number. The base 12.51 release does not include a cumulative release number.
  
  Important! If you are running this wizard on Windows Server 2008, run the executable file with Administrator permissions, even if you are logged into the system as an Administrator.
  
  The SiteMinder WSS Agent is installed and configured on the subsequent server automatically.
5. (Optional) Delete the temporary directory from your subsequent web server.
Repeat Step 3 for each additional web server in your CA SiteMinder® environment that uses the configuration that the settings in your ca-wss-installer.properties file specify.

Apply CA SiteMinder® Changes to Oracle iPlanet Configuration Files with Oracle iPlanet Administration Server Console for SunOne 6.1 Servers

The Agent Configuration Wizard modifies the default obj.conf, and mime.types files that the Oracle iPlanet web server uses.

If you are using version 6.1 of a SunOne web server, and you plan to use the Oracle iPlanet Administration console, apply the changes to these files before using the console. If you do not apply the changes using the console first, the changes that are made for your CA SiteMinder® configuration could be corrupted. If you lose your configuration, run the configuration program again.

Note: The agent adds settings to the obj.conf file of the Oracle iPlanet web server when the Agent is configured to support an advanced authentication scheme. CA SiteMinder® does not remove these settings later. Edit the obj.conf file manually to remove any obsolete settings.

Follow these steps:

Log in to the Oracle iPlanet Administration Server console.
From the Servers tab, select the web server with the CA SiteMinder® agent installed and click Manage.
In the right corner of the dialog, click Apply.
A warning message about loading the modified configuration files appears.
Click Load Configuration Files.
Exit the console.
Restart the web server.
Optimize the Agent for Oracle iPlanet by tuning the shared memory segments.
The CA SiteMinder® changes are applied.

More Information

Reconfigured Web Agent Won't Operate

Manually Configure Non-Default Server Instances, Virtual Servers, or Reverse Proxies for Oracle iPlanet Web Servers

The SiteMinder WSS Agent Configuration wizard only configures the default instance of your Oracle iPlanet web server. To configure a different instance of the Oracle iPlanet web server for CA SiteMinder®, manually edit the obj.conf file that is associated with that server instance. Examples of server instances that need manual configuration include:

Servers installed in a nondefault directory
Servers that you want to configure as a reverse proxy. We recommend configuring the reverse proxy using your Oracle iPlanet interface before adding the CA SiteMinder® settings to the obj.conf file.
Note: The CA SiteMinder® Agent Configuration wizard only modifies the default obj.conf file on the Oracle iPlanet (formerly Sun Java System) web server. To protect other instances or reverse proxy deployments with CA SiteMinder®, copy the CA SiteMinder® settings from the default obj.conf file to any respective instance_name-obj.conf files. For example, your web server created an obj.conf file when you installed it, but you later added a server instance named my_server.example.com. To protect resources on my_server.example.com with CA SiteMinder®, copy the CA SiteMinder® settings the wizard added from the obj.conf file to the my_server.example.com-obj.conf file.
Virtual servers on the same computer

Note: SunOne/Sun Java 7.0 web servers do not require these manual configuration steps.

Follow these steps:

Locate the directory of the server instance you want to configure.
Open the obj.conf file with a text editor.
Locate the following line:
```
<Object name="default">
```
Insert a new line below the previous one, and then add the following text:
```
AuthTrans fn="SiteMinderAgent"
```

Locate the following line:

AuthTrans fn="match-browser" browser="*MSIE*" ssl-unclean-shutdown="true"

Insert a new line below the previous one, and then add the following text:

NameTrans fn="pfx2dir" from="/siteminderagent/pwcgi" dir="agent_home/pw" name="cgi"
NameTrans fn="pfx2dir" from="/siteminderagent/pw" dir="agent_home/pw"
NameTrans fn="pfx2dir" from="/siteminderagent/jpw" dir="agent_home/jpw"
NameTrans fn="pfx2dir" from="/siteminderagent/redirectjsp" dir="agent_home/affwebservices/redirectjsp"
NameTrans fn="pfx2dir" from="/siteminderagent/certoptional" dir="agent_home/samples"
NameTrans fn="pfx2dir" from="/siteminderagent" dir="agent_home/samples"
NameTrans fn="pfx2dir" from="/siteminderagent/pwservlet" dir=agent_home/jpw"

agent_home

Indicates the directory where the SiteMinder WSS Agent is installed on your web server.

Default (Windows 32-bit SiteMinder WSS Agent installations: C:\Program Files\CA\Web Services Security\webagent

Default (Windows 64-bit SiteMinder WSS Agent installations: C:\Program Files\CA\Web Services Security\webagent\win64

Default (Windows 32-bit SiteMinder WSS Agent installations operating on 64-bit systems: C:\Program Files (x86)\CA\Web Services Security\webagent\win32

Locate the following line:
```
NameTrans fn="ntrans-j2ee" name="j2ee"
```
Insert a new line below the previous one, and then add the following text:
```
PathCheck fn="SmRequireAuth"
```

Remove the following line:

NameTrans fn="pfx2dir" from="/mc-icons" dir="C:/Program Files/Sun/WebServer7.0/lib/icons" name="es-internal"

Locate the following line:

ObjectType fn="force-type" type="text/plain"

Insert a new line below the previous one, and then add the following text:
```
Service method="(GET|POST)" fn="SmAdvancedAuth"
```
Locate the following line:
```
Error fn="error-j2ee
```
Insert a new line above the previous one, and then add the following text:
```
Error fn="SmSoapFault" code="500" reason="SmSoapFault"
```
Save the obj.conf file.
Open the magnus.conf file with a text editor.

Add the following line:

Init fn="load-modules" shlib="agent_home/bin/SunOneWebAgent.dll" funcs="SmInitAgent,SmInitChild,SiteMinderAgent,SmRequireAuth,SmAdvancedAuth,SmSoapFault

Save the magnus.conf file.
The Oracle iPlanet web server is manually configured.

(Optional) Improve Server Performance with httpd.conf File Changes

You can improve server performance by modifying the default configuration settings in the httpd.conf file; however, these changes are not required:

Follow these steps:

For Oracle iPlanet web servers, assign a higher priority level to your Apache20WebAgent.dll file than any other auth modules or access modules on your web server.
For low-traffic websites, define the following directives:
- Set MaxRequestsPerChild>1000 or Set MaxRequestsPerChild=0
- MinSpareServers >5
- MaxSpareServers>10
- StartServers=MinSpareServers>5
For high-traffic websites, define the following directives:
- Set MaxRequestsPerChild>3000 or Set MaxRequestsPerChild=0
- MinSpareServers >10
- MaxSpareServers>15
- StartServers=MinSpareServers>10