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.gnu.org/software/gnutls/>
   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.gnu.org/software/gnutls/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-2.10.3
  27     ./configure --prefix=/usr
  28     make
  29     sudo make install
  30
  31 The commands above build and install the static archive (libgnutls.a),
  32 the shared object (libgnutls.so), and additional binaries such as certtool
  33 and gnutls-cli.
  34
  35 The library depends on libnettle and p11-kit. Versions
  36 2.10.3 and prior used libgcrypt as the default cryptographic library.
  37 Nettle can be found at http://www.gnu.org/software/nettle/, while
  38 p11-kit can be found at <http://p11-glue.freedesktop.org/p11-kit.html>.
  39
  40 To configure libnettle for installation and use by GnuTLS, a typical
  41 command sequence would be:
  42
  43     cd nettle-2.2
  44     ./configure --prefix=/usr --disable-openssl --enable-shared
  45     make
  46     sudo make install
  47
  48 For the Nettle project, --enable-shared will instruct automake and
  49 friends to build and install both the static archive (libnettle.a)
  50 and the shared object (libnettle.so).
  51
  52 In case you are compiling for an embedded system, you can disable
  53 unneeded features of GnuTLS.  In general, it is usually best not to
  54 disable anything (for future mailing list questions and possible bugs).
  55
  56 Depending on your installation, additional libraries, such as libtasn1
  57 and zlib, may be required.
  58
  59
  60 DOCUMENTATION
  61 -------------
  62 See the documentation in doc/ and online at
  63 http://www.gnu.org/software/gnutls/manual/html_node/index.htm.
  64
  65
  66 EXAMPLES
  67 --------
  68 See the examples in doc/examples/ and online at 'How To Use GnuTLS in
  69 Applications' at http://www.gnu.org/software/gnutls/manual/html_node/How-
  70 to-use-GnuTLS-in-applications.html#How-to-use-GnuTLS-in-applications.
  71 The examples include client, server, and multi-threaded examples.
  72
  73
  74 SECURITY ADVISORIES
  75 -------------------
  76 The project collects and publishes information on past security
  77 incidents and vulnerabilities.  Open information exchange, including
  78 information which is [sometimes] suppressed in non-open or non-free
  79 projects, is one of the goals of the GnuTLS project.  Please visit
  80 http://www.gnu.org/software/gnutls/security.html.
  81
  82
  83 MAILING LISTS
  84 -------------
  85 The GnuTLS project maintains mailing lists for users, developers, and
  86 commits.  Please see http://www.gnu.org/software/gnutls/lists.html.
  87
  88
  89 LICENSING
  90 ---------
  91 Since GnuTLS version 3.0.0, the core library has been released under
  92 the GNU Lesser General Public License (LGPL) version 3 or later.
  93
  94 The GNU LGPL applies to the main GnuTLS library, while the
  95 included applications as well as gnutls-openssl
  96 library are under the GNU GPL version 3.  The gnutls library is
  97 located in the lib/ directory, while the applications in src/ and
  98 gnutls-openssl library is at extra/.
  99
 100 For any copyright year range specified as YYYY-ZZZZ in this package
 101 note that the range specifies every single year in that closed interval.
 102
 103
 104 BUGS
 105 ----
 106 Thorough testing is very important and expensive.  Often, the
 107 developers do not have access to a particular piece of hardware or
 108 configuration to reproduce a scenario.  Notifying the developers about a
 109 possible bug will greatly help the project.
 110
 111 If you believe you have found a bug, please report it to bug-gnutls@gnu.org
 112 together with any applicable information.  A web interface for the system
 113 is available at http://savannah.gnu.org/support/?group=gnutls.
 114
 115 Applicable information would include why the issue is a GnuTLS bug (if
 116 not readily apparent), output from 'uname -a', the version of the library or
 117 tool being used, a stack trace if available ('bt full' if under gdb or
 118 valgrind output), and perhaps a network trace.  Vague queries or piecemeal
 119 messages are difficult to act upon and don't help the development effort.
 120
 121 Additional information can be found at the project's manual at:
 122 http://www.gnu.org/software/gnutls/documentation.html.
 123
 124
 125 PATCHES
 126 -------
 127 Patches are welcome and encouraged. Patches can be submitted through the
 128 bug tracking system or the mailing list.  When submitting patches, please
 129 be sure to use sources from the git repository, and preferrably from the
 130 master branch.  To create a patch for the project from a local git repository,
 131 please use the following commands. 'gnutls' should be the local directory
 132 of a previous git clone.
 133
 134     cd gnutls
 135     git add the-file-you-modified.c another-file.c
 136     git commit the-file-you-modified.c another-file.c
 137     git format-patch
 138
 139 For more information on use of Git, visit http://git-scm.com/
 140
 141 ----------------------------------------------------------------------
 142 Copying and distribution of this file, with or without modification,
 143 are permitted in any medium without royalty provided the copyright
 144 notice and this notice are preserved.