* README.W32: Adjusted some descriptions. Fixed the regsitry
[gnupg.git] / README
diff --git a/README b/README
index 0bec85a..de3093e 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 mainly released
-    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 are released as needed.
-
-    GnuPG works best on GNU/Linux or *BSD.  Other Unices are
-    also supported but not as good tested as those Freenix ones.
-    Please verify the tar file; there is a PGP2 and a GnuPG/PGP5
-    signature available. 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 it 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 a closed one (only subscribers are allowed
-    to post) to avoid misuse by folks who don't know the Netiquette
-    and trash your mailspool with commercial junk.
+                           Version 1.0
 
-    See the file COPYING for copyright and warranty information.
+    Copyright 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
+
+    This file is free software; as a special exception the author gives
+    unlimited permission to copy and/or distribute it, with or without
+    modifications, as long as this notice is preserved.
 
-    GnuPG is in compliance with RFC2440 (OpenPGP), see doc/OpenPGP for
-    details.
+    This file is distributed in the hope that it will be useful, but
+    WITHOUT ANY WARRANTY, to the extent permitted by law; without even the
+    implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 
-    Due to the fact that GnuPG does not use use any patented algorithm,
-    it cannot be compatible with PGP2 versions; PGP 2.x does only use
-    IDEA (which is patented worldwide) and RSA (which is patented in
-    the United States until Sep 20, 2000).
+    Intro
+    -----
 
-    The default algorithms are now DSA and ElGamal.  ElGamal for signing
-    is still available, but due to the larger size of such signatures it
-    is depreciated (Please note that the GnuPG implementation of ElGamal
-    signatures is *not* insecure).  Symmetric algorithms are: 3DES,
-    Blowfish and CAST5 (Twofish will come soon),  available digest
-    algorithms are MD5, RIPEMD160, SHA1 and TIGER/192.
+    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 IDEA (which is patented
+    worldwide).
+
+    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: AES, 3DES, Blowfish, CAST5 and Twofish 
+    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) "make"
+    2) Unpack the TAR.  With GNU tar you can do it this way:
+       "tar xzvf gnupg-x.y.z.tar.gz"
 
-    3) "make install"
+    3) "cd gnupg-x.y.z"
 
-    4) You end up with the binaries "gpg" and "gpgm" in /usr/local/bin.
+    4) "./configure"
 
-    5) Optional, but suggested: install the binary "gpg" as suid root.
+    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"
 
