ETPKI 5.x (CAPKI) Silent Installer ---------------------------------- **CA Internal Use Only** This document is provided for CA Internal Use Only and should not be distributed to customers. Overview -------- This installer is intended to be run in silent mode allowing for the simple installation of the ETPKI r5.x (CAPKI) libraries without user interaction. The following is installed depending on the target platform: Windows: ETPKI r5.x (CAPKI) Install Directory - The value from any of the following steps considered in order. - HKEY_LOCAL_MACHINE->SOFTWARE->ComputerAssociates->Shared->CAPKI5->InstallDir registry key value. This represents an upgrade or repair case. - \CAPKI\CAPKI5 where user supplied directory is the value specified by user against instdir option of setup. See the Setup Usage section below for more information. - \CAPKI\CAPKI5 where default location is %ProgramFiles%\CA\SC ETPKI r5.x (CAPKI) directory structure subsequent to successful installation: \ uninstaller.exe lib\ libcapki.dll libcapki_thread.dll libcapki_ipthread.dll libcaopenssl_crypto.dll libcaopenssl_ssl.dll capki\ log\ liblog_api.dll _capki_log.cfg For example: for Windows x86 is Windows\x86\32 Environment variables: ETPKI r5.x (CAPKI) on Windows does not need any environment variable. UNIX Platforms: Install Location - The value from any of the following steps considered in order. - $CASHCOMP/CAPKI/CAPKI5 - if CASHCOMP environment variable is present - $CALIB/../CAPKI/CAPKI5 - if CALIB environment variable is present - /CAPKI/CAPKI5 - user supplied directory is the value specified by user against instdir option of setup. See the Setup Usage section below for more information. - /CAPKI/CAPKI5 - default location is /opt/CA/SharedComponents ETPKI r5.x (CAPKI) directory structure subsequent to successful installation /opt/CA/SharedComponents/CAPKI/CAPKI5/ uninstaller lib/ libcapki. libcapki_thread_posix. libcaopenssl_crypto. libcaopenssl_ssl. capki\ log/ liblog_api. _capki_log.cfg For example: for solaris x86 is SunOS/x86/32 ETPKI r5.x (CAPKI) installer creates the following environment variables if env=user or env=all option is passed to setup. Please see the Setup Usage section for more information on options. CASHCOMP - It points to parent directory of CAPKI install directory CALIB - It points to $CASHCOMP/lib CABIN - It points to $CASHCOMP/bin Note: These variables are not set if env=none option is passed to the ETPKI r5.x (CAPKI) installer. Setup Usage ----------- Usage: setup.exe caller= [options...] where: CallerID is the parent application that is installing ETPKI r5.x (CAPKI) options: instdir= - This would be considered only if ETPKI r5.x (CAPKI) being installed is the first CA shared component to be installed on the system. verbose/veryverbose - It enables diagnostic output /it enables the diagnostic output in more detail discover - Please see the below "Discovering ETPKI r5.x (CAPKI) installation" section for it usage. (Unix Platforms Only) env= - It enables setting environment variables for the specified user(s) as shown below: none: do not set environment variables (default) user: current user only ($HOME/.profile) all : all users (for using this, login must be root). NB: env=none option acts same as env=all except that it does not set any environment variables. So, when env=none is passed, it may require root priveleges depending on the installation directory. Note: If /etc/profile should not be updated as part of CAPKI r5.x installation (with env=all option), then Update_Profile=0 should be set in the environment before the installation of CAPKI r5.x. CallerID -------- The CallerID identifies the parent application or component that is installing and is dependent upon CAPKI. This ID can be selected by users of CAPKI, but it is important that it uniquely identifies the parent product. As such, where there are multiple subcomponents of a product that each rely on CAPKI a CallerID that uniquely identifies each must be chosen. The maximum length of the identifier is 255 characters. CAPKI maintains a list of the CallerIDs of the products that installed it. On each uninstall the relevant identifier is removed from this list. When the list is empty CAPKI will be removed from the machine. Whilst it may be the usual case that newer versions of a product continue to use the identifier of the previous versions, there may be situations where a new identifier may be required, possibly incorporating the version number of the parent product. This situation may most likely arise when different versions of a product can coexist on the one machine. In this situation, if the same identifier was used for the CallerID the first uninstall with that identifier could result in CAPKI being removed. Logging/diagnostics ------------------- An install log file capki_install.log containing error/warning/info messages is generated by setup. On UNIX systems it can be found in /tmp directory and on Windows systems in %TEMP% directory. Discovering ETPKI r5.x (CAPKI) installation ------------------------------------------- The following command discovers any ETPKI r5.x (CAPKI) installation present on the system and logs information in /tmp/capki_install.log on UNIX and in %TEMP%/capki_install.log on Windows. On UNIX systems it also prints this information on the console. Command: setup discover This option can also be used with other options to "setup" but in that case it should be last argument. Setup Return codes ------------------ The return code is one of the following values: 0 - Success 1 - Windows only: Success, reboot required to cleanup temporary files 2 - Windows only: Success, reboot required to complete installation (*) 3 - Failure (see log file for details) (*) For return code 2, ETPKI r5.x (CAPKI) may not be in a usable state until the reboot has been performed. Special Notes ------------- (*) The install directory must be specified with an absolute path (if not using the default). (*) CAPKIHOME environment variable has been provided only for your UNIT testing. It is not needed in production environment. While doing UNIT testing uncompress ETPKI SDK in a directory and set CAPKIHOME to point to it. (*) User should complete whole installation process before going for un-installation. The completion of this installation process includes deletion of temporary files, created as part of ETPKI upgrade either manually (Windows or UNIX) or by machine reboot (Windows). If the installation process is not complete, un-installation would fail to delete the temporary files and existing ETPKI directory structure created.