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