This commit was generated by cvs2svn to track changes on a CVS vendor
[openssl.git] / crypto / des / README
1
2                 libdes, Version 4.01 10-Jan-97
3
4                 Copyright (c) 1997, Eric Young
5                           All rights reserved.
6
7     This program is free software; you can redistribute it and/or modify
8     it under the terms specified in COPYRIGHT.
9     
10 --
11 The primary ftp site for this library is
12 ftp://ftp.psy.uq.oz.au/pub/Crypto/DES/libdes-x.xx.tar.gz
13 libdes is now also shipped with SSLeay.  Primary ftp site of
14 ftp://ftp.psy.uq.oz.au/pub/Crypto/SSL/SSLeay-x.x.x.tar.gz
15
16 The best way to build this library is to build it as part of SSLeay.
17
18 This kit builds a DES encryption library and a DES encryption program.
19 It supports ecb, cbc, ofb, cfb, triple ecb, triple cbc, triple ofb,
20 triple cfb, desx, and MIT's pcbc encryption modes and also has a fast
21 implementation of crypt(3).
22 It contains support routines to read keys from a terminal,
23 generate a random key, generate a key from an arbitrary length string,
24 read/write encrypted data from/to a file descriptor.
25
26 The implementation was written so as to conform with the manual entry
27 for the des_crypt(3) library routines from MIT's project Athena.
28
29 destest should be run after compilation to test the des routines.
30 rpw should be run after compilation to test the read password routines.
31 The des program is a replacement for the sun des command.  I believe it
32 conforms to the sun version.
33
34 The Imakefile is setup for use in the kerberos distribution.
35
36 These routines are best compiled with gcc or any other good
37 optimising compiler.
38 Just turn you optimiser up to the highest settings and run destest
39 after the build to make sure everything works.
40
41 I believe these routines are close to the fastest and most portable DES
42 routines that use small lookup tables (4.5k) that are publicly available.
43 The fcrypt routine is faster than ufc's fcrypt (when compiling with
44 gcc2 -O2) on the sparc 2 (1410 vs 1270) but is not so good on other machines
45 (on a sun3/260 168 vs 336).  It is a function of CPU on chip cache size.
46 [ 10-Jan-97 and a function of an incorrect speed testing program in
47   ufc which gave much better test figures that reality ].
48
49 It is worth noting that on sparc and Alpha CPUs, performance of the DES
50 library can vary by upto %10 due to the positioning of files after application
51 linkage.
52
53 Eric Young (eay@cryptsoft.com)
54