See ChangeLog: Fri Mar 24 11:25:45 CET 2000 Werner Koch
[libgcrypt.git] / README
diff --git a/README b/README
index 845c15b..9292d36 100644 (file)
--- a/README
+++ b/README
@@ -1,57 +1,43 @@
 -----BEGIN PGP SIGNED MESSAGE-----
 
-                    GnuPG - The GNU Privacy Guard
-                   -------------------------------
-                            Version 0.9
-
-    GnuPG is now in Beta test and you should report all bugs to the
-    mailing list (see below).  The 0.9.x versions are released mainly
-    to fix all remaining serious bugs.  As soon as version 1.0 is out,
-    development will continue with a 1.1 series and bug fixes for the
-    1.0 version as needed.
-
-    GnuPG works best on GNU/Linux or *BSD.  Other Unices are
-    also supported but are not as well tested as the Free Unices.
-    Please verify the tar file with the PGP2 or GnuPG/PGP5
-    signatures provided.  My PGP2 key is well known and published in
-    the "Global Trust Register for 1998", ISBN 0-9532397-0-5.
-
-    I have included my pubring as "g10/pubring.asc", which contains
-    the key used to make GnuPG signatures:
-    "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
-    "Key fingerprint = 6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
-
-    My new DSA key is:
-    "pub  1024D/621CC013 1998-07-07 Werner Koch <werner.koch@guug.de>"
-    "Key fingerprint = ECAF 7590 EB34 43B5 C7CF  3ACB 6C7E E1B8 621C C013"
-
-    You may want add my new DSA key to your GnuPG pubring and use it in
-    the future to verify new releases.  Because you verified this README
-    file and _checked_that_it_is_really_my PGP2 key 0C9857A5, you can be
-    sure that the above fingerprints are correct.
-
-    Please subscribe to g10@net.lut.ac.uk by sending a mail with
-    the word "subscribe" in the body to "g10-request@net.lut.ac.uk".
-    This mailing list is closed (only subscribers are allowed to post)
-    to avoid misuse by folks who don't know the Netiquette and trash
-    your mailspool with commercial junk.
+                   GnuPG - The GNU Privacy Guard
+                  -------------------------------
+                           Version 1.1
+
+       WARNING:  This is the current development branch
+                 of GnuPG.  THIS SHOULD NOT BE USED IN
+                 A PRODUCTION ENVIRONMENT.  It will
+                 change quite often and may have serious
+                 problems.  Use the GnuPG from the stable
+                 Branch 1.0.x  for real work.  The next
+                 stable release will be 1.2
 
-    See the file COPYING for copyright and warranty information.
 
-    GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP for
-    details.
+    GnuPG is GNU's tool for secure communication and data storage.
+    It can be used to encrypt data and to create digital signatures.
+    It includes an advanced key management facility and is compliant
+    with the proposed OpenPGP Internet standard as described in RFC2440.
+
+    GnuPG works best on GNU/Linux or *BSD systems.  Most other Unices
+    are also supported but are not as well tested as the Free Unices.
+    See http://www.gnupg.org/gnupg.html#supsys for a list of systems
+    which are known to work.
+
+    See the file COPYING for copyright and warranty information.
 
     Because GnuPG does not use use any patented algorithm it cannot be
     compatible with PGP2 versions.  PGP 2.x uses only IDEA (which is
     patented worldwide) and RSA (which is patented in the United States
     until Sep 20, 2000).
 
-    The default algorithms are now DSA and ElGamal.  ElGamal for signing
+    The default algorithms are DSA and ElGamal.  ElGamal for signing
     is still available, but because of the larger size of such
     signatures it is deprecated (Please note that the GnuPG
     implementation of ElGamal signatures is *not* insecure).  Symmetric
-    algorithms are: 3DES, Blowfish, and CAST5 (Twofish will come soon).
-    Digest algorithms available are MD5, RIPEMD160, SHA1, and TIGER/192.
+    algorithms are: 3DES, Blowfish, CAST5 and Twofish (GnuPG does not
+    yet create Twofish encrypted messages because there is no agreement
+    in the OpenPGP WG on how to use it together with a MDC algorithm)
+    Digest algorithms available are MD5, RIPEMD160 and SHA1.
 
 
     Installation
 
     Here is a quick summary:
 
