Advanced Password Services (APS) Guide › Install and Configure APS › Installation

Installation

Note: Any instructions included in the readme or in release notes supercede instructions included here.

SiteMinder Policy Server

Windows

r12.52 and later

The Policy Server installer installs the required shared library and all other required APS server files as part of the Policy Server installation.

Follow these steps:

1. When you enable APS for an r12.52 Policy Server, the installer automatically adds the following file:

   siteminder_home\bin\smaps.dll
   

2. Restart the Policy Server to enable the Policy Server–side components.

   Note: The Policy Server installer installed all of the other required APS server files as part Policy Server installation.

r12.5 and 12.51

The Policy Server installer installs the required shared library and all other required APS server files as part of the Policy Server installation.

Follow these steps:

1. Navigate to siteminder_home\bin and locate the following shared library file:

   smaps.rename4aps.dll
   

   siteminder_home

   Specifies the Policy Server installation path.

2. Rename the shared library to the following:

   smaps.dll
   

3. Restart the Policy Server to enable the Policy Server–side components.

   Note: The Policy Server installer installed all of the other required APS server files as part Policy Server installation.

r6.x and r12.0.x

Follow these steps:

1. Log in to the Policy Server host system.
2. Unzip smaps–5.5_version.zip in to a temporary directory.

   version

   Specifies the latest version of the zip.

3. Double–click the installation executable.
4. Follow the installer prompts and select the items that you would like to install. The program determines which parts of APS can be installed on the current system.

   Consider the following:

   • Any LANG (translation) or CFG (configuration) files are not replaced in production directories. However, new copies are always added to siteminder_home/Samples/APS_Translation_Files.
   • Only a default APS.cfg file is installed. Modify it to suit the needs of your site. If an APS.cfg file existed before installation, it is not overwritten. Locate the new APS.cfg file installed to SiteMinder\Docs.
5. Restart the Policy Server to enable the Policy Server–side components.

UNIX

r12.52 and later

The Policy Server installer installs the required shared library and all other required APS server files as part of the Policy Server installation.

Follow these steps:

1. When you enable APS, the Policy Server automatically adds the following file:

   siteminder_home/bin/libsmaps.so
   

2. Restart the Policy Server to enable the Policy Server–side components.

r12.5 and 12.51

The Policy Server installer installs the required shared library and all other required APS server files as part of the Policy Server installation.

Follow these steps:

1. Log in to the Policy Server host system.
2. Navigate to siteminder_home/lib/ and locate the following shared library file:

   libsmaps_rename4aps.so
   

   siteminder_home

   Specifies the Policy Server installation path.

3. Rename the shared library to the following:

   libsmaps.so
   

4. Restart the Policy Server to enable the Policy Server–side components.

r6.x and r12.0.x

Each kit supplies two installation scripts. One script for the Policy Server–side components and one kit for web–side components. These scripts are supplied in a single file, tarred, and compressed.

The installation program does the following:

• Backs up existing files by appending a timestamp as an extension.
• Verifies that all text files have only UNIX style line endings.
• Copies files to the correct directories.
• Records the list of installed files in a logfile named:

  siteminder_home/apsinstall_datestamp.log
  

Follow these steps:

1. Decompress the supplied file and then untar it to gain access to the two scripts.
2. Log in to the Policy Server host system as the user who installed the Policy Server.
3. Run the Policy Sever shell script.

   Consider the following:

   • The installation program can locate the SiteMinder Policy Server directories automatically.
   • The shell script is a korn script. The script includes all installation files in the form of a uuencoded, compressed, tar file appended to the end of the script.
   • Existing files are backed up in place by appending a timestamp as an extension.
   • All LANG (translation), CFG (configuration), or sample source files are backed-up in place. If you changed a file, merge the changes into the new version of the file that is installed.
   • The default APS.cfg file is installed. Modify it as needed. If an APS configuration file existed before installation, the installer renames it with the date of installation as an extension. The new version is installed in the same directory. Modify the new version by merging changes forward from the old version. If this is a new installation, edit it manually as needed.
4. Restart the Policy Server to enable the Policy Server–side components.

Web Server – Change Password Interface

Windows

r12.5 and 12.51

The web agent installer installs the Change Password Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Map the agent_home\bin\web\CPW directory to your web server as a virtual CGI directory.

   Note: For more information, see your vendor–specific documentation.

r6.x and r12.0.x

Follow these steps:

