Configure KMES Series 3

this section starts with the general {{k}} configurations necessary for the {{futurex}} pkcs #11 module to integrate with the {{k3}} then, it covers the necessary steps to configure tls communication between the {{k}} and the {{futurex}} pkcs #11 library configure general kmes settings for {{futurex}} pkcs #11 communication perform the following tasks to configure the {{k3}} for communication with fxpkcs #11 create an fxpkcs #11 role and identity with the correct assigned permissions enable host api commands the following sections show you how to complete these tasks create a role and identity perform the following steps to create a new role and identity for {{futurex}} pkcs #11 ( fxpkcs11 ) with the required permissions on the {{k3}} a later section shows you how to configure the identity name and password in the {{futurex}} pkcs #11 configuration file log in to the {{k3}} application interface with the default admin identities go to identity management > roles and select \[ add ] at the bottom of the page in the info tab of the role editor window, under type, select application , specify a name for the role, and set the number of logins required to 1 on the permissions tab, select the following permissions permission subpermission certificate authority add, export, export private key cryptographic operations sign, verify keys add, export on the advanced tab, allow authentication to the host api port only 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 hsm for the storage location and specify a name for the identity on the assigned roles tab, select the role you just created on the authentication tab, click on api key , and select \[ remove ] select \[ add ] in the configure credential window, leave the type as password , click on \[ change ] enter a password and select \[ save ] select \[ ok ] in the configure credential window and click \[ ok ] in the identity editor to finish creating the identity enable host api commands since the {{futurex}} pkcs #11 library connects to the host api port on the {{k}} , you must define which host api commands to enable for execution by the fxpkcs11 library to enable the host api commands required for fxpkcs #11 operation with bind, complete the following steps log in to the {{k3}} application interface with the default admin identities go to administration > configuration > host api options and enable the following commands command description or subcommand (if applicable) atkg add hsm trusted asymmetric key group get retrieve hsm trusted asymmetric key group add add hsm trusted asymmetric key group attr generic attribute operations get retrieve generic attributes echo communication test or retrieve version rafa filter issuance policy rand generate a random number rkcp get command permissions get retrieve enabled commands rkgp export asymmetric hsm trusted key rkgs generate signature rkln lookup objects rklo login user rkpk pop generated key time set time select \[ save ] to finish configure tls communication perform the following tasks to configure tls communication between the {{k3}} and the {{k3}} pkcs #11 module create a certificate authority generate a csr for the system/host api connection pair sign the system/host api csr export the root ca export the signed system/host api tls certificate load the exported certificates into the system/host api connection pair issue a client certificate for the futurex pkcs #11 module export the client certificate as a pkcs #12 file the following sections describe how to perform these tasks create a ca perform the following steps to create a certificate authority (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 ] the certificate container you just created now displays in the certificate authorities menu right click the certificate container you just created 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 and select \[ ok ] the root ca certificate now displays under the previously created certificate container 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 ssl will not be functional until new certificates are imported , select \[ yes ] to continue in the pki parameters window, leave all fields set to the default values and select \[ ok ] you should see that a pki key pair is loaded now 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 prompted 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 the main network options window now shows loaded 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 go to pki > certificate authorities right click the root ca certificate you created and select add certificate > from request in the file browser, select the csr that 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 certificate now shows under the root ca certificate on the certificate authorities page export the root ca 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 certificate 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 the name of the file and select \[ open ] select \[ ok ] a message box confirms 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 go to pki > certificate authorities right click the {{k}} system/host api 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 root ca certificate specify the name of the file and select \[ open ] select \[ ok ] a message box confirms 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 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, 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 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 issue a client certificate perform the following steps to issue a client certificate for the {{futurex}} pkcs #11 module 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 leave all fields in the basic info tab set to the default values on the v3 extensions tab, select the tls client certificate profile and select \[ ok ] the pkcs #11 client certificate now displays under the system tls ca root certificate export the client certificate perform the following steps to export the client certificate as a pkcs #12 file to perform the following steps, you must go to configuration > options and enable the allow export of certificates using passwords option go to pki > certificate authorities right click the pkcs #11 client certificate and select export > pkcs12 set a pkcs12 password, leave export selected certificate with parents selected, and select \[ next ] enter a name for the file, select the location where you want to save it, and select \[ open ] to start the export move the fxpkcs11 client certificate to the computer where you installed the {{futurex}} pkcs #11 module a later section shows you how to configure it in the fxpkcs11 configuration file and use it for tls communication with the {{k3}}