-    Intro
-    -----
-    This is a brief overview how to use GnuPG - it is highly suggested
-    that you read the manual^H^H^H more information about the use
-    of cryptography.  GnuPG is only the technical tool to do it and
-    the security highly depends on that YOU KNOW WHAT YOU ARE DOING.
+    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 doc/samplekeys.asc (use "gpg --import  doc/samplekeys.asc"
+       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
+
+       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 don't have any of the above programs, you have to verify
+       the MD5 checksum:
+
+       $ md5sum gnupg-x.y.z.tar.gz
+
+       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
+    -------------
+
+    The manual will be distributed separate under the name "gph".
+    An online version of the latest manual draft is available at the
+    GnuPG web pages:
+
+       http://www.gnupg.org/gph/
+
+    A list of frequently asked questions is available in GnuPG's
+    distibution in the file doc/FAQ and online as:
+
+       http://www.gnupg.org/faq.html
+
+    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
+    ------------
+
+    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
-    running gpg once, so that it can create the correct directory.
+    running gpg once to create the correct directory.
 
-    The normal way to create a key is:
+    The normal way to create a key is
 
        gpg --gen-key
 
     access - don't do it over the network or on a machine used also
     by others - especially if you have no access to the root account.
 
-    When you are asked for a passphrase; use a good one which you can easy
-    remember. Don't make the passphrase too long because you have to
-    type it for every decryption or signing; but - AND THIS IS VERY
-    IMPORTANT - use a good one which is not easily guessable as the
+    When you are asked for a passphrase use a good one which you can
+    easy remember.  Don't make the passphrase too long because you have
+    to type it for every decryption or signing; but, - AND THIS IS VERY
+    IMPORTANT - use a good one that is not easily to guess because the
     security of the whole system relies on your secret key and the
-    passphrase is used to protect this secret key in case someone was
-    able to get access to your secret keyring. A good way to select
-    a passphrase is to figure out a short nonsense sentence which makes
-    some sense for you and modify it by inserting extra spaces, non-letters
-    and changing the case of some characters - this is really easy to
-    remember especially if you associate some pictures with it.
+    passphrase that protects it when someone gains access to your secret
+    keyring.  A good way to select a passphrase is to figure out a short
+    nonsense sentence which makes some sense for you and modify it by
+    inserting extra spaces, non-letters and changing the case of some
+    characters - this is really easy to remember especially if you
+    associate some pictures with it.
 
-    Then you should create a revocation certificate in case someone
-    gets knowledge of your secret key or you forgot your passphrase:
+    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
 
-    Run this command and store it away; output is always ASCII armored,
-    so that you can print it and (hopefully never) re-create it if
-    your electronic media fails.
+    Run this command and store the revocation certificate away.  The output
+    is always ASCII armored, so that you can print it and (hopefully
+    never) re-create it if your electronic media fails.
 
-    Now you can use your key to create digital signatures:
+    Now you can use your key to create digital signatures
 
        gpg -s file
 
-    This creates a file file.gpg which is compressed and has a signature
-    attached.
+    This creates a file "file.gpg" which is compressed and has a
+    signature attached.
 
        gpg -sa file
 
-    Same as above, but creates the file.asc which is ascii armored and
-    and ready for sending by mail.  Note: It is better to use your
+    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
     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
 
-    Creates a signature of file, but writes the output to the file "out".
+    Creates a signature of "file", but writes the output to the file
+    "out".
 
     Everyone who knows your public key (you can and should publish
     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;
+    file) is now able to check whether you really signed this text
 
        gpg --verify file
 
     appropriate message.  If the signature is good, you know at least
     that the person (or machine) has access to the secret key which
     corresponds to the published public key.
+
     If you run gpg without an option it will verify the signature and
-    create a new file which is identical to the original file. gpg
-    can also run as a filter, so that you can pipe data to verify
-    trough it:
+    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
 
-    will check the signature of signed-file and then display the
+    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 this:
+    To send a message encrypted to someone you can use
 
        gpg -e -r heine file
 
-    This encrypts file with the public key of the user "heine" and
+    This encrypts "file" with the public key of the user "heine" and
     writes it to "file.gpg"
 
-       echo "hallo" | gpg -ea -r heine | mail heine
+       echo "hello" | gpg -ea -r heine | mail heine
 
-    Ditto, but encrypts "hallo\n" and mails it as ascii armored message
+    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
 
-    This encrypts file with the public key of "heine" and writes it
+    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
     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:
+    GnuPG has some options to help you publish public keys.  This is
+    called "exporting" a key, thus
 
        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 MIME attachment
-    to someone else or put it on an FTP server. To export only some
-    user IDs, you give them as arguments on the command line.
+    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
+    MIME attachment to someone else or put it on an FTP server. To
+    export only some user IDs, you give them as arguments on the command
+    line.
 
     To mail a public key or put it on a web page you have to create
-    the key in ASCII armored format:
+    the key in ASCII armored format
 
        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; is called "importing":
+    into your public keyring.  This is called "importing"
 
        gpg --import [filenames]
 
     New keys are appended to your keyring and already existing
-    keys are updated. Note that GnuPG does not allow keys which
-    are not self-signed by the user.
+    keys are updated. Note that GnuPG does not import keys that
+    are not self-signed.
 
-    Because anyone can claim that the public key belongs to her
-    we must have some way to check that the public key really belongs
+    Because anyone can claim that a public key belongs to her
+    we must have some way to check that a public key really belongs
     to the owner.  This can be achieved by comparing the key during
     a phone call.  Sure, it is not very easy to compare a binary file
     by reading the complete hex dump of the file - GnuPG (and nearly
     every other program used for management of cryptographic keys)
-    provides other solutions:
+    provides other solutions.
 
        gpg --fingerprint <username>
 
-    prints the so called "fingerprint" of the given username; this
+    prints the so called "fingerprint" of the given username which
     is a sequence of hex bytes (which you may have noticed in mail
-    sigs or on business cards) which uniquely identify the public
-    key - two different keys will always have different fingerprints.
-    It is easy to compare this fingerprint by phone and I suggest
+    sigs or on business cards) that uniquely identifies the public
+    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.
-
-    If you don't know the owner of the public key you are in trouble;
-    but wait: A friend of you knows someone who knows someone who
-    has met the owner of the public key at some computer conference.
-    So all the persons between you and the public key holder may now
-    act as introducer to you; this is done by signing the keys and
-    thereby certifying the other keys. If you then trust all the
-    introducers to correctly sign other keys, you can be be sure that
-    the other key really belongs to the one who claims so.
-
-    There are 2 steps to validate a target key:
+    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
+    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.
         normally needs only one chain of signatures to validate
         a target key okay. (But this may be adjusted with the help
         of some options).
-    These information are confidential because they give your
-    personal opinion on the trustworthy of someone else.  Therefore
-    this data is not stored in the keyring but in the "trustdb"
+    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"
     (~/.gnupg/trustdb.gpg).  Do not assign a high trust value just
