Configure the KMES Series 3

this section covers the general kmes configurations that enable hashicorp vault to integrate with the kmes (providing master key wrapping, automatic unsealing, seal wrapping, and entropy augmentation functionality) and describes the necessary steps to configure tls communication between the kmes and the vault instance configure the general kmes series 3 settings perform the following tasks to complete the general kmes series 3 configuration create a role and identity for vault create a key group for vault keys enable host api commands create a role and identity for vault with the required permissions perform the following steps to create a new role and identity for vault on the kmes series 3 a later section shows you how to configure the name of this user in the futurex pkcs #11 configuration file log in to the kmes series 3 application interface with the default admin identities go to identity management > roles , and select \[ add ] in the role editor window, specify a name for the role and set the number of logins required to 1 go to the advanced tab and allow authentication to the host api port only leave all other fields set to the default values go to the permissions tab and select the following permissions permission sub permission cryptographic operations sign, verify, encrypt, decrypt keys add, export select \[ ok ] to finish creating the 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, select application for the storage location, and specify a name for the identity on the assigned roles tab, select the role you created on the authentication tab, configure the password for the identity leave all other fields set to the default values, and select \[ ok ] to finish creating the identity create a key group for vault keys perform the following steps to create a key group on the kmes series 3 so vault has a place to store the encryption keys that it uses for the seal wrap functionality a later section shows you how to configure the name of the key group in the futurex pkcs #11 configuration file log in to the kmes series 3 application interface with the default admin identities go to the key management > keys menu, then right click and select add > key group select symmetric and trusted in the key group storage in the key group editor window, specify a name for the key group in the owner group drop down list, select the vault role you created select \[ permissions ] and give the vault role you created the use permission select \[ ok ] to save select \[ ok ] again to finish creating the key group enable the host api commands required for the hashicorp vault 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 the fxpkcs11 library to set the enabled commands, complete the following steps log in to the kmes series 3 application interface with the default admin identities go to administration > configuration > host api options , then enable the following commands command description echo communication test/retrieve version rafa filter issuance policy rand generate a random number rkck create an hsm trusted key rkcp get command permissions rkcs create a symmetric hsm trusted key group rked encrypt or decrypt data rkhm hmac data rkln look up objects rklo login user rkrc get an hsm trusted key select \[ save ] to finish configure tls communication perform the following tasks to configure tls communications between the kmes series 3 and vault create a ca create a csr for the connection pair sign the csr export the root ca certificate export the signed system/host api certificate load the exported certificates to the connection pair issue a client certificate for vault export the vault certificate as a pkcs #12 file create a certificate authority (ca) log in to the kmes series 3 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 ] the certificate container now displays in the certificate authorities menu right click the certificate container and select add certificate > new certificate on the subject dn tab, set a common name for the certificate, such as system tls ca root on the basic info tab, leave all fields set to the default values on the v3 extensions tab, select the certificate authority profile, then select \[ ok ] the root ca certificate now displays under the previously created certificate container 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 ssl 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 pki key pair now shows as loaded in the application public keys window select \[ request ] on the subject dn tab, set a common name for the certificate, such as kmes 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 file location that was selected , select \[ ok ] select \[ ok ] again to save the application public keys settings in the main network options window, loaded now displays next to pki keys for the system/host api connection pair sign the system/host api csr go to pki > certificate authorities right click the root ca certificate you created, and select add certificate > from request in the file browser, find and select the csr that you generated for the system/host api connection pair after it loads, you don't need to modify any settings for the certificate select \[ ok ] the signed system/host api certificate now displays under the root ca certificate on the certificate authorities page 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 certificate window, change the encoding to pem , and select \[ browse ] in the file browser, go to the location where you want to save the signed system/host api certificate specify tls ca pem as the name for the file, and select \[ open ] select \[ ok ] a message box notifies you that the pem file was successfully written to the location that you specified export the signed system/host api certificate go to pki > certificate authorities right click the kmes certificate, and select export > certificate(s) in the export certificate 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 certificate specify tls kmes pem as the name for the file, and select \[ open ] select \[ ok ] a message box notifies you that the pem file was successfully written to the location that you specified load the exported certificates into the system/host api connection pair go to administration > configuration > network options in the network options window, go to the tls/ssl settings tab 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 dialog in the file browser, select both the root ca certificate and the signed system/host api certificate and select \[ open ] 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 select \[ ok ] to save and exit the network options dialog issue a client certificate for vault 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 a common name for the certificate, such as vault 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 vault certificate now displays under the system tls ca root certificate a later section shows you how to configure this client certificate (created for vault) in the futurex pkcs #11 configuration file export the vault certificate as a pkcs #12 file to perform the following steps, go to configuration > options and enable the allow export of certificates using passwords option go to pki > certificate authorities right click the vault certificate, and select export > pkcs12 select the export selected option, specify a unique name for the export file, and select \[ next ] enter a file password of your choosing and select \[ next ] select \[ finish ] to initiate the export move both the vault certificate and the root ca certificate exported in a previous section to the computer that runs the vault instance a later section shows how to configure and use them for tls communication with the kmes series 3