1. Log in to the web agent host system.
2. Unzip smaps–5.5_version.zip in to a temporary directory.

   version

   Specifies the latest version of the zip.

3. Double–click the installation executable.
4. Follow the installer prompts and select Change Password Interface when prompted to select components.

   Note: You can install all web–side components at the same time.

5. Follow the remaining prompts to specify destination locations and installer options.

   Consider the following:

   • Existing LANG (translation) or CFG (configuration) files are not overwritten. New copies of these files are added to agent_home/Samples/APS_Translation_Files.
   • The default SmPortal.cfg file is installed.
   • If a Policy Server is installed on this system, some files are copied in to CA SiteMinder® directories instead of web agent directories.
6. Restart the host system to complete the installation.

After you complete the installation:

1. Modify the SmPortal configuration file to meet the needs of your organization. Verify that the file references a service named smaps.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Map the agent_home\bin\web\CPW directory to your web server as a virtual CGI directory.

   Note: For more information, see your vendor–specific documentation.

UNIX

r12.52 and later

The web agent installer installs the Change Password Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Define a virtual CGI directory for the directory that contains the SmCPW CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variable in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

r12.5 and 12.51

The web agent installer installs the Change Password Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Define a virtual CGI directory for the directory that contains the SmCPW CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   APS_LANG_PATH

   The path to the Language directory.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

r6.x and r12.0.x

Each kit supplies two installation scripts. One script for the Policy Server–side components and one kit for web–side components. These scripts are supplied in a single file, tarred, and compressed.

The installation program does the following:

• Backs up existing files by appending a timestamp as an extension.
• Verifies that all text files have only UNIX style line endings.
• Copies files to the correct directories.
• Records the list of installed files in a logfile named:

  agent_home/cpwinstall_datestamp.log
  

Follow these steps:

1. Decompress the supplied file and then untar it to gain access to the two scripts.
2. Log in to the web agent host system as the user who installed the agent.
3. Run the agent shell script.

   Consider the following:

   • The installer requires you to enter the absolute path to the parent directory of the web agent.

     Example: If you installed the agent in /opt/smuser/ca/webagent, enter the following when prompted:

     /opt/smuser/ca
     

   • The shell script is a korn script. The script includes all installation files in the form of a uuencoded, compressed, tar file appended to the end of the script.
   • All LANG (translation), CFG (configuration), and sample source files are backed-up by appending a timestamp as an extension. If you changed a file, merge the changes into the new version of the file that is installed.
   • The default SmPortal.cfg file is installed.
4. Restart the system to complete the installation.

After you complete the installation:

1. If this is a new installation, modify SMPortal configuration file as needed. For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

   If an SmPortal configuration file existed before the installation, the installer renames it with the date of installation as an extension. The new version is installed in the same directory. Modify the new version by merging changes forward from the old version. Verify that the file references a service named smaps.

2. Define a virtual CGI directory for the directory that contains the SmCPW CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   APS_LANG_PATH

   The path to the Language directory.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

Web Server – Forgotten Password Interface

Windows

r12.5 and 12.51

The web agent installer installs the Forgotten Password Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Map the agent_home\bin\web\FPS directory to your web server as a virtual CGI directory.

   Note: For more information, see your vendor–specific documentation.

3. The installation provides sample FPS presentation forms. Create, modify and install the required forms. After you create the forms, configure them in the APS configuration file (APS.cfg) on the Policy Server host systems.

   Note: For more information, see the Forgotten Password Interface chapter.

r6.x and r12.0.x

Follow these steps:

1. Log in to the web agent host system.
2. Unzip smaps–5.5_version.zip in to a temporary directory.

   version

   Specifies the latest version of the zip.

3. Double–click the installation executable.
4. Follow the installer prompts and select Forgotten Password Interface when prompted to select components.

   Note: You can install all web–side components at the same time.

5. Follow the remaining prompts to specify destination locations and installer options.

   Consider the following:

   • Existing LANG (translation) or CFG (configuration) files are not overwritten. New copies of these files are added to the Docs directory for reference.
   • The default SmPortal.cfg file is installed.
   • If a Policy Server is installed on this system, some files are copied in to CA SiteMinder® directories instead of web agent directories.
6. Restart the host system to complete the installation.

After you complete the installation:

1. Modify the SmPortal configuration file to meet the needs of your organization. Verify that the file references a service named smaps.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Map the agent_home\bin\web\FPS directory to your web server as a virtual CGI directory.

   Note: For more information, see your vendor–specific documentation.

