ssh-keygen-pro

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

https://github.com/sixarm/ssh-keygen-pro

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (8.8%) to scientific vocabulary
Last synced: 8 months ago · JSON representation ·

Repository

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

Basic Info
  • Host: GitHub
  • Owner: SixArm
  • Language: Shell
  • Default Branch: main
  • Size: 10.7 KB
Statistics
  • Stars: 9
  • Watchers: 2
  • Forks: 4
  • Open Issues: 0
  • Releases: 0
Created over 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme Code of conduct Citation

README.md

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:

  • useridentifer=systemidentifer=uniqueidentifer=automation=ided25519
  • useridentifer=systemidentifer=uniqueidentifer=automation=ided25519.pub
  • useridentifer=systemidentifer=uniqueidentifer=passphrase=ided25519
  • useridentifer=systemidentifer=uniqueidentifer=passphrase=ided25519.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)

Owner

  • Name: SixArm
  • Login: SixArm
  • Kind: organization
  • Email: sixarm@sixarm.com
  • Location: San Francisco

SixArm Software

Citation (CITATION.cff)

cff-version: 1.2.0
title: ssh-keygen-pro
message: >-
  If you use this work and you want to cite it,
  then you can use the metadata from this file.
type: software
authors:
  - given-names: Joel Parker
    family-names: Henderson
    email: joel@joelparkerhenderson.com
    affiliation: joelparkerhenderson.com
    orcid: 'https://orcid.org/0009-0000-4681-282X'
identifiers:
  - type: url
    value: 'https://github.com/SixArm/ssh-keygen-pro/'
    description: ssh-keygen-pro
repository-code: 'https://github.com/SixArm/ssh-keygen-pro/'
abstract: >-
  ssh-keygen-pro
license: See license file

GitHub Events

Total
  • Push event: 1
Last Year
  • Push event: 1

Committers

Last synced: 12 months ago

All Time
  • Total Commits: 12
  • Total Committers: 2
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.083
Past Year
  • Commits: 1
  • Committers: 1
  • Avg Commits per committer: 1.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Joel Parker Henderson j****l@j****m 11
Joseph Presley j****y@o****o 1
Committer Domains (Top 20 + Academic)

Issues and Pull Requests

Last synced: 8 months ago

All Time
  • Total issues: 0
  • Total pull requests: 1
  • Average time to close issues: N/A
  • Average time to close pull requests: 4 months
  • Total issue authors: 0
  • Total pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 0
  • Average time to close issues: N/A
  • Average time to close pull requests: N/A
  • Issue authors: 0
  • Pull request authors: 0
  • Average comments per issue: 0
  • Average comments per pull request: 0
  • Merged pull requests: 0
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
  • jwp23 (1)
Top Labels
Issue Labels
Pull Request Labels