edit-key is now complete
[gnupg.git] / README
1                   GNUPG - The GNU Privacy Guard
2                  -------------------------------
3                           Version 0.3
4
5
6     As you can see from the version number, the program may have some
7     bugs and some features may not work at all - please report this to
8     the mailing list.
9
10     On a Linux box (version 2.x.x, alpha or x86 CPU) it should
11     work reliably.  You may create your key on such a machine and
12     use it.  Please verify the tar file; there is a PGP and a GNUPG
13     signature available. My PGP 2 key is well known and published in
14     the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
15
16     I have included my pubring as "g10/pubring.asc", which contains
17     the key used to make GNUPG signatures:
18     "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
19     "Key fingerprint = 6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
20
21     Old version of gnupg are signed with this key:
22     "pub  1312G/FF3EAA0B 1998-02-09 Werner Koch <wk@isil.d.shuttle.de>"
23     "Key fingerprint = 8489 6CD0 1851 0E33 45DA  CD67 036F 11B8 FF3E AA0B"
24
25     My standard key is now:
26     "pub  1024D/621CC013 1998-07-07 Werner Koch <werner.koch@guug.de>"
27     "Key fingerprint = ECAF 7590 EB34 43B5 C7CF  3ACB 6C7E E1B8 621C C013"
28
29     You may add it to your GNUPG pubring and use it in the future to
30     verify new releases.  Because you verified this README file and
31     _checked_that_it_is_really_my PGP2 key 0C9857A5, you can be sure
32     that the above fingerprints are correct.
33
34     Please subscribe to g10@net.lut.ac.uk by sending a mail with
35     the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
36     This mailing is closed (only subscribers can post) to avoid spam.
37
38     See the file COPYING for copyright and warranty information.
39
40     Due to the fact that GNUPG does not use use any patented algorithm,
41     it cannot be compatible with old PGP versions, because those use
42     IDEA (which is patented worldwide) and RSA (which is patented in
43     the United States until Sep 20, 2000).
44
45     GNUPG is in most aspects compatible with other OpenPGP implementations.
46
47     The default algorithms are now DSA and ELGamal.  ELGamal for signing
48     is still available, but due to the larger size of such signatures it
49     is depreciated (Please note that the GNUPG implementation of ElGamal
50     signatures is *not* insecure).  Symmetric algorithms are: Blowfish
51     and CAST5,  Digest algorithms are MD5, RIPEMD160, SHA1 and TIGER/192.
52
53
54
55     Installation
56     ------------
57
58     See the file INSTALL.  Here is a quick summary:
59
60     1)  "./configure"
61
62     2) "make"
63
64     3) "make install"
65
66     4) You end up with a binary "gpg" in /usr/local/bin
67
68     5) Optional, but suggested: install the program "gpg" as suid root.
69
70
71
72     Key Generation
73     --------------
74
75         gpg --gen-key
76
77     This asks some questions and then starts key generation. To create
78     good random numbers for prime number generation, it uses a /dev/random
79     which will only emit bytes if the kernel can gather enough entropy.
80     If you see no progress, you should start some other activities such
81     as mouse moves, "find /" or using the keyboard (in another window).
82     Because we have no hardware device to generate randomness we have to
83     use this method.
84
85     You should make a revocation certificate in case someone gets
86     knowledge of your secret key or you forgot your passphrase:
87
88         gpg --gen-revoke your_user_id
89
90     Run this command and store it away; output is always ASCII armored,
91     so that you can print it and (hopefully never) re-create it if
92     your electronic media fails.
93
94     If you decided to create a DSA key, you should add an ElGamal
95     for encryption:
96
97         gpg --add-key user_id_of_your_key
98
99     and follow the displayed instructions (select "ElGamal using v4 packets").
100
101
102     You can sign a key with this command:
103
104         gpg --sign-key Donald
105
106     This let you sign the key of "Donald" with your default userid.
107
108         gpg --sign-key -u Karl -u Joe Donald
109
110     This let you sign the key of of "Donald" with the userids of "Karl"
111     and "Joe".
112     All existing signatures are checked; if some are invalid, a menu is
113     offered to delete some of them, and then you are asked for every user
114     whether you want to sign this key.
115
116     You may remove a signature at any time using the option "--edit-sig",
117     which asks for the sigs to remove.  Self-signatures are not removable.
118
119
120
121
122     Sign
123     ----
124
125         gpg -s file
126
127     This creates a file file.gpg which is compressed and has a signature
128     attached.
129
130         gpg -sa file
131
132     Same as above, but file.gpg is ascii armored.
133
134         gpg -s -o out file
135
136     Creates a signature of file, but writes the output to the file "out".
137
138     If you use the option "--rfc1991", gnupg tries to me more compatible
139     to RFC1991 (pgp 2.x).
140
141
142     Encrypt
143     -------
144
145         gpg -e -r heine file
146
147     This encrypts files with the public key of "heine" and writes it
148     to "file.gpg"
149
150         echo "hallo" | gpg -ea -r heine | mail heine
151
152     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
153
154
155     Sign and Encrypt
156     ----------------
157
158         gpg -se -r heine file
159
160     This encrypts files with the public key of "heine" and writes it
161     to "file.gpg" after signing it with the default user id.
162
163
164         gpg -se -r heine -u Suttner file
165
166     Ditto, but sign the file with the user id "Suttner"
167
168
169     Keyring Management
170     ------------------
171     To export your complete keyring(s) do this:
172
173         gpg --export
174
175     To export only some user ids do this:
176
177         gpg --export userids
178
179     Use "-a" or "--armor" to create ASCII armored output.
180
181     Importing keys is done with the option, you guessed it, "--import":
182
183         gpg --import [filenames]
184
185     New keys are appended to the default keyring and already existing
186     keys are merged.  Keys without a self-signature are ignored.
187
188
189     How to Specify a UserID
190     -----------------------
191     There are several ways to specify a userID, here are some examples:
192
193     * Only by the short keyid (prepend a zero if it begins with A..F):
194
195         "234567C4"
196         "0F34E556E"
197         "01347A56A"
198         "0xAB123456
199
200     * By a complete keyid:
201
202         "234AABBCC34567C4"
203         "0F323456784E56EAB"
204         "01AB3FED1347A5612"
205         "0x234AABBCC34567C4"
206
207     * By a fingerprint:
208
209         "1234343434343434C434343434343434"
210         "123434343434343C3434343434343734349A3434"
211         "0E12343434343434343434EAB3484343434343434"
212
213       The first one is MD5 the others are ripemd160 or sha1.
214
215     * By an exact string (not yet implemented):
216
217         "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
218
219     * By an email address:
220
221         "<heinrichh@uni-duesseldorf.de>"
222
223       This can be used by a keyserver instead of a substring to
224       find this key faster.
225
226     * By the Local ID (from the trustdb):
227
228         "#34"
229
230       This can be used by a MUA to specify an exact key after selecting
231       a key from GNUPG (by the use of a special option or an extra utility)
232
233
234     * Or by the usual substring:
235
236         "Heine"
237         "*Heine"
238
239       The '*' indicates substring search explicitly.
240
241
242
243
244     Batch mode
245     ----------
246     If you use the option "--batch", GNUPG runs in non-interactive mode and
247     never prompts for input data.  This does not even allow entering the
248     passphrase; until we have a better solution (something like ssh-agent),
249     you can use the option "--passhrase-fd n", which works like PGPs
250     PGPPASSFD.
251
252     Batch mode also causes GNUPG to terminate as soon as a BAD signature is
253     detected.
254
255
256     Exit status
257     -----------
258     GNUPG returns with an exit status of 1 if in batch mode and a bad signature
259     has been detected or 2 or higher for all other errors.  You should parse
260     stderr or the output of the fd specified with --status-fd to get detailed
261     information about the errors.
262
263
264     Esoteric commands
265     -----------------
266
267         gpg --list-packets datafile
268
269     Use this to list the contents of a data file. If the file is encrypted
270     you are asked for the passphrase, so that GNUPG is able to look at the
271     inner structure of a encrypted packet.
272
273         gpgm --list-trustdb
274
275     List the contents of the trustdb in a human readable format
276
277         gpgm --list-trustdb  <usernames>
278
279     List the tree of certificates for the given usernames
280
281         gpgm --list-trust-path  depth  username
282
283     List the possible trust paths for the given username, up to the specified
284     depth.  If depth is negative, duplicate introducers are not listed,
285     because those would increase the trust probability only minimally.
286     (you must use the special option "--" to stop option parsing when
287      using a negative number). This option may create new entries in the
288     trustdb.
289
290         gpgm --print-mds  filenames
291
292     List all available message digest values for the fiven filenames
293
294     For more options/commands see the file g10/OPTIONS, or use "gpg --help"
295
296
297     Debug Flags
298     -----------
299     Use the option "--debug n" to output debug information. This option
300     can be used multiple times, all values are ORed; n maybe prefixed with
301     0x to use hex-values.
302
303          value  used for
304          -----  ----------------------------------------------
305           1     packet reading/writing
306           2     MPI details
307           4     ciphers and primes (may reveal sensitive data)
308           8     iobuf filter functions
309           16    iobuf stuff
310           32    memory allocation stuff
311           64    caching
312           128   show memory statistics at exit
313           256   trust verification stuff
314
315
316     Other Notes
317     -----------
318     This is work in progress, so you may find duplicated code fragments,
319     ugly data structures, weird usage of filenames and other things.
320
321     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
322     The primary WWW page is "http://www.d.shuttle.de/isil/crypt/gnupg.html"
323
324     If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
325     "gpg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
326
327     Please direct bug reports to <gnupg-bugs@gnu.org> or better
328     post them to the mailing list <g10@net.lut.ac.uk> (this is a closed list,
329     please subscribe before posting).
330