-    1)  "./configure"
+    1) Check that you have unmodified sources. The below on how to do this.
+       Don't skip it - this is an important step!
+
+    2) Unpack the TAR.  With GNU tar you can do it this way:
+       "tar xzvf gnupg-x.y.z.tar.gz"
+
+    3) "cd gnupg-x.y.z"
+
+    4) "./configure"
+
+    5) "make"
+
+    6) "make install"
+
+    7) You end up with a "gpg" binary in /usr/local/bin.
+       Note: Because some old programs rely on the existence of a
+       binary named "gpgm" (which was build by some Beta versions
+       of GnuPG); you may want to install a symbolic link to it:
+       "cd /usr/local/bin; ln -s gpg gpgm"
+
+    8) To avoid swapping out of sensitive data, you can install "gpg" as
+       suid root.  If you don't do so, you may want to add the option
+       "no-secmem-warning" to ~/.gnupg/options
+
+
+    How to Verify the Source
+    ------------------------
+
+    In order to check that the version of GnuPG which you are going to
+    install is an original and unmodified one, you can do it in one of
+    the following ways:
+
+    a) If you already have a trusted Version of GnuPG installed, you
+       can simply check the supplied signature:
+
+       $ gpg --verify gnupg-x.y.z.tar.gz.asc
+
+       This checks that the detached signature gnupg-x.y.z.tar.gz.asc
+       is indeed a a signature of gnupg-x.y.z.tar.gz.  The key used to
+       create this signature is:
+
+       "pub  1024D/57548DCD 1998-07-07 Werner Koch (gnupg sig) <dd9jn@gnu.org>"
+
+       If you do not have this key, you can get it from the source in
+       the file g10/pubring.asc (use "gpg --import g10/pubring.gpg" to
+       add it to the keyring) or from any keyserver.  You have to make
+       sure that this is really the key and not a faked one. You can do
+       this by comparing the output of:
+
+               $ gpg --fingerprint 0x57548DCD
+
+       with the elsewhere published fingerprint, or - if you are able to
+       _positively_ verify the signature of this README file - with
+       this fingerprint: "6BD9 050F D8FC 941B 4341  2DCC 68B7 AB89 5754 8DCD"
+
+       Please note, that you have to use an old version of GnuPG to
+       do all this stuff.  *Never* use the version which you are going
+       to check!
+
+
+    b) If you have a trusted Version of PGP 2 or 5 installed, you
+       can check the supplied PGP 2 signature:
 
-    2) "make"
+       $ pgp gnupg-x.y.z.tar.gz.sig gnupg-x.y.z.tar.gz
 
-    3) "make install"
+       This checks that the detached signature gnupg-x.y.z.tar.gz.sig
+       is indeed a a signature of gnupg-x.y.z.tar.gz.  Please note,
+       that this signature has been created with a RSA signature and
+       you probably can't use this method (due to legal reasons) when
+       you are in the U.S.  The key used to create this signature is
+       the same as the one used to sign this README file.  It should be
+       available at the keyservers and is also included in the source
+       of GnuPG in g10/pubring.asc.
 
-    4) You end up with the binaries "gpg" and "gpgm" in /usr/local/bin.
+       "pub   768R/0C9857A5 1995-09-30 Werner Koch <werner.koch@guug.de>"
 
-    5) Optional, but suggested, install the binary "gpg" as suid root.
+       The fingerprint of this key is published in printed form in the
+         "Global Trust Register for 1998", ISBN 0-9532397-0-5.
 
 
+    c) If you don't have any of the above programs, you have to verify
+       the MD5 checksum:
+
+       $ md5sum gnupg-x.y.z.tar.gz.sig
+
+       This should yield an output similar_to this:
+
+       fd9351b26b3189c1d577f0970f9dcadc  gnupg-x.y.z.tar.gz
+
+       Now check that this checksum is _exactly_ the same as the one
+       published via the announcement list and probably via Usenet.
+
+
+
+    Documentation
+    -------------
+
+    A draft version of the manual is included in the subdirectory doc/gph.
+    The supplied version is rendered in HTML and you may access it with any
+    browser (e.g.: lynx doc/gpg/index.html).  The GnuPG webpages have a link
+    to the latest development version and you may want to read those instead.
+
+    A couple of HOWTO documents are available online; for a listing see:
+
+       http://www.gnupg.org/docs.html#howtos
+
+    A man page with a description of all commands and options gets installed
+    along with the program.
+
 
     Introduction
     ------------
 
-    This is a brief overview how to use GnuPG - it is strongly suggested
-    that you read the manual^H^H^H more information about the use of
-    cryptography.  GnuPG is only a tool, secure results require that YOU
-    KNOW WHAT YOU ARE DOING.
+    Here is a brief overview on how to use GnuPG - it is strongly suggested
+    that you read the manual and other information about the use of
+    cryptography.  GnuPG is only a tool, secure usage requires that
+    YOU KNOW WHAT YOU ARE DOING.
 
     If you already have a DSA key from PGP 5 (they call them DH/ElGamal)
     you can simply copy the pgp keyrings over the GnuPG keyrings after
 
     The normal way to create a key is
 
