diff options
author | Colin Watson <cjwatson@debian.org> | 2003-09-01 18:33:32 +0000 |
---|---|---|
committer | Colin Watson <cjwatson@debian.org> | 2003-09-01 18:33:32 +0000 |
commit | 58bfa257481a1c6938ada9bbd38801cc45633fb0 (patch) | |
tree | 385160ff5c19376a1e1bfd34fcf5c91cff42908e /ssh-keygen.0 | |
parent | ae225aa5594655e3fa5685b4dd7f2ae0e1a5e2d7 (diff) | |
parent | 58657d96514cd6f16d82add8d6f4adbb36765758 (diff) |
Import OpenSSH 3.6p1.
Diffstat (limited to 'ssh-keygen.0')
-rw-r--r-- | ssh-keygen.0 | 182 |
1 files changed, 182 insertions, 0 deletions
diff --git a/ssh-keygen.0 b/ssh-keygen.0 new file mode 100644 index 000000000..2e151a95c --- /dev/null +++ b/ssh-keygen.0 | |||
@@ -0,0 +1,182 @@ | |||
1 | SSHM-bM-^@M-^PKEYGEN(1) BSD General Commands Manual SSHM-bM-^@M-^PKEYGEN(1) | ||
2 | |||
3 | ^[[1mNAME^[[0m | ||
4 | ^[[1msshM-bM-^@M-^Pkeygen ^[[22mM-bMM-^R authentication key generation, management and conversion | ||
5 | |||
6 | ^[[1mSYNOPSIS^[[0m | ||
7 | ^[[1msshM-bM-^@M-^Pkeygen ^[[22m[^[[1mM-bMM-^Rq^[[22m] [^[[1mM-bMM-^Rb ^[[4m^[[22mbits^[[24m] ^[[1mM-bMM-^Rt ^[[4m^[[22mtype^[[24m [^[[1mM-bMM-^RN ^[[4m^[[22mnew_passphrase^[[24m] [^[[1mM-bMM-^RC ^[[4m^[[22mcomment^[[24m] | ||
8 | [^[[1mM-bMM-^Rf ^[[4m^[[22moutput_keyfile^[[24m] | ||
9 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^Rp ^[[22m[^[[1mM-bMM-^RP ^[[4m^[[22mold_passphrase^[[24m] [^[[1mM-bMM-^RN ^[[4m^[[22mnew_passphrase^[[24m] [^[[1mM-bMM-^Rf ^[[4m^[[22mkeyfile^[[24m] | ||
10 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^Ri ^[[22m[^[[1mM-bMM-^Rf ^[[4m^[[22minput_keyfile^[[24m] | ||
11 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^Re ^[[22m[^[[1mM-bMM-^Rf ^[[4m^[[22minput_keyfile^[[24m] | ||
12 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^Ry ^[[22m[^[[1mM-bMM-^Rf ^[[4m^[[22minput_keyfile^[[24m] | ||
13 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^Rc ^[[22m[^[[1mM-bMM-^RP ^[[4m^[[22mpassphrase^[[24m] [^[[1mM-bMM-^RC ^[[4m^[[22mcomment^[[24m] [^[[1mM-bMM-^Rf ^[[4m^[[22mkeyfile^[[24m] | ||
14 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^Rl ^[[22m[^[[1mM-bMM-^Rf ^[[4m^[[22minput_keyfile^[[24m] | ||
15 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^RB ^[[22m[^[[1mM-bMM-^Rf ^[[4m^[[22minput_keyfile^[[24m] | ||
16 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^RD ^[[4m^[[22mreader^[[0m | ||
17 | ^[[1msshM-bM-^@M-^Pkeygen M-bMM-^RU ^[[4m^[[22mreader^[[24m [^[[1mM-bMM-^Rf ^[[4m^[[22minput_keyfile^[[24m] | ||
18 | |||
19 | ^[[1mDESCRIPTION^[[0m | ||
20 | ^[[1msshM-bM-^@M-^Pkeygen ^[[22mgenerates, manages and converts authentication keys for | ||
21 | ssh(1). ^[[1msshM-bM-^@M-^Pkeygen ^[[22mcan create RSA keys for use by SSH protocol version 1 | ||
22 | and RSA or DSA keys for use by SSH protocol version 2. The type of key to | ||
23 | be generated is specified with the ^[[1mM-bMM-^Rt ^[[22moption. | ||
24 | |||
25 | Normally each user wishing to use SSH with RSA or DSA authentication runs | ||
26 | this once to create the authentication key in ^[[4m$HOME/.ssh/identity^[[24m, | ||
27 | ^[[4m$HOME/.ssh/id_dsa^[[24m or ^[[4m$HOME/.ssh/id_rsa^[[24m. Additionally, the system adminM-bM-^@M-^P | ||
28 | istrator may use this to generate host keys, as seen in ^[[4m/etc/rc^[[24m. | ||
29 | |||
30 | Normally this program generates the key and asks for a file in which to | ||
31 | store the private key. The public key is stored in a file with the same | ||
32 | name but M-bM-^@M-^\.pubM-bM-^@M-^] appended. The program also asks for a passphrase. The | ||
33 | passphrase may be empty to indicate no passphrase (host keys must have an | ||
34 | empty passphrase), or it may be a string of arbitrary length. A | ||
35 | passphrase is similar to a password, except it can be a phrase with a | ||
36 | series of words, punctuation, numbers, whitespace, or any string of charM-bM-^@M-^P | ||
37 | acters you want. Good passphrases are 10M-bM-^@M-^P30 characters long, are not | ||
38 | simple sentences or otherwise easily guessable (English prose has only | ||
39 | 1M-bM-^@M-^P2 bits of entropy per character, and provides very bad passphrases), | ||
40 | and contain a mix of upper and lowercase letters, numbers, and nonM-bM-^@M-^P | ||
41 | alphanumeric characters. The passphrase can be changed later by using | ||
42 | the ^[[1mM-bMM-^Rp ^[[22moption. | ||
43 | |||
44 | There is no way to recover a lost passphrase. If the passphrase is lost | ||
45 | or forgotten, a new key must be generated and copied to the corresponding | ||
46 | public key to other machines. | ||
47 | |||
48 | For RSA1 keys, there is also a comment field in the key file that is only | ||
49 | for convenience to the user to help identify the key. The comment can | ||
50 | tell what the key is for, or whatever is useful. The comment is initialM-bM-^@M-^P | ||
51 | ized to M-bM-^@M-^\user@hostM-bM-^@M-^] when the key is created, but can be changed using the | ||
52 | ^[[1mM-bMM-^Rc ^[[22moption. | ||
53 | |||
54 | After a key is generated, instructions below detail where the keys should | ||
55 | be placed to be activated. | ||
56 | |||
57 | The options are as follows: | ||
58 | |||
59 | ^[[1mM-bMM-^Rb ^[[4m^[[22mbits^[[0m | ||
60 | Specifies the number of bits in the key to create. Minimum is | ||
61 | 512 bits. Generally, 1024 bits is considered sufficient. The | ||
62 | default is 1024 bits. | ||
63 | |||
64 | ^[[1mM-bMM-^Rc ^[[22mRequests changing the comment in the private and public key | ||
65 | files. This operation is only supported for RSA1 keys. The proM-bM-^@M-^P | ||
66 | gram will prompt for the file containing the private keys, for | ||
67 | the passphrase if the key has one, and for the new comment. | ||
68 | |||
69 | ^[[1mM-bMM-^Re ^[[22mThis option will read a private or public OpenSSH key file and | ||
70 | print the key in a M-bM-^@M-^XSECSH Public Key File FormatM-bM-^@M-^Y to stdout. | ||
71 | This option allows exporting keys for use by several commercial | ||
72 | SSH implementations. | ||
73 | |||
74 | ^[[1mM-bMM-^Rf ^[[4m^[[22mfilename^[[0m | ||
75 | Specifies the filename of the key file. | ||
76 | |||
77 | ^[[1mM-bMM-^Ri ^[[22mThis option will read an unencrypted private (or public) key file | ||
78 | in SSH2M-bM-^@M-^Pcompatible format and print an OpenSSH compatible private | ||
79 | (or public) key to stdout. ^[[1msshM-bM-^@M-^Pkeygen ^[[22malso reads the M-bM-^@M-^XSECSH | ||
80 | Public Key File FormatM-bM-^@M-^Y. This option allows importing keys from | ||
81 | several commercial SSH implementations. | ||
82 | |||
83 | ^[[1mM-bMM-^Rl ^[[22mShow fingerprint of specified public key file. Private RSA1 keys | ||
84 | are also supported. For RSA and DSA keys ^[[1msshM-bM-^@M-^Pkeygen ^[[22mtries to | ||
85 | find the matching public key file and prints its fingerprint. | ||
86 | |||
87 | ^[[1mM-bMM-^Rp ^[[22mRequests changing the passphrase of a private key file instead of | ||
88 | creating a new private key. The program will prompt for the file | ||
89 | containing the private key, for the old passphrase, and twice for | ||
90 | the new passphrase. | ||
91 | |||
92 | ^[[1mM-bMM-^Rq ^[[22mSilence ^[[1msshM-bM-^@M-^Pkeygen^[[22m. Used by ^[[4m/etc/rc^[[24m when creating a new key. | ||
93 | |||
94 | ^[[1mM-bMM-^Ry ^[[22mThis option will read a private OpenSSH format file and print an | ||
95 | OpenSSH public key to stdout. | ||
96 | |||
97 | ^[[1mM-bMM-^Rt ^[[4m^[[22mtype^[[0m | ||
98 | Specifies the type of the key to create. The possible values are | ||
99 | M-bM-^@M-^\rsa1M-bM-^@M-^] for protocol version 1 and M-bM-^@M-^\rsaM-bM-^@M-^] or M-bM-^@M-^\dsaM-bM-^@M-^] for protocol | ||
100 | version 2. | ||
101 | |||
102 | ^[[1mM-bMM-^RB ^[[22mShow the bubblebabble digest of specified private or public key | ||
103 | file. | ||
104 | |||
105 | ^[[1mM-bMM-^RC ^[[4m^[[22mcomment^[[0m | ||
106 | Provides the new comment. | ||
107 | |||
108 | ^[[1mM-bMM-^RD ^[[4m^[[22mreader^[[0m | ||
109 | Download the RSA public key stored in the smartcard in ^[[4mreader^[[24m. | ||
110 | |||
111 | ^[[1mM-bMM-^RN ^[[4m^[[22mnew_passphrase^[[0m | ||
112 | Provides the new passphrase. | ||
113 | |||
114 | ^[[1mM-bMM-^RP ^[[4m^[[22mpassphrase^[[0m | ||
115 | Provides the (old) passphrase. | ||
116 | |||
117 | ^[[1mM-bMM-^RU ^[[4m^[[22mreader^[[0m | ||
118 | Upload an existing RSA private key into the smartcard in ^[[4mreader^[[24m. | ||
119 | |||
120 | ^[[1mFILES^[[0m | ||
121 | $HOME/.ssh/identity | ||
122 | Contains the protocol version 1 RSA authentication identity of | ||
123 | the user. This file should not be readable by anyone but the | ||
124 | user. It is possible to specify a passphrase when generating the | ||
125 | key; that passphrase will be used to encrypt the private part of | ||
126 | this file using 3DES. This file is not automatically accessed by | ||
127 | ^[[1msshM-bM-^@M-^Pkeygen ^[[22mbut it is offered as the default file for the private | ||
128 | key. ssh(1) will read this file when a login attempt is made. | ||
129 | |||
130 | $HOME/.ssh/identity.pub | ||
131 | Contains the protocol version 1 RSA public key for authenticaM-bM-^@M-^P | ||
132 | tion. The contents of this file should be added to | ||
133 | ^[[4m$HOME/.ssh/authorized_keys^[[24m on all machines where the user wishes | ||
134 | to log in using RSA authentication. There is no need to keep the | ||
135 | contents of this file secret. | ||
136 | |||
137 | $HOME/.ssh/id_dsa | ||
138 | Contains the protocol version 2 DSA authentication identity of | ||
139 | the user. This file should not be readable by anyone but the | ||
140 | user. It is possible to specify a passphrase when generating the | ||
141 | key; that passphrase will be used to encrypt the private part of | ||
142 | this file using 3DES. This file is not automatically accessed by | ||
143 | ^[[1msshM-bM-^@M-^Pkeygen ^[[22mbut it is offered as the default file for the private | ||
144 | key. ssh(1) will read this file when a login attempt is made. | ||
145 | |||
146 | $HOME/.ssh/id_dsa.pub | ||
147 | Contains the protocol version 2 DSA public key for authenticaM-bM-^@M-^P | ||
148 | tion. The contents of this file should be added to | ||
149 | ^[[4m$HOME/.ssh/authorized_keys^[[24m on all machines where the user wishes | ||
150 | to log in using public key authentication. There is no need to | ||
151 | keep the contents of this file secret. | ||
152 | |||
153 | $HOME/.ssh/id_rsa | ||
154 | Contains the protocol version 2 RSA authentication identity of | ||
155 | the user. This file should not be readable by anyone but the | ||
156 | user. It is possible to specify a passphrase when generating the | ||
157 | key; that passphrase will be used to encrypt the private part of | ||
158 | this file using 3DES. This file is not automatically accessed by | ||
159 | ^[[1msshM-bM-^@M-^Pkeygen ^[[22mbut it is offered as the default file for the private | ||
160 | key. ssh(1) will read this file when a login attempt is made. | ||
161 | |||
162 | $HOME/.ssh/id_rsa.pub | ||
163 | Contains the protocol version 2 RSA public key for authenticaM-bM-^@M-^P | ||
164 | tion. The contents of this file should be added to | ||
165 | ^[[4m$HOME/.ssh/authorized_keys^[[24m on all machines where the user wishes | ||
166 | to log in using public key authentication. There is no need to | ||
167 | keep the contents of this file secret. | ||
168 | |||
169 | ^[[1mAUTHORS^[[0m | ||
170 | OpenSSH is a derivative of the original and free ssh 1.2.12 release by | ||
171 | Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo | ||
172 | de Raadt and Dug Song removed many bugs, reM-bM-^@M-^Padded newer features and creM-bM-^@M-^P | ||
173 | ated OpenSSH. Markus Friedl contributed the support for SSH protocol | ||
174 | versions 1.5 and 2.0. | ||
175 | |||
176 | ^[[1mSEE ALSO^[[0m | ||
177 | ssh(1), sshM-bM-^@M-^Padd(1), sshM-bM-^@M-^Pagent(1), sshd(8) | ||
178 | |||
179 | J. Galbraith and R. Thayer, ^[[4mSECSH^[[24m ^[[4mPublic^[[24m ^[[4mKey^[[24m ^[[4mFile^[[24m ^[[4mFormat^[[24m, draftM-bM-^@M-^PietfM-bM-^@M-^P | ||
180 | secshM-bM-^@M-^PpublickeyfileM-bM-^@M-^P01.txt, March 2001, work in progress material. | ||
181 | |||
182 | BSD September 25, 1999 BSD | ||