version 0.3.5
[gnupg.git] / README
diff --git a/README b/README
index 664c8a3..80b228a 100644 (file)
--- a/README
+++ b/README
@@ -1,50 +1,61 @@
+-----BEGIN PGP SIGNED MESSAGE-----
 
                  GNUPG - The GNU Privacy Guard
                 -------------------------------
+                         Version 0.3
 
-    THIS IS ALPHA SOFTWARE, EXPECT BUGS AND UNIMPLEMENTED STUFF.
+    WARNING: IF YOU ARE ALREADY USING GNUPG YOU SHOULD NOW MAKE A BACKUP
+    OF "gpg" BECAUSE YOU NEED IT TO CONVERT YOUR PASSPHRASE AND OTHER
+    THINGS - SEE "NEWS"!
+
+
+    As you can see from the version number, the program may have some
+    bugs and some features may not work at all - please report this to
+    the mailing list.
 
     On a Linux box (version 2.x.x, alpha or x86 CPU) it should
-    work reliable. You may create your key on such a machine and
+    work reliably.  You may create your key on such a machine and
     use it.  Please verify the tar file; there is a PGP and a GNUPG
-    signature available. My PGP key is well known and published in
+    signature available. My PGP 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"
+
+    Old version of gnupg are signed with this key:
     "pub  1312G/FF3EAA0B 1998-02-09 Werner Koch <wk@isil.d.shuttle.de>"
     "Key fingerprint = 8489 6CD0 1851 0E33 45DA  CD67 036F 11B8 FF3E AA0B"
 
-    You may add it to your GNUPG pubring and use it in the future to
-    verify new releases.  Because you verified the tar file containing
-    this file here, you can be sure that the above fingerprint is correct.
+    My usual key is now:
+    "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 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 is closed (only subscribers can post) to avoid spam.
 
     See the file COPYING for copyright and warranty information.
 
     Due to the fact that GNUPG does not use use any patented algorithm,
-    it cannot be compatible to old PGP versions, because those use
-    IDEA (which is worldwide patented) and RSA (which is patented in
-    the United States until Sep 20, 2000).  I'm sorry about this, but
-    this is the world we have created (e.g. by using proprietary software).
+    it cannot be compatible with old PGP versions, because those use
+    IDEA (which is patented worldwide) and RSA (which is patented in
+    the United States until Sep 20, 2000).
 
+    GNUPG is in almost all  aspects compatible with other OpenPGP
+    implementations.
 
-    Because the OpenPGP standard is still a draft, GNUPG is not yet
-    compatible to it (or PGP 5) - but it will. The data structures
-    used are compatible with PGP 2.x, so it can parse an list such files
-    and PGP should be able to parse data created by GNUPG and complain
-    about unsupported algorithms.
-
-    The default algorithms used by GNUPG are ElGamal for public-key
-    encryption and signing; Blowfish with a 160 bit key for protecting
-    the secret-key components, conventional and session encryption;
-    RIPE MD-160 to create message digest.  DSA, SHA-1 and CAST are
-    also implemented, but not used on default. I decided not
-    to use DSA as default signing algorithm, because it allows only for
-    1024 bit keys and this may be not enough in a couple of years.
+    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: Blowfish
+    and CAST5, Digest algorithms are MD5, RIPEMD160, SHA1 and TIGER/192.
 
 
 
 
     This asks some questions and then starts key generation. To create
     good random numbers for prime number generation, it uses a /dev/random
-    which will emit only bytes if the kernel can gather enough entropy.
+    which will only emit bytes if the kernel can gather enough entropy.
     If you see no progress, you should start some other activities such
-    as mouse moves, "find /" or using the keyboard (on another window).
-    Because we have no hardware device to generate random we have to use
-    this method.
-
-    Key generation shows progress by printing different characters to
-    stderr:
-            "."  Last 10 Miller-Rabin tests failed.
-            "+"  Miller-Rabin test succeeded.
-            "!"  Reloading the pool with fresh prime numbers
-            "^"  Checking a new value for the generator
-            "<"  Size of one factor decreased
-            ">"  Size of one factor increased
-
-    The prime number for ElGamal is generated this way:
-
-    1) Make a prime number q of 160, 200, 240 bits (depending on the keysize).
-    2) Select the length of the other prime factors to be at least the size
-       of q and calculate the number of prime factors needed
-    3) Make a pool of prime number, each of the length determined in step 2
-    4) Get a new permutation out of the pool or continue with step 3
-       if we have tested all permutations.
-    5) Calculate a candidate prime p = 2 * q * p[1] * ... * p[n] + 1
-    6) Check that this prime has the correct length (this may change q if
-       it seems not to be possible to make a prime of the desired length)
-    7) Check whether this is a prime using trial divisions and the
-       Miller-Rabin test.
-    8) Continue with step 4 if we did not find a prime in step 7.
-    9) Find a generator for that prime.
+    as mouse moves, "find /" or using the keyboard (in another window).
+    Because we have no hardware device to generate randomness we have to
+    use this method.
 
     You should make a revocation certificate in case someone gets
     knowledge of your secret key or you forgot your passphrase:
     so that you can print it and (hopefully never) re-create it if
     your electronic media fails.
 
