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