Merge branch 'master' of ssh://nmav@git.sv.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 For OpenPGP key support, the OpenCDK library can be used.  You can
22 find libopencdk at: <ftp://ftp.gnutls.org/pub/gnutls/opencdk/>.  A
23 copy of libopencdk is also included with GnuTLS.
24
25 In case you are compiling for embedded systems you should check the
26 configure options (that is run: 'configure --help'), and disable
27 unneeded features of gnutls.
28
29 Experimental:
30
31 If you specify --with-builtin-crypto, you will use gnulib instead of
32 libgcrypt for (some) crypto routines.
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 If --with-builtin-crypto is specified, random data will be read from
39 system device files (e.g., /dev/random) directly.  The files used are
40 printed when running configure, you can override them using
41 --enable-random-device, --enable-pseudo-random-device, and
42 --enable-nonce-device.  Please let us know if the defaults for some
43 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 LICENSE ISSUES
50 --------------
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
54 GPL.
55
56 We changed the license for most of GNUTLS because other free libraries
57 already exist that do the same jobs and have lax licenses.  We want
58 GNUTLS to be usable in all the same places as those other libraries.
59 We kept some parts of GNUTLS under the GPL because they are unique,
60 and with the GPL they provide free software projects (which deserve
61 our help) an advantage over non-free projects (which do not deserve
62 our help, since they refuse to share with us).  For more explanation,
63 see http://www.gnu.org/philosophy/why-not-lgpl.html.
64
65 The GNU Lesser GPL license applies to the main gnutls library, while
66 the gnutls-extra library is under the GPL. The gnutls-extra library
67 contains the code for "GnuTLS Inner Application" support and the
68 OpenSSL compatibility layer.  The gnutls library is located in the
69 lib/ directory, while the gnutls-extra library is at libextra/.
70
71
72 BUGS
73 ----
74
75 Currently GnuTLS needs testing.  By notifying the developers about a
76 possible bug you may help a lot, since testing is really important and
77 expensive.  If you think you found a bug, report it to
78 bug-gnutls@gnu.org together with the needed information, in order for
79 developers to reproduce it.
80
81 ----------------------------------------------------------------------
82 Copying and distribution of this file, with or without modification,
83 are permitted in any medium without royalty provided the copyright
84 notice and this notice are preserved.