-        gpg --gen-key
+       gpg --gen-key
 
     This asks some questions and then starts key generation. To create
     good random numbers for the key parameters, GnuPG needs to gather
     Next, you should create a revocation certificate in case someone
     gets knowledge of your secret key or you forgot your passphrase
 
-        gpg --gen-revoke your_user_id
+       gpg --gen-revoke your_user_id
 
     Run this command and store the revocation certificate away.  The output
     is always ASCII armored, so that you can print it and (hopefully
 
     Now you can use your key to create digital signatures
 
-        gpg -s file
+       gpg -s file
 
     This creates a file "file.gpg" which is compressed and has a
     signature attached.
 
-        gpg -sa file
+       gpg -sa file
 
     Same as above, but creates a file "file.asc" which is ASCII armored
-    and and ready for sending by mail.  It is better to use your
+    and and ready for sending by mail. It is better to use your
     mailers features to create signatures (The mailer uses GnuPG to do
     this) because the mailer has the ability to MIME encode such
     signatures - but this is not a security issue.
 
-        gpg -s -o out file
+       gpg -s -o out file
 
     Creates a signature of "file", but writes the output to the file
     "out".
     your key by putting it on a key server, a web page or in your .plan
     file) is now able to check whether you really signed this text
 
-        gpg --verify file
+       gpg --verify file
 
     GnuPG now checks whether the signature is valid and prints an
     appropriate message.  If the signature is good, you know at least
     create a new file that is identical to the original.  gpg can also
     run as a filter, so that you can pipe data to verify trough it
 
-        cat signed-file | gpg | wc -l
+       cat signed-file | gpg | wc -l
 
     which will check the signature of signed-file and then display the
     number of lines in the original file.
 
     To send a message encrypted to someone you can use
 
-        gpg -e -r heine file
+       gpg -e -r heine file
 
     This encrypts "file" with the public key of the user "heine" and
     writes it to "file.gpg"
 
-        echo "hello" | gpg -ea -r heine | mail heine
+       echo "hello" | gpg -ea -r heine | mail heine
 
     Ditto, but encrypts "hello\n" and mails it as ASCII armored message
     to the user with the mail address heine.
 
-        gpg -se -r heine file
+       gpg -se -r heine file
 
     This encrypts "file" with the public key of "heine" and writes it
     to "file.gpg" after signing it with your user id.
 
-        gpg -se -r heine -u Suttner file
+       gpg -se -r heine -u Suttner file
 
     Ditto, but sign the file with your alternative user id "Suttner"
 
     GnuPG has some options to help you publish public keys.  This is
     called "exporting" a key, thus
 
-        gpg --export >all-my-keys
+       gpg --export >all-my-keys
 
     exports all the keys in the keyring and writes them (in a binary
     format) to "all-my-keys".  You may then mail "all-my-keys" as an
     To mail a public key or put it on a web page you have to create
     the key in ASCII armored format
 
-        gpg --export --armor | mail panther@tiger.int
+       gpg --export --armor | mail panther@tiger.int
 
     This will send all your public keys to your friend panther.
 
     If you have received a key from someone else you can put it
     into your public keyring.  This is called "importing"
 
-        gpg --import [filenames]
+       gpg --import [filenames]
 
     New keys are appended to your keyring and already existing
     keys are updated. Note that GnuPG does not import keys that
     every other program used for management of cryptographic keys)
     provides other solutions.
 
-        gpg --fingerprint <username>
+       gpg --fingerprint <username>
 
     prints the so called "fingerprint" of the given username which
     is a sequence of hex bytes (which you may have noticed in mail
     key - different keys will always have different fingerprints.
     It is easy to compare fingerprints by phone and I suggest
     that you print your fingerprint on the back of your business
-    card.
+    card.  To see the fingerprints of the secondary keys, you can
+    give the command twice; but this is normally not needed.
 
     If you don't know the owner of the public key you are in trouble.
     Suppose however that friend of yours knows someone who knows someone
     who has met the owner of the public key at some computer conference.
     Suppose that all the people between you and the public key holder
-    may now act as introducers to you.  Introducers signing keys thereby
+    may now act as introducers to you. Introducers signing keys thereby
     certify that they know the owner of the keys they sign.  If you then
     trust all the introducers to have correctly signed other keys, you
     can be be sure that the other key really belongs to the one who
     claims to own it..
 
     There are 2 steps to validate a key:
-        1. First check that there is a complete chain
-           of signed keys from the public key you want to use
-           and your key and verify each signature.
-        2. Make sure that you have full trust in the certificates
-           of all the introduces between the public key holder and
-           you.
+       1. First check that there is a complete chain
+          of signed keys from the public key you want to use
+          and your key and verify each signature.
+       2. Make sure that you have full trust in the certificates
+          of all the introduces between the public key holder and
+          you.
     Step 2 is the more complicated part because there is no easy way
     for a computer to decide who is trustworthy and who is not.  GnuPG
     leaves this decision to you and will ask you for a trust value
     (here also referenced as the owner-trust of a key) for every key
-    needed to check the chain of certificates.  You may choose from:
+    needed to check the chain of certificates. You may choose from:
       a) "I don't know" - then it is not possible to use any
