Install the CA SiteMinder® Agent for JBoss

Web Services Security Guides › CA SiteMinder® Agent for JBoss › Installing the CA SiteMinder® Agent for JBoss › Install the CA SiteMinder® Agent for JBoss

Install the CA SiteMinder® Agent for JBoss

The SiteMinder Agent installation includes the following security interceptors:

Web Application Security Interceptor (SiteMinder functionality)
Web Service Interceptor (SOA Security Manager functionality)

Note: All components of both interceptors are installed when you run the SiteMinder Agent installation. However, you need only configure the interceptor modules that you want to use.

Installation Options

This section describes the options for installing the SiteMinder Agent.

Windows:

Run the installation in the graphical user interface (GUI) mode to install the SiteMinder Agent.

UNIX:

Do one of the following to install or upgrade the SiteMinder Agent:

Use the graphical user interface (GUI) mode.
Use the console mode.

Information Required During SiteMinder Agent Installation

The SiteMinder Agent for JBoss installation program prompts you to supply the following information:

Location of the JVM to use.
Location of the JBoss Application Server installation. For example, the default for JBoss Enterprise Application Platform 4.3 is C:\jboss-eap-4.3\jboss-as on Windows and /jboss-eap-4.3/jboss-as on UNIX.
If you proceed to configure the Agent, the configuration wizard prompts you for the following additional information:
- Policy Server IP Address
- Information about the Trusted Host:
  To register a new Trusted Host, you need the name of the Trusted Host Configuration Object that you created when you configured the SiteMinder Policy Server for the SiteMinder agent providers.
  
  Note: If you want to register a new Trusted Host, be sure that the Policy Server is running before you start the SiteMinder Agent installation.
  
  To use an existing Trusted Host on the physical computer where the SiteMinder Agent resides, you need the location of the SmHost.conf file.
- Agent Configuration Object name for the Agent you created when you configured the SiteMinder Policy Server for the SiteMinder agent providers

Install a SiteMinder Agent on a Windows System

The following sections describe how to install the SiteMinder Agent on a Windows system.

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.

Run the Installation on Windows

Install the SiteMinder Agent for JBoss using the using the installation media on the Technical Support site.

Note: For a list of installation media names for each operating system, see the installation and upgrade considerations in the Release Notes.

Follow these steps:

Exit all applications that are running.
Navigate to where the installation executable is located.
Double-click ca-sm-jboss-12.52 SP1-cr-win32.exe.

cr

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

The SiteMinder Agent for JBoss installation wizard starts.
Use gathered system and component information to install the SiteMinder Agent. Consider the following when running the installer:
- 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.
- 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).
Review the information on the Pre-Installation Summary page, then click Install.
Note: The installation program may detect 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 Agent files are copied to the specified location. Afterward, the CA SiteMinder Agent for JBoss Configuration screen is displayed.
Choose one of the following options:
- Yes. I would like to configure the CA SiteMinder Agent for JBoss now.
- No. I will configure the CA SiteMinder Agent for JBoss later.
Click Done.
If you selected the option to configure the Agent now, the installation program prepares the CA SiteMinder Agent for JBoss Configuration Wizard and begins the trusted host registration and configuration processes.

Do the following:
- Register the trusted host. You can do this before or after configuring an Agent, but the Agent will not be able to communicate properly with the Policy Server unless the trusted host is registered.
- Configure the SiteMinder Agent.
If you did not select the option to configure the Agent now, the installation program prompts you to restart your system.Select whether to restart the system automatically or later on your own.

Installation Notes:

After installation, you can review the installation log file in SMAGENT_HOME\install_config_info. The file name is: CA_SiteMinder®_Agent_for_JBoss_InstallLog.log

SMAGENT_HOME

Specifies the path to where the SiteMinder Agent is installed.

Default: C:\Program Files\CA\JBossAgent
You may choose not to start the CA SiteMinder Agent for JBoss Configuration Wizard immediately after installation or you may have to reboot your machine after installation. If so, you can start the Wizard manually when you are ready to configure an Agent.

