SSH
SSH Key Offloading
Configure KMES Series 3
17min
this section covers the necessary {{k3}} configurations for this integration configure the futurex pkcs #11 integration this section covers general configurations you must make on the {{k3}} to enable the {{futurex}} pkcs #11 module to integrate for ssh key offloading create a role and identity for ssh with the required permissions perform the following steps to create a new role and identity for ssh on the kmes series 3 a later section configures 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 ] in the role editor window, configure the following settings specify a name for the role set the number of logins required to 1 navigate to the advanced tab 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 subpermission certificate authority export, upload keys top level permission only signing approval add select \[ ok ] to finish creating the role go to identity management > identities , right click anywhere in the window, and select add > client application in the info tab of the identity editor window, select application for the storage location and specify a name for the identity, such as crypto1 in the assigned roles tab, select the role you created in the previous section under authentication , select the api key mechanism and then \[ remove ] then select \[ add ] and set the type to password set the password for the identity and then select \[ ok ] to finish a later section configures the password in the futurex pkcs #11 configuration file select \[ ok ] to finish creating the identity enable the host api commands required for pkcs #11 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 execution by the fxpkcs11 library to set the allowed commands, complete the following steps log in to the {{k3}} application interface with the default admin identities go to administration > configuration > host api options , select the all preset to enable all commands, and then select \[ save ] configure tls communication this section covers the steps required to configure tls communication between the {{k}} and the {{futurex}} pkcs #11 library create a certificate authority (ca) log in to the {{k3}} application interface with the default admin identities select pki > certificate authorities in the left menu, then 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 as the default values, and then select \[ ok ] the new certificate container now displays in the certificate authorities menu right click the certificate container and select add certificate > new certificate in 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 in 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 use futurex certificates , 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 default values set and select \[ ok ] a message states that a pki key pair is loaded in the application public keys window select \[ request ] in the subject dn tab, set a common name for the certificate, such as kmes in the v3 extensions tab, select the tls server certificate profile in the pkcs #10 info tab, select a save location for the csr, then select \[ ok ] a message states that the certificate signing request was successfully written to the file location selected select \[ ok ] select \[ ok ] again to save the application public keys settings the main network options window shows loaded next to pki keys for the system/host api connection pair sign the system/host api csr go to pki > certificate authorities right click on the root ca certificate you created for this integration, and select add certificate > from request select the csr generated for the system/host api connection pair in the file browser after it loads, you don't need to modify any certificate settings 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 directory 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 your specified location 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, go to the directory where you want to save the signed system/host api certificate specify a name for the file and select \[ open ] select \[ ok ] a message states that the pem file was successfully written to your specified location 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 on the system/host api ssl ca x 509 certificate container and select \[ import ] select \[ add ] at the bottom of the import certificates window select the root ca certificate and the signed system/host api certificate in the file browser and select \[ open ] the certificate chain displays in the verified section of the window select \[ ok ] to save the changes in the network options window, the system/host api connection pair shows signed loaded next to certificates in the user certificates section issue a client certificate for the futurex pkcs #11 module you configure the client certificate created here in the futurex pkcs #11 configuration file go to pki > certificate authorities right click the system tls ca root certificate and select add certificate > new certificate in the subject dn tab, set a common name for the certificate leave all settings in the basic info tab set to the default values in the v3 extensions tab, select the tls client certificate profile and select \[ ok ] the pkcs #11 client certificate will now be listed under the system tls ca root certificate export the client certificate as a pkcs #12 file to perform the following steps, go to administration > configuration > options and enable the allow export of certificates using password option go to pki > certificate authorities right click the pkcs #11 client certificate, and select export > pkcs12 set a pkcs #12 password, leave export selected certificate with parents selected, and select \[ next ] select the storage device to use and select \[ ok ] enter a name for the file, select the location where you want to save it, and select \[ open ] you must move the fxpkcs11 client certificate to the computer where the {{futurex}} pkcs #11 module is installed a later section configures it in the fxpkcs11 configuration file and uses it for tls communication with the {{k3}} general kmes configurations for ssh key offloading this section covers general {{k}} ssh key offloading configuration create a ca for the ssh key pair go to pki > certificate authorities , then select \[ add ca ] at the bottom of the page set the name of the certificate container, such as ssh key offloading , and set the owner group to the role you created for this integration then select \[ ok ] right click on the certificate container you created and select add certificate > new certificate in the subject dn tab of the create x 509 certificate window, select the classic preset in the drop down list and specify ssh as the certificate's common name in the basic info tab, you can leave the default values set in the v3 extensions tab, leave the default value of none in the profile drop down menu select \[ ok ] to finish creating the ssh client key pair create an approval group for pki signing go to pki > signing workflow and select \[ add approval group ] at the bottom of the page specify ssh as the name of the approval group and select \[ ok ] right click on the newly created approval group and select permission give the role created for ssh key offloading the use permission, then select \[ ok ] add an issuance policy to the ssh certificate go to pki > certificate authorities right click the ssh certificate and select issuance policy > add in the basic info tab, set approvals to 0 and allowed hashes to sha 512 in the x 509 tab, set the default approval group to ssh in the object signing tab, select the allow object signing checkbox select \[ ok ] to apply the issuance policy to the ssh client certificate right click the ssh certificate and select change security usage in the security usage drop down menu, select anonymous signing select \[ ok ] to apply the change export the public key for the ssh key pair go to pki > certificate authorities right click on the ssh certificate and select export > public key(s) browse for where you want to save the file and select \[ choose ] select \[ ok ] in the dialog box that says, successfully exported certificate public key(s)