ssh-keygen

Creates new authentication key pairs for SSH.

Syntax

ssh-keygen [-q] [-b bits] [-C comment] [-f output_keyfile] [-m format] [-N new_passphrase] [-t dsa | ecdsa | ed25519 | rsa]

Options

option

Description

-b

“Bits” This option specifies the number of bits in the key. The regulations that govern the use case for SSH may require a specific key length to be used. In general, 2048 bits is considered to be sufficient for RSA keys.

-e

“Export” This option allows reformatting of existing keys between the OpenSSH key file format and the format documented in RFC 4716, “SSH Public Key File Format”.

-p

“Change the passphrase” This option allows changing the passphrase of a private key file with [-P old_passphrase] and [-N new_passphrase], [-f keyfile]

-t

“Type” This option specifies the type of key to be created. Commonly used values are: - rsa for RSA keys - dsa for DSA keys - ecdsa for elliptic curve DSA keys

-i

"Input" When ssh-keygen is required to access an existing key, this option designates the file.

-f

"File" Specifies name of the file in which to store the created key.

-N

"New" Provides a new passphrase for the key.

-P

"Passphrase" Provides the (old) passphrase when reading a key.

-c

"Comment" Changes the comment for a keyfile.

-p

"passphrase" Change the passphrase of a private key file.

-q

Silence ssh-keygen

-v

Verbose mode

-l

Fingerprint" Print the fingerprint of the specified public key.

-B

"Bubble babble" Shows a "bubble babble" (Tectia format) fingerprint of a keyfile.

-F

Search for a specified hostname in a known_hosts file.

-R

Remove all keys belonging to a hostname from a known_hosts file.

-y

Read a private OpenSSH format file and print an OpenSSH public key to stdout.

Choosing an Algorithm and Key Size

SSH supports several public key algorithms for authentication keys. These include:

  • rsa - an old algorithm based on the difficulty of factoring large numbers. A key size of at least 2048 bits is recommended for RSA; 4096 bits is better. RSA is getting old and significant advances are being made in factoring. Choosing a different algorithm may be advisable. It is quite possible the RSA algorithm will become practically breakable in the foreseeable future. All SSH clients support this algorithm.

  • dsa - an old US government Digital Signature Algorithm. It is based on the difficulty of computing discrete logarithms. A key size of 1024 would normally be used with it. DSA in its original form is no longer recommended.

  • ecdsa - a new Digital Signature Algorithm standarized by the US government, using elliptic curves. This is probably a good algorithm for current applications. Only three key sizes are supported: 256, 384, and 521 (sic!) bits. We would recommend always using it with 521 bits, since the keys are still small and probably more secure than the smaller keys (even though they should be safe as well). Most SSH clients now support this algorithm.

  • ed25519 - this is a new algorithm added in OpenSSH. Support for it in clients is not yet universal. Thus its use in general purpose applications may not yet be advisable.

The algorithm is selected using the -t option and key size using the -b option. The following commands illustrate:

ssh-keygen -t rsa -b 4096
ssh-keygen -t dsa
ssh-keygen -t ecdsa -b 521
ssh-keygen -t ed25519

Reference

Manpage

SSH Academy : ssh.com

Last updated