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 section starts by covering the steps required to configure TLS communication between the KMES Series 3 and the FXCL CNG module, where Microsoft ADCS is running. Then, it covers general configurations that you must make on the KMES Series 3 to enable Microsoft ADCS to integrate with the KMES to manage certificate authorities in a scalable manner and enable secure storage, encryption, and signing by using FXCL CNG.

​
Configure TLS communication

Perform the following tasks to configure the KMES Series 3 for communication with the FXCL CNG module:
  1. Add a PKI identity provider.
  2. Create an AD CS role with the required permissions.
  3. Create an AD CS identity with the correct assigned roles.
  4. Enable Host API commands.
The following sections show you how to complete these tasks.

​
Create a CA

Perform the following steps to create a Certificate Authority (CA):
1
Log in to the KMES Series 3 application interface with the default Admin identities.
2
Go to PKI > Certificate Authorities and select [ Add CA ] at the bottom of the page.
3
In the Certificate Authority window, enter a name for the Certificate Container, leave all other fields set to the default values, and select [ OK ].
4
Right-click the certificate container you just created and select Add Certificate > New Certificate.
5
On the Subject DN tab, select the Classic preset and set a Common Name for the certificate, such as TLS CA Root.
6
On the Basic Info tab, leave all fields set to the default values.
7
On the V3 Extensions tab, select the Certificate Authority profile and select [ OK ].
The certificate container and the root CA certificate now display in the Certificate Authorities window.

​
Generate a CSR

Perform the following steps to generate a CSR for the System/Host API connection pair:
1
Go to Administration > Configuration > Network Options.
2
In the Network Options window, go to the TLS/SSL Settings tab.
3
Under the System/Host API connection pair, uncheck the Use Futurex Certificates checkbox and select [ Edit ] next to PKI keys in the User Certificates section.
4
In the Application Public Keys window, select [ Generate ].
5
When warned that SSL will not be functional until new certificates are imported, select [ Yes ] to continue.
6
In the PKI Parameters window, leave all fields set to the default values and select [ OK ]*.
You should see that a PKI Key Pair is loaded in the Application Public Keys window
7
Select [ Request ].
8
On the Subject DN tab, set a Common Name for the certificate, such as KMES.
9
On the V3 Extensions tab, select the TLS Server Certificate profile.
10
On the PKCS #10 Info tab, select a save location for the CSR and select [ OK ].
11
When prompted that the certificate signing request was successfully written to the file location that was selected, select [ OK ].
12
Select [ OK ] again to save the Application Public Keys settings.
The main Network Options window now says Loaded next to PKI keys for the System/Host API connection pair.

​
Sign the CSR

Perform the following steps to sign the System/Host API CSR:
1
Go to PKI > Certificate Authorities.
2
Right-click the System TLS CA Root certificate you created, then select Add Certificate > From Request.
3
In the file browser, find and select the CSR that was generated for the System/Host API connection pair.
4
After it loads, you don’t need to modify any settings for the certificate. Select [ OK ].
The signed System/Host API TLS certificate now shows under the TLS root CA certificate on the Certificate Authorities page.

​
Export the certificate

Perform the following steps to export the Root CA certificate:
1
Go to PKI > Certificate Authorities.
2
Right-click the System TLS CA Root certificate and select Export > Certificate(s).
3
In the Export Certificates window, change the encoding to PEM and select [ Browse ].
4
In the file browser, go to the location where you want to save the root CA certificate. Specify a name for the file, and select [ Open ].
5
Select [ OK ].
A message box says that the PEM file was successfully written to the location that you specified.
You must move the Root CA certificate to the computer where the Microsoft ADCS instance is running. A later section shows you how to configure and use it for TLS communication with the KMES Series 3.

​
Export the certificate

Perform the following steps to export the signed System/Host API TLS certificate:
1
Go to PKI > Certificate Authorities.
2
Right-click the KMES certificate and select Export > Certificate(s).
3
In the Export Certificate window, change the encoding to PEM and select [ Browse ].
4
In the file browser, go to the location where you want to save the signed System/Host API TLS certificate. Specify a name for the file and select [ Open ].
5
Select [ OK ].
A message box states that the PEM file was successfully written to the location that you specified.

​
Load the certificates

Perform the following steps to load the exported TLS certificates into the System/Host API connection pair:
1
Go to Administration > Configuration > Network Options.
2
In the Network Options window, go to the TLS/SSL Settings tab.
3
Under the System/Host API connection pair, select [ Edit ] next to Certificates in the User Certificates section.
4
Right-click the System/Host API SSL CA X.509 certificate container and select [ Import ].
5
Select [ Add ] at the bottom of the Import Certificates window.
6
In the file browser, select both the root CA certificate and the signed System/Host API certificate, and select [ Open ].
The certificate chain appears in the Verified section.
7
Select [ OK ] to save the changes.
In the Network Options window, the System/Host API connection pair now shows Signed Loaded next to Certificates in the User Certificates section
8
Select [ OK ] to save and exit the Network Options window.

​
Issue a client certificate

