ctmkeygen

The ctmkeygen utility generates private and public SSH key pairs, which enables you to authenticate via private or public SSH keys instead of password authentication when you create or modify a job owner definition.

The ctmkeygen utility manages the key table that contains the logical key name as the unique table key, the private key, and the key passphras, which is encrypted. The generated, unencrypted public key is stored in a file.

Running the ctmkeygen Utility

This procedure describes how to run the ctmkeygen utility, which generates private and public SSH key pairs. You can run the ctmkeygen utility in interactive or batch mode.

Begin

1. Do one of the following:

   • UNIX: Log in to a Control-M/Server account

   • Windows: Open a command prompt where Control-M/Server is installed.

2. Do one of the following:

   • Interactive Mode: Run the following command:

     ctmkeygen

     The Control-M Key Generator Utility menu is displayed and provides a list of options, as described in ctmkeygen Utility Actions.

   • Batch Mode:

     Run one of the following commands:

     • ctmkeygen -action add -name <logicalKeyName> -passphrase <keyPassphrase> -type rsa|dsa -bits 512|768|1024|2048|3072 -format openssh|ssh2 -path <publicKeyPath>

     • ctmkeygen -action update -name <logicalKeyName> -passphrase <keyPassphrase> [-type rsa|dsa] [-bits 512|768|1024|2048|3072] [-format openssh|ssh2] -path <publicKeyPath>

     • ctmkeygen -action delete -name <logicalKeyName> -passphrase <keyPassphrase>

     • ctmkeygen -action list

     • ctmkeygen -action export -filename <exportFileName>

     • ctmkeygen -action import -filename <importFileName> -data append|truncate

     • ctmkeygen help

     The ctmkeygen utility actions and parameters are described in ctmkeygen Utility Actions and ctmkeygen Utility Parameters.

ctmkeygen Utility Actions

The following table describes the ctmkeygen utility actions.

Action	Description
add	Creates a new entry in the SSH key table and verifies that a key with the same name does not exist. You must use all the parameters, as described in ctmkeygen Utility Parameters..
update	Modifies the details of an existing SSH key table entry. The entry includes the same fields that are used to create a new SSH key pair. The updated entry replaces the existing entry in the key table in the database and the public key file. The passphrase must match the one that was used to create the existing key. For optional parameters, if a value is not specified, the value stored in the Control-M/Server database is used.
delete	Deletes the entry associated with the logical key name. The passphrase must match the one that was used to create the existing key.
list	Returns a list of lines, that contain the logical key name, type, bits, and format.
export	Exports the details of the keys stored in the key table to a text file. ctmkeygen -action export -filename $HOME/ctm_server/data/key_details.txt
import	Imports the details of the keys stored in the key table, which enables you to do the following: Prepare and save files of keys that can be reused. Specify utility input that is longer than the number of characters allowed in the command line. ctmkeygen -action import -filename $HOME/ctm_server/data/key_details.txt
help	Displays the usage of the ctmkeygen utility.

ctmkeygen Utility Parameters

The following table describes the ctmkeygen utility parameters.

Parameter	Description
-name	Defines a logical key name that is used as a unique identifier and that is saved as the public key filename. Valid Characters: A–Z, a–z, 0–9, and _ (underscores).
-passphrase	Defines a phrase used as a key to encrypt the key itself.
-type	Defines the type of key to generate. This parameter is mandatory when you add an SSH key and optional when you update one. Valid Values: RSA DSA
-bits	Defines the key length, in bits. You must define a bit value that is equal to or greater than the number required for the SSH server. This parameter is mandatory when you add an SSH key and optional when you update one. Valid Values: 512 768 1024 2048 3072
-format	Determines the public key file format, which must match the format that is used by the SSH server. This parameter is mandatory when you add an SSH key and optional when you update one. Valid Values: openssh: File format used by OpenSSH servers. ssh2:  File format used by SSH2 servers.
-path	Defines the pathname where the public key file is created.
-filename	Defines the public key filename. You must use the same file format that is defined in the -format parameter.
-data	Determines one of the following actions to perform with the imported data from the text file: append: The details of the SSH keys that are saved in the imported text file are added to the existing SSH keys. truncate: The details of the SSH keys that are saved in the imported text file replace the existing SSH keys.

Copying Public Keys to the SSH Server

This procedure describes how to copy public keys to the SSH server, which is mandatory. If such a file already exists on the SSH server, you must choose to either append or truncate the new file to the existing one.

Begin

• Copy the public key to the following directory on the SSH server, based on one of the following SSH server types:

  • OpenSSH on UNIX: <Job_Owner_Home_Directory>/.ssh/authorized_keys

  • SSH2 Tectia Server: 

    • UNIX: <jobOwnerHomeDirectory>/.ssh2/authorization

    • Windows: <jobOwnerHomeDirectory>\.ssh2\authorization