README

   1 GnuTLS README -- Important introductory notes.
   2 Copyright (C) 2000-2012 Free Software Foundation, Inc.
   3 See the end of this document for copying conditions.
   4
   5 GnuTLS implements the TLS/SSL (Transport Layer Security aka Secure
   6 Sockets Layer) protocol.  GnuTLS is a GNU project.  Additional
   7 information can be found at <http://www.gnutls.org/>
   8 and <http://www.gnutls.org/>.
   9
  10
  11 README
  12 ------
  13 This README is targeted for users of the library who build from
  14 sources but do not necessarily develop.  If you are interested
  15 in developing and contributing to the GnuTLS project, please
  16 see README-alpha and visit
  17 http://www.gnutls.org/manual/html_node/Contributing.html.
  18
  19
  20 COMPILATION
  21 -----------
  22 A typical command sequence for building the library is shown below.
  23 A complete list of options available for configure can be found
  24 by running './configure --help'.
  25
  26     cd gnutls-<version>
  27     ./configure --prefix=/usr
  28     make
  29     make check
  30     sudo make install
  31
  32 The commands above build and install the static archive (libgnutls.a),
  33 the shared object (libgnutls.so), and additional binaries such as certtool
  34 and gnutls-cli.
  35
  36 The library depends on libnettle and gmplib.
  37  * gmplib: for big number arithmetic
  38      http://gmplib.org/
  39  * nettle: for cryptographic algorithms
  40      http://www.lysator.liu.se/~nisse/nettle/
  41
  42 Versions 2.10.3 and prior used libgcrypt as the default cryptographic library.
  43
  44 Optionally it may use the following libraries:
  45  * libtasn1: For ASN.1 parsing (a copy is included, if not found)
  46      http://www.gnu.org/software/libtasn1/
  47  * p11-kit: for smart card support
  48      http://p11-glue.freedesktop.org/p11-kit.html
  49  * libtspi: for Trusted Platform Module (TPM) support,
  50      http://trousers.sourceforge.net/
  51  * libunbound: For DNSSEC/DANE support,
  52      http://unbound.net/
  53  * libz: For compression support.
  54      http://www.zlib.net/
  55
  56 To configure libnettle for installation and use by GnuTLS, a typical
  57 command sequence would be:
  58
  59     cd nettle-<version>
  60     ./configure --prefix=/usr --disable-openssl --enable-shared
  61     make
  62     sudo make install
  63
  64 For the Nettle project, --enable-shared will instruct automake and
  65 friends to build and install both the static archive (libnettle.a)
  66 and the shared object (libnettle.so).
  67
  68 In case you are compiling for an embedded system, you can disable
  69 unneeded features of GnuTLS.  In general, it is usually best not to
  70 disable anything (for future mailing list questions and possible bugs).
  71
  72 Depending on your installation, additional libraries, such as libtasn1
  73 and zlib, may be required.
  74
  75
  76 DOCUMENTATION
  77 -------------
  78 See the documentation in doc/ and online at
  79 http://www.gnutls.org/manual.
  80
  81
  82 EXAMPLES
  83 --------
  84 See the examples in doc/examples/ and online at 'How To Use GnuTLS in
  85 Applications' at http://www.gnutls.org/manual.
  86
  87
  88 SECURITY ADVISORIES
  89 -------------------
  90 The project collects and publishes information on past security
  91 incidents and vulnerabilities.  Open information exchange, including
  92 information which is [sometimes] suppressed in non-open or non-free
  93 projects, is one of the goals of the GnuTLS project.  Please visit
  94 http://www.gnutls.org/security.html.
  95
  96
  97 MAILING LISTS
  98 -------------
  99 The GnuTLS project maintains mailing lists for users, developers, and
 100 commits.  Please see http://www.gnutls.org/lists.html.
 101
 102
 103 LICENSING
 104 ---------
 105 Since GnuTLS version 3.1.10, the core library has been released under
 106 the GNU Lesser General Public License (LGPL) version 2.1 or later.
 107
 108 Note, however, that version 6.0.0 and later of the gmplib library used
 109 by GnuTLS are distributed under a LGPLv3+ or GPLv2+ dual license, and
 110 as such binaries of this library need to be distributed under either
 111 LGPLv3+ or GPLv2+ license. If this is undesirable older versions
 112 of the gmplib which are under LGPLv2.1 (e.g., version 4.2.1) may be
 113 used instead. (gmplib versions between 4.2.2 through 5.1.3 were
 114 licensed under LGPLv3+ only).
 115
 116 The GNU LGPL applies to the main GnuTLS library, while the
 117 included applications as well as gnutls-openssl
 118 library are under the GNU GPL version 3.  The gnutls library is
 119 located in the lib/ directory, while the applications in src/ and
 120 gnutls-openssl library is at extra/.
 121
 122 For any copyright year range specified as YYYY-ZZZZ in this package
 123 note that the range specifies every single year in that closed interval.
 124
 125
 126 BUGS
 127 ----
 128 Thorough testing is very important and expensive.  Often, the
 129 developers do not have access to a particular piece of hardware or
 130 configuration to reproduce a scenario.  Notifying the developers about a
 131 possible bug will greatly help the project.
 132
 133 If you believe you have found a bug, please report it to bugs@gnutls.org
 134 together with any applicable information.
 135
 136 Applicable information would include why the issue is a GnuTLS bug (if
 137 not readily apparent), output from 'uname -a', the version of the library or
 138 tool being used, a stack trace if available ('bt full' if under gdb or
 139 valgrind output), and perhaps a network trace.  Vague queries or piecemeal
 140 messages are difficult to act upon and don't help the development effort.
 141
 142 Additional information can be found at the project's manual.
 143
 144
 145 PATCHES
 146 -------
 147 Patches are welcome and encouraged. Patches can be submitted through the
 148 bug tracking system or the mailing list.  When submitting patches, please
 149 be sure to use sources from the git repository, and preferrably from the
 150 master branch.  To create a patch for the project from a local git repository,
 151 please use the following commands. 'gnutls' should be the local directory
 152 of a previous git clone.
 153
 154     cd gnutls
 155     git add the-file-you-modified.c another-file.c
 156     git commit the-file-you-modified.c another-file.c
 157     git format-patch
 158
 159 For more information on use of Git, visit http://git-scm.com/
 160
 161 ----------------------------------------------------------------------
 162 Copying and distribution of this file, with or without modification,
 163 are permitted in any medium without royalty provided the copyright
 164 notice and this notice are preserved.