Configure TLS communication
Perform the following tasks to configure TLS communication between the KMES Series 3 and the CyberArk TPF instance:- Create a certificate authority (CA).
- Generate a CSR for the System/Host API connection pair.
- Sign the System/Host API CSR.
- Export the Root CA and signed System/Host API certificates.
- Load the exported certificates into the System/Host API connection pair.
- Issue a client certificate for CyberArk TPF.
- Export the signed CyberArk TPF certificate.
Create a CA
Perform the following steps to create a 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
System TLS CA Root.6
On the Basic Info tab, leave all settings at the default values.
7
On the V3 Extensions tab, select the Certificate Authority profile and select [ OK ].
The root CA certificate now 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 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 the fields set to the default values and select [ OK ].
The Application Public Keys window now shows that a PKI Key Pair is Loaded.
7
Select [ Request ].
8
On the Subject DN tab, you can leave the default Common Name value set to
System/Host API.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 notified that the certificate signing request was successfully written to the location you specified, select [ OK ].
12
Select [ OK ] again to save the Application Public Keys settings.
In the main Network Options window, the System/Host API connection pair now shows Loaded next to PKI keys.
13
Select [ OK ] to save and close the Network Options menu.
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 and select Add Certificate > From Request.
3
In the file browser, select the CSR you generated for the System/Host API connection pair.
4
After it loads, don’t modify any settings for the certificate. Select [ OK ].
The signed System/Host API TLS certificate now shows under the System TLS CA Root 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 states that the PEM file was successfully written to the location you specified.
Export the TLS certificate
Perform the following steps to export the signed System/Host API TLS certificate:1
Go to PKI > Certificate Authorities.
2
Right-click the System/Host API 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, navigate 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 you specified.
Load the TLS certificate
Perform the following steps to load the exported TLS certificate into the System/Host API connection pair:1
Go to Administration > Configuration > Network Options.
2
In the Network Options window, select 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 a 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.
Issue a client certificate
Perform the following steps to issue a client certificate for CyberArk TPF: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 Venafi as the Common Name for the certificate.
4
Leave all fields on the Basic Info tab set to the default values.
5
On the V3 Extensions tab, select the TLS Client Certificate profile and select [ OK ]*.
The Venafi certificate now displays under the System TLS CA Root certificate.A later section of the guide shows you how to modify the Futurex PKCS #11 configuration file to use the client certificate you create for CyberArk TPF in this section.
Export the certificate
Perform the following steps to export the Venafi client certificate as a PKCS #12 file:To export the Venafi client certificate as a PKCS #12 file, you must go to Administration > Configuration > Options and enable the Allow export of certificates using passwords setting before continuing.
1
Go to PKI > Certificate Authorities.
2
Right-click the Venafi certificate and select Export > PKCS#12.
3
Set a password for the PKCS #12 file, select Export Selected Certificate, and select [ Next ].
4
In the file browser, select a location for the PKCS #12 file and select [ Open ].
A message box notifies you that the PKCS #12 export was successful.
5
Move both the Venafi certificate and the root CA certificate exported in the Export the Root CA certificate section to the computer that runs the CyberArk TPF instance.The next section shows you how to configure and use them for TLS communication with the KMES Series 3.
Configure general KMES Series 3 settings for KMES to the CyberArk TPF instance
Perform the following tasks to configure the KMES Series 3 for communication with the CyberArk TPF instance:- Create a new role and identity with the required permissions.
- Create a new instance with the Venafi role.
- Enable Host API commands.
Create a new role
Perform the following steps to create a new role with the permissions Venafi requires: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, set the Type to Application, the Name to
Venafi, select the Hardened checkbox, and set the Logins Required to 1.3
On the Permissions tab, enable the following permissions:
| Permission | Subpermission |
|---|---|
| Certificate Authority | Add, Export |
| Cryptographic Operations | Encrypt, Decrypt, Wrap, Unwrap |
| Keys | Add, Export |
| Secure Key Functions | Import PKI, No Usage Wrap, Remove Security, Strength Bypass |
4
On the Advanced tab, set Allowed Ports to Host API only.
5
Select [ OK ] to finish creating the role.
Create a new identity
Perform the following steps to create a new identity and assign it the Venafi role: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, set the Storage type to HSM and specify a Name for the identity.
4
On the Assigned Roles tab, select the Venafi role.
5
On the Authentication tab, remove the default Hardened API Key mechanism and select [ Add ].
6
In the Configure Credential window, the Hardened Password mechanism populates by default. Select [ Change ], configure a password, and select [ Save ]. Select [ OK ] to finish configuring the new credential.
7
Select [ OK ] to finish creating the identity.
Enable the Host API commands required for CyberArk TPF operation
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 Futurex PKCS #11. To enable the Host API commands required for CyberArk TPF operation, complete the following steps:1
Go to Administration > Configuration > Host API Options.
2
Enable the following commands:
| Command | Description and subcommand (if applicable) |
|---|---|
| ATKG | Manipulate HSM trusted asymmetric key group
|
| ATTR | Generic Attribute Operations
|
| ECHO | Echo text |
| RAFA | Filter Issuance Policy |
| RAND | Generate Random Number |
| RKCK | Create HSM Trusted Key |
| RKCP | Get Command Permissions
|
| RKCS | Create Symmetric HSM Trusted Key Group |
| RKDK | Delete HSM Trusted Key |
| RKDP | Delete Asymmetric HSM Trusted Key |
| RKED | Encrypt or Decrypt Data |
| RKEP | PKI Encrypt Public Key |
| RKGP | Export Asymmetric HSM Trusted Key |
| RKLN | Lookup Objects |
| RKLO | Login User |
| RKPK | Pop Generated Key |
| RKRC | Get HSM Trusted Key |
| RKRW | Get HSM Trusted Key |
| TIME | Set Time |
3
Select [ Save ] to finish.