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