|
Home > |
|---|
These instructions assume that you have already acquired the SafeNet Client software, either on DVD or in the form of a downloaded .tar archive. Applicability to specific versions of AIX is summarized in the Customer Release Notes for the current release.
Note: Before installing a SafeNet system, you should confirm that the product you have received is in factory condition and has not been tampered with in transit. Refer to the Content Sheet included with your product shipment. If you have any questions about the condition of the product that you have received, please contact SafeNet Support.
Each computer that connects to the SafeNet HSM appliance as a Client must have the cryptoki library, the vtl client shell and other utilities and supporting files installed. Each computer that contains, or is connected to a SafeNet USB HSM or a SafeNet PCIe HSM must have the cryptoki library and other utilities and supporting files installed.
Note: This example shows all the SafeNet Client products and components. Some items are not supported on all operating systems and therefore do not appear as you proceed through the installation script.
Do not install SafeNet client software on the same system as legacy SafeNet CA3, SafeNet CA4, SafeNet PCM, or SafeNet PCI software. The software is intended for modern/current SafeNet HSMs, SafeNet Network HSM, SafeNet PCIe HSM, SafeNet USB HSM, SafeNet (Remote) Backup HSM.
Before starting the installation, ensure that you have a Random Number Generator (RNG) or Entropy Gathering Daemon (EGD) on your system in one of the following locations:
•/dev/egd-pool
•/etc/egd-pool
•/etc/entropy
•/var/run/egd-pool
Cryptographic algorithms, including those that assure the security of communication – such as in OpenSSL and other protocols – depend upon random numbers for the creation of strong keys and certificates. A readily available source of random data is the entropy that exists in complex computer processes. Utilities exist for every operating system, to gather bits of system entropy into a pool, which can then be used by other processes.
Windows and Linux have these installed by default. Other systems might or might not. See your system administrator.
In the case of SafeNet Network HSM, the SafeNet Client administration tool (vtl) expects to find a source of randomness at /dev/random. If one is not found, vtl fails, because the link cannot be secured from the Client end.
If your system does have an entropy pool, but the random number generator (RNG) is not in the expected place, then you can create a symbolic link between the actual location and one of the following:
•/dev/random
• /dev/egd-pool
•/etc/egd-pool
•/etc/entropy
• /var/run/egd-pool
If your system does not have an entropy gathering daemon or random number generator, please direct your system administrator to install one, and point it to one of the named devices.
If you are installing the SafeNet PCIe HSM, or SafeNet USB HSM, or SafeNet Remote Backup HSM clients, ensure that the following items are installed:
•Kernel headers for build
•rpm-build package
•C and C++ compilers
•make command
These items are required because the driver module is built on Linux before it is installed. If one of these items is missing, the driver build will fail and the module will not get installed.
Check the SafeNet HSM Customer Release Notes for any installation-related issues or instructions before you begin the following software installation process.
CAUTION: You must be logged in as root when you run the installation script.
1.Log on to the client system, open a console or terminal window, and use su to gain administrative permissions for the installation.
2.If you have downloaded the SafeNet Client software as a .tar archive, skip to step 6.
3.Insert the DVD (mount it if you do not have automount).
4.Go to the DVD (/cdrom or whatever devicename your system uses) and the install directory:
| 32-bit OS | cd /cdrom/AIX/32 |
| 64-bit OS | cd /cdrom/AIX/64 |
Note: Not all platforms are supported with each release, so the available install options might not match the list above.
5.Skip to step 9.
6.If you downloaded the software, copy or move the .tar archive (which usually has a name like "Luna Client_6.x.y-nn.tar") to a suitable directory where you can untar the archive and launch the installation script.
7.Enter the following command to extract the contents from the archive:
tar xvf SafeNet Client<version>.tar
8.Change directory to the software version suitable for your system (for example, under the "aix" subdirectory, choose 32-bit or 64-bit according to your system requirement).
9.Install the client software as follows:
–To see the 'help', or a list of available installer options, type:
sh install.sh -? or ./sh install.sh --help
–To install all available products and optional components, type:
sh install.sh all
–To selectively install individual products and optional components, type the command without arguments:
sh install.sh
10.Type "y" if you agree to be bound by the license agreement:
[mylunaclient-1 32]$ sh install.sh
IMPORTANT: The terms and conditions of use outlined in the software
license agreement (Document #008-010005-001_053110) shipped with the product
("License") constitute a legal agreement between you and SafeNet Incorporated. Please read the License contained in the packaging of this product in its entirety before installing this product. Do you agree to the License contained in the product packaging? If you select 'yes' or 'y' you agree to be bound by all the terms and conditions set out in the License.
If you select 'no' or 'n', this product will not be installed.
(y/n)
11.A list of installable SafeNet products appears (might be different, depending on your platform). Select as many as you require, by typing the number of each (in any order) and pressing Enter. As each item is selected, the list updates, with a "*" in front of any item that has been selected. This example shows item 1 has been selected.
Products
Choose Luna Products to be installed
*[1]: SafeNet Network HSM
[2]: SafeNet PCIe HSM
[N|n]: Next
[Q|q]: Quit
Enter selection: 2
Note: When the above was captured, AIX supported only SafeNet Network HSM and SafeNet PCIe HSM among SafeNet HSM products. To install SafeNet USB HSM or the SafeNet Remote Backup HSM, you will need one of the other supported host platforms.
12.When selection is complete, type "N" or "n" for "Next", and press Enter. If you wish to make a change, simply type a number again and press Enter to de-select a single item.
13.The next list is called "Advanced" and includes additional items to install. Some items might be pre-selected to provide the optimum SafeNet HSM experience for the majority of customers, but you can change any selection in the list.
Products
Choose Luna Products to be installed
*[1]: SafeNet Network HSM
[2]: SafeNet PCIe HSM
[N|n]: Next
[Q|q]: Quit
Enter selection: n
If you wish to make a change, simply type a number again and press Enter to de-select a single item.
If the script detects an existing cryptoki library, it stops and suggests that you uninstall your previous SafeNet software before starting the SafeNet Client installation again.
14.The system installs all packages related to the products and any optional components that you selected. By default, the Client programs are installed in the /usr/safenet/lunaclient directory.
Note: When installing, ensure that the full path of a package does not contain any space characters. (The IBM examples do not show any spaces, implying that this might be a system requirement.)
As a general rule, do not modify the Chrystoki.conf/crystoki.ini file, unless directed to do so by SafeNet Customer Support. If you do modify the file, never insert TAB characters - use individual space characters. Avoid modifying the PED timeout settings. These are now hardcoded in the appliance, but the numbers in the Chrystoki.conf file must match.
You may need to uninstall the SafeNet Client software prior to upgrading to a new release, or if the software is no longer required. You must be logged in as root.
1.Log in as root.
2.Go to the client installation directory:
cd /usr/safenet/lunaclient/bin
3.Run the uninstall script:
sh uninstall.sh
During the installation, the script provides the opportunity to install SafeNet Java components. If you select Java components, the SafeNet Java files are installed in the /usr/safenet/lunaclient/jsp/ directory. In order to use Java, you must have separately installed Java (JDK or run-time environment from the vendor of your choice) onto your system.
Copy the SafeNet Java library and jar files from their default location under /usr/safenet/lunaclient/jsp/lib to the Java environment directory, for example /usr/jre/lib/ext. The exact directory might differ depending on where you obtained your Java system, the version, and any choices that you made while installing and configuring it.
CAUTION: Copy libLunaAPI.so to system lib (/usr/lib) in order to make either java5 or java6 work on AIX 6.1 64-bit client.
For additional Java-related information, see Java Interfaces in the SDK Reference Guide.
You would choose static registration of providers if you want all applications to default to our (SafeNet) provider.
Once your client has externally logged in using salogin (see ) in the Reference section of this document) or your own HSM-aware utility, any application would be able to use SafeNet product without being designed to login to the HSM Partition.
Edit the java.security file located in the \jre\lib\security directory of your Java SDK/JRE 1.6.x or 1.7.x installation to read as follows:
security.provider.1=sun.security.provider.Sun
security.provider.2=com.sun.net.ssl.internal.ssl.Provider
security.provider.3=com.safenetinc.luna.provider.LunaProvider
security.provider.4=com.sun.rsajca.Provider
security.provider.5=com.sun.crypto.provider.SunJCE
security.provider.6=sun.security.jgss.SunProvider
You can set our provider in first position for efficiency if SafeNet HSM operations are your primary mode. However, if your application needs to perform operations not supported by the LunaProvider (secure random generation or random publickey verification, for example) then it would receive error messages from the HSM and would need to handle those gracefully before resorting to providers further down the list. We have found that having our provider in third position works well for most applications.
The modifications in the "java.security" file are global, and they might result in the breaking of another application that uses the default KeyPairGenerator without logging into the SafeNet Network HSM first. This consideration might argue for using dynamic registration, instead.
For your situation, you may prefer to employ dynamic registration of Providers, in order to avoid possible negative impacts on other applications running on the same machine. As well, the use of dynamic registration allows you to keep installation as straightforward as possible for your customers.
We formally test SafeNet HSMs and our Java provider with SUN JDK for all platforms except AIX, and with IBM JDK for the AIX platform. We have not had problems with OpenJDK, although it has not been part of our formal test suite. The SafeNet JCE provider is compliant with the JCE specification, and should work with any JVM that implements the Java language specification.
Occasional problems have been encountered with respect to IBM JSSE.
GNU JDK shipped with most Linux systems has historically been incomplete and not suitable.
To uninstall the JSP component or the SDK component, you must uninstall SafeNet Client completely (see Uninstalling the SafeNet Client Software, then re-run the installation script without selecting the unwanted component(s).
Do not interrupt the installation script in progress, and ensure that your host computer is served by an uninterruptible power supply (UPS). If you press [Ctrl] [C], or otherwise interrupt the installation (OS problem, power outage, other), some components will not be installed. It is not possible to resume an interrupted install process. The result of an interruption depends on where, in the process, the interruption occurred (what remained to install before the process was stopped).
As long as the cryptoki RPM package is installed, any subsequent installation attempt results in refusal with the message "A version of Luna Client is already installed."
If components are missing or are not working properly after an interrupted installation, or if you wish to install any additional components at a later date (following an interrupted installation, as described), you would need to uninstall everything first. If ‘sh uninstall.sh’ is unable to do it, then you must uninstall all packages manually.
Because interruption of the install.sh script is not recommended, and mitigation is possible, this is considered a low-likelihood corner case, fully addressed by these comments.
When you have installed the software onto a Client, the next task is to configure the SafeNet HSM, as described in the Configuration Guide.