-    because the introducer is a friend of you - decide how far she
-    understands all the implications of key signatures and you may
-    want to tell him more about public key cryptography so you
-    can later change the trust value you assigned.
+    because the introducer is a friend of yours - decide how well she
+    understands the implications of key signatures and you may want to
+    tell her more about public key cryptography so you can later change
+    the trust value you assigned.
 
-    Okay, here is how GnuPG helps you in key management:  Most stuff is
-    done with the --edit-key  command:
+    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>
 
     for a command (enter "help" to see a list of commands and see
     the man page for a more detailed explanation).  To sign a key
     you select the user ID you want to sign by entering the number
-    which is displayed in the leftmost column (or do nothing if the
+    that is displayed in the leftmost column (or do nothing if the
     key has only one user ID) and then enter the command "sign" and
     follow all the prompts.  When you are ready, give the command
     "save" (or use "quit" to cancel your actions).
 
-    If you want to sign the key with another user ID of yours, you
+    If you want to sign the key with another of your user IDs, you
     must give an "-u" option on the command line together with the
     "--edit-key".
 
     Normally you want to sign only one user ID because GnuPG
-    does only use one and this keeps the public key certificate
+    uses only one and this keeps the public key certificate
     small.  Because such key signatures are very important you
-    should make sure that the signators of your key sign a user ID
+    should make sure that the signatories of your key sign a user ID
     which is very likely to stay for a long time - choose one with an
     email address you have full control of or do not enter an email
     address at all.  In future GnuPG will have a way to tell which
     user ID is the one with an email address you prefer - because
     you have no signatures on this email address it is easy to change
-    this address.  Remember: Your signators sign your public key (the
+    this address.  Remember, your signatories sign your public key (the
     primary one) together with one of your user IDs - so it is not possible
     to change the user ID later without voiding all the signatures.
 
     trust you assign to a key).
 
 
-    7 Ways to Specify a User ID
+    8 Ways to Specify a User ID
     --------------------------
-    There are several ways to specify a user ID, here are some examples:
+    There are several ways to specify a user ID, here are some examples.
 
     * Only by the short keyid (prepend a zero if it begins with A..F):
 
 
        "<heinrichh@uni-duesseldorf.de>"
 
-    * By the Local ID (from the trust DB):
+    * By word match
 
-       "#34"
+       "+Heinrich Heine duesseldorf"
 
-      This may be used by a MUA to specify an exact key after selecting
-      a key from GnuPG (by the use of a special option or an extra utility)
+      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.
 
     * Or by the usual substring:
 
     ----------
     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
+    passphrase.  Until we have a better solution (something like ssh-agent),
+    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
     -----------
     GnuPG returns with an exit status of 1 if in batch mode and a bad signature
     has been detected or 2 or higher for all other errors.  You should parse
-    stderr or better the output of the fd specified with --status-fd to get
+    stderr or, better, the output of the fd specified with --status-fd to get
     detailed information about the errors.
 
 
-    Esoteric commands
-    -----------------
-
-       gpg --list-packets datafile
-
-    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 be able
-    to list all kinds of rfc2440 messages.
-
-       gpgm --list-trustdb
+    How to Get More Information
+    ---------------------------
 
-    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/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 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.
 
-    Other Notes
-    -----------
+       gnupg-users@gnupg.org       For general user discussion and
+                                   help.
 
-    The primary FTP site is "ftp://ftp.gnupg.org/pub/gcrypt/"
-    The primary WWW page is "http://www.gnupg.org"
+       gnupg-devel@gnupg.org       GnuPG developers main forum.
 
-    See http://www.gnupg.org/mirrors.html for a list of FTP mirrors
-    and use them if possible.
+    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 .
 
-    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; this gives me more time to improve
-    GnuPG.  Commercial support for GnuPG will be available soon.
+    The gnupg.org domain is hosted in Germany to avoid possible legal
+    problems (technical advices may count as a violation of ITAR).
 
-    Have fun and remember: Echelon is looking at you kid.
+    Please direct bug reports to <gnupg-bugs@gnu.org> or post
+    them direct to the mailing list <gnupg-devel@gnupg.org>.
 
+    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.
 
------BEGIN PGP SIGNATURE-----
-Version: GnuPG v0.9.1 (GNU/Linux)
-Comment: For info see http://www.gnupg.org
+    Commercial grade support for GnuPG is available; please see
+    the GNU service directory or search other resources.
 
-iQB1AwUBNpyIDR0Z9MEMmFelAQGn4gL+IVlEye5I6LplxdUExsrHQpLV21H0UXFa
-/Dl1T/HjrGHj41NeW2evO4Ck2K6Z0TG5jPg9CuJdcJp0siJ8odO7BTLaF3r6gwxF
-CA4EXgqhSyE8PXRPS4m4M5I7Ru/bsZrF
-=HfE0
------END PGP SIGNATURE-----