summaryrefslogtreecommitdiff
path: root/ssh-keygen.1
diff options
context:
space:
mode:
authorDamien Miller <djm@mindrot.org>2005-03-02 12:05:06 +1100
committerDamien Miller <djm@mindrot.org>2005-03-02 12:05:06 +1100
commit265d309ebc97447f5e710df04196e626f018cad8 (patch)
tree0e321aac23035ff163d17c61efb19b59bf3a3432 /ssh-keygen.1
parent792c01749a754db5e2e6932869d315113c180461 (diff)
- jmc@cvs.openbsd.org 2005/03/01 18:15:56
[ssh-keygen.1] sort options (no attempt made at synopsis clean up though); spelling (occurance -> occurrence); use prompt before examples; grammar;
Diffstat (limited to 'ssh-keygen.1')
-rw-r--r--ssh-keygen.1134
1 files changed, 67 insertions, 67 deletions
diff --git a/ssh-keygen.1 b/ssh-keygen.1
index 4f2af5815..3987b1e66 100644
--- a/ssh-keygen.1
+++ b/ssh-keygen.1
@@ -1,4 +1,4 @@
1.\" $OpenBSD: ssh-keygen.1,v 1.65 2005/03/01 15:05:00 jmc Exp $ 1.\" $OpenBSD: ssh-keygen.1,v 1.66 2005/03/01 18:15:56 jmc Exp $
2.\" 2.\"
3.\" -*- nroff -*- 3.\" -*- nroff -*-
4.\" 4.\"
@@ -183,16 +183,23 @@ Specifies the number of primality tests to perform when screening DH-GEX
183candidates using the 183candidates using the
184.Fl T 184.Fl T
185command. 185command.
186.It Fl B
187Show the bubblebabble digest of specified private or public key file.
186.It Fl b Ar bits 188.It Fl b Ar bits
187Specifies the number of bits in the key to create. 189Specifies the number of bits in the key to create.
188Minimum is 512 bits. 190Minimum is 512 bits.
189Generally, 1024 bits is considered sufficient. 191Generally, 1024 bits is considered sufficient.
190The default is 1024 bits. 192The default is 1024 bits.
193.It Fl C Ar comment
194Provides a new comment.
191.It Fl c 195.It Fl c
192Requests changing the comment in the private and public key files. 196Requests changing the comment in the private and public key files.
193This operation is only supported for RSA1 keys. 197This operation is only supported for RSA1 keys.
194The program will prompt for the file containing the private keys, for 198The program will prompt for the file containing the private keys, for
195the passphrase if the key has one, and for the new comment. 199the passphrase if the key has one, and for the new comment.
200.It Fl D Ar reader
201Download the RSA public key stored in the smartcard in
202.Ar reader .
196.It Fl e 203.It Fl e
197This option will read a private or public OpenSSH key file and 204This option will read a private or public OpenSSH key file and
198print the key in a 205print the key in a
@@ -200,12 +207,41 @@ print the key in a
200to stdout. 207to stdout.
201This option allows exporting keys for use by several commercial 208This option allows exporting keys for use by several commercial
202SSH implementations. 209SSH implementations.
210.It Fl F Ar hostname
211Search for the specified
212.Ar hostname
213in a
214.Pa known_hosts
215file, listing any occurrences found.
216This option is useful to find hashed host names or addresses and may also be
217used in conjunction with the
218.Fl H
219option to print found keys in a hashed format.
220.It Fl f Ar filename
221Specifies the filename of the key file.
222.It Fl G Ar output_file
223Generate candidate primes for DH-GEX.
224These primes must be screened for
225safety (using the
226.Fl T
227option) before use.
203.It Fl g 228.It Fl g
204Use generic DNS format when printing fingerprint resource records using the 229Use generic DNS format when printing fingerprint resource records using the
205.Fl r 230.Fl r
206command. 231command.
207.It Fl f Ar filename 232.It Fl H
208Specifies the filename of the key file. 233Hash a
234.Pa known_hosts
235file, printing the result to standard output.
236This replaces all hostnames and addresses with hashed representations.
237These hashes may be used normally by
238.Nm ssh
239and
240.Nm sshd ,
241but they do not reveal identifying information should the file's contents
242be disclosed.
243This option will not modify existing hashed hostnames and is therefore safe
244to use on files that mix hashed and non-hashed names.
209.It Fl i 245.It Fl i
210This option will read an unencrypted private (or public) key file 246This option will read an unencrypted private (or public) key file
211in SSH2-compatible format and print an OpenSSH compatible private 247in SSH2-compatible format and print an OpenSSH compatible private
@@ -221,6 +257,13 @@ Private RSA1 keys are also supported.
221For RSA and DSA keys 257For RSA and DSA keys
222.Nm 258.Nm
223tries to find the matching public key file and prints its fingerprint. 259tries to find the matching public key file and prints its fingerprint.
260.It Fl M Ar memory
261Specify the amount of memory to use (in megabytes) when generating
262candidate moduli for DH-GEX.
263.It Fl N Ar new_passphrase
264Provides the new passphrase.
265.It Fl P Ar passphrase
266Provides the (old) passphrase.
224.It Fl p 267.It Fl p
225Requests changing the passphrase of a private key file instead of 268Requests changing the passphrase of a private key file instead of
226creating a new private key. 269creating a new private key.
@@ -233,48 +276,6 @@ Silence
233Used by 276Used by
234.Pa /etc/rc 277.Pa /etc/rc
235when creating a new key. 278when creating a new key.
236.It Fl y
237This option will read a private
238OpenSSH format file and print an OpenSSH public key to stdout.
239.It Fl t Ar type
240Specifies the type of the key to create.
241The possible values are
242.Dq rsa1
243for protocol version 1 and
244.Dq rsa
245or
246.Dq dsa
247for protocol version 2.
248.It Fl B
249Show the bubblebabble digest of specified private or public key file.
250.It Fl C Ar comment
251Provides the new comment.
252.It Fl D Ar reader
253Download the RSA public key stored in the smartcard in
254.Ar reader .
255.It Fl F Ar hostname
256Search for the specified
257.Ar hostname
258in a
259.Pa known_hosts
260file, listing any occurances found.
261This option is useful to find hashed host names or addresses and may also be
262used in conjunction with the
263.Fl H
264option to print found keys in a hashed format.
265.It Fl H
266Hash a
267.Pa known_hosts
268file, printing the result to standard output.
269This replaces all hostnames and addresses with hashed representations.
270These hashes may be used normally by
271.Nm ssh
272and
273.Nm sshd ,
274but they do not reveal identifying information should the file's contents
275be disclosed.
276This option will not modify existing hashed hostnames and is therefore safe
277to use on files that mix hashed and non-hashed names.
278.It Fl R Ar hostname 279.It Fl R Ar hostname
279Removes all keys belonging to 280Removes all keys belonging to
280.Ar hostname 281.Ar hostname
@@ -284,27 +285,25 @@ file.
284This option is useful to delete hashed hosts (see the 285This option is useful to delete hashed hosts (see the
285.Fl H 286.Fl H
286option above). 287option above).
287.It Fl G Ar output_file 288.It Fl r Ar hostname
288Generate candidate primes for DH-GEX. 289Print the SSHFP fingerprint resource record named
289These primes must be screened for 290.Ar hostname
290safety (using the 291for the specified public key file.
291.Fl T
292option) before use.
293.It Fl M Ar memory
294Specify the amount of memory to use (in megabytes) when generating
295candidate moduli for DH-GEX.
296.It Fl N Ar new_passphrase
297Provides the new passphrase.
298.It Fl P Ar passphrase
299Provides the (old) passphrase.
300.It Fl S Ar start 292.It Fl S Ar start
301Specify start point (in hex) when generating candidate moduli for DH-GEX. 293Specify start point (in hex) when generating candidate moduli for DH-GEX.
302.It Fl T Ar output_file 294.It Fl T Ar output_file
303Test DH group exchange candidate primes (generated using the 295Test DH group exchange candidate primes (generated using the
304.Fl G 296.Fl G
305option) for safety. 297option) for safety.
306.It Fl W Ar generator 298.It Fl t Ar type
307Specify desired generator when testing candidate moduli for DH-GEX. 299Specifies the type of key to create.
300The possible values are
301.Dq rsa1
302for protocol version 1 and
303.Dq rsa
304or
305.Dq dsa
306for protocol version 2.
308.It Fl U Ar reader 307.It Fl U Ar reader
309Upload an existing RSA private key into the smartcard in 308Upload an existing RSA private key into the smartcard in
310.Ar reader . 309.Ar reader .
@@ -318,10 +317,11 @@ Multiple
318.Fl v 317.Fl v
319options increase the verbosity. 318options increase the verbosity.
320The maximum is 3. 319The maximum is 3.
321.It Fl r Ar hostname 320.It Fl W Ar generator
322Print the SSHFP fingerprint resource record named 321Specify desired generator when testing candidate moduli for DH-GEX.
323.Ar hostname 322.It Fl y
324for the specified public key file. 323This option will read a private
324OpenSSH format file and print an OpenSSH public key to stdout.
325.El 325.El
326.Sh MODULI GENERATION 326.Sh MODULI GENERATION
327.Nm 327.Nm
@@ -340,7 +340,7 @@ The desired length of the primes may be specified by the
340option. 340option.
341For example: 341For example:
342.Pp 342.Pp
343.Dl ssh-keygen -G moduli-2048.candidates -b 2048 343.Dl # ssh-keygen -G moduli-2048.candidates -b 2048
344.Pp 344.Pp
345By default, the search for primes begins at a random point in the 345By default, the search for primes begins at a random point in the
346desired length range. 346desired length range.
@@ -360,7 +360,7 @@ will read candidates from standard input (or a file specified using the
360option). 360option).
361For example: 361For example:
362.Pp 362.Pp
363.Dl ssh-keygen -T moduli-2048 -f moduli-2048.candidates 363.Dl # ssh-keygen -T moduli-2048 -f moduli-2048.candidates
364.Pp 364.Pp
365By default, each candidate will be subjected to 100 primality tests. 365By default, each candidate will be subjected to 100 primality tests.
366This may be overridden using the 366This may be overridden using the
@@ -371,7 +371,7 @@ prime under consideration.
371If a specific generator is desired, it may be requested using the 371If a specific generator is desired, it may be requested using the
372.Fl W 372.Fl W
373option. 373option.
374Valid generator values are 2, 3 and 5. 374Valid generator values are 2, 3, and 5.
375.Pp 375.Pp
376Screened DH groups may be installed in 376Screened DH groups may be installed in
377.Pa /etc/moduli . 377.Pa /etc/moduli .