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