3. The installation provides sample FPS presentation forms. Create, modify and install the required forms. After you create the forms, configure them in the APS configuration file (APS.cfg) on the Policy Server host systems.

   Note: For more information, see the Forgotten Password Interface chapter.

UNIX

r12.52 and later

The web agent installer installs the Forgotten Password Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Define a virtual CGI directory for the directory that contains the Forgot CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

4. The installation provides sample FPS presentation forms. Create, modify and install the required forms. After you create the forms, configure them in the APS configuration file (APS.cfg) on the Policy Server host systems.

r12.5 and 12.51

The web agent installer installs the Forgotten Password Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Define a virtual CGI directory for the directory that contains the Forgot CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   APS_LANG_PATH

   The path to the Language directory.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

4. The installation provides sample FPS presentation forms. Create, modify and install the required forms. After you create the forms, configure them in the APS configuration file (APS.cfg) on the Policy Server host systems.

   Note: For more information, see the Forgotten Password Interface chapter.

r6.x and r12.0.x

Each kit supplies two installation scripts. One script for the Policy Server–side components and one kit for web–side components. These scripts are supplied in a single file, tarred, and compressed.

The installation program does the following:

• Backs up existing files by appending a timestamp as an extension.
• Verifies that all text files have only UNIX style line endings.
• Copies files to the correct directories.
• Records the list of installed files in a logfile named:

  agent_home/fpsinstall_datestamp.log
  

Follow these steps:

1. Decompress the supplied file and then untar it to gain access to the two scripts.
2. Log in to the web agent host system as the user who installed the agent.
3. Run the agent shell script.

   Consider the following:

   • The installer requires you to enter the absolute path to the parent directory of the web agent.

     Example: If you installed the agent in /opt/smuser/ca/webagent, enter the following when prompted:

     /opt/smuser/ca
     

   • The shell script is a korn script. The script includes all installation files in the form of a uuencoded, compressed, tar file appended to the end of the script.
   • All LANG (translation), CFG (configuration), and sample source files are backed-up by appending a timestamp as an extension. If you changed a file, merge the changes into the new version of the file that is installed.
   • The default SmPortal.cfg file is installed.
4. Restart the system to complete the installation.

After you complete the installation:

1. If this is a new installation, modify SMPortal configuration file as needed. For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

   If an SmPortal configuration file existed before the installation, the installer renames it with the date of installation as an extension. The new version is installed in the same directory. Modify the new version by merging changes forward from the old version. Verify that the file references a service named smaps.

2. Define a virtual CGI directory for the directory that contains the Forgot CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   APS_LANG_PATH

   The path to the Language directory.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

4. The installation provides sample FPS presentation forms. Create, modify and install the required forms. After you create the forms, configure them in the APS configuration file (APS.cfg) on the Policy Server host systems.

   Note: For more information, see the Forgotten Password Interface chapter.

Web Server – Help Desk (APSAdmin) Interface

Windows

r12.5

The web agent installer installs the Help Desk Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Map the agent_home\bin\web\APSAdmin directory to your web server as a virtual CGI directory.

   Note: For more information, see your vendor–specific documentation.

r6.x and r12.0.x

Follow these steps:

1. Log in to the web agent host system.
2. Unzip smaps–5.5_version.zip in to a temporary directory.

   version

   Specifies the latest version of the zip.

3. Double–click the installation executable.
4. Follow the installer prompts and select Help Desk Interface when prompted to select components.

   Note: You can install all web–side components at the same time.

5. Follow the remaining prompts to specify destination locations and installer options.

   Consider the following:

   • Existing LANG (translation) or CFG (configuration) files are not overwritten. New copies of these files are added to the Docs directory for reference.
   • The default SmPortal.cfg file is installed.
   • If a Policy Server is installed on this system, some files are copied in to CA SiteMinder® directories instead of web agent directories.
6. Restart the host system to complete the installation.

After you complete the installation:

1. Modify the SmPortal configuration file to meet the needs of your organization. Verify that the file references a service named smaps.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Map the agent_home\bin\web\APSAdmin directory to your web server as a virtual CGI directory.

   Note: For more information, see your vendor–specific documentation.

UNIX

r12.52 and later

The web agent installer installs the Help Desk Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.
2. Define a virtual CGI directory for the directory that contains the APSAdmin CGI program.
3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

r12.5 and 12.51

The web agent installer installs the Help Desk Interface client component. You do not have to use the APS installation kit to install it.

Follow these steps to complete the installation:

