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