Install the SiteMinder Agent Using the Unattended Installer on Windows

Once the SiteMinder Agent is installed on one system, you can reinstall it on the same system or install it with the same options on another system using an unattended installation mode. An unattended installation lets you install or uninstall the agent without any user interaction

The unattended installation uses the ca-jboss-agent-installer.properties file generated during the initial install from the information you specified to define the necessary installation parameters, passwords, and so on.

The ca-jboss-agent-installer.properties is located in SMAGENT_HOME\install_config_info.

Follow these steps:

From a system where the agent is already installed, copy the ca-jboss-agent-installer.properties file to a local directory on your system.
Download the agent installation media from the Technical Support site.
Note: For a list of installation media names for each operating system, see the installation and upgrade considerations in the Release Notes.
Copy the installation media into the same local directory as the ca-jboss-agent-installer.properties file.
Open a console window and navigate to the location where you copied the files.
Run the following command:
```
ca-sm-jboss-12.52 SP1-cr-win32.exe  -f ca-jboss-agent-installer.properties -i silent
```
cr

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

The -i silent setting instructs the installer to run in the unattended installation mode.

When running this command, if the ca-jboss-agent-installer.properties file is not in the same directory as the installation program, use double quotes if the argument contains spaces.

For example:
```
ca-sm-jboss-12.52 SP1-cr-win32.exe -f "C:\Program Files\CA\JBossAgent\install_config_info\ca-jboss-agent-installer.properties " -i silent
```
An InstallAnywhere status bar appears, which shows that the unattended SiteMinder Agent installer has begun. The installer uses the parameters specified in the ca-jboss-agent-installer.properties file.

Note: To stop the installation manually, open the Windows Task Manager and stop the installation_media process.

To verify that the unattended installation completed successfully, see the CA_SiteMinder®_Agent_for_JBoss_InstallLog.log file in the SMAGENT_HOME\install_config_info directory. This log file contains the results of the installation.

Install a SiteMinder Agent on a UNIX System

The following sections describe how to install the SiteMinder Agent on a UNIX system.

Set the JRE in the PATH Variable

Set the Java Runtime Environment (JRE) in the UNIX system PATH variable.

To set the JRE in the PATH variable

Open a Command Window.
Run the following commands:
```
PATH=$PATH:JRE_HOME
export PATH
```
JRE_HOME

Defines the installed location of your Java Runtime Environment.

Run the Installer in GUI Mode on UNIX

Install the SiteMinder Agent for JBoss using the installation media on the Technical Support site.

Note: For a list of installation media names for each operating system, see the installation and upgrade considerations in the Release Notes.

Follow these steps:

Exit all applications that are running.
Open a shell and navigate to where the install program is located
If necessary, add executable permissions to the install file by running the following command:
```
chmod +x installation_media
```
installation_media

Specifies the SiteMinder Agent installer executable
Enter the following command:
```
sh ./ca-sm-jboss-12.52 SP1-cr-unix_version.bin
```
cr

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

unix_version

Specifies the UNIX version: sol or linux.

The SiteMinder Agent for JBoss installation wizard starts.
Use gathered system and component information to install the SiteMinder Agent. Consider the following when running the installer:
- 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.
- 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).
- Do not use space characters in the SiteMinder WSS Agent install path. For example, "/CA Technologies/agent" will result in install failure.
Review the information displayed on the Pre-Installation Summary page, then click Install.
Note: If the installer detects newer versions of certain system libraries 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 Agent files are copied to the specified location. Afterward, the CA SiteMinder Agent for JBoss Configuration screen is displayed.
Choose one of the following options:
- Yes. I would like to configure the CA SiteMinder Agent for JBoss now.
- No. I will configure the CA SiteMinder Agent for JBoss later.
Click Done.
If you selected the option to configure the Agent now, the installer prepares the CA SiteMinder Agent for JBoss Configuration Wizard and begins the host registration and configuration processes.

