Renamed to GNUPG
[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              "."  Miller-Rabin test failed.
86              "+"  Miller-Rabin test succeeded.
87              "!"  Reloading the pool with fresh prime numbers
88              "^"  Checking a new value for the generator
89              "~"  Issued during generator checks
90              "<"  Size of one factor decreased
91              ">"  Size of one factor increased
92
93     The prime number for ElGamal is generated this way:
94
95     1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
96     2) Select the length of the other prime factors to be at least the size
97        of q and calculate the number of prime factors needed
98     3) Make a pool of prime number, each of the length determined in step 2
99     4) Get a new permutation out of the pool or continue with step 3
100        if we have tested all permutations.
101     5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
102     6) Check that this prime has the correct length (this may change q if
103        it seems not to be possible to make a prime of the desired length)
104     7) Check whether this is a prime using trial divisions and the
105        Miller-Rabin test.
106     8) Continue with step 4 if we did not find a prime in step 7.
107     9) Find a generator for that prime.
108
109     You should make a revocation certificate in cases someone gets
110     knowledge of your secret key or you forgot your passphrase:
111
112         gpg --gen-revoke your_user_id
113
114     Run this command and store it away; output is always ASCII armored,
115     so that you can print it and (hopefully never) re-create it if
116     your electronic media fails.
117
118
119     You can sign a key with this command:
120
121         gpg --sign-key Donald
122
123     This let you sign the key of "Donald" with your default userid.
124
125         gpg --sign-key -u Karl -u Joe Donald
126
127     This let you sign the key of of "Donald" with the userids of "Karl"
128     and "Joe".
129     All existing signatures are checked, if some are invalid, a menu is
130     offered to delete some of them, and the you are asked for every user
131     wether you want to sign this key.
132
133     You may remove a signature at any time using the option "--edit-sig",
134     which asks for the sigs to remove. Self-signatures are not removable.
135
136
137
138
139     Sign
140     ----
141
142         gpg -s file
143
144     This creates a file file.gpg which is compressed and has a signature
145     attached.
146
147         gpg -sa file
148
149     Same as above, but file.gpg is ascii armored.
150
151         gpg -s -o out file
152
153     Creates a signature of file, but writes the output to the file "out".
154
155
156     Encrypt
157     -------
158
159         gpg -e -r heine file
160
161     This encrypts files with the public key of "heine" and writes it
162     to "file.gpg"
163
164         echo "hallo" | gpg -ea -r heine | mail heine
165
166     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
167
168
169     Sign and Encrypt
170     ----------------
171
172         gpg -se -r heine file
173
174     This encrypts files with the public key of "heine" and writes it
175     to "file.gpg" after signing it with the default user id.
176
177
178         gpg -se -r heine -u Suttner file
179
180     Ditto, but sign the file with the user id "Suttner"
181
182
183     Keyring Management
184     ------------------
185     To export your complete keyring(s) do this:
186
187         gpg --export
188
189     To export only some user ids do this:
190
191         gpg --export userids
192
193     Use "-a" or "--armor" to create ASCII armored output.
194
195     Importing keys is done with the option, you guessed it, "--import":
196
197         gpg --import [filenames]
198
199     New keys are appended to the default keyring and already existing
200     keys are merged.  Keys without a self-signature are ignored.
201
202
203     How to Specify a UserID
204     -----------------------
205     There are several ways to specify a userID, here are some examples:
206
207     * Only by the short keyid (prepend a zero if it start with A..F):
208
209         "234567C4"
210         "0F34E556E"
211         "01347A56A"
212
213     * By a complete keyid:
214
215         "234AABBCC34567C4"
216         "0F323456784E56EAB"
217         "01AB3FED1347A5612"
218
219     * By a fingerprint (not yet implemented):
220
221         "1234343434343434C434343434343434"
222         "123434343434343C3434343434343734349A3434"
223         "0E12343434343434343434EAB3484343434343434"
224
225       The first one is MD5 the others are ripemd160 or sha1.
226
227     * By an exact string (not yet implemented):
228
229         "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
230
231     * By an email address:
232
233         "<heinrichh@uni-duesseldorf.de>"
234
235       This can be used by a keyserver instead of a substring to
236       find this key faster.
237
238     * By the Local ID (from the trustdb):
239
240         "#34"
241
242       This can be used by a MUA to specify an exact key after selecting
243       a key from GNUPG (by the use of a special option or an extra utility)
244
245
246     * Or by the usual substring:
247
248         "Heine"
249         "*Heine"
250
251       The '*' indicates substring search explicitly.
252
253
254
255
256     Batch mode
257     ----------
258     If you use the option "--batch", GNUPG runs in non-interactive mode and
259     never prompts for input data.  This even does not allow to enter
260     passphrase; until we have a better solution (something like ssh-agent),
261     you can use the option "--passhrase-fd n", which works like PGPs
262     PGPPASSFD.
263
264     Batch mode also causes GNUPG to terminate as soon as a BAD signature is
265     detected.
266
267
268     Exit status
269     -----------
270     GNUPG returns with an exit status of 1 if in batch mode and a bad signature
271     has been detected or 2 or higher for all other errors.  You should parse
272     stderr to get detailed informations about the errors.
273
274
275     Esoteric commands
276     -----------------
277
278         gpg --list-packets datafile
279
280     Use this to list the contents of a data file. If the file is encrypted
281     you are asked for the passphrase, so that GNUPG is able to look at the
282     inner structure of a encrypted packet.
283
284         gpgm --quick-random
285
286     Do not use the stroing random generator but a faster one.  This can be
287     used to generate keys for tests; those are marked as insecure.
288
289         gpgm --list-trustdb
290
291     List the contents of the trustdb in a human readable format
292
293         gpgm --list-trustdb  <usernames>
294
295     List the tree of certificates for the given usernames
296
297         gpgm --list-trust-path  depth  username
298
299     List the possible trust paths for the given username, up to the specified
300     depth.  If depth is negative, duplicate introducers are not listed,
301     because those would increase the trust probabilty only minimal.
302     (you must use the special option "--" to stop option parsing when
303      using a negative number). This option may create new entries in the
304     trustdb.
305
306         gpgm --print-mds  filenames
307
308     List all available message digest values for the fiven filenames
309
310         gpgm --gen-prime n
311
312     Generate and print a simple prime number of size n
313
314         gpgm --gen-prime n q
315
316     Generate a prime number suitable for ElGamal signatures of size n with
317     a q as largest primefactor of n-1.
318
319         gpgm --gen-prime n q 1
320
321     Ditto, but calculate a generator too.
322
323
324     For more options/commands see the file g10/OPTIONS, or use "gpg --help"
325
326
327     Debug Flags
328     -----------
329     Use the option "--debug n" to output debug informations. This option
330     can be used multiple times, all values are ORed; n maybe prefixed with
331     0x to use hex-values.
332
333          value  used for
334          -----  ----------------------------------------------
335           1     packet reading/writing
336           2     MPI details
337           4     ciphers and primes (may reveal sensitive data)
338           8     iobuf filter functions
339           16    iobuf stuff
340           32    memory allocation stuff
341           64    caching
342           128   show memory statistics at exit
343           256   trust verification stuff
344
345
346     Other Notes
347     -----------
348     This is work in progress, so you may find duplicated code fragments,
349     ugly data structures, weird usage of filenames and other thinks.
350     I will run "indent" over the source when making a real distribution,
351     but for now I stick to my own formatting rules.
352
353     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
354     The primary WWW page is "http://www.d.shuttle.de/isil/crypt/gnupg.html"
355
356     If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
357     "gnupg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
358
359     Please direct bug reports to <gnupg-bugs@isil.d.shuttle.de> or better
360     post them to the mailing list <g10@net.lut.ac.uk>.
361
362