Configure Venafi TPP to integrate with the KMES Series 3
This section describes the following tasks for integrating Venafi TPP (Trust Protection Platform) with the Futurex KMES Series 3 for data encryption, key generation, and key storage:
- Create an HSM connector and generate an HSM-Protected encryption key.
- Enable Venafi Advanced Key Protect.
- Set up HSM private key generation.
- Configure code signing.
Open the Venafi Configuration Console application.
Select the Connectors node.
Select [ Create HSM Connector ] in the Actions panel.
Enter the local master admin username and password and select [ OK ].
In the Create new HSM (Cryptoki) Connector window, enter any name for the HSM connector in the Name field.
For Cryptoki DLL Path, select [ Browse ] and locate the following path to the Futurex PKCS #11 DLL file:
Select [ Load Slots ].
Select the slot number configured in your Futurex PKCS #11 configuration file (the default is slot 0). This is where TPP accesses the encryption keys.
For User Type, leave the default option selected, Crypto Officer (User). Venafi uses the identity configured in the Futurex PKCS #11 file to connect to the KMES Series 3.
For Pin, enter the password for the identity configured in the Futurex PKCS #11 file.
Select [ Verify ].
If the connection to the KMES Series 3 is successful, a new Permitted Keys section populates in the window.
Select [ New Key ].
In the Create New HSM Key window, enter a key Name and select the Type for the key.
Select the Allow Key Storage checkbox if you plan to use Venafi CodeSign Protect to store private code signing keys in the KMES Series 3.
Select [ Create ].
If key creation is successful, the key is now viewable in the keys menu on the KMES Series 3. The name of the key displays in the list of Permitted Key in the Create New HSM Key window.
Select [ Create ] to save and close the window.
Venafi Advanced Key Protect is required for HSM Private Key Generation. In addition, Venafi Code Signing Certificate Private Key Storage requires you to enable this feature. To enable Venafi Advanced Key Protect, perform the following steps:
Open the Venafi Configuration Console application.
Select [ Enable Venafi Advanced Key Protect ] in the Actions panel.
Enter the local master admin username and password and select [ OK ].
Review the information in the Enable Venafi Advanced Key Protect window, and select [ Enable ] if you wish to proceed.
Restart the IIS service. Select the Product node, select Website, and then select [ Restart ] in the Actions panel.
Restart the Venafi Platform service. Select the Product node, select Venafi Platform, then select [ Restart ] in the Actions panel.
Restart the Logging service. Select the Product node, select Logging, then select [ Restart ] in the Actions panel.
Venafi TPP uses the KMES Series 3 for private key generation for SSH keys and certificates.
Venafi TPP uses Certificate Authority (CA) template objects to manage the certificate lifecycle. Creating one is a prerequisite to HSM Key Generation. See Venafi documentation for more information.
Perform the following tasks to configure HSM private key generation settings:
- Configure the Venafi platform policy.
- Generate the certificate.
Log in to the admin console: https://[IP_address_of_Venafi_TPP]/vedadmin
Select the Policy Tree in the main menu at the top of the page.
In the Policy : Certificate window, go to the Certificate tab.
Under Other Information, select the name of the HSM Connector you created for the KMES Series 3 in the Key Generation drop-down menu.
Under Other Information, select the name of the HSM-Protected Encryption Key you created on the KMES Series 3.
Select [ Save ] at the bottom of the page to finish.
Select Policy Tree in the main menu at the top of the page.
On the left side of the page, select [ Add ] under the Policy drop-down list and select Certificates > Certificate.
Under General Information, enter the required information, and for Management Type, select Provisioning or Enrollment.
Under CSR Handling, leave Service Generated CSR selected for CSR Generation and leave Generate Key/CSR on Application set to No.
Under Subject DN, enter the required information.
Under Private Key, select the Key Algorithm to use and the desired Key Strength in bits.
Under Other Information, search for and select the previously configured CA Template.
Select [ Save ].
Select the newly generated certificate from the policy tree. The Certificate Status should be OK.
Select [ Renew Now ].
The Certificate Status changes to Queued for renewal.
After about a minute, select [ Refresh ].
The certificate details display in the window.
If you selected Provisioning for Management Type, associate the certificate with the intended application object.
Venafi CodeSign Protect can store private code signing keys in the KMES Series 3. This section describes the basic steps to configure this functionality for the integration. See Venafi documentation for more details.
To take advantage of the CodeSign Project, you must create a Certificate Authority (CA) template object, which Venafi TPP uses to manage the certificate lifecycle. See Venafi documentation for more information.
To use an HSM for key storage, you must first complete the steps in the Set up HSM private key generation section.
Open the Venafi Configuration Console application.
Select the System Roles node.
Select [ Add CodeSign Protect Administrator ] in the Actions panel.
Select a user and grant that user CodeSign Protect Administrator permissions.
Open the Venafi Configuration Console application.
Under the Code Signing node, select [ Custom Flows ].
Select [ Add new Code Signing Flow ] in the Actions panel.
Enter a name for the Code Signing Flow.
Select the newly created Code Signing Flow and add an approver through the Actions panel.
Open the Venafi Configuration Console application.
Under the Code Signing node, select [ Environment Templates ].
Select [ Certificate ] in the Actions panel under Add Single Template.
Enter a name for the Code Signing Environment Template and select [ Create ].
On the Settings tab of the Properties window, enter a Description and select a Certificate Container and Signing Flow.
Open the Certificate Authority tab, select a CA Template, and select [ Add ].
On the Keys tab, select which key sizes to allow for RSA and Elliptic Curve keys.
On the Key Storage tab, select the Futurex HSM Connector and select [ Add ].
Enter any optional information in the remaining tabs and select [ OK ].
Log in to Aperture: https://[IP_address_of_Venafi_TPP]/aperture/codesign.
Select Projects in the main menu at the top of the page
Select [ Create Project ].
Enter a Project Name and Description.
Select [ Create ].
In the newly created code signing project, go to the Environments tab and select Add Environment > Certificate & Key.
Enter the Environment Name.
Select the Environment Template that you created for this code signing project.
For Creation Type, select Create New.
The Key Storage Location should now list the Futurex HSM Connector.
Enter any other necessary information for the certificate.
Select [ Save ].
Select [ Submit For Approval ] to generate a new certificate and private key after approval.
Log in to Aperture: https://[IP_address_of_Venafi_TPP]/aperture/codesign
Select Approvals in the main menu at the top of the page.