Luna HSM Client 10.5.0

Luna HSM Client 10.5.0 was released in July 2022. It includes bug fixes and security updates.

>Download Luna HSM Client 10.5.0 for Windows

>Download Luna HSM Client 10.5.0 for Linux

>Download Minimal Luna HSM Client 10.5.0 for Linux

NOTE   This version of Luna HSM Client is compatible with Luna HSMs with firmware 6.2.1 and newer. Features that do not have client version dependencies will function without issue.

New Features and Enhancements

Luna HSM Client 10.5.0 includes the following new features and enhancements:

Configurable Mutex Folder on Linux

The Linux version of Luna HSM Client 10.5.0 allows the administrator to set a custom folder for temporary files. Previously these files were written to /tmp, but some services could be disrupted when the /tmp folder was cleared. The new default folder is <install_dir>/lock, but if access rights to this directory are restricted, you can set a custom location by editing the MutexFolder entry of the Misc section of Chrystoki.conf.

See Configuration File Summary.

Supported Operating Systems

You can install Luna HSM Client 10.5.0 on the following operating systems:

Operating System Version
Windows 10
Windows Server Standard 2022
2019
2016
Windows Server Core 2022
2019
2016
Red Hat-based Linux (including variants like CentOS)

8.0, 8.1, 8.2, 8.3, 8.4, 8.5 (†)

7
Ubuntu * 21.04
20.04
18.04
14.04

* The Linux installer for Luna HSM Client software is compiled as .rpm packages. To install on a Debian-based distribution, such as Ubuntu, alien is used to convert the packages. We used build-essential:

apt-get install build-essential alien

If you are using a Docker container or another such microservice to install the Luna Minimal Client on Ubuntu, and your initial client installation was on another supported Linux distribution as listed above, you do not require alien. Refer to the product documentation for instructions. You might need to account for your particular system and any pre-existing dependencies for your other applications.

RHEL and CentOS 8.0-8.5 with their original kernels. See also Red Hat Enterprise Linux 8 in FIPS Mode Requires Minimal Luna HSM Client.

Secure Boot Support

Luna HSM Client can be used on all supported OS platforms in the table above, with Secure Boot enabled. If you are using Luna HSM Client to access partitions on a Luna Network HSM 7 only, no drivers are required. On Windows, the drivers for all other Luna HSM variants and components (Luna PCIe HSM 7, Luna USB HSM 7, Luna Backup HSM 7, Luna Backup HSM G5, Luna PED) are signed by Thales for use with Windows Secure Boot. In both these cases, you can proceed with the standard Luna HSM Client Software Installation procedure.

On Linux, these drivers are compiled for the host OS during Luna HSM Client installation. If Secure Boot is enabled on the host system, these drivers must be signed as directed by the host OS provider:

>Secure Boot on Red Hat Enterprise Linux

>Secure Boot on Ubuntu

>Secure Boot on Debian

ESXi Passthrough

Luna PCIe HSM 7, Luna USB HSM 7, Luna Backup HSM 7, and Luna Backup HSM G5 can be used in passthrough mode, connected to an ESXi host.

CAUTION!   You must set the ESXi power policy to High Performance to ensure that adequate power is supplied to the USB-connected devices.

The following combinations of ESXi version and virtual machine operating system are supported:

ESXi Version Supported VM OS's

ESXi 7.0

Windows 11, 2016, 2022
RHEL 8.7, 8.8, 9.1
Ubuntu 14.04, 18.04, 22.04
ESXi 6.7

RHEL 8.7, 8.8, 9.0, 9.1, 9.2

Ubuntu 21.04, 22.04

Windows 2016, 2022

ESXi 6.5 Windows Server Core 2019
Windows Server Core 2016

Supported Cryptographic APIs

Applications can perform cryptographic operations using the following APIs:

>PKCS#11 2.20

>OpenSSL

>Microsoft CAPI

>Microsoft CNG

>Supported Java versions:

Open JDK 7 up to Open JDK 17

Oracle Java 7 up to JDK 17

IBM Java 7, 8 and 11

Advisory Notes

This section highlights important issues you should be aware of before deploying Luna HSM Client 10.5.0.

Backup/USB/PCIe Drivers Not Installed on Windows 10 or Windows Server 2022 Unless Device is Connected

Due to changes in Windows 10 and Server 2022, device drivers are not installed unless the USB or PCIe device is connected to the client workstation. If you plan to use a Luna Backup HSM 7, Luna Backup HSM G5, Luna USB HSM 7, or Luna PCIe HSM 7 with these operating systems, use one of the following workarounds:

>Connect the Luna device to the workstation (or install the Luna PCIe HSM 7 card) before installing the Luna HSM Client software

>After installing the Luna HSM Client software:

a.Connect the Luna device(s) to the workstation (or install the Luna PCIe HSM 7 card)

b.Run LunaHSMClient.exe.

c.Select the devices you want to install drivers for.

d.Click Modify.

CentOS 8.4 Missing Dependency

Due to a missing dependency on CentOS 8.4 [specifically the symlink (libnsl.so.1) to libnsl was removed], when installing Luna HSM Client 10.5.0 or newer, you must install an additional rpm package first:

Run yum install libnsl before invoking the install.sh script.

CSP/KSP Registrations Can Fail if Windows Update Missing

CSP or KSP registration includes a step that verifies the DLLs are signed by our certificate that chains back to the DigiCert root of trust G4 (in compliance with industry security standards).

This step can fail if your Windows operating system does not have the required certificate. If you have been keeping your Windows OS updated, you should already have that certificate.

If your Luna HSM Client host is connected to the internet, use the following commands to update the certificate manually:

certutil -urlcache -f http://cacerts.digicert.com/DigiCertTrustedRootG4.crt

certutil -addstore -f root DigiCertTrustedRootG4.crt

To manually update a non-connected host

1. Download the DigiCert Trusted Root G4 (http://cacerts.digicert.com/DigiCertTrustedRootG4.crt) to a separate internet-connected computer.

2.Transport the certificate, using your approved means, to the Luna HSM Client host into a <downloaded cert path> location of your choice

3.Add the certificate to the certificate store using the command:

certutil -addstore -f root <downloaded cert path>

Red Hat Enterprise Linux 8 in FIPS Mode Requires Minimal Luna HSM Client

RHEL 8.x introduced system-wide cryptographic modes. The full Luna HSM Client installer is supported only when RHEL 8.x is in DEFAULT mode. If your RHEL 8.x OS is in FIPS mode, use the minimal Luna HSM Client.

Luna HSM Client No Longer Supports Luna PCIe HSM 6 on any platform

Luna HSM Client 10.5.0 and newer cannot be used with a Luna PCIe HSM 6 that might be present in the host. If you need to use a version 6.x HSM card with your application, install Luna HSM Client 10.3.0 or older for Windows, or Luna HSM Client 10.4.1 or older for Linux.

CKR_MECHANISM_INVALID Messages in Mixed Luna Cloud HSM Implementations

When using a Luna Cloud HSM service with Luna HSM Client, you might encounter errors like "CKR_MECHANISM_INVALID" or "Error NCryptFinalizeKey" during some operations in Hybrid HA and FIPS mode (3DES Issue). This can occur if firmware versions differ between a Luna HSM partition and a Luna Cloud HSM service in an HA group when you invoke a mechanism that is supported on one but not the other. Similarly, if one member is in FIPS mode, while the other is not, a mechanism might be requested that is allowed for one member, but not the other. For example, the ms2luna tool can fail when 3DES operations are invoked.