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