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