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