+    If you decided to create a DSA key, you should add an ElGamal
+    for encryption:
+
+       gpg --add-key user_id_of_your_key
+
+    and follow the displayed instructions (select "ElGamal using v4 packets").
+
 
     You can sign a key with this command:
 
 
     This let you sign the key of of "Donald" with the userids of "Karl"
     and "Joe".
-    All existing signatures are checked, if some are invalid, a menu is
-    offered to delete some of them, and the you are asked for every user
-    wether you want to sign this key.
+    All existing signatures are checked; if some are invalid, a menu is
+    offered to delete some of them, and then you are asked for every user
+    whether you want to sign this key.
 
     You may remove a signature at any time using the option "--edit-sig",
-    which asks for the sigs to remove. Self-signatures are not removable.
+    which asks for the sigs to remove. Self-signatures are not removable.
 
 
 
 
     Creates a signature of file, but writes the output to the file "out".
 
+    If you use the option "--rfc1991", gnupg tries to me more compatible
+    to RFC1991 (pgp 2.x).
+
 
     Encrypt
     -------
        "01AB3FED1347A5612"
        "0x234AABBCC34567C4"
 
-    * By a fingerprint (not yet implemented):
+    * By a fingerprint:
 
        "1234343434343434C434343434343434"
        "123434343434343C3434343434343734349A3434"
     Batch mode
     ----------
     If you use the option "--batch", GNUPG runs in non-interactive mode and
-    never prompts for input data.  This even does not allow to enter
+    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 "--passhrase-fd n", which works like PGPs
     PGPPASSFD.
     -----------
     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 to get detailed informations about the errors.
+    stderr or the output of the fd specified with --status-fd to get detailed
+    information about the errors.
 
 
     Esoteric commands
 
     List the possible trust paths for the given username, up to the specified
     depth.  If depth is negative, duplicate introducers are not listed,
-    because those would increase the trust probabilty only minimal.
+    because those would increase the trust probability only minimally.
     (you must use the special option "--" to stop option parsing when
      using a negative number). This option may create new entries in the
     trustdb.
 
     List all available message digest values for the fiven filenames
 
-       gpgm --gen-prime n
-
-    Generate and print a simple prime number of size n
-
-       gpgm --gen-prime n q
-
-    Generate a prime number suitable for ElGamal signatures of size n with
-    a q as largest primefactor of n-1.
-
-       gpgm --gen-prime n q 1
-
-    Ditto, but calculate a generator too.
-
-
     For more options/commands see the file g10/OPTIONS, or use "gpg --help"
 
 
     Debug Flags
     -----------
-    Use the option "--debug n" to output debug informations. This option
+    Use the option "--debug n" to output debug information. This option
     can be used multiple times, all values are ORed; n maybe prefixed with
     0x to use hex-values.
 
     Other Notes
     -----------
     This is work in progress, so you may find duplicated code fragments,
-    ugly data structures, weird usage of filenames and other thinks.
-    I will run "indent" over the source when making a real distribution,
-    but for now I stick to my own formatting rules.
+    ugly data structures, weird usage of filenames and other things.
 
     The primary FTP site is "ftp://ftp.guug.de/pub/gcrypt/"
     The primary WWW page is "http://www.d.shuttle.de/isil/crypt/gnupg.html"
 
     If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
-    "gnupg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
+    "gpg --export --armor | mail gnupg-keys@isil.d.shuttle.de" to do this.
 
-    Please direct bug reports to <gnupg-bugs@isil.d.shuttle.de> or better
-    post them to the mailing list <g10@net.lut.ac.uk>.
+    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,
+    please subscribe before posting).
 
+-----BEGIN PGP SIGNATURE-----
+Version: GNUPG v0.3.2b (GNU/Linux)
+Comment: Get GNUPG from ftp://ftp.guug.de/pub/gcrypt/
 
+iQB1AwUBNcy3yh0Z9MEMmFelAQEUXwMAg8h8GaecR1jWVwCqaWO4oGCyWgaxvi0yfQR1Y1GC
+j6Hpo5Hwa3d2UAYETL3M42/M32uxe0Wh8PMgLTWTfhV9XjwxCNg3BBDm2Zb5Enpr9UEIFOdN
+OCV3J4gED4jXDOtO
+=oPV/
+-----END PGP SIGNATURE-----