Install Futurex PKCS #11

1min
You must install the Futurex PKCS #11 module on the computer or server where you plan to install Vault
The following process installs only the HSM Version of the PKCS #11 configuration file. For KMES integrations, you need to replace the <HSM> section with a <KMS> section. 
Perform the following steps to install Futurex PKCS #11 on your Windows or Linux server:
Windows
Linux
1
In a Windows Environment, the easiest way to install the Futurex PKCS #11 module is through installing FXTools. Download FXTools from the Futurex portal. 
2
After you download it, run the FXTools installer as an administrator.
3
By default, all tools are installed on the system. However, you can overwrite and choose not to install certain modules. The modules include the following options:
Module
Description
﻿
Futurex Client Tools
Command Line Interface (CLI) and associated SDK for both Java and C.
﻿
Futurex CNG Module
The Microsoft Next Generation Cryptographic Library.
﻿
Futurex Cryptographic Service Provider (CSP)
The Legacy Microsoft Cryptographic Libary.
﻿
Futurex EKM Module
The Microsoft Enterprise Key Management library.
﻿
Futurex PKCS #11 Module
The Futurex PKCS #11 library and associated tools.
﻿
Futurex Secure Access Client
The Client connects a Futurex Excrypt Touch to a local laptop through USB or to a remote Futurex device.
﻿
After starting the installation, the system installs all noted services. If you selected the Futurex Secure Access Client, the Futurex Excrypt Touch driver also installs and might start minimized or run in the background.
4
After installation finishes, you can find all services in the C:\Program Files\Futurex directory. The CNG, CSP, EKM, and PKCS #11 modules all require configuration files, located in their corresponding directory with a .cfg extension.
﻿
﻿
1
For a Linux Environment, download the tarball of the PKCS #11 binaries from the Futurex Portal.
2
Extract the .tar file locally where you want to install the application on your file system.
For the Futurex PKCS #11 module to be accessible system-wide, an administrative user needs extract it in /usr/local/bin. If only the current user needs to use the module, then you can extract it in $HOME/bin.
The extracted content of the .tar file is a single fxpkcs11 directory. Inside the fxpkcs11 directory are the following files and directories (only files and folders relevant to the installation process are included):
Filename/Directory
Description
﻿
fxpkcs11.cfg
﻿
PKCS #11 configuration file to use for HSM Integrations.
﻿
fxpkcs11-kms.cfg
PKCS #11 configuration file to use for KMES Series 3 integrations.
﻿
x86/
This folder contains the module files for 32-bit architecture.
﻿
x64/
This folder contains the module files for 64-bit architecture.
﻿
The x86 and x64 directories contain multiple directories named for the specific OpenSSL versions. These OpenSSL directories contain the PKCS #11 module files, built with the respective OpenSSL versions.
﻿
configTest
Program to test configuration and connection to the HSM.
﻿
libfxpkcs11.so
PKCS #11 Library file.
﻿
PKCS11Manager
Program to test connection and manage the HSM through the PKCS #11 library.
3
Because the configTest and PKCS11Manager programs look for the PKCS #11 configuration file in the /etc directory, you must either move the file from the /usr/local/bin/fxpkcs11 directory to the /etc directory or set the FXPKCS11_CFG environment variable to point to the PKCS #11 configuration file.
Note: If using the KMES version of the PKCS #11 Configuration File (fxpkcs11-kms.cfg), you must rename the file to fxpkcs11.cfg.
﻿
﻿
﻿
Updated 25 Feb 2024
Did this page help you?
Before you start
Configure the KMES Series 3