summaryrefslogtreecommitdiff
path: root/ssh-keygen.1
diff options
context:
space:
mode:
Diffstat (limited to 'ssh-keygen.1')
-rw-r--r--ssh-keygen.163
1 files changed, 57 insertions, 6 deletions
diff --git a/ssh-keygen.1 b/ssh-keygen.1
index 486de0421..50e74e110 100644
--- a/ssh-keygen.1
+++ b/ssh-keygen.1
@@ -9,7 +9,7 @@
9.\" 9.\"
10.\" Created: Sat Apr 22 23:55:14 1995 ylo 10.\" Created: Sat Apr 22 23:55:14 1995 ylo
11.\" 11.\"
12.\" $Id: ssh-keygen.1,v 1.13 2000/04/29 13:57:12 damien Exp $ 12.\" $Id: ssh-keygen.1,v 1.14 2000/05/07 02:03:18 damien Exp $
13.\" 13.\"
14.Dd September 25, 1999 14.Dd September 25, 1999
15.Dt SSH-KEYGEN 1 15.Dt SSH-KEYGEN 1
@@ -19,7 +19,7 @@
19.Nd authentication key generation 19.Nd authentication key generation
20.Sh SYNOPSIS 20.Sh SYNOPSIS
21.Nm ssh-keygen 21.Nm ssh-keygen
22.Op Fl q 22.Op Fl dq
23.Op Fl b Ar bits 23.Op Fl b Ar bits
24.Op Fl N Ar new_passphrase 24.Op Fl N Ar new_passphrase
25.Op Fl C Ar comment 25.Op Fl C Ar comment
@@ -30,6 +30,15 @@
30.Op Fl N Ar new_passphrase 30.Op Fl N Ar new_passphrase
31.Op Fl f Ar keyfile 31.Op Fl f Ar keyfile
32.Nm ssh-keygen 32.Nm ssh-keygen
33.Fl x
34.Op Fl f Ar keyfile
35.Nm ssh-keygen
36.Fl X
37.Op Fl f Ar keyfile
38.Nm ssh-keygen
39.Fl y
40.Op Fl f Ar keyfile
41.Nm ssh-keygen
33.Fl c 42.Fl c
34.Op Fl P Ar passphrase 43.Op Fl P Ar passphrase
35.Op Fl C Ar comment 44.Op Fl C Ar comment
@@ -43,11 +52,21 @@
43.Nm 52.Nm
44generates and manages authentication keys for 53generates and manages authentication keys for
45.Xr ssh 1 . 54.Xr ssh 1 .
55.Nm
56defaults to generating an RSA key for use by protocols 1.3 and 1.5;
57specifying the
58.Fl d
59flag will create a DSA key instead for use by protocol 2.0.
60.Pp
46Normally each user wishing to use SSH 61Normally each user wishing to use SSH
47with RSA authentication runs this once to create the authentication 62with RSA or DSA authentication runs this once to create the authentication
48key in 63key in
49.Pa $HOME/.ssh/identity . 64.Pa $HOME/.ssh/identity
50Additionally, the system administrator may use this to generate host keys. 65or
66.Pa $HOME/.ssh/id_dsa .
67Additionally, the system administrator may use this to generate host keys,
68as seen in
69.Pa /etc/rc .
51.Pp 70.Pp
52Normally this program generates the key and asks for a file in which 71Normally this program generates the key and asks for a file in which
53to store the private key. 72to store the private key.
@@ -71,7 +90,7 @@ If the passphrase is
71lost or forgotten, you will have to generate a new key and copy the 90lost or forgotten, you will have to generate a new key and copy the
72corresponding public key to other machines. 91corresponding public key to other machines.
73.Pp 92.Pp
74There is also a comment field in the key file that is only for 93For RSA, there is also a comment field in the key file that is only for
75convenience to the user to help identify the key. 94convenience to the user to help identify the key.
76The comment can tell what the key is for, or whatever is useful. 95The comment can tell what the key is for, or whatever is useful.
77The comment is initialized to 96The comment is initialized to
@@ -80,6 +99,9 @@ when the key is created, but can be changed using the
80.Fl c 99.Fl c
81option. 100option.
82.Pp 101.Pp
102After a key is generated, instructions below detail where the keys
103should be placed to be activated.
104.Pp
83The options are as follows: 105The options are as follows:
84.Bl -tag -width Ds 106.Bl -tag -width Ds
85.It Fl b Ar bits 107.It Fl b Ar bits
@@ -118,6 +140,15 @@ Provides the (old) passphrase.
118If RSA support is functional, immediately exits with code 0. If RSA 140If RSA support is functional, immediately exits with code 0. If RSA
119support is not functional, exits with code 1. This flag will be 141support is not functional, exits with code 1. This flag will be
120removed once the RSA patent expires. 142removed once the RSA patent expires.
143.It Fl x
144This option will read a private
145OpenSSH DSA format file and prints to stdout a SSH2-compatible public key.
146.It Fl X
147This option will read a
148SSH2-compatible public key file and print to stdout an OpenSSH DSA compatible public key.
149.It Fl y
150This option will read a private
151OpenSSH DSA format file and prints to stdout an OpenSSH DSA public key.
121.El 152.El
122.Sh FILES 153.Sh FILES
123.Bl -tag -width Ds 154.Bl -tag -width Ds
@@ -130,6 +161,8 @@ used to encrypt the private part of this file using 3DES.
130This file is not automatically accessed by 161This file is not automatically accessed by
131.Nm 162.Nm
132but it is offered as the default file for the private key. 163but it is offered as the default file for the private key.
164.Xr sshd 8
165will read this file when a login attempt is made.
133.It Pa $HOME/.ssh/identity.pub 166.It Pa $HOME/.ssh/identity.pub
134Contains the public key for authentication. 167Contains the public key for authentication.
135The contents of this file should be added to 168The contents of this file should be added to
@@ -137,6 +170,24 @@ The contents of this file should be added to
137on all machines 170on all machines
138where you wish to log in using RSA authentication. 171where you wish to log in using RSA authentication.
139There is no need to keep the contents of this file secret. 172There is no need to keep the contents of this file secret.
173.It Pa $HOME/.ssh/id_dsa
174Contains the DSA authentication identity of the user.
175This file should not be readable by anyone but the user.
176It is possible to
177specify a passphrase when generating the key; that passphrase will be
178used to encrypt the private part of this file using 3DES.
179This file is not automatically accessed by
180.Nm
181but it is offered as the default file for the private key.
182.Xr sshd 8
183will read this file when a login attempt is made.
184.It Pa $HOME/.ssh/id_dsa.pub
185Contains the public key for authentication.
186The contents of this file should be added to
187.Pa $HOME/.ssh/authorized_keys2
188on all machines
189where you wish to log in using DSA authentication.
190There is no need to keep the contents of this file secret.
140.Sh AUTHOR 191.Sh AUTHOR
141Tatu Ylonen <ylo@cs.hut.fi> 192Tatu Ylonen <ylo@cs.hut.fi>
142.Pp 193.Pp