-         of the chains of certificates, in which this key is used
-         as an introducer, to validate the target key.  Use this if
-         you don't know the introducer.
+        of the chains of certificates, in which this key is used
+        as an introducer, to validate the target key.  Use this if
+        you don't know the introducer.
       b) "I do not trust" - Use this if you know that the introducer
-         does not do a good job in certifying other keys.  The effect
-         is the same as with a) but for a) you may later want to
-         change the value because you got new information about this
-         introducer.
+        does not do a good job in certifying other keys.  The effect
+        is the same as with a) but for a) you may later want to
+        change the value because you got new information about this
+        introducer.
       c) "I trust marginally" - Use this if you assume that the
-         introducer knows what he is doing.  Together with some
-         other marginally trusted keys, GnuPG validates the target
-         key then as good.
+        introducer knows what he is doing.  Together with some
+        other marginally trusted keys, GnuPG validates the target
+        key then as good.
       d) "I fully trust" - Use this if you really know that this
-         introducer does a good job when certifying other keys.
-         If all the introducer are of this trust value, GnuPG
-         normally needs only one chain of signatures to validate
-         a target key okay. (But this may be adjusted with the help
-         of some options).
+        introducer does a good job when certifying other keys.
+        If all the introducer are of this trust value, GnuPG
+        normally needs only one chain of signatures to validate
+        a target key okay. (But this may be adjusted with the help
+        of some options).
     This information is confidential because it gives your personal
     opinion on the trustworthiness of someone else.  Therefore this data
     is not stored in the keyring but in the "trustdb"
     Okay, here is how GnuPG helps you with key management.  Most stuff
     is done with the --edit-key command
 
