release 0.2.9
[libgcrypt.git] / README
1
2                   GNUPG - The GNU Privacy Guard
3                  -------------------------------
4
5     THIS IS ALPHA SOFTWARE, EXPECT BUGS AND UNIMPLEMENTED STUFF.
6     IT MAY HAPPEN THAT SOME DATA FORMATS OR PROGRAMM OPTIONS
7     CHANGE WITH THE NEXT VERSION.
8
9     On a Linux box (version 2.x.x, alpha or x86 CPU) it should
10     work reliable. You may create your key on such a machine and
11     use it.  Please verify the tar file; there is a PGP and a GNUPG
12     signature available. My PGP key is well known and published in
13     the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
14
15     I have included my pubring as "g10/pubring.asc", which contains
16     the key used to make GNUPG signatures:
17     "pub  1312G/FF3EAA0B 1998-02-09 Werner Koch <wk@isil.d.shuttle.de>"
18     "Key fingerprint = 8489 6CD0 1851 0E33 45DA  CD67 036F 11B8 FF3E AA0B"
19
20     You may add it to your GNUPG pubring and use it in the future to
21     verify new releases.  Because you verified the tar file containing
22     this file here, you can be sure that the above fingerprint is correct.
23
24
25     Please subscribe to g10@net.lut.ac.uk by sending a mail with
26     the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
27
28     See the file COPYING for copyright and warranty information.
29
30     Due to the fact that GNUPG does not use use any patented algorithm,
31     it cannot be compatible to old PGP versions, because those use
32     IDEA (which is worldwide patented) and RSA (which is patented in
33     the United States until Sep 20, 2000).  I'm sorry about this, but
34     this is the world we have created (e.g. by using proprietary software).
35
36
37     Because the OpenPGP standard is still a draft, GNUPG is not yet
38     compatible to it (or PGP 5) - but it will.  The data structures
39     used are compatible with PGP 2.x, so it can parse an list such files
40     and PGP should be able to parse data created by GNUPG and complain
41     about unsupported algorithms.
42
43     The default algorithms used by GNUPG are ElGamal for public-key
44     encryption and signing; Blowfish with a 160 bit key for protecting
45     the secret-key components, conventional and session encryption;
46     RIPE MD-160 to create message digest.  DSA, SHA-1 and CAST are
47     also implemented, but not used on default.  I decided not
48     to use DSA as default signing algorithm, because it allows only for
49     1024 bit keys and this may be not enough in a couple of years.
50
51
52
53     Installation
54     ------------
55
56     See the file INSTALL.  Here is a quick summary:
57
58     1)  "./configure"
59
60     2) "make"
61
62     3) "make install"
63
64     4) You end up with a binary "gpg" in /usr/local/bin
65
66     5) Optional, but suggested: install the program "gpg" as suid root.
67
68
69
70     Key Generation
71     --------------
72
73         gpg --gen-key
74
75     This asks some questions and then starts key generation. To create
76     good random numbers for prime number generation, it uses a /dev/random
77     which will emit only bytes if the kernel can gather enough entropy.
78     If you see no progress, you should start some other activities such
79     as mouse moves, "find /" or using the keyboard (on another window).
80     Because we have no hardware device to generate random we have to use
81     this method.
82
83     Key generation shows progress by printing different characters to
84     stderr:
85              "."  Last 10 Miller-Rabin tests failed.
86              "+"  Miller-Rabin test succeeded.
87              "!"  Reloading the pool with fresh prime numbers
88              "^"  Checking a new value for the generator
89              "<"  Size of one factor decreased
90              ">"  Size of one factor increased
91
92     The prime number for ElGamal is generated this way:
93
94     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
95     2) Select the length of the other prime factors to be at least the size
96        of q and calculate the number of prime factors needed
97     3) Make a pool of prime number, each of the length determined in step 2
98     4) Get a new permutation out of the pool or continue with step 3
99        if we have tested all permutations.
100     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
101     6) Check that this prime has the correct length (this may change q if
102        it seems not to be possible to make a prime of the desired length)
103     7) Check whether this is a prime using trial divisions and the
104        Miller-Rabin test.
105     8) Continue with step 4 if we did not find a prime in step 7.
106     9) Find a generator for that prime.
107
108     You should make a revocation certificate in cases someone gets
109     knowledge of your secret key or you forgot your passphrase:
110
111         gpg --gen-revoke your_user_id
112
113     Run this command and store it away; output is always ASCII armored,
114     so that you can print it and (hopefully never) re-create it if
115     your electronic media fails.
116
117
118     You can sign a key with this command:
119
120         gpg --sign-key Donald
121
122     This let you sign the key of "Donald" with your default userid.
123
124         gpg --sign-key -u Karl -u Joe Donald
125
126     This let you sign the key of of "Donald" with the userids of "Karl"
127     and "Joe".
128     All existing signatures are checked, if some are invalid, a menu is
129     offered to delete some of them, and the you are asked for every user
130     wether you want to sign this key.
131
132     You may remove a signature at any time using the option "--edit-sig",
133     which asks for the sigs to remove. Self-signatures are not removable.
134
135
136
137
138     Sign
139     ----
140
141         gpg -s file
142
143     This creates a file file.gpg which is compressed and has a signature
144     attached.
145
146         gpg -sa file
147
148     Same as above, but file.gpg is ascii armored.
149
150         gpg -s -o out file
151
152     Creates a signature of file, but writes the output to the file "out".
153
154
155     Encrypt
156     -------
157
158         gpg -e -r heine file
159
160     This encrypts files with the public key of "heine" and writes it
161     to "file.gpg"
162
163         echo "hallo" | gpg -ea -r heine | mail heine
164
165     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
166
167
168     Sign and Encrypt
169     ----------------
170
171         gpg -se -r heine file
172
173     This encrypts files with the public key of "heine" and writes it
174     to "file.gpg" after signing it with the default user id.
175
176
177         gpg -se -r heine -u Suttner file
178
179     Ditto, but sign the file with the user id "Suttner"
180
181
182     Keyring Management
183     ------------------
184     To export your complete keyring(s) do this:
185
186         gpg --export
187
188     To export only some user ids do this:
189
190         gpg --export userids
191
192     Use "-a" or "--armor" to create ASCII armored output.
193
194     Importing keys is done with the option, you guessed it, "--import":
195
196         gpg --import [filenames]
197
198     New keys are appended to the default keyring and already existing
199     keys are merged.  Keys without a self-signature are ignored.
200
201
202     How to Specify a UserID
203     -----------------------
204     There are several ways to specify a userID, here are some examples:
205
206     * Only by the short keyid (prepend a zero if it begins with A..F):
207
208         "234567C4"
209         "0F34E556E"
210         "01347A56A"
211
212     * By a complete keyid:
213
214         "234AABBCC34567C4"
215         "0F323456784E56EAB"
216         "01AB3FED1347A5612"
217
218     * By a fingerprint (not yet implemented):
219
220         "1234343434343434C434343434343434"
221         "123434343434343C3434343434343734349A3434"
222         "0E12343434343434343434EAB3484343434343434"
223
224       The first one is MD5 the others are ripemd160 or sha1.
225
226     * By an exact string (not yet implemented):
227
228         "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
229
230     * By an email address:
231
232         "<heinrichh@uni-duesseldorf.de>"
233
234       This can be used by a keyserver instead of a substring to
235       find this key faster.
236
237     * By the Local ID (from the trustdb):
238
239         "#34"
240
241       This can be used by a MUA to specify an exact key after selecting
242       a key from GNUPG (by the use of a special option or an extra utility)
243
244
245     * Or by the usual substring:
246
247         "Heine"
248         "*Heine"
249
250       The '*' indicates substring search explicitly.
251
252
253
254
255     Batch mode
256     ----------
257     If you use the option "--batch", GNUPG runs in non-interactive mode and
258     never prompts for input data.  This even does not allow to enter
259     passphrase; until we have a better solution (something like ssh-agent),
260     you can use the option "--passhrase-fd n", which works like PGPs
261     PGPPASSFD.
262
263     Batch mode also causes GNUPG to terminate as soon as a BAD signature is
264     detected.
265
266
267     Exit status
268     -----------
269     GNUPG returns with an exit status of 1 if in batch mode and a bad signature
270     has been detected or 2 or higher for all other errors.  You should parse
271     stderr to get detailed informations about the errors.
272
273
274     Esoteric commands
275     -----------------
276
277         gpg --list-packets datafile
278
279     Use this to list the contents of a data file. If the file is encrypted
280     you are asked for the passphrase, so that GNUPG is able to look at the
281     inner structure of a encrypted packet.
282
283         gpgm --quick-random
284
285     Do not use the stroing random generator but a faster one.  This can be
286     used to generate keys for tests; those are marked as insecure.
287
288         gpgm --list-trustdb
289
290     List the contents of the trustdb in a human readable format
291
292         gpgm --list-trustdb  <usernames>
293
294     List the tree of certificates for the given usernames
295
296         gpgm --list-trust-path  depth  username
297
298     List the possible trust paths for the given username, up to the specified
299     depth.  If depth is negative, duplicate introducers are not listed,
300     because those would increase the trust probabilty only minimal.
301     (you must use the special option "--" to stop option parsing when
302      using a negative number). This option may create new entries in the
303     trustdb.
304
305         gpgm --print-mds  filenames
306
307     List all available message digest values for the fiven filenames
308
309         gpgm --gen-prime n
310
311     Generate and print a simple prime number of size n
312
313         gpgm --gen-prime n q
314
315     Generate a prime number suitable for ElGamal signatures of size n with
316     a q as largest primefactor of n-1.
317
318         gpgm --gen-prime n q 1
319
320     Ditto, but calculate a generator too.
321
322
323     For more options/commands see the file g10/OPTIONS, or use "gpg --help"
324
325
326     Debug Flags
327     -----------
328     Use the option "--debug n" to output debug informations. This option
329     can be used multiple times, all values are ORed; n maybe prefixed with
330     0x to use hex-values.
331
332          value  used for
333          -----  ----------------------------------------------
334           1     packet reading/writing
335           2     MPI details
336           4     ciphers and primes (may reveal sensitive data)
337           8     iobuf filter functions
338           16    iobuf stuff
339           32    memory allocation stuff
340           64    caching
341           128   show memory statistics at exit
342           256   trust verification stuff
343
344
345     Other Notes
346     -----------
347     This is work in progress, so you may find duplicated code fragments,
348     ugly data structures, weird usage of filenames and other thinks.
349     I will run "indent" over the source when making a real distribution,
350     but for now I stick to my own formatting rules.
351
352     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
353     The primary WWW page is "http://www.d.shuttle.de/isil/crypt/gnupg.html"
354
355     If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
356     "gnupg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
357
358     Please direct bug reports to <gnupg-bugs@isil.d.shuttle.de> or better
359     post them to the mailing list <g10@net.lut.ac.uk>.
360
361