Do the following:
- Register the trusted host. You can perform this process before or after configuring an Agent. However the Agent cannot communicate properly with the Policy Server unless the trusted host is registered.
- Configure the SiteMinder Agent.
If you did not select the option to configure the Agent now, the installation program prompts you to restart your system. Select whether to restart the system automatically or later on your own.

Installation Notes:

After installation, you can review the installation log file in SMAGENT_HOME/install_config_info. The file name is: CA_SiteMinder®_Agent_for_JBoss_InstallLog.log

SMAGENT_HOME

Specifies the path to where the SiteMinder Agent is installed.
If you do not start the configuration wizard immediately after installation, you can start the Wizard manually when you are ready to configure an Agent.
If you must reboot the server after installation, you can start the Wizard manually when you are ready to configure an Agent.

Run the Installer in Console Mode on UNIX

Install the SiteMinder Agent for JBoss using the installation media on the Technical Support site.

Note: For a list of installation media names for each operating system, see the installation and upgrade considerations in the Release Notes.

Follow these steps:

Exit all applications that are running.
Open a shell and navigate to where the install program is located
If necessary, add executable permissions to the install file by running the following command:
```
chmod +x installation_media
```
installation_media

Specifies the SiteMinder Agent installer executable
Enter the following command:
```
sh ./ca-sm-jboss-12.52 SP1-cr-unix_version.bin -i console
```
cr

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

unix_version

Specifies the UNIX version: sol or linux.

The SiteMinder Agent for JBoss installation wizard starts.
Use gathered system and component information to install the SiteMinder Agent. Consider the following as you make your selections:
- 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).
- Do not use space characters in the SiteMinder WSS Agent install path. For example, "/CA Technologies/agent" will result in install failure.
Review the information displayed on the Pre-Installation Summary page, then proceed.
Note: If the installer detects newer versions of certain system libraries 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 Agent files are copied to the specified location. Afterward, the CA SiteMinder Agent for JBoss Configuration page is displayed.
Select whether to restart the system now or later on your own.
Hit Enter.

Note: After installation, you can review the installation log file in SMAGENT_HOME/install_config_info. The file name is: CA_SiteMinder®_Agent_for_JBoss_InstallLog.log.

Install the SiteMinder Agent Using the Unattended Installer on UNIX

Follow these steps:

From a system where the SiteMinder Agent is already installed, copy the ca-jboss-agent-installer.properties file to a local directory on your system.
Download the agent installation media from the Technical Support site.
Note: For a list of installation media names for each operating system, see the installation and upgrade considerations in the Release Notes.
Copy the installation media into the same local directory as the ca-jboss-agent-installer.properties file.
Open a console window and navigate to the location where you copied the files.
Run the following command:
```
ca-sm-jboss-12.52 SP1-cr-unix_version.bin -f ca-jboss-agent-installer.properties -i silent
```
cr

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

unix_version

Specifies the UNIX version: sol or linux.

The -i silent setting instructs the installer to run in the unattended installation mode.

When running this command, if the ca-jboss-agent-installer.properties file is not in the same directory as the installation program, use double quotes if the argument contains spaces.

For example:

ca-sm-jboss-12.52 SP1-cr-unix_version.bin -f "/CA/JBossAgent/install_config_info/ca-jboss-agent-installer.properties " -i silent

The -i silent setting instructs the installer to run in the unattended installation mode.

An InstallAnywhere status bar appears, which shows that the unattended SiteMinder Agent installer has begun. The installer uses the parameters specified in the ca-jboss-agent-installer.properties file.

Note: To stop the installation manually, type Ctrl+C.

To verify that the unattended installation completed successfully, see the CA_SiteMinder®_Agent_for_JBoss_InstallLog.log file in the SMAGENT_HOME/install_config_info directory. This log file contains the results of the 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.