Fix.
[gnutls:gnutls.git] / README
1 This is the GNU TLS library. More up to date information can be found
2 at http://www.gnu.org/software/gnutls/ and http://www.gnutls.org/
3
4 This is a TLS (Transport Layer Security) 1.0 and SSL (Secure Sockets Layer) 3.0
5 implementation for the GNU project. 
6
7 - The library needs libgcrypt. You can find libgcrypt at
8  ftp://ftp.gnupg.org/pub/gcrypt/alpha/libgcrypt/
9
10  Note that by compiling libgcrypt with CPU optimizations gnutls' speed
11  will increase.
12
13 - For OpenPGP key support the OpenCDK library is required. You can find
14  libopencdk at:
15  ftp://ftp.gnutls.org/pub/gnutls/opencdk/
16
17 - Documentation:
18  view the doc/ directory and the examples in the doc/examples directory.
19
20
21 ****************************
22 COMPILATION ISSUES:
23
24 Nothing special here. In case you are compiling for embedded systems
25 you should check the configure options (that is run: 'configure --help'),
26 and disable unneeded features of gnutls.
27
28 Experimental:
29
30 If you specify --with-nettle, the copy of some files from Nettle that
31 are included in nettle/ will be used.  It is used via the generic
32 crypto interface in crypto/, which would normally invoke Libgcrypt.
33
34 Currently the generic crypto interface only support secret key
35 ciphering, hashing and gathering of random data.  Supporting
36 RSA/DSA/DH/SEXP/MPI in the generic crypto interface is pending.
37
38 As Nettle do not include a randomness gatherer, if --with-nettle is
39 specified, random data will be read from system device files (e.g.,
40 /dev/urandom) directly.  The files used are printed when running
41 configure, you can override them using --enable-random-device,
42 --enable-pseudo-random-device, and --enable-nonce-device.  Please let
43 us know if the defaults for some systems are wrong.
44
45 The goal here is to make GnuTLS build standalone, in case Libgcrypt is
46 not available, but also to allow easy use of other crypto libraries or
47 crypto hardware.
48
49 ****************************
50 LICENSE ISSUES:
51
52 Since the 0.4.2 version the gnutls library is covered under the GNU 
53 Lesser GPL. Previously released versions were licensed under the GNU GPL.
54
55 We changed the license for most of GNUTLS because other free libraries
56 already exist that do the same jobs and have lax licenses.  We want
57 GNUTLS to be usable in all the same places as those other libraries.
58 We kept some parts of GNUTLS under the GPL because they are unique,
59 and with the GPL they provide free software projects (which deserve
60 our help) an advantage over non-free projects (which do not deserve
61 our help, since they refuse to share with us).  For more explanation,
62 see http://www.gnu.org/philosophy/why-not-lgpl.html.
63
64 The GNU Lesser GPL license applies to the main gnutls library, while the
65 gnutls-extra library is under the GPL. The gnutls-extra library contains
66 the code for the "OpenPGP key" support and the OpenSSL compatibility layer. 
67 The gnutls library is located in the lib/ directory, while the gnutls-extra 
68 library is at libextra/.
69
70
71 ****************************
72 BUGS:
73
74 Currently gnuTLS needs a lot of testing. By notifying the developers
75 about a possible bug you may help a lot, since testing is really
76 important and expensive. If you think you found a bug,
77 report it to bug-gnutls@gnu.org, together with the needed information,
78 in order for developers to reproduce it. 
79