-        gpg --edit-key <keyid or username>
+       gpg --edit-key <keyid or username>
 
     GnuPG displays some information about the key and then prompts
     for a command (enter "help" to see a list of commands and see
 
     * Only by the short keyid (prepend a zero if it begins with A..F):
 
-        "234567C4"
-        "0F34E556E"
-        "01347A56A"
-        "0xAB123456
+       "234567C4"
+       "0F34E556E"
+       "01347A56A"
+       "0xAB123456
 
     * By a complete keyid:
 
-        "234AABBCC34567C4"
-        "0F323456784E56EAB"
-        "01AB3FED1347A5612"
-        "0x234AABBCC34567C4"
+       "234AABBCC34567C4"
+       "0F323456784E56EAB"
+       "01AB3FED1347A5612"
+       "0x234AABBCC34567C4"
 
     * By a fingerprint:
 
-        "1234343434343434C434343434343434"
-        "123434343434343C3434343434343734349A3434"
-        "0E12343434343434343434EAB3484343434343434"
+       "1234343434343434C434343434343434"
+       "123434343434343C3434343434343734349A3434"
+       "0E12343434343434343434EAB3484343434343434"
 
       The first one is MD5 the others are ripemd160 or sha1.
 
     * By an exact string:
 
-        "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
+       "=Heinrich Heine <heinrichh@uni-duesseldorf.de>"
 
     * By an email address:
 
-        "<heinrichh@uni-duesseldorf.de>"
+       "<heinrichh@uni-duesseldorf.de>"
 
     * By word match
 
-        "+Heinrich Heine duesseldorf"
+       "+Heinrich Heine duesseldorf"
 
-      All words must match excatly (not case sensitive) and appear in
+      All words must match exactly (not case sensitive) and appear in
       any order in the user ID.  Words are any sequences of letters,
       digits, the underscore and characters with bit 7 set.
 
     * By the Local ID (from the trust DB):
 
-        "#34"
+       "#34"
 
       This may be used by a MUA to specify an exact key after selecting
       a key from GnuPG (by using a special option or an extra utility)
 
     * Or by the usual substring:
 
-        "Heine"
-        "*Heine"
+       "Heine"
+       "*Heine"
 
       The '*' indicates substring search explicitly.
 
     If you use the option "--batch", GnuPG runs in non-interactive mode and
     never prompts for input data.  This does not even allow entering the
     passphrase.  Until we have a better solution (something like ssh-agent),
-    you can use the option "--passphrase-fd n", which works like PGPs
+    you can use the option "--passphrase-fd n", which works like PGP's
     PGPPASSFD.
 
     Batch mode also causes GnuPG to terminate as soon as a BAD signature is
     detailed information about the errors.
 
 
-    Esoteric commands
-    -----------------
-
-        gpg --list-packets datafile
+    How to Get More Information
+    ---------------------------
 
-    Use this to list the contents of a data file. If the file is encrypted
-    you are asked for the passphrase, so that GnuPG is able to look at the
-    inner structure of a encrypted packet.  This command should list all
-    kinds of rfc2440 messages.
-
-        gpgm --list-trustdb
-
-    List the contents of the trust DB in a human readable format
-
-        gpgm --list-trustdb  <usernames>
-
-    List the tree of certificates for the given usernames
-
-        gpgm --list-trust-path  username
+    The primary WWW page is "http://www.gnupg.org"
+    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
 
-    List the possible trust paths for the given username. The length
-    of such a trust path is limited by the option --max-cert-depth
-    which defaults to 5.
+    See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
+    and use them if possible.  You may also find GnuPG mirrored on
+    some of the regular GNU mirrors.
 
-    For more options/commands see the man page or use "gpg --help".
+    We have some mailing lists dedicated to GnuPG:
 
+       gnupg-announce@gnupg.org    For important announcements like
+                                   new versions and  such stuff.
+                                   This is a moderated list and has
+                                   very low traffic.
+       gnupg-users@gnupg.org       For general user discussion and
+                                   help.
+       gnupg-devel@gnupg.org       GnuPG developers main forum.
 
-    Other Notes
-    -----------
+    You subscribe to one of the list by sending mail with a subject
+    of "subscribe" to x-request@gnupg.org, where x is the name of the
+    mailing list (gnupg-announce, gnupg-users, etc.).  An archive of
+    the mailing lists is available at http://lists.gnupg.org .
 
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
-    The primary WWW page is "http://www.gnupg.org"
+    The gnupg.org domain is hosted in Germany to avoid possible legal
+    problems (technical advices may count as a violation of ITAR).
 
-    See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
-    and use them if possible.
+    Please direct bug reports to <gnupg-bugs@gnu.org> or post
+    them direct to the mailing list <gnupg-devel@gnupg.org>.
 
-    Please direct bug reports to <gnupg-bugs@gnu.org> or, better,
-    post them to the mailing list <g10@net.lut.ac.uk> (this is a
-    closed list - subscribe before posting, see above (~line 33)).
-    Please direct questions about GnuPG to the mailing list or
-    one of the pgp newsgroups and give me more time to improve
-    GnuPG.  Commercial support for GnuPG will be available soon.
+    Please direct questions about GnuPG to the users mailing list or
+    one of the pgp newsgroups; please do not direct questions to one
+    of the authors directly as we are busy working on improvements
+    and bug fixes.  Both mailing lists are watched by the authors
+    and we try to answer questions when time allows us to do so.
 
-    Have fun and remember: Echelon is looking at you kid.
+    Commercial grade support for GnuPG is available; please see
+    the GNU service directory or search other resources.
 
 -----BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.9.2 (GNU/Linux)
+Version: GnuPG v1.0.0 (GNU/Linux)
 Comment: For info see http://www.gnupg.org
 
-iQB1AwUBNr2fPh0Z9MEMmFelAQHqNAL/e7pApR0CGUJ/zuIsjaVhNGPEgKAglcEd
-YuVdB+RCN0wq7ZfI0AHU2FdVISRACmSN3xituTTgeiOUsczM40EZ4l1XNfyRF768
-fglui6XxEeYHFY7mSQMgzzFWDG0Squx0
-=enRo
+iQB1AwUBN+M8CB0Z9MEMmFelAQFmggMAuwHxMcQPsS1r2pD1KVZ67qTUeZnSM+wP
+daX3wnBgZzxYhzZiuciaFYky6ERC0Er4HVKtSlLBPhY1N1y2d98Se7TTUaUsVY8F
+uvGJkK/7ykaHfWgcIbKFb6hlnpy29+mO
+=1oCH
 -----END PGP SIGNATURE-----