add-key

NAME

 

add-key — Add a new server key to the MFT Gateway system.

 

SYNOPSIS

 

add-key -alias <alias> [-rsa | -dsa | -ec] [-size <bits>] [-curve <name>] [-h]

 

DESCRIPTION

 

The add-key command-line tool is used to generate and add a new server key to MFT Gateway's key repository. This tool supports various key algorithms, sizes, and elliptic curves.

 

OPTIONS

 

-alias <alias>

The unique alias (name) for the new key.

 

-rsa

Use the RSA algorithm for key generation. This is the default algorithm.

 

-dsa

Use the DSA algorithm for key generation.

 

-ec

Use the Elliptic Curve (EC) algorithm for key generation.

 

-size <bits>

The size of the key in bits. The default is 2048.

 

-curve <name>

The elliptic curve name for EC keys. Default is secp256k1. This option is only applicable when using the -ec algorithm.

 

In the MFT Gateway UI, the newly added key is listed in Keys > Server Keys.

 

-h

Displays help information about the command.

 

USAGE EXAMPLES

 

Add an RSA key with default size

 

Example: add-key -alias my_rsa_key

 

Add an RSA key with a specific size

 

Example: add-key -alias my_rsa_key -size 4096

 

Add a DSA key

 

Example: add-key -alias my_dsa_key -dsa -size 2048

 

Add an EC key with a specific curve

 

Example: add-key -alias my_ec_key -ec -curve secp384r1

 

Display help information

 

Example: add-key -h

 

NOTES

 

  • The key alias is mandatory and must be unique.

  • If no algorithm is specified, RSA is used by default.

  • The key size defaults to 2048 bits if not specified.

  • The curve name defaults to secp256k1 for EC keys if not specified.

  • The tool interacts with the MFT Gateway database to store server keys.

  • The program outputs Adding key... and Done. during its operation.

  • Error messages are printed to the console if any issues occur during the process.

  • The program exits with a non-zero exit code upon encountering an error.