75c769db4c074b7cfe36d26e0cf59de993a5ed06
[gnupg.git] / README
1 Please note that this is only a bug fix release and some things
2 do not yet work - see TODO for parts which are problematic
3
4 The genkey1024 test will fail due to an expect problem :-(
5
6
7 -----BEGIN PGP SIGNED MESSAGE-----
8
9                     GnuPG - The GNU Privacy Guard
10                    -------------------------------
11                             Version 0.9
12
13     GnuPG is now in Beta test and you should report all bugs to the
14     mailing list (see below).  The 0.9.x versions are released mainly
15     to fix all remaining serious bugs.  As soon as version 1.0 is out,
16     development will continue with a 1.1 series and bug fixes for the
17     1.0 version as needed.
18
19     GnuPG works best on GNU/Linux or *BSD.  Other Unices are
20     also supported but are not as well tested as the Free Unices.
21     Please verify the tar file with the PGP2 or GnuPG/PGP5
22     signatures provided.  My PGP2 key is well known and published in
23     the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
24
25     I have included my pubring as "g10/pubring.asc", which contains
26     the key used to make GnuPG signatures:
27     "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
28     "Key fingerprint = 6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
29
30     My new DSA key is:
31     "pub  1024D/621CC013 1998-07-07 Werner Koch <werner.koch@guug.de>"
32     "Key fingerprint = ECAF 7590 EB34 43B5 C7CF  3ACB 6C7E E1B8 621C C013"
33
34     You may want add my new DSA key to your GnuPG pubring and use it in
35     the future to verify new releases.  Because you verified this README
36     file and _checked_that_it_is_really_my PGP2 key 0C9857A5, you can be
37     sure that the above fingerprints are correct.
38
39     Please subscribe to g10@net.lut.ac.uk by sending a mail with
40     the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
41     This mailing list is closed (only subscribers are allowed to post)
42     to avoid misuse by folks who don't know the Netiquette and trash
43     your mailspool with commercial junk.
44
45     See the file COPYING for copyright and warranty information.
46
47     GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP for
48     details.
49
50     Because GnuPG does not use use any patented algorithm it cannot be
51     compatible with PGP2 versions.  PGP 2.x uses only IDEA (which is
52     patented worldwide) and RSA (which is patented in the United States
53     until Sep 20, 2000).
54
55     The default algorithms are now DSA and ElGamal.  ElGamal for signing
56     is still available, but because of the larger size of such
57     signatures it is deprecated (Please note that the GnuPG
58     implementation of ElGamal signatures is *not* insecure).  Symmetric
59     algorithms are: 3DES, Blowfish, and CAST5 (Twofish will come soon).
60     Digest algorithms available are MD5, RIPEMD160, SHA1, and TIGER/192.
61
62
63     Installation
64     ------------
65
66     Please read the file INSTALL!
67
68     Here is a quick summary:
69
70     1)  "./configure"
71
72     2) "make"
73
74     3) "make install"
75
76     4) You end up with the binaries "gpg" and "gpgm" in /usr/local/bin.
77
78     5) Optional, but suggested, install the binary "gpg" as suid root.
79
80
81
82     Introduction
83     ------------
84
85     This is a brief overview how to use GnuPG - it is strongly suggested
86     that you read the manual^H^H^H more information about the use of
87     cryptography.  GnuPG is only a tool, secure results require that YOU
88     KNOW WHAT YOU ARE DOING.
89
90     If you already have a DSA key from PGP 5 (they call them DH/ElGamal)
91     you can simply copy the pgp keyrings over the GnuPG keyrings after
92     running gpg once to create the correct directory.
93
94     The normal way to create a key is
95
96         gpg --gen-key
97
98     This asks some questions and then starts key generation. To create
99     good random numbers for the key parameters, GnuPG needs to gather
100     enough noise (entropy) from your system.  If you see no progress
101     during key generation you should start some other activities such
102     as mouse moves or hitting on the CTRL and SHIFT keys.
103
104     Generate a key ONLY on a machine where you have direct physical
105     access - don't do it over the network or on a machine used also
106     by others - especially if you have no access to the root account.
107
108     When you are asked for a passphrase use a good one which you can
109     easy remember.  Don't make the passphrase too long because you have
110     to type it for every decryption or signing; but, - AND THIS IS VERY
111     IMPORTANT - use a good one that is not easily to guess because the
112     security of the whole system relies on your secret key and the
113     passphrase that protects it when someone gains access to your secret
114     keyring.  A good way to select a passphrase is to figure out a short
115     nonsense sentence which makes some sense for you and modify it by
116     inserting extra spaces, non-letters and changing the case of some
117     characters - this is really easy to remember especially if you
118     associate some pictures with it.
119
120     Next, you should create a revocation certificate in case someone
121     gets knowledge of your secret key or you forgot your passphrase
122
123         gpg --gen-revoke your_user_id
124
125     Run this command and store the revocation certificate away.  The output
126     is always ASCII armored, so that you can print it and (hopefully
127     never) re-create it if your electronic media fails.
128
129     Now you can use your key to create digital signatures
130
131         gpg -s file
132
133     This creates a file "file.gpg" which is compressed and has a
134     signature attached.
135
136         gpg -sa file
137
138     Same as above, but creates a file "file.asc" which is ASCII armored
139     and and ready for sending by mail.  It is better to use your
140     mailers features to create signatures (The mailer uses GnuPG to do
141     this) because the mailer has the ability to MIME encode such
142     signatures - but this is not a security issue.
143
144         gpg -s -o out file
145
146     Creates a signature of "file", but writes the output to the file
147     "out".
148
149     Everyone who knows your public key (you can and should publish
150     your key by putting it on a key server, a web page or in your .plan
151     file) is now able to check whether you really signed this text
152
153         gpg --verify file
154
155     GnuPG now checks whether the signature is valid and prints an
156     appropriate message.  If the signature is good, you know at least
157     that the person (or machine) has access to the secret key which
158     corresponds to the published public key.
159
160     If you run gpg without an option it will verify the signature and
161     create a new file that is identical to the original.  gpg can also
162     run as a filter, so that you can pipe data to verify trough it
163
164         cat signed-file | gpg | wc -l
165
166     which will check the signature of signed-file and then display the
167     number of lines in the original file.
168
169     To send a message encrypted to someone you can use
170
171         gpg -e -r heine file
172
173     This encrypts "file" with the public key of the user "heine" and
174     writes it to "file.gpg"
175
176         echo "hello" | gpg -ea -r heine | mail heine
177
178     Ditto, but encrypts "hello\n" and mails it as ASCII armored message
179     to the user with the mail address heine.
180
181         gpg -se -r heine file
182
183     This encrypts "file" with the public key of "heine" and writes it
184     to "file.gpg" after signing it with your user id.
185
186         gpg -se -r heine -u Suttner file
187
188     Ditto, but sign the file with your alternative user id "Suttner"
189
190
191     GnuPG has some options to help you publish public keys.  This is
192     called "exporting" a key, thus
193
194         gpg --export >all-my-keys
195
196     exports all the keys in the keyring and writes them (in a binary
197     format) to "all-my-keys".  You may then mail "all-my-keys" as an
198     MIME attachment to someone else or put it on an FTP server. To
199     export only some user IDs, you give them as arguments on the command
200     line.
201
202     To mail a public key or put it on a web page you have to create
203     the key in ASCII armored format
204
205         gpg --export --armor | mail panther@tiger.int
206
207     This will send all your public keys to your friend panther.
208
209     If you have received a key from someone else you can put it
210     into your public keyring.  This is called "importing"
211
212         gpg --import [filenames]
213
214     New keys are appended to your keyring and already existing
215     keys are updated. Note that GnuPG does not import keys that
216     are not self-signed.
217
218     Because anyone can claim that a public key belongs to her
219     we must have some way to check that a public key really belongs
220     to the owner.  This can be achieved by comparing the key during
221     a phone call.  Sure, it is not very easy to compare a binary file
222     by reading the complete hex dump of the file - GnuPG (and nearly
223     every other program used for management of cryptographic keys)
224     provides other solutions.
225
226         gpg --fingerprint <username>
227
228     prints the so called "fingerprint" of the given username which
229     is a sequence of hex bytes (which you may have noticed in mail
230     sigs or on business cards) that uniquely identifies the public
231     key - different keys will always have different fingerprints.
232     It is easy to compare fingerprints by phone and I suggest
233     that you print your fingerprint on the back of your business
234     card.
235
236     If you don't know the owner of the public key you are in trouble.
237     Suppose however that friend of yours knows someone who knows someone
238     who has met the owner of the public key at some computer conference.
239     Suppose that all the people between you and the public key holder
240     may now act as introducers to you.  Introducers signing keys thereby
241     certify that they know the owner of the keys they sign.  If you then
242     trust all the introducers to have correctly signed other keys, you
243     can be be sure that the other key really belongs to the one who
244     claims to own it..
245
246     There are 2 steps to validate a key:
247         1. First check that there is a complete chain
248            of signed keys from the public key you want to use
249            and your key and verify each signature.
250         2. Make sure that you have full trust in the certificates
251            of all the introduces between the public key holder and
252            you.
253     Step 2 is the more complicated part because there is no easy way
254     for a computer to decide who is trustworthy and who is not.  GnuPG
255     leaves this decision to you and will ask you for a trust value
256     (here also referenced as the owner-trust of a key) for every key
257     needed to check the chain of certificates.  You may choose from:
258       a) "I don't know" - then it is not possible to use any
259          of the chains of certificates, in which this key is used
260          as an introducer, to validate the target key.  Use this if
261          you don't know the introducer.
262       b) "I do not trust" - Use this if you know that the introducer
263          does not do a good job in certifying other keys.  The effect
264          is the same as with a) but for a) you may later want to
265          change the value because you got new information about this
266          introducer.
267       c) "I trust marginally" - Use this if you assume that the
268          introducer knows what he is doing.  Together with some
269          other marginally trusted keys, GnuPG validates the target
270          key then as good.
271       d) "I fully trust" - Use this if you really know that this
272          introducer does a good job when certifying other keys.
273          If all the introducer are of this trust value, GnuPG
274          normally needs only one chain of signatures to validate
275          a target key okay. (But this may be adjusted with the help
276          of some options).
277     This information is confidential because it gives your personal
278     opinion on the trustworthiness of someone else.  Therefore this data
279     is not stored in the keyring but in the "trustdb"
280     (~/.gnupg/trustdb.gpg).  Do not assign a high trust value just
281     because the introducer is a friend of yours - decide how well she
282     understands the implications of key signatures and you may want to
283     tell her more about public key cryptography so you can later change
284     the trust value you assigned.
285
286     Okay, here is how GnuPG helps you with key management.  Most stuff
287     is done with the --edit-key command
288
289         gpg --edit-key <keyid or username>
290
291     GnuPG displays some information about the key and then prompts
292     for a command (enter "help" to see a list of commands and see
293     the man page for a more detailed explanation).  To sign a key
294     you select the user ID you want to sign by entering the number
295     that is displayed in the leftmost column (or do nothing if the
296     key has only one user ID) and then enter the command "sign" and
297     follow all the prompts.  When you are ready, give the command
298     "save" (or use "quit" to cancel your actions).
299
300     If you want to sign the key with another of your user IDs, you
301     must give an "-u" option on the command line together with the
302     "--edit-key".
303
304     Normally you want to sign only one user ID because GnuPG
305     uses only one and this keeps the public key certificate
306     small.  Because such key signatures are very important you
307     should make sure that the signatories of your key sign a user ID
308     which is very likely to stay for a long time - choose one with an
309     email address you have full control of or do not enter an email
310     address at all.  In future GnuPG will have a way to tell which
311     user ID is the one with an email address you prefer - because
312     you have no signatures on this email address it is easy to change
313     this address.  Remember, your signatories sign your public key (the
314     primary one) together with one of your user IDs - so it is not possible
315     to change the user ID later without voiding all the signatures.
316
317     Tip: If you hear about a key signing party on a computer conference
318     join it because this is a very convenient way to get your key
319     certified (But remember that signatures have nothing to to with the
320     trust you assign to a key).
321
322
323     8 Ways to Specify a User ID
324     --------------------------
325     There are several ways to specify a user ID, here are some examples.
326
327     * Only by the short keyid (prepend a zero if it begins with A..F):
328
329         "234567C4"
330         "0F34E556E"
331         "01347A56A"
332         "0xAB123456
333
334     * By a complete keyid:
335
336         "234AABBCC34567C4"
337         "0F323456784E56EAB"
338         "01AB3FED1347A5612"
339         "0x234AABBCC34567C4"
340
341     * By a fingerprint:
342
343         "1234343434343434C434343434343434"
344         "123434343434343C3434343434343734349A3434"
345         "0E12343434343434343434EAB3484343434343434"
346
347       The first one is MD5 the others are ripemd160 or sha1.
348
349     * By an exact string:
350
351         "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
352
353     * By an email address:
354
355         "<heinrichh@uni-duesseldorf.de>"
356
357     * By word match
358
359         "+Heinrich Heine duesseldorf"
360
361       All words must match excatly (not case sensitive) and appear in
362       any order in the user ID.  Words are any sequences of letters,
363       digits, the underscore and characters with bit 7 set.
364
365     * By the Local ID (from the trust DB):
366
367         "#34"
368
369       This may be used by a MUA to specify an exact key after selecting
370       a key from GnuPG (by using a special option or an extra utility)
371
372     * Or by the usual substring:
373
374         "Heine"
375         "*Heine"
376
377       The '*' indicates substring search explicitly.
378
379
380     Batch mode
381     ----------
382     If you use the option "--batch", GnuPG runs in non-interactive mode and
383     never prompts for input data.  This does not even allow entering the
384     passphrase.  Until we have a better solution (something like ssh-agent),
385     you can use the option "--passphrase-fd n", which works like PGPs
386     PGPPASSFD.
387
388     Batch mode also causes GnuPG to terminate as soon as a BAD signature is
389     detected.
390
391
392     Exit status
393     -----------
394     GnuPG returns with an exit status of 1 if in batch mode and a bad signature
395     has been detected or 2 or higher for all other errors.  You should parse
396     stderr or, better, the output of the fd specified with --status-fd to get
397     detailed information about the errors.
398
399
400     Esoteric commands
401     -----------------
402
403         gpg --list-packets datafile
404
405     Use this to list the contents of a data file. If the file is encrypted
406     you are asked for the passphrase, so that GnuPG is able to look at the
407     inner structure of a encrypted packet.  This command should list all
408     kinds of rfc2440 messages.
409
410         gpgm --list-trustdb
411
412     List the contents of the trust DB in a human readable format
413
414         gpgm --list-trustdb  <usernames>
415
416     List the tree of certificates for the given usernames
417
418         gpgm --list-trust-path  username
419
420     List the possible trust paths for the given username. The length
421     of such a trust path is limited by the option --max-cert-depth
422     which defaults to 5.
423
424     For more options/commands see the man page or use "gpg --help".
425
426
427     Other Notes
428     -----------
429
430     The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
431     The primary WWW page is "http://www.gnupg.org"
432
433     See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
434     and use them if possible.
435
436     Please direct bug reports to <gnupg-bugs@gnu.org> or, better,
437     post them to the mailing list <g10@net.lut.ac.uk> (this is a
438     closed list - subscribe before posting, see above (~line 33)).
439     Please direct questions about GnuPG to the mailing list or
440     one of the pgp newsgroups and give me more time to improve
441     GnuPG.  Commercial support for GnuPG will be available soon.
442
443     Have fun and remember: Echelon is looking at you kid.
444
445 -----BEGIN PGP SIGNATURE-----
446 Version: GnuPG v0.9.2 (GNU/Linux)
447 Comment: For info see http://www.gnupg.org
448
449 iQB1AwUBNr2fPh0Z9MEMmFelAQHqNAL/e7pApR0CGUJ/zuIsjaVhNGPEgKAglcEd
450 YuVdB+RCN0wq7ZfI0AHU2FdVISRACmSN3xituTTgeiOUsczM40EZ4l1XNfyRF768
451 fglui6XxEeYHFY7mSQMgzzFWDG0Squx0
452 =enRo
453 -----END PGP SIGNATURE-----