Solved cvs conflict
[gnupg.git] / README
1
2                     GnuPG - The GNU Privacy Guard
3                    -------------------------------
4                             Version 1.3.3
5
6              Copyright 1998, 1999, 2000, 2001, 2002, 2003
7                     Free Software Foundation, Inc.
8
9     This file is free software; as a special exception the author gives
10     unlimited permission to copy and/or distribute it, with or without
11     modifications, as long as this notice is preserved.
12
13     This file is distributed in the hope that it will be useful, but
14     WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
15     implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16
17
18     Intro
19     -----
20
21     GnuPG is GNU's tool for secure communication and data storage.
22     It can be used to encrypt data and to create digital signatures.
23     It includes an advanced key management facility and is compliant
24     with the proposed OpenPGP Internet standard as described in RFC2440.
25
26     GnuPG works best on GNU/Linux or *BSD systems.  Most other Unices
27     are also supported but are not as well tested as the Free Unices.
28     See http://www.gnupg.org/download/supported_systems.html for a
29     list of systems which are known to work.
30
31     See the file COPYING for copyright and warranty information.
32
33     Because GnuPG does not use use any patented algorithms it is not
34     by default fully compatible with PGP 2.x, which uses the patented
35     IDEA algorithm.  See http://www.gnupg.org/why-not-idea.html for
36     more information on this subject, including what to do if you are
37     legally entitled to use IDEA.
38
39     The default algorithms are DSA and ElGamal, but RSA is also
40     supported.  ElGamal for signing is available, but because of the
41     larger size of such signatures it is strongly deprecated (Please
42     note that the GnuPG implementation of ElGamal signatures is *not*
43     insecure).  Symmetric algorithms are: AES, 3DES, Blowfish, CAST5
44     and Twofish.  Digest algorithms available are MD5, RIPEMD/160,
45     SHA-1, SHA-256, SHA-384, and SHA-512.  Compression algorithms
46     available are ZIP and ZLIB.
47
48
49     Installation
50     ------------
51     Please read the file INSTALL and the sections in this file
52     related to the installation.  Here is a quick summary:
53
54     1) Check that you have unmodified sources.  See below on how to do
55        this.  Don't skip it - this is an important step!
56
57     2) Unpack the tarball.  With GNU tar you can do it this way:
58        "tar xzvf gnupg-x.y.z.tar.gz"
59
60     3) "cd gnupg-x.y.z"
61
62     4) "./configure"
63
64     5) "make"
65
66     6) "make install"
67
68     7) You end up with a "gpg" binary in /usr/local/bin.
69
70     8) To avoid swapping out of sensitive data, you can install "gpg"
71        setuid root.  If you don't do so, you may want to add the
72        option "no-secmem-warning" to ~/.gnupg/gpg.conf
73
74
75     How to Verify the Source
76     ------------------------
77     In order to check that the version of GnuPG which you are going to
78     install is an original and unmodified one, you can do it in one of
79     the following ways:
80
81     a) If you already have a trusted Version of GnuPG installed, you
82        can simply check the supplied signature:
83
84         $ gpg --verify gnupg-x.y.z.tar.gz.asc
85
86        This checks that the detached signature gnupg-x.y.z.tar.gz.asc
87        is indeed a a signature of gnupg-x.y.z.tar.gz.  The key used to
88        create this signature is:
89
90        "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
91
92        If you do not have this key, you can get it from the source in
93        the file doc/samplekeys.asc (use "gpg --import  doc/samplekeys.asc"
94        to add it to the keyring) or from any keyserver.  You have to
95        make sure that this is really the key and not a faked one. You
96        can do this by comparing the output of:
97
98                 $ gpg --fingerprint 0x57548DCD
99
100        with the fingerprint published elsewhere.
101
102        Please note, that you have to use an old version of GnuPG to
103        do all this stuff.  *Never* use the version which you are going
104        to check!
105
106
107     b) If you don't have any of the above programs, you have to verify
108        the MD5 checksum:
109
110         $ md5sum gnupg-x.y.z.tar.gz
111
112        This should yield an output _similar_ to this:
113
114         fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
115
116        Now check that this checksum is _exactly_ the same as the one
117        published via the announcement list and probably via Usenet.
118
119
120     Documentation
121     -------------
122
123     The manual will be distributed separately under the name "gph".
124     An online version of the latest manual draft is available at the
125     GnuPG web pages:
126
127         http://www.gnupg.org/documentation/
128
129     A list of frequently asked questions is available in the GnuPG
130     distribution in the file doc/FAQ and online as:
131
132         http://www.gnupg.org/documentation/faqs.html
133
134     A couple of HOWTO documents are available online; for a listing see:
135
136         http://www.gnupg.org/documentation/howtos.html
137
138     A man page with a description of all commands and options gets installed
139     along with the program. 
140
141
142     Introduction
143     ------------
144     Here is a brief overview on how to use GnuPG - it is strongly suggested
145     that you read the manual and other information about the use of
146     cryptography.  GnuPG is only a tool, secure usage requires that
147     YOU KNOW WHAT YOU ARE DOING.
148
149     The first time you run gpg, it will create a .gnupg directory in
150     your home directory and populate it with a default configuration
151     file.  Once this is done, you may create a new key, or if you
152     already have keyrings from PGP, you can import them into GnuPG
153     with:
154
155         gpg --import path/to/pgp/keyring/pubring.pkr
156     and
157         gpg --import path/to/pgp/keyring/secring.skr
158
159     The normal way to create a key is
160
161         gpg --gen-key
162
163     This asks some questions and then starts key generation. To create
164     good random numbers for the key parameters, GnuPG needs to gather
165     enough noise (entropy) from your system.  If you see no progress
166     during key generation you should start some other activities such
167     as moving the mouse or hitting the CTRL and SHIFT keys.
168
169     Generate a key ONLY on a machine where you have direct physical
170     access - don't do it over the network or on a machine also used
171     by others, especially if you have no access to the root account.
172
173     When you are asked for a passphrase use a good one which you can
174     easily remember.  Don't make the passphrase too long because you
175     have to type it for every decryption or signing; but, - AND THIS
176     IS VERY IMPORTANT - use a good one that is not easily to guess
177     because the security of the whole system relies on your secret key
178     and the passphrase that protects it when someone gains access to
179     your secret keyring.  One good way to select a passphrase is to
180     figure out a short nonsense sentence which makes some sense for
181     you and modify it by inserting extra spaces, non-letters and
182     changing the case of some characters - this is really easy to
183     remember especially if you associate some pictures with it.
184
185     Next, you should create a revocation certificate in case someone
186     gets knowledge of your secret key or you forgot your passphrase
187
188         gpg --gen-revoke your_user_id
189
190     Run this command and store the revocation certificate away.  The output
191     is always ASCII armored, so that you can print it and (hopefully
192     never) re-create it if your electronic media fails.
193
194     Now you can use your key to create digital signatures
195
196         gpg -s file
197
198     This creates a file "file.gpg" which is compressed and has a
199     signature attached.
200
201         gpg -sa file
202
203     Same as above, but creates a file "file.asc" which is ASCII armored
204     and and ready for sending by mail.  It is better to use your
205     mailers features to create signatures (The mailer uses GnuPG to do
206     this) because the mailer has the ability to MIME encode such
207     signatures - but this is not a security issue.
208
209         gpg -s -o out file
210
211     Creates a signature of "file", but writes the output to the file
212     "out".
213
214     Everyone who knows your public key (you can and should publish
215     your key by putting it on a key server, a web page or in your .plan
216     file) is now able to check whether you really signed this text
217
218         gpg --verify file
219
220     GnuPG now checks whether the signature is valid and prints an
221     appropriate message.  If the signature is good, you know at least
222     that the person (or machine) has access to the secret key which
223     corresponds to the published public key.
224
225     If you run gpg without an option it will verify the signature and
226     create a new file that is identical to the original.  gpg can also
227     run as a filter, so that you can pipe data to verify trough it
228
229         cat signed-file | gpg | wc -l
230
231     which will check the signature of signed-file and then display the
232     number of lines in the original file.
233
234     To send a message encrypted to someone you can use
235
236         gpg -e -r heine file
237
238     This encrypts "file" with the public key of the user "heine" and
239     writes it to "file.gpg"
240
241         echo "hello" | gpg -ea -r heine | mail heine
242
243     Ditto, but encrypts "hello\n" and mails it as ASCII armored message
244     to the user with the mail address heine.
245
246         gpg -se -r heine file
247
248     This encrypts "file" with the public key of "heine" and writes it
249     to "file.gpg" after signing it with your user id.
250
251         gpg -se -r heine -u Suttner file
252
253     Ditto, but sign the file with your alternative user id "Suttner"
254
255
256     GnuPG has some options to help you publish public keys.  This is
257     called "exporting" a key, thus
258
259         gpg --export >all-my-keys
260
261     exports all the keys in the keyring and writes them (in a binary
262     format) to "all-my-keys".  You may then mail "all-my-keys" as an
263     MIME attachment to someone else or put it on an FTP server. To
264     export only some user IDs, you give them as arguments on the command
265     line.
266
267     To mail a public key or put it on a web page you have to create
268     the key in ASCII armored format
269
270         gpg --export --armor | mail panther@tiger.int
271
272     This will send all your public keys to your friend panther.
273
274     If you have received a key from someone else you can put it
275     into your public keyring.  This is called "importing"
276
277         gpg --import [filenames]
278
279     New keys are appended to your keyring and already existing
280     keys are updated. Note that GnuPG does not import keys that
281     are not self-signed.
282
283     Because anyone can claim that a public key belongs to her
284     we must have some way to check that a public key really belongs
285     to the owner.  This can be achieved by comparing the key during
286     a phone call.  Sure, it is not very easy to compare a binary file
287     by reading the complete hex dump of the file - GnuPG (and nearly
288     every other program used for management of cryptographic keys)
289     provides other solutions.
290
291         gpg --fingerprint <username>
292
293     prints the so called "fingerprint" of the given username which
294     is a sequence of hex bytes (which you may have noticed in mail
295     sigs or on business cards) that uniquely identifies the public
296     key - different keys will always have different fingerprints.
297     It is easy to compare fingerprints by phone and I suggest
298     that you print your fingerprint on the back of your business
299     card.  To see the fingerprints of the secondary keys, you can
300     give the command twice; but this is normally not needed.
301
302     If you don't know the owner of the public key you are in trouble.
303     Suppose however that friend of yours knows someone who knows someone
304     who has met the owner of the public key at some computer conference.
305     Suppose that all the people between you and the public key holder
306     may now act as introducers to you.  Introducers signing keys thereby
307     certify that they know the owner of the keys they sign.  If you then
308     trust all the introducers to have correctly signed other keys, you
309     can be be sure that the other key really belongs to the one who
310     claims to own it..
311
312     There are 2 steps to validate a key:
313         1. First check that there is a complete chain
314            of signed keys from the public key you want to use
315            and your key and verify each signature.
316         2. Make sure that you have full trust in the certificates
317            of all the introduces between the public key holder and
318            you.
319     Step 2 is the more complicated part because there is no easy way
320     for a computer to decide who is trustworthy and who is not.  GnuPG
321     leaves this decision to you and will ask you for a trust value
322     (here also referenced as the owner-trust of a key) for every key
323     needed to check the chain of certificates.  You may choose from:
324       a) "I don't know" - then it is not possible to use any
325          of the chains of certificates, in which this key is used
326          as an introducer, to validate the target key.  Use this if
327          you don't know the introducer.
328       b) "I do not trust" - Use this if you know that the introducer
329          does not do a good job in certifying other keys.  The effect
330          is the same as with a) but for a) you may later want to
331          change the value because you got new information about this
332          introducer.
333       c) "I trust marginally" - Use this if you assume that the
334          introducer knows what he is doing.  Together with some
335          other marginally trusted keys, GnuPG validates the target
336          key then as good.
337       d) "I fully trust" - Use this if you really know that this
338          introducer does a good job when certifying other keys.
339          If all the introducer are of this trust value, GnuPG
340          normally needs only one chain of signatures to validate
341          a target key okay. (But this may be adjusted with the help
342          of some options).
343     This information is confidential because it gives your personal
344     opinion on the trustworthiness of someone else.  Therefore this data
345     is not stored in the keyring but in the "trustdb"
346     (~/.gnupg/trustdb.gpg).  Do not assign a high trust value just
347     because the introducer is a friend of yours - decide how well she
348     understands the implications of key signatures and you may want to
349     tell her more about public key cryptography so you can later change
350     the trust value you assigned.
351
352     Okay, here is how GnuPG helps you with key management.  Most stuff
353     is done with the --edit-key command
354
355         gpg --edit-key <keyid or username>
356
357     GnuPG displays some information about the key and then prompts
358     for a command (enter "help" to see a list of commands and see
359     the man page for a more detailed explanation).  To sign a key
360     you select the user ID you want to sign by entering the number
361     that is displayed in the leftmost column (or do nothing if the
362     key has only one user ID) and then enter the command "sign" and
363     follow all the prompts.  When you are ready, give the command
364     "save" (or use "quit" to cancel your actions).
365
366     If you want to sign the key with another of your user IDs, you
367     must give an "-u" option on the command line together with the
368     "--edit-key".
369
370     Normally you want to sign only one user ID because GnuPG
371     uses only one and this keeps the public key certificate
372     small.  Because such key signatures are very important you
373     should make sure that the signatories of your key sign a user ID
374     which is very likely to stay for a long time - choose one with an
375     email address you have full control of or do not enter an email
376     address at all.  In future GnuPG will have a way to tell which
377     user ID is the one with an email address you prefer - because
378     you have no signatures on this email address it is easy to change
379     this address.  Remember, your signatories sign your public key (the
380     primary one) together with one of your user IDs - so it is not possible
381     to change the user ID later without voiding all the signatures.
382
383     Tip: If you hear about a key signing party on a computer conference
384     join it because this is a very convenient way to get your key
385     certified (But remember that signatures have nothing to to with the
386     trust you assign to a key).
387
388
389     8 Ways to Specify a User ID
390     --------------------------
391     There are several ways to specify a user ID, here are some examples.
392
393     * Only by the short keyid (prepend a zero if it begins with A..F):
394
395         "234567C4"
396         "0F34E556E"
397         "01347A56A"
398         "0xAB123456
399
400     * By a complete keyid:
401
402         "234AABBCC34567C4"
403         "0F323456784E56EAB"
404         "01AB3FED1347A5612"
405         "0x234AABBCC34567C4"
406
407     * By a fingerprint:
408
409         "1234343434343434C434343434343434"
410         "123434343434343C3434343434343734349A3434"
411         "0E12343434343434343434EAB3484343434343434"
412
413       The first one is MD5 the others are ripemd160 or sha1.
414
415     * By an exact string:
416
417         "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
418
419     * By an email address:
420
421         "<heinrichh@uni-duesseldorf.de>"
422
423     * By word match
424
425         "+Heinrich Heine duesseldorf"
426
427       All words must match exactly (not case sensitive) and appear in
428       any order in the user ID.  Words are any sequences of letters,
429       digits, the underscore and characters with bit 7 set.
430
431     * Or by the usual substring:
432
433         "Heine"
434         "*Heine"
435
436       The '*' indicates substring search explicitly.
437
438
439     Batch mode
440     ----------
441     If you use the option "--batch", GnuPG runs in non-interactive mode and
442     never prompts for input data.  This does not even allow entering the
443     passphrase.  Until we have a better solution (something like ssh-agent),
444     you can use the option "--passphrase-fd n", which works like PGP's
445     PGPPASSFD.
446
447     Batch mode also causes GnuPG to terminate as soon as a BAD signature is
448     detected.
449
450
451     Exit status
452     -----------
453     GnuPG returns with an exit status of 1 if in batch mode and a bad signature
454     has been detected or 2 or higher for all other errors.  You should parse
455     stderr or, better, the output of the fd specified with --status-fd to get
456     detailed information about the errors.
457
458
459     Configure options 
460     -----------------
461     Here is a list of configure options which are sometime useful 
462     for installation.
463
464     --enable-static-rnd=<name> 
465                      Force the use of the random byte gathering
466                      module <name>.  Default is either to use /dev/random
467                      or the auto mode.  Value for name:
468                        egd - Use the module which accesses the
469                              Entropy Gathering Daemon. See the webpages
470                              for more information about it.
471                       unix - Use the standard Unix module which does not
472                              have a very good performance.
473                      linux - Use the module which accesses /dev/random.
474                              This is the first choice and the default one
475                              for GNU/Linux or *BSD.
476                       auto - Compile linux, egd and unix in and 
477                              automagically select at runtime.
478   
479     --with-egd-socket=<name>
480                      This is only used when EGD is used as random
481                      gatherer. GnuPG uses by default "~/.gnupg/entropy"
482                      as the socket to connect EGD.  Using this option the
483                      socket name can be changed.  You may use any filename
484                      here with 2 exceptions:  a filename starting with
485                      "~/" uses the socket in the home directory of the user
486                      and one starting with a "=" uses a socket in the
487                      GnuPG home directory which is "~/.gnupg" by default.
488    
489      --with-included-zlib
490                      Forces usage of the local zlib sources. Default is
491                      to use the (shared) library of the system.
492
493      --with-included-gettext
494                      Forces usage of the local gettext sources instead of
495                      the one provided by your system.
496
497      --disable-nls
498                      Disable NLS support (See the file ABOUT-NLS)
499
500      --enable-m-guard
501                      Enable the integrated malloc checking code. Please
502                      note that this feature does not work on all CPUs
503                      (e.g. SunOS 5.7 on UltraSparc-2) and might give
504                      you a bus error.
505
506      --disable-dynload 
507                     If you have problems with dynamic loading, this
508                     option disables all dynamic loading stuff.  Note
509                     that the use of dynamic linking is very limited.
510
511      --disable-asm
512                     Do not use assembler modules.  It is not possible 
513                     to use this on some CPU types.
514                     
515      --disable-exec
516                     Disable all remote program execution.  This
517                     disables photo ID viewing as well as all keyserver
518                     types aside from HKP.
519
520      --disable-photo-viewers
521                     Disable only photo ID viewing.
522
523      --disable-keyserver-helpers
524                     Disable only keyserver helpers (not including
525                     HKP).
526
527      --disable-keyserver-path
528                     Disables the user's ability to use the exec-path
529                     feature to add additional search directories when
530                     executing a keyserver helper.
531
532      --with-photo-viewer=FIXED_VIEWER
533                     Force the photo viewer to be FIXED_VIEWER and
534                     disable any ability for the user to change it in
535                     their options file.
536
537      --disable-idea
538      --disable-cast5
539      --disable-blowfish
540      --disable-aes
541      --disable-twofish
542      --disable-sha256
543      --disable-sha512
544                     Removes support for the selected algorithm.  This
545                     can give a smaller gpg binary for places where
546                     space is tight.
547
548                     *** Note, that if there are existing keys that
549                     have one of these algorithms as a preference,
550                     messages may be received that use one of these
551                     algorithms and you will not be able to decrypt the
552                     message! ***
553
554                     A public key preference list can be updated to
555                     match the list of available algorithms by using
556                     'gpg --edit (thekey)', and running the "updpref"
557                     command.
558
559
560     Installation Problems
561     ---------------------
562     If you get unresolved externals "gettext" you should run configure
563     again with the option "--with-included-gettext"; this is version
564     0.10.40 which is available at ftp.gnu.org.
565
566     If you have other compile problems, try the configure options
567     "--with-included-zlib" or "--disable-nls" (See ABOUT-NLS) or
568     --disable-dynload.
569
570     We can't check all assembler files, so if you have problems
571     assembling them (or the program crashes) use --disable-asm with
572     ./configure.  If you opt to delete individual replacement files in
573     hopes of using the remaining ones, be aware that the configure
574     scripts may consider several subdirectories to get all available
575     assembler files; be sure to delete the correct ones. The assembler
576     replacements are in C and in mpi/generic; never delete
577     udiv-qrnnd.S in any CPU directory, because there may be no C
578     substitute.  Don't forget to delete "config.cache" and run
579     "./config.status --recheck".  We have also heard reports of
580     problems when using versions of gcc earlier than 2.96 along with a
581     non-GNU assembler (as).  If this applies to your platform, you can
582     either upgrade gcc to a more recent version, or use the GNU
583     assembler.
584
585     Some make tools are broken - the best solution is to use GNU's
586     make.  Try gmake or grab the sources from a GNU archive and
587     install them.
588
589     On some OSF systems you may get unresolved externals.  This is a
590     libtool problem and the workaround is to manually remove all the
591     "-lc -lz" but the last one from the linker line and execute them
592     manually.
593
594     On some architectures you see warnings like:
595       longlong.h:175: warning: function declaration isn't a prototype
596     or
597       http.c:647: warning: cast increases required alignment of target type
598     This doesn't matter and we know about it (actually it is due to
599     some warning options which we have enabled for gcc)
600
601
602     Specific problems on some machines
603     ----------------------------------
604
605     * Apple Darwin 6.1:
606
607         ./configure --with-libiconv-prefix=/sw
608
609     * Compaq C V6.2 for alpha:
610
611         You may want to use the option "-msg-disable ptrmismatch1"
612         to get rid of the sign/unsigned char mismatch warnings.
613
614     * IBM RS/6000 running AIX:
615
616         Due to a change in gcc (since version 2.8) the MPI stuff may
617         not build. In this case try to run configure using:
618             CFLAGS="-g -O2 -mcpu=powerpc" ./configure
619
620     * SVR4.2 (ESIX V4.2 cc)
621
622         Due to problems with the ESIX as, you probably want to do
623             CFLAGS="-O -K pentium" ./configure --disable-asm
624
625     * SunOS 4.1.4
626
627          ./configure ac_cv_sys_symbol_underscore=yes
628
629     The Random Device
630     -----------------
631
632     Random devices are available in Linux, FreeBSD and OpenBSD.
633     Operating systems without a random devices must use another
634     entropy collector. 
635
636     This collector works by running a lot of commands that yield more
637     or less unpredictable output and feds this as entropy into the
638     random generator - It should work reliably but you should check
639     whether it produces good output for your version of Unix. There
640     are some debug options to help you (see cipher/rndunix.c).
641
642
643     Creating an RPM package
644     -----------------------
645     The file scripts/gnupg.spec is used to build a RPM package (both
646     binary and src):
647       1. copy the spec file into /usr/src/redhat/SPECS
648       2. copy the tar file into /usr/src/redhat/SOURCES
649       3. type: rpm -ba SPECS/gnupg.spec
650
651     Or use the -t (--tarbuild) option of rpm:
652       1. rpm -ta gnupg-x.x.x.tar.gz
653
654     The binary rpm file can now be found in /usr/src/redhat/RPMS, source
655     rpm in /usr/src/redhat/SRPMS
656
657
658     How to Get More Information
659     ---------------------------
660
661     The primary WWW page is "http://www.gnupg.org"
662     The primary FTP site is "ftp://ftp.gnupg.org/gcrypt/"
663
664     See http://www.gnupg.org/download/mirrors.html for a list of
665     mirrors and use them if possible.  You may also find GnuPG
666     mirrored on some of the regular GNU mirrors.
667
668     We have some mailing lists dedicated to GnuPG:
669
670         gnupg-announce@gnupg.org    For important announcements like
671                                     new versions and such stuff.
672                                     This is a moderated list and has
673                                     very low traffic.
674
675         gnupg-users@gnupg.org       For general user discussion and
676                                     help.
677
678         gnupg-devel@gnupg.org       GnuPG developers main forum.
679
680     You subscribe to one of the list by sending mail with a subject
681     of "subscribe" to x-request@gnupg.org, where x is the name of the
682     mailing list (gnupg-announce, gnupg-users, etc.).  An archive of
683     the mailing lists are available at
684     http://www.gnupg.org/documentation/mailing-lists.html
685
686     Please direct bug reports to http://bugs.gnupg.org or post
687     them direct to the mailing list <gnupg-devel@gnupg.org>.
688
689     Please direct questions about GnuPG to the users mailing list or
690     one of the pgp newsgroups; please do not direct questions to one
691     of the authors directly as we are busy working on improvements
692     and bug fixes.  Both mailing lists are watched by the authors
693     and we try to answer questions when time allows us to do so.
694
695     Commercial grade support for GnuPG is available; please see
696     the GNU service directory or search other resources.