]>
Commit | Line | Data |
---|---|---|
a4e5acef | 1 | .\" $OpenBSD: ssh-keygen.1,v 1.56 2003/03/28 10:11:43 jmc Exp $ |
23c2a7a5 | 2 | .\" |
bf740959 | 3 | .\" -*- nroff -*- |
4 | .\" | |
bf740959 | 5 | .\" Author: Tatu Ylonen <ylo@cs.hut.fi> |
bf740959 | 6 | .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland |
7 | .\" All rights reserved | |
8 | .\" | |
bcbf86ec | 9 | .\" As far as I am concerned, the code I have written for this software |
10 | .\" can be used freely for any purpose. Any derived versions of this | |
11 | .\" software must be clearly marked as such, and if the derived work is | |
12 | .\" incompatible with the protocol description in the RFC file, it must be | |
13 | .\" called by a name other than "ssh" or "Secure Shell". | |
14 | .\" | |
15 | .\" | |
f3c7c613 | 16 | .\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. |
17 | .\" Copyright (c) 1999 Aaron Campbell. All rights reserved. | |
18 | .\" Copyright (c) 1999 Theo de Raadt. All rights reserved. | |
bcbf86ec | 19 | .\" |
20 | .\" Redistribution and use in source and binary forms, with or without | |
21 | .\" modification, are permitted provided that the following conditions | |
22 | .\" are met: | |
23 | .\" 1. Redistributions of source code must retain the above copyright | |
24 | .\" notice, this list of conditions and the following disclaimer. | |
25 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
26 | .\" notice, this list of conditions and the following disclaimer in the | |
27 | .\" documentation and/or other materials provided with the distribution. | |
bf740959 | 28 | .\" |
bcbf86ec | 29 | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR |
30 | .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES | |
31 | .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. | |
32 | .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, | |
33 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT | |
34 | .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
35 | .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
36 | .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
37 | .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF | |
38 | .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
bf740959 | 39 | .\" |
40 | .Dd September 25, 1999 | |
41 | .Dt SSH-KEYGEN 1 | |
42 | .Os | |
43 | .Sh NAME | |
44 | .Nm ssh-keygen | |
5deceabb | 45 | .Nd authentication key generation, management and conversion |
bf740959 | 46 | .Sh SYNOPSIS |
47 | .Nm ssh-keygen | |
a4e5acef | 48 | .Bk -words |
fa08c86b | 49 | .Op Fl q |
bf740959 | 50 | .Op Fl b Ar bits |
2a55e100 | 51 | .Fl t Ar type |
bf740959 | 52 | .Op Fl N Ar new_passphrase |
53 | .Op Fl C Ar comment | |
7cd3766c | 54 | .Op Fl f Ar output_keyfile |
a4e5acef | 55 | .Ek |
bf740959 | 56 | .Nm ssh-keygen |
57 | .Fl p | |
58 | .Op Fl P Ar old_passphrase | |
59 | .Op Fl N Ar new_passphrase | |
f095fcc7 | 60 | .Op Fl f Ar keyfile |
bf740959 | 61 | .Nm ssh-keygen |
5deceabb | 62 | .Fl i |
7cd3766c | 63 | .Op Fl f Ar input_keyfile |
1d1ffb87 | 64 | .Nm ssh-keygen |
5deceabb | 65 | .Fl e |
7cd3766c | 66 | .Op Fl f Ar input_keyfile |
1d1ffb87 | 67 | .Nm ssh-keygen |
68 | .Fl y | |
7cd3766c | 69 | .Op Fl f Ar input_keyfile |
1d1ffb87 | 70 | .Nm ssh-keygen |
bf740959 | 71 | .Fl c |
72 | .Op Fl P Ar passphrase | |
73 | .Op Fl C Ar comment | |
f095fcc7 | 74 | .Op Fl f Ar keyfile |
75 | .Nm ssh-keygen | |
76 | .Fl l | |
aaf45d87 | 77 | .Op Fl f Ar input_keyfile |
78 | .Nm ssh-keygen | |
79 | .Fl B | |
7cd3766c | 80 | .Op Fl f Ar input_keyfile |
f0d6bdcf | 81 | .Nm ssh-keygen |
82 | .Fl D Ar reader | |
83 | .Nm ssh-keygen | |
84 | .Fl U Ar reader | |
85 | .Op Fl f Ar input_keyfile | |
f54651ce | 86 | .Sh DESCRIPTION |
bf740959 | 87 | .Nm |
5deceabb | 88 | generates, manages and converts authentication keys for |
bf740959 | 89 | .Xr ssh 1 . |
1d1ffb87 | 90 | .Nm |
7203d6bb | 91 | can create RSA keys for use by SSH protocol version 1 and RSA or DSA |
3dc93cd8 | 92 | keys for use by SSH protocol version 2. The type of key to be generated |
93 | is specified with the | |
fa08c86b | 94 | .Fl t |
3dc93cd8 | 95 | option. |
1d1ffb87 | 96 | .Pp |
bf740959 | 97 | Normally each user wishing to use SSH |
1d1ffb87 | 98 | with RSA or DSA authentication runs this once to create the authentication |
bf740959 | 99 | key in |
c0ecc314 | 100 | .Pa $HOME/.ssh/identity , |
101 | .Pa $HOME/.ssh/id_dsa | |
1d1ffb87 | 102 | or |
c0ecc314 | 103 | .Pa $HOME/.ssh/id_rsa . |
1d1ffb87 | 104 | Additionally, the system administrator may use this to generate host keys, |
105 | as seen in | |
106 | .Pa /etc/rc . | |
bf740959 | 107 | .Pp |
108 | Normally this program generates the key and asks for a file in which | |
4fe2af09 | 109 | to store the private key. |
110 | The public key is stored in a file with the same name but | |
bf740959 | 111 | .Dq .pub |
4fe2af09 | 112 | appended. |
113 | The program also asks for a passphrase. | |
114 | The passphrase may be empty to indicate no passphrase | |
b5c334cc | 115 | (host keys must have an empty passphrase), or it may be a string of |
4fe2af09 | 116 | arbitrary length. |
c840d0ad | 117 | A passphrase is similar to a password, except it can be a phrase with a |
118 | series of words, punctuation, numbers, whitespace, or any string of | |
119 | characters you want. | |
120 | Good passphrases are 10-30 characters long, are | |
bf740959 | 121 | not simple sentences or otherwise easily guessable (English |
e5b71e99 | 122 | prose has only 1-2 bits of entropy per character, and provides very bad |
c840d0ad | 123 | passphrases), and contain a mix of upper and lowercase letters, |
124 | numbers, and non-alphanumeric characters. | |
4fe2af09 | 125 | The passphrase can be changed later by using the |
bf740959 | 126 | .Fl p |
127 | option. | |
128 | .Pp | |
4fe2af09 | 129 | There is no way to recover a lost passphrase. |
130 | If the passphrase is | |
91789042 | 131 | lost or forgotten, a new key must be generated and copied to the |
bf740959 | 132 | corresponding public key to other machines. |
133 | .Pp | |
5deceabb | 134 | For RSA1 keys, |
135 | there is also a comment field in the key file that is only for | |
4fe2af09 | 136 | convenience to the user to help identify the key. |
137 | The comment can tell what the key is for, or whatever is useful. | |
138 | The comment is initialized to | |
bf740959 | 139 | .Dq user@host |
140 | when the key is created, but can be changed using the | |
141 | .Fl c | |
142 | option. | |
143 | .Pp | |
1d1ffb87 | 144 | After a key is generated, instructions below detail where the keys |
145 | should be placed to be activated. | |
146 | .Pp | |
bf740959 | 147 | The options are as follows: |
148 | .Bl -tag -width Ds | |
149 | .It Fl b Ar bits | |
4fe2af09 | 150 | Specifies the number of bits in the key to create. |
151 | Minimum is 512 bits. | |
63baa058 | 152 | Generally, 1024 bits is considered sufficient. |
4fe2af09 | 153 | The default is 1024 bits. |
bf740959 | 154 | .It Fl c |
155 | Requests changing the comment in the private and public key files. | |
f564d016 | 156 | This operation is only supported for RSA1 keys. |
bf740959 | 157 | The program will prompt for the file containing the private keys, for |
cf7ff074 | 158 | the passphrase if the key has one, and for the new comment. |
5deceabb | 159 | .It Fl e |
b587c165 | 160 | This option will read a private or public OpenSSH key file and |
161 | print the key in a | |
5deceabb | 162 | .Sq SECSH Public Key File Format |
163 | to stdout. | |
164 | This option allows exporting keys for use by several commercial | |
165 | SSH implementations. | |
f0d6bdcf | 166 | .It Fl f Ar filename |
f095fcc7 | 167 | Specifies the filename of the key file. |
5deceabb | 168 | .It Fl i |
169 | This option will read an unencrypted private (or public) key file | |
170 | in SSH2-compatible format and print an OpenSSH compatible private | |
171 | (or public) key to stdout. | |
172 | .Nm | |
bcaa828e | 173 | also reads the |
5deceabb | 174 | .Sq SECSH Public Key File Format . |
175 | This option allows importing keys from several commercial | |
176 | SSH implementations. | |
f095fcc7 | 177 | .It Fl l |
f564d016 | 178 | Show fingerprint of specified public key file. |
179 | Private RSA1 keys are also supported. | |
180 | For RSA and DSA keys | |
181 | .Nm | |
182 | tries to find the matching public key file and prints its fingerprint. | |
bf740959 | 183 | .It Fl p |
184 | Requests changing the passphrase of a private key file instead of | |
4fe2af09 | 185 | creating a new private key. |
186 | The program will prompt for the file | |
bf740959 | 187 | containing the private key, for the old passphrase, and twice for the |
188 | new passphrase. | |
189 | .It Fl q | |
190 | Silence | |
191 | .Nm ssh-keygen . | |
192 | Used by | |
193 | .Pa /etc/rc | |
194 | when creating a new key. | |
5deceabb | 195 | .It Fl y |
196 | This option will read a private | |
197 | OpenSSH format file and print an OpenSSH public key to stdout. | |
fa08c86b | 198 | .It Fl t Ar type |
199 | Specifies the type of the key to create. | |
200 | The possible values are | |
201 | .Dq rsa1 | |
202 | for protocol version 1 and | |
203 | .Dq rsa | |
204 | or | |
205 | .Dq dsa | |
206 | for protocol version 2. | |
aaf45d87 | 207 | .It Fl B |
208 | Show the bubblebabble digest of specified private or public key file. | |
bf740959 | 209 | .It Fl C Ar comment |
210 | Provides the new comment. | |
f0d6bdcf | 211 | .It Fl D Ar reader |
212 | Download the RSA public key stored in the smartcard in | |
213 | .Ar reader . | |
bf740959 | 214 | .It Fl N Ar new_passphrase |
215 | Provides the new passphrase. | |
216 | .It Fl P Ar passphrase | |
217 | Provides the (old) passphrase. | |
f0d6bdcf | 218 | .It Fl U Ar reader |
219 | Upload an existing RSA private key into the smartcard in | |
220 | .Ar reader . | |
bf740959 | 221 | .El |
222 | .Sh FILES | |
223 | .Bl -tag -width Ds | |
bf740959 | 224 | .It Pa $HOME/.ssh/identity |
c0ecc314 | 225 | Contains the protocol version 1 RSA authentication identity of the user. |
4fe2af09 | 226 | This file should not be readable by anyone but the user. |
227 | It is possible to | |
bf740959 | 228 | specify a passphrase when generating the key; that passphrase will be |
4fe2af09 | 229 | used to encrypt the private part of this file using 3DES. |
230 | This file is not automatically accessed by | |
bf740959 | 231 | .Nm |
232 | but it is offered as the default file for the private key. | |
8a497b11 | 233 | .Xr ssh 1 |
1d1ffb87 | 234 | will read this file when a login attempt is made. |
bf740959 | 235 | .It Pa $HOME/.ssh/identity.pub |
c0ecc314 | 236 | Contains the protocol version 1 RSA public key for authentication. |
4fe2af09 | 237 | The contents of this file should be added to |
bf740959 | 238 | .Pa $HOME/.ssh/authorized_keys |
239 | on all machines | |
91789042 | 240 | where the user wishes to log in using RSA authentication. |
4fe2af09 | 241 | There is no need to keep the contents of this file secret. |
1d1ffb87 | 242 | .It Pa $HOME/.ssh/id_dsa |
c0ecc314 | 243 | Contains the protocol version 2 DSA authentication identity of the user. |
1d1ffb87 | 244 | This file should not be readable by anyone but the user. |
245 | It is possible to | |
246 | specify a passphrase when generating the key; that passphrase will be | |
247 | used to encrypt the private part of this file using 3DES. | |
248 | This file is not automatically accessed by | |
249 | .Nm | |
250 | but it is offered as the default file for the private key. | |
8a497b11 | 251 | .Xr ssh 1 |
1d1ffb87 | 252 | will read this file when a login attempt is made. |
253 | .It Pa $HOME/.ssh/id_dsa.pub | |
c0ecc314 | 254 | Contains the protocol version 2 DSA public key for authentication. |
255 | The contents of this file should be added to | |
96a7b0cc | 256 | .Pa $HOME/.ssh/authorized_keys |
c0ecc314 | 257 | on all machines |
91789042 | 258 | where the user wishes to log in using public key authentication. |
c0ecc314 | 259 | There is no need to keep the contents of this file secret. |
260 | .It Pa $HOME/.ssh/id_rsa | |
261 | Contains the protocol version 2 RSA authentication identity of the user. | |
262 | This file should not be readable by anyone but the user. | |
263 | It is possible to | |
264 | specify a passphrase when generating the key; that passphrase will be | |
265 | used to encrypt the private part of this file using 3DES. | |
266 | This file is not automatically accessed by | |
267 | .Nm | |
268 | but it is offered as the default file for the private key. | |
8a497b11 | 269 | .Xr ssh 1 |
c0ecc314 | 270 | will read this file when a login attempt is made. |
271 | .It Pa $HOME/.ssh/id_rsa.pub | |
272 | Contains the protocol version 2 RSA public key for authentication. | |
1d1ffb87 | 273 | The contents of this file should be added to |
96a7b0cc | 274 | .Pa $HOME/.ssh/authorized_keys |
1d1ffb87 | 275 | on all machines |
91789042 | 276 | where the user wishes to log in using public key authentication. |
1d1ffb87 | 277 | There is no need to keep the contents of this file secret. |
089fbbd2 | 278 | .El |
fa08c86b | 279 | .Sh AUTHORS |
5fb622e4 | 280 | OpenSSH is a derivative of the original and free |
281 | ssh 1.2.12 release by Tatu Ylonen. | |
282 | Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, | |
283 | Theo de Raadt and Dug Song | |
284 | removed many bugs, re-added newer features and | |
285 | created OpenSSH. | |
286 | Markus Friedl contributed the support for SSH | |
287 | protocol versions 1.5 and 2.0. | |
bf740959 | 288 | .Sh SEE ALSO |
289 | .Xr ssh 1 , | |
290 | .Xr ssh-add 1 , | |
0c372277 | 291 | .Xr ssh-agent 1 , |
a5ef76f1 | 292 | .Xr sshd 8 |
5deceabb | 293 | .Rs |
7b518233 | 294 | .%A J. Galbraith |
295 | .%A R. Thayer | |
5deceabb | 296 | .%T "SECSH Public Key File Format" |
297 | .%N draft-ietf-secsh-publickeyfile-01.txt | |
298 | .%D March 2001 | |
299 | .%O work in progress material | |
300 | .Re |