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