Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.futurex.com/llms.txt

Use this file to discover all available pages before exploring further.

This guide includes instructions for installing Futurex Command Line Interface (FXCLI) because FXCLI is one of the two methods we support for decrypting files encrypted through the File Encryption functionality on the KMES Series 3. The File Decryption Methods section of this administrative guide provides an example of decrypting a file by using FXCLI. To install FXCLI, select your operating system and perform the following steps:

Windows

Perform the following steps to install FXCLI on Windows:
1
The FXTools installation package includes Futurex Client Tools (FXCLI). Similar to the Futurex PKCS #11 (FXPKCS11) module, download FXTools from the Futurex Portal and install it.
2
To install FXCLI, run the Futurex Tools installer as an administrator and follow the prompts in the setup wizard to complete the installation.
3
By default, all tools are installed on the system. You can overwrite and choose not to install the following modules:
ModuleDescription
Futurex Client ToolsCommand Line Interface (CLI) and associated SDK for both Java and C.
Futurex CNG ModuleThe Microsoft Next Generation Cryptographic Library.
Futurex Cryptographic Service Provider (CSP)The Legacy Microsoft Cryptographic Library.
Futurex EKM ModuleThe Microsoft Enterprise Key Management library.
Futurex PKCS #11 ModuleThe Futurex PKCS #11 library and associated tools.
Futurex Secure Access ClientThe Client used to connect a Futurex Excrypt Touch to a local laptop with a USB or to a remote Futurex device.
After starting the installation, the system installs all noted services. If you select the Futurex Secure Access Client, the system also installs the Futurex Excrypt Touch driver, which might start minimized or in the background.

Linux

Perform the following steps to install FXCLI on Linux:
1
Download the appropriate FXCLI package files for your system from the Futurex Portal.
2
If the system is 64-bit, select from the files marked amd64. If the system is 32-bit, select from the files marked i386.
3
If running an OpenSSL version in the 1.0.x branch, select from the files marked ssl1.0. If running an OpenSSL version in the 1.1.x branch, select from the files marked ssl1.1.FXCLI offers the following features:
  • Java Software Development Kit (java)
  • HSM command line interface (cli-hsm)
  • KMES Series 3 command line interface (cli-kmes)
  • Software Development Kit headers (devel)
  • YAML parser used to parse bash output (cli-fxparse)
4
To install an rpm package, run the following command in a terminal:
Shell
sudo rpm -ivh [fxcl-xxxx.rpm]
To install a deb package, run the following command in a terminal:
Shell
sudo dpkg -i [fxcl-xxxx.deb]
5
To run FXCLI and enter the HSM FXCLI prompt, run the following command in a terminal:
Shell
fxcli-hsm
6
After entering the FXCLI prompt, you can run help to list all of the available FXCLI commands.