1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
|
SSH-KEYGEN(1) System Reference Manual SSH-KEYGEN(1)
NAME
ssh-keygen - authentication key generation
SYNOPSIS
ssh-keygen [-dq] [-b bits] [-N new_passphrase] [-C comment] [-f keyfile]
ssh-keygen -p [-P old_passphrase] [-N new_passphrase] [-f keyfile]
ssh-keygen -x [-f keyfile]
ssh-keygen -X [-f keyfile]
ssh-keygen -y [-f keyfile]
ssh-keygen -c [-P passphrase] [-C comment] [-f keyfile]
ssh-keygen -l [-f keyfile]
ssh-keygen -R
DESCRIPTION
ssh-keygen generates and manages authentication keys for ssh(1). ssh-
keygen defaults to generating an RSA key for use by protocols 1.3 and
1.5; specifying the -d flag will create a DSA key instead for use by pro-
tocol 2.0.
Normally each user wishing to use SSH with RSA or DSA authentication runs
this once to create the authentication key in $HOME/.ssh/identity or
$HOME/.ssh/id_dsa. 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
empty passphrase), or it may be a string of arbitrary length. Good
passphrases are 10-30 characters long and are not simple sentences or
otherwise easily guessable (English prose has only 1-2 bits of entropy
per word, and provides very bad passphrases). The passphrase can be
changed later by using the -p option.
There is no way to recover a lost passphrase. If the passphrase is lost
or forgotten, you will have to generate a new key and copy the corre-
sponding public key to other machines.
For RSA, 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 can tell
what the key is for, or whatever is useful. The comment is initialized
to ``user@host'' when the key is created, but can be changed using the -c
option.
After a key is generated, instructions below detail where the keys should
be placed to be activated.
The options are as follows:
-b bits
Specifies the number of bits in the key to create. Minimum is
512 bits. Generally 1024 bits is considered sufficient, and key
sizes above that no longer improve security but make things slow-
er. The default is 1024 bits.
-c Requests changing the comment in the private and public key
files. The program will prompt for the file containing the pri-
vate keys, for passphrase if the key has one, and for the new
comment.
-f Specifies the filename of the key file.
-l Show fingerprint of specified private or public key file.
-p 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.
-q Silence ssh-keygen. Used by /etc/rc when creating a new key.
-C comment
Provides the new comment.
-N new_passphrase
Provides the new passphrase.
-P passphrase
Provides the (old) passphrase.
-R If RSA support is functional, immediately exits with code 0. If
RSA support is not functional, exits with code 1. This flag will
be removed once the RSA patent expires.
-x This option will read a private OpenSSH DSA format file and print
a SSH2-compatible public key to stdout.
-X This option will read a SSH2-compatible public key file and print
an OpenSSH DSA compatible public key to stdout.
-y This option will read a private OpenSSH DSA format file and print
an OpenSSH DSA public key to stdout.
FILES
$HOME/.ssh/identity
Contains the 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 by ssh-keygen but it is
offered as the default file for the private key. sshd(8) will
read this file when a login attempt is made.
$HOME/.ssh/identity.pub
Contains the public key for authentication. The contents of this
file should be added to $HOME/.ssh/authorized_keys on all ma-
chines where you wish to log in using RSA authentication. There
is no need to keep the contents of this file secret.
$HOME/.ssh/id_dsa
Contains the 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 by ssh-keygen but it is
offered as the default file for the private key. sshd(8) will
read this file when a login attempt is made.
$HOME/.ssh/id_dsa.pub
Contains the public key for authentication. The contents of this
file should be added to $HOME/.ssh/authorized_keys2 on all ma-
chines where you wish to log in using DSA authentication. There
is no need to keep the contents of this file secret.
AUTHOR
Tatu Ylonen <ylo@cs.hut.fi>
OpenSSH is a derivative of the original (free) ssh 1.2.12 release, but
with bugs removed and newer features re-added. Rapidly after the 1.2.12
release, newer versions bore successively more restrictive licenses.
This version of OpenSSH
o has all components of a restrictive nature (i.e., patents) directly
removed from the source code; any licensed or patented components are
chosen from external libraries.
o has been updated to support ssh protocol 1.5.
o contains added support for kerberos(8) authentication and ticket
passing.
o supports one-time password authentication with skey(1).
SEE ALSO
ssh(1), ssh-add(1), ssh-agent(1), sshd(8),
BSD Experimental September 25, 1999 3
|
