Initial revision

CVS patchset: 5051
CVS date: 2001/09/18 19:23:46

1 files changed, 109 insertions, 0 deletions

diff --git a/beecrypt/README b/beecrypt/README
new file mode 100644
index 000000000..835bf9cd2
--- /dev/null
+++ b/beecrypt/README
@@ -0,0 +1,109 @@
+Welcome to the BeeCrypt crypto library!
+
+Copyright (c) 1997-2000 Virtual Unlimited B.V.
+
+Author: Bob Deblier <bob@virtualunlimited.com>
+
+This library is free software; you can redistribute it and/or
+modify it under the terms of the GNU Lesser General Public
+License as published by the Free Software Foundation; either
+version 2.1 of the License, or (at your option) any later version.
+
+This library is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+Lesser General Public License for more details.
+
+You should have received a copy of the GNU Lesser General Public
+License along with this library; if not, write to the Free Software
+Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+
+For the specifics of this license, see file 'LICENSE', included in this
+distribution.
+
+
+
+About BeeCrypt:
+
+This library is an ongoing project of Virtual Unlimited B.V. Its goal is to
+provide strong and fast cryptography for use by our products, but we're
+not limiting the use to that. We're releasing it under the LGPL license,
+because we feel that cryptography should be open to inspection by everybody,
+and available for use by everybody to safeguard privacy.
+
+Note that depending on where you are, the use of cryptography may be limited
+or forbidden by law. Before using this library, make sure you are legally
+entitled to do so.
+
+For more on Virtual Unlimited B.V. and our products please consult our website:
+
+http://www.virtualunlimited.com
+
+<plug>
+Most of the algorithms are implemented from reliable sources such as:
+
+"Handbook of Applied Cryptography"
+ Alfred J. Menezes, Paul C. van Oorschot, Scott A. Vanstone
+ CRC Press
+
+"Applied Cryptography", second edition
+ Bruce Schneier
+ Wiley
+
+For crypto enthusiasts these books are invaluable background material.
+
+IEEE P1363 "Standard Specifications for Public Key Cryptography" is a very
+interesting draft standard, which we will try to comply with.
+</plug>
+
+The structures in the library are geared towards exchange with Java
+and its security and cryptography classes. We already have quite a number
+of cryptographic classes developed in Java, which will be released in the
+future in another open source project.
+
+Included in the library are:
+    - entropy sources for initializing pseudo-random generators
+    - pseudo-random generators: FIPS-186, Mersenne Twister
+    - block ciphers: Blowfish
+    - hash functions: SHA-1
+    - keyed hash functions: SHA-1/HMAC
+    - multi-precision integer library, with assembler-optimized routines
+    - probabilistic primality testing, with optimized small prime trial division
+    - discrete logarithm parameter generation over a prime field
+    - Diffie-Hellman key agreement
+    - ElGamal signature scheme (two variants)
+
+Planned for the near future are:
+    - compliance with and compliance statements for IEEE P1363
+	- DHAES
+    - DSA (i.e. the rest of FIPS-186)
+    - more blockciphers (Twofish, Rijndael, ... )
+	- more hash functions (RIPEMD-160, HAVAL, ... )
+	- Elliptic Curves (ECDSA, ... )
+
+The library has been tested on the following platforms:
+    - Solaris 2.6 Sparc, Solaris 2.7 Sparc
+        - includes assembler optimization for ultrasparc
+    - Linux glibc 2.x x86
+        - includes assembler optimization (tuned for Pentium Pro and higher)
+    - Linux glibc 2.x ppc
+        - includes assembler optimization (generic 32-bit PowerPC)
+    - Win32 (Windows 95, 98, NT 4.0)
+        - includes assembler optimization (tuned for Pentium Pro and higher)
+        - once the entropy provider bug is fixed (see BUGS), the library should
+		  work fine on Windows 2000.
+Planned platforms for the near future are:
+    - Solaris Intel
+    - FreeBSD x86
+
+Consult file 'DOCUMENTATION' on how to use the library. There is also a program
+called 'beetest.c' included which gives an example of how to use the API. You
+can also use it to test whether your compiled library works.
+
+If you want to report bugs, make suggestions, contribute fixes or
+enhancements, please see our website: http://beecrypt.virtualunlimited.com
+or contact me at beecrypt@virtualunlimited.com
+
+Sincerely
+
+Bob Deblier