NAME
sssshh-kkeeyyggeenn - authentication key generation, management and conversion
SYNOPSIS
sssshh-kkeeyyggeenn [-qq] [-bb bits] -tt type [-NN newpassphrase] [-CC comment]
[-ff outputkeyfile]
sssshh-kkeeyyggeenn -pp [-PP oldpassphrase] [-NN newpassphrase] [-ff keyfile]
sssshh-kkeeyyggeenn -ii [-ff inputkeyfile]
sssshh-kkeeyyggeenn -ee [-ff inputkeyfile]
sssshh-kkeeyyggeenn -yy [-ff inputkeyfile]
sssshh-kkeeyyggeenn -cc [-PP passphrase] [-CC comment] [-ff keyfile]
sssshh-kkeeyyggeenn -ll [-ff inputkeyfile]
sssshh-kkeeyyggeenn -BB [-ff inputkeyfile]
sssshh-kkeeyyggeenn -DD reader
sssshh-kkeeyyggeenn -FF hostname [-ff knownhostsfile]
sssshh-kkeeyyggeenn -HH [-ff knownhostsfile]
sssshh-kkeeyyggeenn -RR hostname [-ff knownhostsfile]
sssshh-kkeeyyggeenn -UU reader [-ff inputkeyfile]
sssshh-kkeeyyggeenn -rr hostname [-ff inputkeyfile] [-gg]
sssshh-kkeeyyggeenn -GG outputfile [-vv] [-bb bits] [-MM memory] [-SS startpoint]
sssshh-kkeeyyggeenn -TT outputfile -ff inputfile [-vv] [-aa numtrials]
[-WW generator]
DESCRIPTION
sssshh-kkeeyyggeenn generates, manages and converts authentication keys for
ssh(1). sssshh-kkeeyyggeenn can create RSA keys for use by SSH protocol version 1
and RSA or DSA keys for use by SSH protocol version 2. The type of keyto be generated is specified with the -tt option. If invoked without any
arguments, sssshh-kkeeyyggeenn will generate an RSA key for use in SSH protocol 2
connections.sssshh-kkeeyyggeenn is also used to generate groups for use in Diffie-Hellman
group exchange (DH-GEX). See the MODULI GENERATION section for details.
Normally each user wishing to use SSH with RSA or DSA authentication runs this once to create the authentication key in ~/.ssh/identity, ~/.ssh/iddsa or ~/.ssh/idrsa. Additionally, the system administrator may use this to generate host keys, as seen in /etc/rc. Normally this program generates the key and asks for a file in which to store the private key. The public key is stored in a file with the same name but ``.pub'' appended. The program also asks for a passphrase. The passphrase may be empty to indicate no passphrase (host keys must have an empty passphrase), or it may be a string of arbitrary length. A passphrase is similar to a password, except it can be a phrase with aseries of words, punctuation, numbers, whitespace, or any string of char-
acters you want. Good passphrases are 10-30 characters long, are not
simple sentences or otherwise easily guessable (English prose has only1-2 bits of entropy per character, and provides very bad passphrases),
and contain a mix of upper and lowercase letters, numbers, and non-
alphanumeric characters. The passphrase can be changed later by usingthe -pp option.
There is no way to recover a lost passphrase. If the passphrase is lost or forgotten, a new key must be generated and copied to the corresponding public key to other machines. For RSA1 keys, there is also a comment field in the key file that is only for convenience to the user to help identify the key. The comment cantell what the key is for, or whatever is useful. The comment is initial-
ized to ``user@host'' when the key is created, but can be changed usingthe -cc option.
After a key is generated, instructions below detail where the keys should be placed to be activated. The options are as follows:-aa trials
Specifies the number of primality tests to perform when screeningDH-GEX candidates using the -TT command.
-BB Show the bubblebabble digest of specified private or public key
file.-bb bits
Specifies the number of bits in the key to create. For RSA keys,the minimum size is 768 bits and the default is 2048 bits. Gen-
erally, 2048 bits is considered sufficient. DSA keys must beexactly 1024 bits as specified by FIPS 186-2.
-CC comment
Provides a new comment.-cc Requests changing the comment in the private and public key
files. This operation is only supported for RSA1 keys. The pro-
gram will prompt for the file containing the private keys, for the passphrase if the key has one, and for the new comment.-DD reader
Download the RSA public key stored in the smartcard in reader.-ee This option will read a private or public OpenSSH key file and
print the key in RFC 4716 SSH Public Key File Format to stdout. This option allows exporting keys for use by several commercial SSH implementations.-FF hostname
Search for the specified hostname in a knownhosts file, listing any occurrences found. This option is useful to find hashed host names or addresses and may also be used in conjunction with the-HH option to print found keys in a hashed format.
-ff filename
Specifies the filename of the key file.-GG outputfile
Generate candidate primes for DH-GEX. These primes must be
screened for safety (using the -TT option) before use.
-gg Use generic DNS format when printing fingerprint resource records
using the -rr command.
-HH Hash a knownhosts file. This replaces all hostnames and
addresses with hashed representations within the specified file; the original content is moved to a file with a .old suffix. These hashes may be used normally by sssshh and sssshhdd, but they do not reveal identifying information should the file's contents be disclosed. This option will not modify existing hashed hostnamesand is therefore safe to use on files that mix hashed and non-
hashed names.-ii This option will read an unencrypted private (or public) key file
in SSH2-compatible format and print an OpenSSH compatible private
(or public) key to stdout. sssshh-kkeeyyggeenn also reads the RFC 4716
SSH Public Key File Format. This option allows importing keys from several commercial SSH implementations.-ll Show fingerprint of specified public key file. Private RSA1 keys
are also supported. For RSA and DSA keys sssshh-kkeeyyggeenn tries to
find the matching public key file and prints its fingerprint. Ifcombined with -vv, an ASCII art representation of the key is sup-
plied with the fingerprint.-MM memory
Specify the amount of memory to use (in megabytes) when generat-
ing candidate moduli for DH-GEX.
-NN newpassphrase
Provides the new passphrase.-PP passphrase
Provides the (old) passphrase.-pp Requests changing the passphrase of a private key file instead of
creating a new private key. The program will prompt for the file containing the private key, for the old passphrase, and twice for the new passphrase.-qq Silence sssshh-kkeeyyggeenn. Used by /etc/rc when creating a new key.
-RR hostname
Removes all keys belonging to hostname from a knownhosts file.This option is useful to delete hashed hosts (see the -HH option
above).-rr hostname
Print the SSHFP fingerprint resource record named hostname for the specified public key file.-SS start
Specify start point (in hex) when generating candidate moduli forDH-GEX.
-TT outputfile
Test DH group exchange candidate primes (generated using the -GG
option) for safety.-tt type
Specifies the type of key to create. The possible values are``rsa1'' for protocol version 1 and ``rsa'' or ``dsa'' for proto-
col version 2.-UU reader
Upload an existing RSA private key into the smartcard in reader.-vv Verbose mode. Causes sssshh-kkeeyyggeenn to print debugging messages
about its progress. This is helpful for debugging moduli genera-
tion. Multiple -vv options increase the verbosity. The maximum
is 3.-WW generator
Specify desired generator when testing candidate moduli for DH-
GEX.-yy This option will read a private OpenSSH format file and print an
OpenSSH public key to stdout. MMOODDUULLII GGEENNEERRAATTIIOONNsssshh-kkeeyyggeenn may be used to generate groups for the Diffie-Hellman Group
Exchange (DH-GEX) protocol. Generating these groups is a two-step
process: first, candidate primes are generated using a fast, but memoryintensive process. These candidate primes are then tested for suitabil-
ity (a CPU-intensive process).
Generation of primes is performed using the -GG option. The desired
length of the primes may be specified by the -bb option. For example:
# ssh-keygen -G moduli-2048.candidates -b 2048
By default, the search for primes begins at a random point in the desiredlength range. This may be overridden using the -SS option, which speci-
fies a different start point (in hex). Once a set of candidates have been generated, they must be tested forsuitability. This may be performed using the -TT option. In this mode
sssshh-kkeeyyggeenn will read candidates from standard input (or a file specified
using the -ff option). For example:
# ssh-keygen -T moduli-2048 -f moduli-2048.candidates
By default, each candidate will be subjected to 100 primality tests.This may be overridden using the -aa option. The DH generator value will
be chosen automatically for the prime under consideration. If a specificgenerator is desired, it may be requested using the -WW option. Valid
generator values are 2, 3, and 5. Screened DH groups may be installed in /etc/moduli. It is important that this file contains moduli of a range of bit lengths and that both ends of a connection share common moduli. FILES ~/.ssh/identity Contains the protocol version 1 RSA authentication identity of the user. This file should not be readable by anyone but the user. It is possible to specify a passphrase when generating the key; that passphrase will be used to encrypt the private part of this file using 3DES. This file is not automatically accessed bysssshh-kkeeyyggeenn but it is offered as the default file for the private
key. ssh(1) will read this file when a login attempt is made. ~/.ssh/identity.pubContains the protocol version 1 RSA public key for authentica-
tion. The contents of this file should be added to ~/.ssh/authorizedkeys on all machines where the user wishes to log in using RSA authentication. There is no need to keep the contents of this file secret. ~/.ssh/iddsa Contains the protocol version 2 DSA authentication identity of the user. This file should not be readable by anyone but the user. It is possible to specify a passphrase when generating the key; that passphrase will be used to encrypt the private part of this file using 3DES. This file is not automatically accessed bysssshh-kkeeyyggeenn but it is offered as the default file for the private
key. ssh(1) will read this file when a login attempt is made. ~/.ssh/iddsa.pubContains the protocol version 2 DSA public key for authentica-
tion. The contents of this file should be added to ~/.ssh/authorizedkeys on all machines where the user wishes to log in using public key authentication. There is no need to keep the contents of this file secret. ~/.ssh/idrsa Contains the protocol version 2 RSA authentication identity of the user. This file should not be readable by anyone but the user. It is possible to specify a passphrase when generating the key; that passphrase will be used to encrypt the private part of this file using 3DES. This file is not automatically accessed bysssshh-kkeeyyggeenn but it is offered as the default file for the private
key. ssh(1) will read this file when a login attempt is made. ~/.ssh/idrsa.pubContains the protocol version 2 RSA public key for authentica-
tion. The contents of this file should be added to ~/.ssh/authorizedkeys on all machines where the user wishes to log in using public key authentication. There is no need to keep the contents of this file secret. /etc/moduliContains Diffie-Hellman groups used for DH-GEX. The file format
is described in moduli(5).SEE ALSO
ssh(1), ssh-add(1), ssh-agent(1), moduli(5), sshd(8)
The Secure Shell (SSH) Public Key File Format, RFC 4716, 2006. AUTHORS OpenSSH is a derivative of the original and free ssh 1.2.12 release by Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theode Raadt and Dug Song removed many bugs, re-added newer features and cre-
ated OpenSSH. Markus Friedl contributed the support for SSH protocol versions 1.5 and 2.0. BSD December 21, 2019 BSD