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