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