1. The default SmPortal.cfg file is installed. Modify the configuration file as needed.

   Note: For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

2. Define a virtual CGI directory for the directory that contains the APSAdmin CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   APS_LANG_PATH

   The path to the Language directory.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

r6.x and r12.x

Each kit supplies two installation scripts. One script for the Policy Server–side components and one kit for web–side components. These scripts are supplied in a single file, tarred, and compressed.

The installation program does the following:

• Backs up existing files by appending a timestamp as an extension.
• Verifies that all text files have only UNIX style line endings.
• Copies files to the correct directories.
• Records the list of installed files in a logfile named:

  agent_home/APSAdmininstall_datestamp.log
  

Follow these steps:

1. Decompress the supplied file and then untar it to gain access to the two scripts.
2. Log in to the web agent host system as the user who installed the agent.
3. Run the agent shell script.

   Consider the following:

   • The installer requires you to enter the absolute path to the parent directory of the web agent.

     Example: If you installed the agent in /opt/smuser/ca/webagent, enter the following when prompted:

     /opt/smuser/ca
     

   • The shell script is a korn script. The script includes all installation files in the form of a uuencoded, compressed, tar file appended to the end of the script.
   • All LANG (translation), CFG (configuration), and sample source files are backed-up by appending a timestamp as an extension. If you changed a file, merge the changes into the new version of the file that is installed.
   • The default SmPortal.cfg file is installed.
4. Restart the system to complete the installation.

After you complete the installation:

1. If this is a new installation, modify SMPortal configuration file as needed. For more information, see the SmPortal/SmTransact Installation and Configuration chapter.

   If an SmPortal configuration file existed before the installation, the installer renames it with the date of installation as an extension. The new version is installed in the same directory. Modify the new version by merging changes forward from the old version. Verify that the file references a service named smaps.

2. Define a virtual CGI directory for the directory that contains the APSAdmin CGI program.

   Note: For more information, see your vendor–specific documentation.

3. Create the following environment variables in the CGI process space of the web server:

   SMPORTAL

   The full path to the SmPortal.cfg file.

   APS_LANG_PATH

   The path to the Language directory.

   Note: Update LD_LIBRARY_PATH to let SmCPW find the SmPortal library. For more information, see your vendor–specific documentation.

   Important! Do not put the definitions in to a user profile. Place them in to a special configuration file that the web server uses.

Delegated Management Services (DMS2) Interface

APS Attributes/Enable/Disable (all platforms)

From this point, the installation of this add-on component requires manual steps. After installing DMS, please make a backup of the following eight files (as mentioned in sections 1, 2, and 3 below) before copying them to the directories mentioned.

Note: working-dir is the directory where SiteMinder is installed.

1. Copy the following modified files into the working-dir/DMS/pages directory:
   • inc_actions.jsp
   • inc_org_roles.jsp
   • manage_data.js
   • manage_data_submitter.jsp
   • user_submitter.jsp
   • user_data_collector.jsp
2. Copy the following modified file into the working-dir/DMS/properties/default/locale directory:
   • dms_en_US.properties
3. Copy the following modified file into the working_dir/DMS/properties/default/tables directory:
   • user.properties
4. Copy the following new files (5 files) into the working-dir/DMS/pages directory:
   • aps.js
   • disable.jsp
   • apsblob.jsp
   • aps_attribute.jsp
   • disableGroup.jsp

Forgotten Password Questions/Answers (all platforms)

1. Copy the following modified files located under the pages subdirectory into the working-dir/DMS/pages directory:
   • forgottenpassword.jsp
   • newuserjs.jsp
2. Copy the following modified files located under the forms subdirectory into the working-dir/DMS/forms directory:
   • loginandregisterwithforgottenpassword-dms-i.fcc
   • loginandregisterwithforgottenpassword-dms.fcc
3. Copy the modified file Verify.jsp, located under pages directory, into the directory as mentioned in the URL setting in the [FPS-Verify] of the APS Configuration File.
4. Copy the jarfile questions.jar into the directory working-dir/DMS/java.
5. Put the required property file related to forgotten questions into the directory working-dir/DMS/properties/default/locale.

   The generic name format of the question property file is: questions_language_country.properties, where language is the LANGUAGE concerned and country is the COUNTRY concerned. For example the name of the property file may look like questions_en_US.properties, where en signifies the language "English" and US signifies the country "USA".

6. Configure the Servlet by adding the following in the servlet classpath:

   working-dir/DMS/java/questions.jar