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