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