Configure the KMES Series 3

this section starts with general configurations you must make on the {{k3}} to allow the {{futurex}} pkcs #11 module to integrate with the {{k}} and then covers the steps required to configure tls communication between the {{k}} and the {{futurex}} pkcs #11 library general kmes configurations perform the tasks in this section to configure the {{k}} for this integration 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 {{k}} a later section shows you how to configure the identity name and password inside of 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, specify a name for the role and set the number of logins required to 1 then, 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 all profile to enable all permissions we usually do not recommend enabling all permissions, but in the case of the generic fxpkcs11 integration guide, the application being integrated is unknown; therefore, the required permissions are also unknown 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 shows you how to configure the password in the futurex pkcs #11 configuration file select \[ ok ] to finish creating the identity enable the host api commands 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 enable the host api commands required for pkcs #11, complete the following steps log in to the {{k3}} application interface with the default admin identities go to administration > configuration > host api options and select the all preset to enable all commands, then select \[ save ] we usually do not recommend enabling all commands, but in the case of the generic fxpkcs11 integration guide, the application being integrated is unknown; therefore, the required commands are also unknown configure tls communication perform the following tasks to configure tls communications between the {{k3}} and the {{futurex}} pkcs #11 module 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 select pki > certificate authorities in the left side menu, 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 created now displays in the certificate authorities menu right click on 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 in the basic info tab, leave all fields set to the default values in 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 use futurex certificates , and select \[ edit ] next to pki keys in the user certificates section in the application public keys window, select \[ generate ] when prompted 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 ] you see 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, 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 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 on the root ca certificate you created for this integration, and select add certificate > from request in the file browser, find and select the csr 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 shows 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, then 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 a name for the file, and select \[ open ] select \[ ok ] export the signed system/host api certificate go to pki > certificate authorities right click the {{k}} certificate, then 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 a name for the file, then select \[ open ] select \[ ok ] a message box will pop up stating that the pem file was successfully written to the location that you specified a message box shows that t he 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 on 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 ] the certificate chain appears in the verified section of the window 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 for the futurex pkcs #11 module a later section shows you how to configure the client certificate created here inside 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 fields 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 now displays under the system tls ca root certificate export the client certificate as a pkcs #12 file to perform the following steps, you must 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, then 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 you installed the {{futurex}} pkcs #11 module a later section shows you how to configure it inside the fxpkcs11 configuration file and use it for tls communication with the {{k3}}