miqoas / otterkeys

:rat::closed_lock_with_key: A .NET Core Tool to quickly create Ed25519 key pairs for signing and verifying messages or other data.

🐀🔐 OtterKeys

A .NET Core Tool to quickly create Ed25519 key pairs for signing and verifying messages or other data.

Installation

Download and install the .NET Core 2.1 SDK or newer. Once installed, run the following command to run OtterKeys:

Usage

Once installed you can call OtterKeys from the command line:

You can use the --help option to get more details about the commands and their options.

Creating a new key pair

Creating a new Ed25519 key pair is as easy as typing:

Otter will print the private and public key.

The private key should be stored securely and should be unique for each of your products. The public key is distributed with your software.

Specify key pair output format

You can specify a key pair output format by adding the option -o. Possible formats are base64, byte and hex. Example:

The default output format is a base64 formatted string.

Recovering a public key

A lost public key can be recovered from a private key by running the following command:

You can specify an input and output format by adding the options -i and -o. The recover command supports base64 and hex as input formats, and base64, byte and hex as output formats.

Example:

Acknowledgements

Otter uses the excellent NSec library.

otterkeys's Issues

Hex encoded keys

The default format is a base64 encoded string, not a hex formatted string.

The user should be able to specify hex, base64 or byte as output format options, and hex should be the default option.

Missing trailing comma in byte array formatted output

Each line in the outputted byte array should end with a comma.

0x8F, 0xAE, 0x61, 0xDB, 0x61, 0x7C, 0xF9, 0xE1,
0x91, 0x09, 0x0C, 0xBA, 0x7A, 0xCA, 0x93, 0x30,
0xED, 0x5E, 0x9F, 0xD6, 0x0E, 0xD9, 0x6E, 0xD4,
0xEA, 0xE7, 0x8F, 0xF7, 0x42, 0x4A, 0x3F, 0x4D