Skip to main content
This section starts with the general KMES configurations necessary to enable CyberArk Vault to integrate with the KMES and provide the Server Key. Then, it covers the necessary steps to configure TLS communication between the KMES and the Vault instance.

​
Create a role and identity

Perform the following steps to create a new role and identity for Vault withe the required permissions on the KMES Series 3 (In the Futurex PKCS #11 configuration file section, you need this identity name for the configuration):
1
Log in to the KMES Series 3 application interface with the default Admin identities.
2
Go to Identity Management > Roles and select [ Add ].
3
Specify a name for the role, and set the number of logins required to 1.
4
Go to the Advanced tab and set authentication to the Host API port only.
5
Go to the Permissions tab and select the following permissions:
PermissionAdditional modifier
Cryptographic OperationsSign, verify, Encrypt, Decrypt
KeysAdd, export
6
Select [ OK ] to finish creating the role.
7
Go to Identity Management > Identities, right-click anywhere on the window, and select Add> Client Application.
8
On the Infotab, select Application for the storage location, and specify a name for the identity.
9
On the Assigned Roles tab, select the role you just created.
10
On the Authenticationtab, configure the password.
11
Leave all other fields as the default values and select [ OK ] to finish creating the identity.

​
Create a key group

Perform the following steps to create a key group for CyberArk Vault keys on the KMES Series 3 where the Vault can store the encryption keys (In the Futurex PKCS #11 configuration file section, you need this key group name for the configuration):
1
Log in to the KMES Series 3 application interface with the default Admin identities.
2
Go to Key Management > Keys, right-click, and select Add> Key Group.
3
Select Symmetricand Trustedin the Key Group Storage.
4
In the Key Group Editor window, specify a name for the key group.
5
In the Owner Group drop-down menu, select the Vault role you created.
6
Select [ Permissions ], give the Vault role you created the Use permission, and select **[ OK ]***to save.
7
Select [ OK ] again to finish creating the key group.

​
Enable the Host API commands

Because the Futurex PKCS #11 library connects to the Host API port on the KMES, you must define which Host API commands to enable for execution by the FXPKCS11 library. To enable the commands, complete the following steps:
1
Log in to the KMES Series 3 application interface with the default Admin identities.
2
Go to Administration> Configuration> Host API Options and enable the following commands:
CommandDescription
ECHOCommunication test/Retrieve version
RAFAFilter issuance policy
RANDGenerate a random number
RKCKCreate an HSM trusted key
RKCPGet command permissions
RKCSCreate a symmetric HSM trusted key group
RKEDEncrypt or decrypt data
RKHMHMAC Data
RKLNLookup objects
RKLOLogin user
RKRCGet an HSM trusted key
3
Select [ Save ].

​
Configure TLS communication

This section covers the necessary tasks to set up TLS communication between the KMES Series 3 and the CyberArk Vault instance.

​
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 ].
3
In the Certificate Authority window, enter a name for the certificate container, leave all other fields as the default values, and select [ OK ].
The certificate container you created displays in the Certificate Authorities menu.
4
Right-click the certificate container and select Add Certificate > New Certificate.
5
On the Subject DN tab, set a Common Name for the certificate, such as System TLS CA Root.
6
On the Basic Info tab, leave all of the default values set.
7
On the V3 Extensions tab, select the Certificate Authority profile and select [ OK ].
The Root CA certificate displays under the certificate container you created.

​
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 Settingstab.
3
Under the System/Host API connection pair, uncheck Use Futurex Certificates, and select **[ Edit ]**next to PKI Keys in the User Certificates section.
4
In the Application Public Keys dialog, select [ Generate ].
5
When prompted that SSL will not be functional until new certificates are imported, select **[ Yes ]**to continue.
6
In the PKI Parameters dialog, leave the default values set and select [ OK ].
The PKI Key Pair displays 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 Infotab, select a save location for the CSR and select [ OK ].
11
When prompted that the certificate signing request was successfully written to the selected file location, select [ OK ].
12
Select [ OK ] again to save the Application Public Keys settings.
In the main Network Options dialog, Loaded displays 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 root CA certificate you created, and select Add Certificate> From Request.
3
In the file browser, find and select the CSR generated for the System/Host API connection pair.
4
After it loads, you don’t need to modify any settings for the certificate, so select [ OK ].
The signed System/Host API certificate displays under the 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 Certificatedialog, 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 states that the PEM file was successfully written to the location that you specified.

​
Export the signed certificate

Perform the following steps to export the signed System/Host API certificate:
1
Go to PKI> Certificate Authorities.
2
Right-click on the KMEScertificate, and select Export> Certificate(s).
3
In the Export Certificate dialog, 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 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 exported certificates

Perform the following steps to load the exported certificates into the System/Host API connection pair:
1
Go to Administration> Configuration> Network Options.
2
In the Network Optionswindow, go to the TLS/SSL Settingstab.
3
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
Click **[ Add ]**at the bottom of the Import Certificates dialog.
6
In the file browser, select the root CA certificate and the signed System/Host API certificate and select [ Open ].
The certificate chain appears in the window under Verified.
7
Select **[ OK ]**to save the changes.
In the Network Options dialog, the System/Host API connection pair shows as 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 Vault:
1
Go to PKI> Certificate Authorities.
2
Right-click the System TLS CARoot certificate and select Add Certificate> New Certificate.
3
On the Subject DNtab, set a Common Name for the certificate, such as Vault.
4
Leave all settings on the Basic Infotab set to the default values.
5
On the V3 Extensions tab, select the TLS Client Certificate profile, and select [ OK ].
The Vault certificate now displays under the System TLS CA Root certificate.A later section shows you how to configure this client certificate in the Futurex PKCS #11 configuration file.

​
Export the Vault certificate

Perform the following steps to export the Vault certificate as a PKCS #12 file:
1
Before beginning the export, go to Configuration > Options and enable the Allow export of certificates using passwords option.
2
Go to PKI> Certificate Authorities.
3
Right-click the Vault certificate, and select Export> PKCS12.
4
Select the Export Selectedoption, specify a unique name for the export file, and select [ Next ].
5
Choose and enter a file password, and select [ Next ].
6
Select [ Finish ] to initiate the export.
7
You must move both the Vault certificate and the Root CA certificate you exported previously to the computer running the Vault instance. In a later section, you can configure and use them for TLS communication with the KMES Series 3.