- djm@cvs.openbsd.org 2010/01/26 02:15:20

[openssh.git] / ssh-keygen.1

diff --git a/ssh-keygen.1 b/ssh-keygen.1
index ac0b7276480694f1d17bdb6a7dd6bc09cc16f8dd..190124e16bf68319678a8566a596ce071075163c 100644 (file)
--- a/ssh-keygen.1
+++ b/ssh-keygen.1
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: ssh-keygen.1,v 1.68 2005/04/21 06:17:50 djm Exp $
+.\"    $OpenBSD: ssh-keygen.1,v 1.80 2009/10/24 00:48:34 dtucker Exp $

 .\"
 .\"  -*- nroff -*-
 .\"
 .\"
 .\"  -*- nroff -*-
 .\"


@@ -37,7 +37,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"

-.Dd September 25, 1999
+.Dd $Mdocdate$

 .Dt SSH-KEYGEN 1
 .Os
 .Sh NAME
 .Dt SSH-KEYGEN 1
 .Os
 .Sh NAME


@@ -83,6 +83,7 @@
 .Nm ssh-keygen
 .Fl F Ar hostname
 .Op Fl f Ar known_hosts_file
 .Nm ssh-keygen
 .Fl F Ar hostname
 .Op Fl f Ar known_hosts_file

+.Op Fl l

 .Nm ssh-keygen
 .Fl H
 .Op Fl f Ar known_hosts_file
 .Nm ssh-keygen
 .Fl H
 .Op Fl f Ar known_hosts_file


@@ -118,6 +119,9 @@ keys for use by SSH protocol version 2.
 The type of key to be generated is specified with the
 .Fl t
 option.
 The type of key to be generated is specified with the
 .Fl t
 option.

+If invoked without any arguments,
+.Nm
+will generate an RSA key for use in SSH protocol 2 connections.

 .Pp
 .Nm
 is also used to generate groups for use in Diffie-Hellman group
 .Pp
 .Nm
 is also used to generate groups for use in Diffie-Hellman group


@@ -187,9 +191,9 @@ command.
 Show the bubblebabble digest of specified private or public key file.
 .It Fl b Ar bits
 Specifies the number of bits in the key to create.
 Show the bubblebabble digest of specified private or public key file.
 .It Fl b Ar bits
 Specifies the number of bits in the key to create.

-Minimum is 512 bits.
-Generally, 1024 bits is considered sufficient.
-The default is 1024 bits.
+For RSA keys, the minimum size is 768 bits and the default is 2048 bits.
+Generally, 2048 bits is considered sufficient.
+DSA keys must be exactly 1024 bits as specified by FIPS 186-2.

 .It Fl C Ar comment
 Provides a new comment.
 .It Fl c
 .It Fl C Ar comment
 Provides a new comment.
 .It Fl c


@@ -202,8 +206,8 @@ Download the RSA public key stored in the smartcard in
 .Ar reader .
 .It Fl e
 This option will read a private or public OpenSSH key file and
 .Ar reader .
 .It Fl e
 This option will read a private or public OpenSSH key file and

-print the key in a
-.Sq SECSH Public Key File Format
+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.
 to stdout.
 This option allows exporting keys for use by several commercial
 SSH implementations.


@@ -250,7 +254,7 @@ in SSH2-compatible format and print an OpenSSH compatible private
 (or public) key to stdout.
 .Nm
 also reads the
 (or public) key to stdout.
 .Nm
 also reads the

-.Sq SECSH Public Key File Format .
+RFC 4716 SSH Public Key File Format.

 This option allows importing keys from several commercial
 SSH implementations.
 .It Fl l
 This option allows importing keys from several commercial
 SSH implementations.
 .It Fl l


@@ -259,6 +263,9 @@ Private RSA1 keys are also supported.
 For RSA and DSA keys
 .Nm
 tries to find the matching public key file and prints its fingerprint.
 For RSA and DSA keys
 .Nm
 tries to find the matching public key file and prints its fingerprint.

+If combined with
+.Fl v ,
+an ASCII art representation of the key is supplied with the fingerprint.

 .It Fl M Ar memory
 Specify the amount of memory to use (in megabytes) when generating
 candidate moduli for DH-GEX.
 .It Fl M Ar memory
 Specify the amount of memory to use (in megabytes) when generating
 candidate moduli for DH-GEX.


@@ -386,7 +393,7 @@ 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
 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.
+used to encrypt the private part of this file using 128-bit AES.

 This file is not automatically accessed by
 .Nm
 but it is offered as the default file for the private key.
 This file is not automatically accessed by
 .Nm
 but it is offered as the default file for the private key.


@@ -404,7 +411,7 @@ 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
 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.
+used to encrypt the private part of this file using 128-bit AES.

 This file is not automatically accessed by
 .Nm
 but it is offered as the default file for the private key.
 This file is not automatically accessed by
 .Nm
 but it is offered as the default file for the private key.


@@ -422,7 +429,7 @@ 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
 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.
+used to encrypt the private part of this file using 128-bit AES.

 This file is not automatically accessed by
 .Nm
 but it is offered as the default file for the private key.
 This file is not automatically accessed by
 .Nm
 but it is offered as the default file for the private key.


@@ -447,12 +454,9 @@ The file format is described in
 .Xr moduli 5 ,
 .Xr sshd 8
 .Rs
 .Xr moduli 5 ,
 .Xr sshd 8
 .Rs

-.%A J. Galbraith
-.%A R. Thayer
-.%T "SECSH Public Key File Format"
-.%N draft-ietf-secsh-publickeyfile-01.txt
-.%D March 2001
-.%O work in progress material
+.%R RFC 4716
+.%T "The Secure Shell (SSH) Public Key File Format"
+.%D 2006

 .Re
 .Sh AUTHORS
 OpenSSH is a derivative of the original and free
 .Re
 .Sh AUTHORS
 OpenSSH is a derivative of the original and free