Perform the following steps to issue a client certificate for Microsoft AD CS:
1
Go to PKI > Certificate Authorities.
2
Right-click the System TLS CA Root certificate and select Add Certificate > New Certificate
3
On the Subject DN tab, set ADCS as the Common Name for the certificate.
The Common Name of the certificate must match the name of the identity to be created later in this guide.
4
All settings on the Basic info tab should be left as the default values
5
On the V3 Extensions tab, select the TLS Client Certificate profile and select [ OK ].
The AD CS certificate now displays under the System TLS CA Root certificate.

​
Export the signed Microsoft AD CS certificate as a PKCS #12 file

Perform the following steps to export the signed Microsoft AD CS certificate as a PKCS #12 file:
To complete the following steps, you must go to Administration > Configuration > Options and enable the Allow export of certificates using passwords option.
1
Go to PKI > Certificate Authorities.
2
Right-click the AD CS certificate and select Export > PKCS#12.
3
Select [ Set Password ], enter a password for the PKCS #12 file, and select [ Save ].
4
In the Export Options section, select Export Selected Certificate, and select [ Next ].
5
Specify a name for the PKCS #12 export file and select [ Open ].
A message window states that the PKCS #12 certificate export was successful.
You must move this PKCS #12 file to the computer where you installed AD CS. A later section shows you how to configure it in the Futurex CNG configuration file and use it for TLS communication with the KMES Series 3.

​
Configure general KMES settings

Perform the following tasks to configure the KMES Series 3 for communication with Microsoft AD CS:
  1. Add a PKI identity provider.
  2. Create an AD CS role with the required permissions.
  3. Create an AD CS identity with the correct assigned roles.
  4. Enable Host API commands.
The following sections show you how to complete these tasks.

​
Add a PKI identity provider

This section shows you how to create a new PKI Identity Provider (IdP), assign it a TLS authentication mechanism, and add it to an identity as a credential. This allows FXCL CNG to authenticate with the KMES by using the signed Microsoft AD CS certificate that you exported.
1
Go to Identity Management > Identity Providers.
2
Right-click anywhere in the window and select Add > Provider > PKI.
3
On the Info tab of the Identity Provider Editor window, specify a name for the IdP and uncheck the Enforce Dual Factor checkbox.
4
On the PKI Options tab, select [ Select ]. In the Certificate Selector window, expand the certificate tree you created, select the CA certificate that signed the ADCS and System/Host API connection pair certificates, and select [ OK ].
5
Select [ OK ] to finish creating the PKI IdP.
6
Right-click the IdP that you created and select Add > Mechanism > TLS.
7
On the PKI tab, leave all fields set to the default values.
8
Select [ OK ] to save.

​
Create a role

Perform the following steps to create a role for Microsoft AD CS and grant it permission to use the PKI IdP:
1
Go to Identity Management > Roles and select [ Add ] at the bottom of the page.
2
On the Info tab of the Role Editor window, leave the Role Type set to Application, specify a Name for the role, such as Microsoft AD CS, and change the number of Logins Required to 1. Leave all other fields set to the default values.
3
On the Permissions tab, select the following permissions:
PermissionSub-permissions
Certificate AuthorityAdd, Export, Upload
Cryptographic OperationsSign
Keys Add, Export
4
On the Advanced tab, set Allowed Ports to Host API only. Leave the other fields set to the default values and select [ OK ] to finish creating the role.
5
Go to Identity Management > Identity Providers, right-click the PKI IdP, and select [ Permission ].
6
In the Set Object-Group Permissions window, select the Show all roles and permissions checkbox, select the drop-down menu next to the Microsoft AD CS role, and select the Use permission.
7
Select [ OK ] to save.

​
Create a new identity

Perform the following steps to create a new identity and assign it the Microsoft AD CS role and PKI authentication credentials:
1
Go to Identity Management > Identities.
2
Right-click anywhere in the window and select Add > Client Application.
3
On the Info tab of the Identity Editor window, leave the Storage Type set to Application, and specify a Name for the identity. Leave all other fields set to the default values.
The name you specify must match the Common Name that you chose for the ADCS certificate in the Issue a client certificate for Microsoft AD CS section.
4
On the Assigned Roles tab, select the Microsoft AD CS role.
5
Perform the following steps on the Authentication tab:
  1. Select [ Add ] to add a new credential.
  2. In the Configure Credential window, select TLS Certificate in the Type drop-down list.
  3. Select the Provider and Mechanism that you created for this integration.
  4. Select [ OK ] to finish creating a credential.
6
Remove the default API Key mechanism, leaving only the TLS Certificate credential, and select [ OK ] to save.

​
Enable the Host API commands

Because FXCL CNG connects to the Host API port on the KMES, you must define which Host API commands to enable FXCL CNG to execute. To set the enabled commands for the Microsoft AD CS operation, complete the following steps:
1
Go to Administration > Configuration > Host API Options and enable the following commands:
CommandDescription/Subcommands (If applicable)
CLKYManipulate the application key and enable all subcommands.
ECHOCommunication Test/Retrieve Version
RKGPExport PKI keypair
RKGSGenerate Signature
RKLNLookup Objects
RKPKPop Generated Key
2
Select [ Save ] to finish.