ssh-keygen-pro

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 9 Open GitHub ↗

ssh-keygen-pro: generate SSH keys using professional quality conventions

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ssh-keygen-pro

SSH keygen helper script to generate professional-quality keys.

Syntax:

```sh
ssh-keygen-pro
    [user_identifier]
    [system_identifier]
    [unique_identifier]
    [algorithm_identifier]
```

Example that prompts you:

```sh
ssh-keygen-pro
```

Example that uses args:

```sh
ssh-keygen-pro alice@example.com host.example.com 8af247255f409533f43c14cae2c07b97 ed25519
```

The output is 4 files:

* A key with a passphrase
    * A public key file
    * A private key file
  * A key without a passphrase, suitable for automation
    * A public key file
    * A private key file

## Install

Option 1: download the file to wherever you want, then make it executable.

```sh
cd /usr/local/bin/
sudo curl -O https://raw.githubusercontent.com/SixArm/ssh-keygen-pro/master/ssh-keygen-pro
sudo chmod +x ssh-keygen-pro
```

Option 2: clone the repo to anywhere you want, then add it to your path.

```sh
cd /anywhere/you/want
git clone https://github.com/SixArm/ssh-keygen-pro
export PATH="$PATH:/anywhere/you/want/ssh-keygen-pro"
```

If you would like to help us by writing a package for any popular package manager, such as apt, yum, brew, etc., we wecome help.

## Details

Typical usage:

* The user identifer is your email address e.g. "alice@example.com"
  * The system identifier is your host name e.g. "demo.example.com"
  * The unique identifer is a ZID e.g. "8af247255f409533f43c14cae2c07b97"
  * The algorithm identifier, either "ed25519" or "rsa".
  
Example with args:

ssh-keygen-pro alice@example.com host.example.com 8af247255f409533f43c14cae2c07b97 ed25519

Output file naming convention:

* user_identifer=system_identifer=unique_identifer=automation=id_ed25519
  * user_identifer=system_identifer=unique_identifer=automation=id_ed25519.pub
  * user_identifer=system_identifer=unique_identifer=passphrase=id_ed25519
  * user_identifer=system_identifer=unique_identifer=passphrase=id_ed25519.pub

Output file examples:

* alice@example.com=host.example.com=8af247255f409533f43c14cae2c07b97=automation=id_ed25519
  * alice@example.com=host.example.com=8af247255f409533f43c14cae2c07b97=automation=id_ed25519.pub
  * alice@example.com=host.example.com=8af247255f409533f43c14cae2c07b97=passphrase=id_ed25519
  * alice@example.com=host.example.com=8af247255f409533f43c14cae2c07b97=passphrase=id_ed25519.pub

## Reasoning

SSH options:

* Type: use the Ed25519 algorithm because it's the most secure.
  * Bits: If RSA, then use 4096 bits because it's stronger than default 2048.
  * Generate two keys, one for automation and one with a passphrase.
  
Inputs:

* Use the email address, so a user's keys sort together.
  * Use the host identifier, so a user's machine keys sort together.
  * Generate an ZID, akin to a UUID4 with only letters and numbers.

Output file name convention:

* Separate items by using an equal sign, because it's not in email adddresses.

## Tracking

* Command: ssh-keygen-pro
  * Version: 4.0.0
  * Created: 2015-12-20 or earlier
  * Updated: 2019-02-03
  * License: GPL
  * Contact: Joel Parker Henderson (joel@joelparkerhenderson.com)

ssh-keygen-pro

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README