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