summaryrefslogtreecommitdiff
path: root/other/ssharp/ssh-keygen.0
diff options
context:
space:
mode:
Diffstat (limited to 'other/ssharp/ssh-keygen.0')
-rw-r--r--other/ssharp/ssh-keygen.0170
1 files changed, 170 insertions, 0 deletions
diff --git a/other/ssharp/ssh-keygen.0 b/other/ssharp/ssh-keygen.0
new file mode 100644
index 0000000..aa04b02
--- /dev/null
+++ b/other/ssharp/ssh-keygen.0
@@ -0,0 +1,170 @@
1
2SSH-KEYGEN(1) System Reference Manual SSH-KEYGEN(1)
3
4NAME
5 ssh-keygen - authentication key generation, management and conversion
6
7SYNOPSIS
8 ssh-keygen [-q] [-b bits] [-t type] [-N new_passphrase] [-C comment] [-f
9 output_keyfile]
10 ssh-keygen -p [-P old_passphrase] [-N new_passphrase] [-f keyfile]
11 ssh-keygen -i [-f input_keyfile]
12 ssh-keygen -e [-f input_keyfile]
13 ssh-keygen -y [-f input_keyfile]
14 ssh-keygen -c [-P passphrase] [-C comment] [-f keyfile]
15 ssh-keygen -l [-f input_keyfile]
16 ssh-keygen -B [-f input_keyfile]
17
18DESCRIPTION
19 ssh-keygen generates, manages and converts authentication keys for
20 ssh(1). ssh-keygen defaults to generating a RSA1 key for use by SSH proM--
21 tocol version 1. specifying the -t option allows you to create a key for
22 use by SSH protocol version 2.
23
24 Normally each user wishing to use SSH with RSA or DSA authentication runs
25 this once to create the authentication key in $HOME/.ssh/identity,
26 $HOME/.ssh/id_dsa or $HOME/.ssh/id_rsa. Additionally, the system adminisM--
27 trator may use this to generate host keys, as seen in /etc/rc.
28
29 Normally this program generates the key and asks for a file in which to
30 store the private key. The public key is stored in a file with the same
31 name but ``.pub'' appended. The program also asks for a passphrase. The
32 passphrase may be empty to indicate no passphrase (host keys must have an
33 empty passphrase), or it may be a string of arbitrary length. Good
34 passphrases are 10-30 characters long and are not simple sentences or
35 otherwise easily guessable (English prose has only 1-2 bits of entropy
36 per word, and provides very bad passphrases). The passphrase can be
37 changed later by using the -p option.
38
39 There is no way to recover a lost passphrase. If the passphrase is lost
40 or forgotten, you will have to generate a new key and copy the correM--
41 sponding public key to other machines.
42
43 For RSA1 keys, there is also a comment field in the key file that is only
44 for convenience to the user to help identify the key. The comment can
45 tell what the key is for, or whatever is useful. The comment is initialM--
46 ized to ``user@host'' when the key is created, but can be changed using
47 the -c option.
48
49 After a key is generated, instructions below detail where the keys should
50 be placed to be activated.
51
52 The options are as follows:
53
54 -b bits
55 Specifies the number of bits in the key to create. Minimum is
56 512 bits. Generally 1024 bits is considered sufficient, and key
57 sizes above that no longer improve security but make things slowM--
58 er. The default is 1024 bits.
59
60 -c Requests changing the comment in the private and public key
61 files. The program will prompt for the file containing the priM--
62 vate keys, for passphrase if the key has one, and for the new
63 comment.
64
65 -e This option will read a private or public OpenSSH key file and
66 print the key in a `SECSH Public Key File Format' to stdout.
67 This option allows exporting keys for use by several commercial
68 SSH implementations.
69
70 -f Specifies the filename of the key file.
71
72 -i This option will read an unencrypted private (or public) key file
73 in SSH2-compatible format and print an OpenSSH compatible private
74 (or public) key to stdout. ssh-keygen also reads the `SECSH
75 Public Key File Format'. This option allows importing keys from
76 several commercial SSH implementations.
77
78 -l Show fingerprint of specified private or public key file.
79
80 -p Requests changing the passphrase of a private key file instead of
81 creating a new private key. The program will prompt for the file
82 containing the private key, for the old passphrase, and twice for
83 the new passphrase.
84
85 -q Silence ssh-keygen. Used by /etc/rc when creating a new key.
86
87 -y This option will read a private OpenSSH format file and print an
88 OpenSSH public key to stdout.
89
90 -t type
91 Specifies the type of the key to create. The possible values are
92 ``rsa1'' for protocol version 1 and ``rsa'' or ``dsa'' for protoM--
93 col version 2. The default is ``rsa1''.
94
95 -B Show the bubblebabble digest of specified private or public key
96 file.
97
98 -C comment
99 Provides the new comment.
100
101 -N new_passphrase
102 Provides the new passphrase.
103
104 -P passphrase
105 Provides the (old) passphrase.
106
107FILES
108 $HOME/.ssh/identity
109 Contains the protocol version 1 RSA authentication identity of
110 the user. This file should not be readable by anyone but the usM--
111 er. It is possible to specify a passphrase when generating the
112 key; that passphrase will be used to encrypt the private part of
113 this file using 3DES. This file is not automatically accessed by
114 ssh-keygen but it is offered as the default file for the private
115 key. sshd(8) will read this file when a login attempt is made.
116
117 $HOME/.ssh/identity.pub
118 Contains the protocol version 1 RSA public key for authenticaM--
119 tion. The contents of this file should be added to
120 $HOME/.ssh/authorized_keys on all machines where you wish to log
121 in using RSA authentication. There is no need to keep the conM--
122 tents of this file secret.
123
124 $HOME/.ssh/id_dsa
125 Contains the protocol version 2 DSA authentication identity of
126 the user. This file should not be readable by anyone but the usM--
127 er. It is possible to specify a passphrase when generating the
128 key; that passphrase will be used to encrypt the private part of
129 this file using 3DES. This file is not automatically accessed by
130 ssh-keygen but it is offered as the default file for the private
131
132 key. sshd(8) will read this file when a login attempt is made.
133
134 $HOME/.ssh/id_dsa.pub
135 Contains the protocol version 2 DSA public key for authenticaM--
136 tion. The contents of this file should be added to
137 $HOME/.ssh/authorized_keys2 on all machines where you wish to log
138 in using public key authentication. There is no need to keep the
139 contents of this file secret.
140
141 $HOME/.ssh/id_rsa
142 Contains the protocol version 2 RSA authentication identity of
143 the user. This file should not be readable by anyone but the usM--
144 er. It is possible to specify a passphrase when generating the
145 key; that passphrase will be used to encrypt the private part of
146 this file using 3DES. This file is not automatically accessed by
147 ssh-keygen but it is offered as the default file for the private
148 key. sshd(8) will read this file when a login attempt is made.
149
150 $HOME/.ssh/id_rsa.pub
151 Contains the protocol version 2 RSA public key for authenticaM--
152 tion. The contents of this file should be added to
153 $HOME/.ssh/authorized_keys2 on all machines where you wish to log
154 in using public key authentication. There is no need to keep the
155 contents of this file secret.
156
157AUTHORS
158 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
159 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo
160 de Raadt and Dug Song removed many bugs, re-added newer features and creM--
161 ated OpenSSH. Markus Friedl contributed the support for SSH protocol
162 versions 1.5 and 2.0.
163
164SEE ALSO
165 ssh(1), ssh-add(1), ssh-agent(1), sshd(8)
166
167 J. Galbraith, and R. Thayer, SECSH Public Key File Format, draft-ietf-
168 secsh-publickeyfile-01.txt, March 2001, work in progress material.
169
170BSD Experimental September 25, 1999 3