a new release
[libgcrypt.git] / README
diff --git a/README b/README
index a13192c..ad836c3 100644 (file)
--- a/README
+++ b/README
@@ -1,55 +1,65 @@
+-----BEGIN PGP SIGNED MESSAGE-----
 
                  GNUPG - The GNU Privacy Guard
                 -------------------------------
+                         Version 0.4
 
-    THIS IS ALPHA SOFTWARE, YOU MAY ENCOUNTER SOOME BUGS.
+    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 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"
 
+    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 the tar file containing
-    this file here, you can be sure that the above fingerprint is correct.
+    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 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).  I'm sorry about this, but
-    this is the world we have created (e.g. by using proprietary software).
+    the United States until Sep 20, 2000).
 
-    Because the OpenPGP standard is still a draft, GNUPG is not yet
-    compatible with it (or PGP 5) - but it will be.  The data structures
-    used are compatible with PGP 2.x, so it can parse and list such files
-    and PGP should be able to parse data created by GNUPG and complain
-    about unsupported algorithms.
+    GNUPG is in almost all  aspects compatible with other OpenPGP
+    implementations.
 
-    The default algorithms used by GNUPG are ElGamal for public-key
-    encryption and signing; Blowfish with a 128 bit key for protecting
-    the secret-key components, conventional and session encryption;
-    RIPE MD-160 to create message digest.  DSA, SHA-1, CAST and TIGER are
-    also implemented, but not used by default. I decided not
-    to use DSA as the default signing algorithm, because it allows only
-    for 1024 bit keys and this may not be 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: 3DES, Blowfish
+    and CAST5, Digest algorithms are MD5, RIPEMD160, SHA1 and TIGER/192.
 
 
 
     Installation
     ------------
 
-    See the file INSTALL.  Here is a quick summary:
+    Please read the file INSTALL!
+
+    Here is a quick summary:
 
     1) "./configure"
 
     Because we have no hardware device to generate randomness 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 numbers, 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.
-
     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:
 
 
     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
     -------
 
     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 prime factor 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"
 
 
     -----------
     This is work in progress, so you may find duplicated code fragments,
     ugly data structures, weird usage of filenames and other things.
-    I will run "indent" over the source when making a real distribution,
-    but for now I stick to my own formatting rules.
 
     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"
+    The primary WWW page is "http://www.d.shuttle.de/isil/gnupg/"
 
     If you like, send your keys to <gnupg-keys@isil.d.shuttle.de>; use
     "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, see above (~line 33)).
 
+-----BEGIN PGP SIGNATURE-----
+Version: GNUPG v0.4.0a (GNU/Linux)
+Comment: For info finger gcrypt@ftp.guug.de
 
+iQB1AwUBNhtSpB0Z9MEMmFelAQHWNQMAuPaj71rzjjtVNlYDV0MYljPFZqAK7tvmbH3i9Lti
+UuvGPCpx1/ej7jwZ2LSQ61O8c/xRwV07chHa5MGmSGT4KZg5g5MejUOliMQJIJwjY5PoZAVb
+6F7+hZf5Bt5Jl2J7
+=6Mbb
+-----END PGP SIGNATURE-----