Edit the Futurex PKCS #11 configuration file
The fxpkcs11.cfg file enables you to set the FXPKCS #11 library to connect to the KMES Series 3. To edit the file, run a text editor as an Administrator on Windows or as root on Linux, and edit the configuration file accordingly. Most notably, you must set the fields described in this section inside the <KMS> section of the file.
Our PKCS #11 library expects to find the PKCS #11 config file in a certain location (C:\Program Files\Futurex\fxpkcs11\fxpkcs11.cfg for Windows and /etc/fxpkcs11.cfg for Linux), but you can override that location by using the FXPKCS11_CFG environment variable.
To configure the fxpkcs11.cfg file, edit the following sections:
Field
Description
<SLOT>
Can leave set to the default value of 0.
<CRYPTO-OPR>
Specify the name of the identity created on the KMES.
<KEYGROUP-NAME>
Comment out this field for this integration because Apache needs to create only an asymmetric key pair on the KMES. You might use this field when an application needs to create symmetric keys on the KMES.
<ASYM-KEYGROUP-NAME>
Define the asymmetric key group name for this integration. The system adds the asymmetric key that Apache creates on the KMES to a key group with the name you specify here.
<ADDRESS>
Specify the IP address of the KMES to which the PKCS #11 library should connect.
<LOG-FILE>
Set the path of the PKCS #11 log file.
<PROD-PORT>
Set the PKCS #11 library to connect to the default Host API port on the KMES, port 2001.
<PROD-TLS-ENABLED>
Set the field to YES. The only way to connect to the Host API port on the KMES is over TLS.
<PROD-TLS-ANONYMOUS>
Set this value to NO because you're connecting to the Host API port by using mutual authentication. This field defines whether the PKCS #11 library authenticates to the KMES.
<PROD-TLS-CA>
Define the location of the CA certificates with one or more instances of this tag. In this example, there is only one CA certificate.
<PROD-TLS-CERT>
Set the location of the signed client certificate.
<PROD-TLS-KEY>
Set the location of the client private key. Supported formats for the TLS private key are PKCS #1 clear private keys, PKCS #8 encrypted private keys, or a PKCS #12 file that contains the private key and certificates encrypted under a password.
<PROD-TLS-KEY-PASS>
Set the password of the PKCS #12 file, if necessary.
<FX-LOAD-BALANCE>
Set this field to YES if you use a Guardian to manage KMES Series 3 devices in a cluster. If you don't use a Guardian, set it to NO
Add the following define line to the <CONFIG> section of the FXPKCS11 configuration file for the Apache integration: