ad836c3d737339f4d29cd9e5d5b5e9e592e9dd82
[libgcrypt.git] / README
1 -----BEGIN PGP SIGNED MESSAGE-----
2
3                   GNUPG - The GNU Privacy Guard
4                  -------------------------------
5                           Version 0.4
6
7     As you can see from the version number, the program may have some
8     bugs and some features may not work at all - please report this to
9     the mailing list.
10
11     On a Linux box (version 2.x.x, alpha or x86 CPU) it should
12     work reliably.  You may create your key on such a machine and
13     use it.  Please verify the tar file; there is a PGP and a GNUPG
14     signature available. My PGP 2 key is well known and published in
15     the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
16
17     I have included my pubring as "g10/pubring.asc", which contains
18     the key used to make GNUPG signatures:
19     "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
20     "Key fingerprint = 6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
21
22     Old version of gnupg are signed with this key:
23     "pub  1312G/FF3EAA0B 1998-02-09 Werner Koch <wk@isil.d.shuttle.de>"
24     "Key fingerprint = 8489 6CD0 1851 0E33 45DA  CD67 036F 11B8 FF3E AA0B"
25
26     My usual key is now:
27     "pub  1024D/621CC013 1998-07-07 Werner Koch <werner.koch@guug.de>"
28     "Key fingerprint = ECAF 7590 EB34 43B5 C7CF  3ACB 6C7E E1B8 621C C013"
29
30     You may add it to your GNUPG pubring and use it in the future to
31     verify new releases.  Because you verified this README file and
32     _checked_that_it_is_really_my PGP2 key 0C9857A5, you can be sure
33     that the above fingerprints are correct.
34
35     Please subscribe to g10@net.lut.ac.uk by sending a mail with
36     the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
37     This mailing is closed (only subscribers can post) to avoid spam.
38
39     See the file COPYING for copyright and warranty information.
40
41     Due to the fact that GNUPG does not use use any patented algorithm,
42     it cannot be compatible with old PGP versions, because those use
43     IDEA (which is patented worldwide) and RSA (which is patented in
44     the United States until Sep 20, 2000).
45
46     GNUPG is in almost all  aspects compatible with other OpenPGP
47     implementations.
48
49     The default algorithms are now DSA and ELGamal.  ELGamal for signing
50     is still available, but due to the larger size of such signatures it
51     is depreciated (Please note that the GNUPG implementation of ElGamal
52     signatures is *not* insecure).  Symmetric algorithms are: 3DES, Blowfish
53     and CAST5,  Digest algorithms are MD5, RIPEMD160, SHA1 and TIGER/192.
54
55
56
57     Installation
58     ------------
59
60     Please read the file INSTALL!
61
62     Here is a quick summary:
63
64     1)  "./configure"
65
66     2) "make"
67
68     3) "make install"
69
70     4) You end up with a binary "gpg" in /usr/local/bin
71
72     5) Optional, but suggested: install the program "gpg" as suid root.
73
74
75
76     Key Generation
77     --------------
78
79         gpg --gen-key
80
81     This asks some questions and then starts key generation. To create
82     good random numbers for prime number generation, it uses a /dev/random
83     which will only emit bytes if the kernel can gather enough entropy.
84     If you see no progress, you should start some other activities such
85     as mouse moves, "find /" or using the keyboard (in another window).
86     Because we have no hardware device to generate randomness we have to
87     use this method.
88
89     You should make a revocation certificate in case someone gets
90     knowledge of your secret key or you forgot your passphrase:
91
92         gpg --gen-revoke your_user_id
93
94     Run this command and store it away; output is always ASCII armored,
95     so that you can print it and (hopefully never) re-create it if
96     your electronic media fails.
97
98     If you decided to create a DSA key, you should add an ElGamal
99     for encryption:
100
101         gpg --add-key user_id_of_your_key
102
103     and follow the displayed instructions (select "ElGamal using v4 packets").
104
105
106     You can sign a key with this command:
107
108         gpg --sign-key Donald
109
110     This let you sign the key of "Donald" with your default userid.
111
112         gpg --sign-key -u Karl -u Joe Donald
113
114     This let you sign the key of of "Donald" with the userids of "Karl"
115     and "Joe".
116     All existing signatures are checked; if some are invalid, a menu is
117     offered to delete some of them, and then you are asked for every user
118     whether you want to sign this key.
119
120     You may remove a signature at any time using the option "--edit-sig",
121     which asks for the sigs to remove.  Self-signatures are not removable.
122
123
124
125
126     Sign
127     ----
128
129         gpg -s file
130
131     This creates a file file.gpg which is compressed and has a signature
132     attached.
133
134         gpg -sa file
135
136     Same as above, but file.gpg is ascii armored.
137
138         gpg -s -o out file
139
140     Creates a signature of file, but writes the output to the file "out".
141
142     If you use the option "--rfc1991", gnupg tries to me more compatible
143     to RFC1991 (pgp 2.x).
144
145
146     Encrypt
147     -------
148
149         gpg -e -r heine file
150
151     This encrypts files with the public key of "heine" and writes it
152     to "file.gpg"
153
154         echo "hallo" | gpg -ea -r heine | mail heine
155
156     Ditto, but encrypts "hallo\n" and mails it as ascii armored message.
157
158
159     Sign and Encrypt
160     ----------------
161
162         gpg -se -r heine file
163
164     This encrypts files with the public key of "heine" and writes it
165     to "file.gpg" after signing it with the default user id.
166
167
168         gpg -se -r heine -u Suttner file
169
170     Ditto, but sign the file with the user id "Suttner"
171
172
173     Keyring Management
174     ------------------
175     To export your complete keyring(s) do this:
176
177         gpg --export
178
179     To export only some user ids do this:
180
181         gpg --export userids
182
183     Use "-a" or "--armor" to create ASCII armored output.
184
185     Importing keys is done with the option, you guessed it, "--import":
186
187         gpg --import [filenames]
188
189     New keys are appended to the default keyring and already existing
190     keys are merged.  Keys without a self-signature are ignored.
191
192
193     How to Specify a UserID
194     -----------------------
195     There are several ways to specify a userID, here are some examples:
196
197     * Only by the short keyid (prepend a zero if it begins with A..F):
198
199         "234567C4"
200         "0F34E556E"
201         "01347A56A"
202         "0xAB123456
203
204     * By a complete keyid:
205
206         "234AABBCC34567C4"
207         "0F323456784E56EAB"
208         "01AB3FED1347A5612"
209         "0x234AABBCC34567C4"
210
211     * By a fingerprint:
212
213         "1234343434343434C434343434343434"
214         "123434343434343C3434343434343734349A3434"
215         "0E12343434343434343434EAB3484343434343434"
216
217       The first one is MD5 the others are ripemd160 or sha1.
218
219     * By an exact string (not yet implemented):
220
221         "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
222
223     * By an email address:
224
225         "<heinrichh@uni-duesseldorf.de>"
226
227       This can be used by a keyserver instead of a substring to
228       find this key faster.
229
230     * By the Local ID (from the trustdb):
231
232         "#34"
233
234       This can be used by a MUA to specify an exact key after selecting
235       a key from GNUPG (by the use of a special option or an extra utility)
236
237
238     * Or by the usual substring:
239
240         "Heine"
241         "*Heine"
242
243       The '*' indicates substring search explicitly.
244
245
246
247
248     Batch mode
249     ----------
250     If you use the option "--batch", GNUPG runs in non-interactive mode and
251     never prompts for input data.  This does not even allow entering the
252     passphrase; until we have a better solution (something like ssh-agent),
253     you can use the option "--passhrase-fd n", which works like PGPs
254     PGPPASSFD.
255
256     Batch mode also causes GNUPG to terminate as soon as a BAD signature is
257     detected.
258
259
260     Exit status
261     -----------
262     GNUPG returns with an exit status of 1 if in batch mode and a bad signature
263     has been detected or 2 or higher for all other errors.  You should parse
264     stderr or the output of the fd specified with --status-fd to get detailed
265     information about the errors.
266
267
268     Esoteric commands
269     -----------------
270
271         gpg --list-packets datafile
272
273     Use this to list the contents of a data file. If the file is encrypted
274     you are asked for the passphrase, so that GNUPG is able to look at the
275     inner structure of a encrypted packet.
276
277         gpgm --list-trustdb
278
279     List the contents of the trustdb in a human readable format
280
281         gpgm --list-trustdb  <usernames>
282
283     List the tree of certificates for the given usernames
284
285         gpgm --list-trust-path  depth  username
286
287     List the possible trust paths for the given username, up to the specified
288     depth.  If depth is negative, duplicate introducers are not listed,
289     because those would increase the trust probability only minimally.
290     (you must use the special option "--" to stop option parsing when
291      using a negative number). This option may create new entries in the
292     trustdb.
293
294         gpgm --print-mds  filenames
295
296     List all available message digest values for the fiven filenames
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
325     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
326     The primary WWW page is "http://www.d.shuttle.de/isil/gnupg/"
327
328     If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
329     "gpg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
330
331     Please direct bug reports to <gnupg-bugs@gnu.org> or better
332     post them to the mailing list <g10@net.lut.ac.uk> (this is a closed list,
333     please subscribe before posting, see above (~line 33)).
334
335 -----BEGIN PGP SIGNATURE-----
336 Version: GNUPG v0.4.0a (GNU/Linux)
337 Comment: For info finger gcrypt@ftp.guug.de
338
339 iQB1AwUBNhtSpB0Z9MEMmFelAQHWNQMAuPaj71rzjjtVNlYDV0MYljPFZqAK7tvmbH3i9Lti
340 UuvGPCpx1/ej7jwZ2LSQ61O8c/xRwV07chHa5MGmSGT4KZg5g5MejUOliMQJIJwjY5PoZAVb
341 6F7+hZf5Bt5Jl2J7
342 =6Mbb
343 -----END PGP SIGNATURE-----