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