ctmkeytool

The ctmkeytool script can perform the following functions:

• Generating a private key (pem) file and certificate signing request (csr) file using the Create CSR Option.

• Deploying a p12 keystore file including the certificate. This deployment updates the relevant SSL configuration on the computer, as described in Deployment Option.

• On Control-M/EM, testing the connection against a specific Control-M/Server using the Status Option.

The ctmkeytool script is located in the following directories and must be used with its full path:

• Control-M/EM: <EM Home Directory>/bin/

• Control-M/Server: <Control-M/Server Home Directory>/scripts/

• Control-M/Agent: <Agent Home Directory>/exe/

Create CSR Option

The ctmkeytool script creates the private key file and the certificate signing request file, using the configuration file csr_params.cfg located in <Product Home Directory>/data/SSL/config directory. Verify that the user running the script has the correct permissions to create and update the directories.

The csr_params.cfg file is a standard openssl configuration file. If you have any requirements from the certificate, you can include them in this file. For more information, see https://www.openssl.org.

Before running the script, update the csr_params.cfg file, as described in Generating a Signed Certificate for zone 1 and Generating a Signed Certificate for zone 2.

The script usage is, as follows:

<ctmkeytool directory>/ctmkeytool -create_csr -password <private key password>

This command creates the private key file and the certificate signing request file:

The default name for the generated private key file consists of the CN field in the configuration file, and the timestamp of the file generation. The suffix of the private key file is .pem. The file is located in the <Product Home Directory>/data/SSL/private_keys directory.

The default name of the generated certificate signing request file consists of the CN field in the configuration file, and the timestamp of the file generation. The suffix of the certificate signing request file is .csr. The file is located in one of the following locations:

• UNIX:<Product Home Directory>/data/SSL/certificate_requests directory.

• Windows: <Product Home Directory>\Data\SSL\certificate_requests directory

You can specify a different configuration file name using the -conf_file flag.

To specify a different name for the created private key file and certificate signing request file, use the -out flag.

The provided name is used for both the pem file and the csr file.

Deployment Option

The ctmkeytool script usage with the deployment option is as follows:

<ctmkeytool directory>/ctmkeytool -keystore <p12 keystore file with its full path> -password <keystore password> -passwkey <name of file containing the password encryption key with full path>

This updates the SSL configuration for the relevant Control-M component.

The file specified by the -passwkey parameter is an encryption key, which is used to encrypt the keystore password in the environment’s SSL configuration. Both binary and textual files can be used for this purpose. Control-M/Agent does not parse the -passwkey parameter. Agent use its own Local.key. To change it, use the ctmagcpk utility.

It is possible to use the ess_key.txt file in the following locations:

• Control-M/EM: <EM Home Directory>/etc/site/resource/ssl/cert/ess_key.txt.

• Control-M/Server: <CTM Home Directory>/data/SSL/cert/ess_key.txt

After you run the script, you must restart the following relevant components:

• Control-M/EM: Control-M/EM Configuration Agent, CMS, and the relevant gateways

• Control-M/Server: Control-M/Server and Control-M/Server Configuration Agent

• Control-M/Agent: Specific Control-M/Agents

Status Option

The ctmkeytool status option tests and receives details about the SSL environment on Control-M/EM and its SSL connection to a specific Control-M/Server. The script usage is as follows:

<EM Home Directory>/bin/ctmkeytool -status -host <Control-M/Server name as displayed in CCM> -keystore_pass <password of the local keystore on EM> -key_pass <password of the private key in the keystore>

The displayed output includes the following details:

• SSL configuration enablement status.

• The status of the connection between the selected Gateway and Control-M/Server. If the connection is not ok, you are prompted for further testing.

• The ports on Control-M/Server that the Gateway and CMS connects to.

• The name of the file holding the keystore used by Control-M/EM Gateway(s) and CMS.

• SSL protocols used by Control-M/EM Gateway(s) and CMS.

• SSL level used by Control-M/EM Gateway(s) and CMS.

Uninstall Option

The ctmkeytool-uninstall option is used to revert to the last SSL certificate and configuration used by the product before the current keystore was deployed. You can only revert to the previous configuration. Any configuration prior cannot be retrieved.

You can retrieve the previous configuration on Control-M/EM, Control-M/Server, and Control-M/Agent.

The ctmkeytool uninstall option script usage is as follows:

<ctmkeytool directory>/ctmkeytool -uninstall

After you run the script, you must restart the following relevant components:

• Control-M/EM: Control-M/EM Configuration Agent, CMS, and the relevant Gateways

• Control-M/Server: Control-M/Server and Control-M/Server Configuration Agent

• Control-M/Agent: Specific Control-M/Agents