Certificate management
Venafi Control Plane for Machi...
Configure KMES Series 3
15min
this section shows you how to configure tls communication between the {{k3}} and the futurex pkcs #11 ( fxpkcs11 ) module installed on the computer that runs venafi tpp then, it covers general configurations on the {{k3}} to enable venafi to use the {{k}} as a root of trust for storage encryption and to protect private keys through the {{futurex}} pkcs #11 ( fxpkcs11 ) module configure tls communication perform the following tasks to configure tls communication between the {{k3}} and the venafi tpp 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 venafi tpp export the signed venafi tpp certificate the following sections describe how to perform these tasks create a ca perform the following steps to create a ca log in to the {{k3}} application interface with the default admin identities go to pki > certificate authorities and select \[ add ca ] at the bottom of the page in the certificate authority window, enter a name for the certificate container, leave all other fields set to the default values, and select \[ ok ] right click the certificate container you just created and select add certificate > new certificate on the subject dn tab, select the classic preset and set a common name for the certificate, such as system tls ca root on the basic info tab, leave all settings at the default values 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 go to administration > configuration > network options in the network options window, go to the tls/ssl settings tab 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 in the application public keys window, select \[ generate ] when warned that s sl will not be functional until new certificates are imported , select \[ yes ] to continue 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 select \[ request ] on the subject dn tab, you can leave the default common name value set to system/host api on the v3 extensions tab, select the tls server certificate profile on the pkcs #10 info tab, select a save location for the csr and select \[ ok ] when notified that the certificate signing request was successfully written to the location you specified , select \[ ok ] 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 select \[ ok ] to save and close the network options menu sign the csr perform the following steps to sign the system/host api csr go to pki > certificate authorities right click the system tls ca root certificate and select add certificate > from request in the file browser, select the csr you generated for the system/host api connection pair 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 go to pki > certificate authorities right click the system tls ca root certificate and select export > certificate(s) in the export certificates window, change the encoding to pem and select \[ browse ] 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 ] 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 go to pki > certificate authorities right click the system/host api certificate and select export > certificate(s) in the export certificates window, change the encoding to pem and select \[ browse ] 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 ] 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 go to administration > configuration > network options in the network options window, select the tls/ssl settings tab under the system/host api connection pair, select \[ edit ] next to certificates in the user certificates section right click the system/host api ssl ca x 509 certificate container and select \[ import ] select \[ add ] at the bottom of the import certificates window 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 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 venafi tpp go to pki > certificate authorities right click the system tls ca root certificate and select add certificate > new certificate on the subject dn tab, set venafi as the common name for the certificate leave all fields on the basic info tab set to the default values 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 {{fu}} pkcs #11 configuration file to use the client certificate you create for venafi tpp 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 go to pki > certificate authorities right click the venafi certificate and select export > pkcs#12 set a password for the pkcs #12 file, select export selected certificate , and select \[ next ] 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 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 venafi tpp instance the next section shows you how to configure and use them for tls communication with the {{k3}} configure general {{k3}} settings for {{k}} to the venafi tpp instance perform the following tasks to configure the {{k3}} for communication with the venafi tpp instance create a new role and identity with the required permissions create a new instance with the venafi role enable host api commands the following sections show you how to complete these tasks create a new role perform the following steps to create a new role with the permissions venafi requires go to identity management > roles and select \[ add ] at the bottom of the page 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 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 on the advanced tab, set allowed ports to host api only 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 go to identity management > identities right click anywhere in the window and select add > client application on the info tab of the identity editor window, set the storage type to hsm and specify a name for the identity on the assigned roles tab, select the venafi role on the authentication tab, remove the default hardened api key mechanism and select \[ add ] 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 select \[ ok ] to finish creating the identity enable the host api commands required for venafi tpp operation because the {{futurex}} pkcs #11 library connects to the host api port on the {{k}} , you must define which host api commands to enable for {{futurex}} pkcs #11 to enable the host api commands required for venafi tpp operation, complete the following steps go to administration > configuration > host api options enable the following commands command description and subcommand (if applicable) atkg manipulate hsm trusted asymmetric key group add add hsm trusted asymmetric key group modify modify hsm trusted asymmetric key group delete delete hsm trusted asymmetric key group get retrieve hsm trusted asymmetric key group attr generic attribute operations get retrieve generic attributes put set generic attributes patch patch generic attributes echo echo text rafa filter issuance policy rand generate random number rkck create hsm trusted key rkcp get command permissions get retrieve enabled commands modify update enabled commands 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 select \[ save ] to finish