Initial Commit
[packages] / xemacs-packages / ecrypto / README
1 this is the Ecrypto library, a group of files implementing strong
2 crypto in elisp.  it is made up of the following:
3
4 idea.el
5   this file contains the code for the IDEA cipher.  it is reasonably
6   secure, in terms of cleaning up intermediate computations.  the
7   functions in it operate on 16-bit vectors.  CBC and a CBC-based
8   package transform are provided.  XEmacs: this file was removed due
9   to supposed patent problems.
10
11 md5.el, md5-old.el, sha1.el, sha1-old.el
12   code for the MD5 and SHA-1 hash algorithms.  md5.el and sha1.el are
13   the actual implementations, geared towards speed and data security
14   (ie, wiping possibly sensitive data).  both files have to be
15   compiled before being loaded.  md5-old.el and sha1-old.el are
16   the original implementations, much more readable, less optimized,
17   but slower and likely to leave secure data around for the GC to
18   clean up.
19
20 ascii-armor.el
21   provides routines for converting a vector of 16-bit numbers into its
22   equivalent ascii-armor, and vice versa.  it could be easily extended
23   to work for octet-streams, but hasn't, yet.
24
25 rc16.el
26   code for Julian Assange's extension of RC4 to 16 bits.
27
28 rander.el
29   this code attempts to provide cryptographically secure random
30   numbers, but probably fails.  it draws together various sources of
31   randomness from within emacs, including the microsecond timings of
32   keypresses, though your emacs may not provide such timings.  this
33   code should be considered somewhat untrustworthy.  it uses rc16.el
34   for its core.
35
36 paranoid.el
37   a slight modification to comint-read-noecho.  it leaves even less
38   possibly sensitive data lying around for the GC to clean up. 
39
40 NOTES
41 ----------------------------------------
42 IDEA is patented, but i believe that this software, which is GPL'd,
43 doesn't require any license fee or registration.  Diffie-Hellman was
44 patented, but that expired in 1997.  RC4 was a trade secret, it is no
45 longer, and so RC16 (which is based on RC4) is safe to use (with
46 credit to Julian Assange).
47
48 until this code has been extensively tested and examined by multiple
49 parties, i wouldn't trust it any more than a Cracker-Jack Secret
50 Decoder Ring.
51
52 enjoy.
53
54 ray jones
55 rjones@pobox.com