[d5404360] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[546b042] | 7 | <!ENTITY gnutls-download-http "http://ftp.gnu.org/gnu/gnutls/gnutls-&gnutls-version;.tar.xz">
|
---|
| 8 | <!ENTITY gnutls-download-ftp "ftp://ftp.gnu.org/gnu/gnutls/gnutls-&gnutls-version;.tar.xz">
|
---|
| 9 | <!ENTITY gnutls-md5sum "37bdac12b5c039c7a8738b5d85eda968">
|
---|
| 10 | <!ENTITY gnutls-size "4.6 MB">
|
---|
[0c6c35d] | 11 | <!ENTITY gnutls-buildsize "120 MB">
|
---|
| 12 | <!ENTITY gnutls-time "1.6 SBU (including the test suite)">
|
---|
[d5404360] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="gnutls" xreflabel="GnuTLS-&gnutls-version;">
|
---|
| 16 | <?dbhtml filename="gnutls.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>GnuTLS-&gnutls-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="gnutls">
|
---|
| 26 | <primary sortas="a-GnuTLS">GnuTLS</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GnuTLS</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>GnuTLS</application> package contains a library and
|
---|
| 33 | userspace tools which provide a secure layer over a reliable transport
|
---|
| 34 | layer. Currently the <application>GnuTLS</application> library implements
|
---|
| 35 | the proposed standards by the IETF's TLS working group. Quoting from the
|
---|
| 36 | TLS protocol specification:</para>
|
---|
| 37 |
|
---|
| 38 | <para><quote>The TLS protocol provides communications privacy over the
|
---|
| 39 | Internet. The protocol allows client/server applications to communicate in
|
---|
| 40 | a way that is designed to prevent eavesdropping, tampering, or message
|
---|
| 41 | forgery.</quote></para>
|
---|
| 42 |
|
---|
| 43 | <para><application>GnuTLS</application> provides support for TLS 1.1, TLS
|
---|
| 44 | 1.0 and SSL 3.0 protocols, TLS extensions, including server name and max
|
---|
| 45 | record size. Additionally, the library supports authentication using the
|
---|
| 46 | SRP protocol, X.509 certificates and OpenPGP keys, along with support for
|
---|
| 47 | the TLS Pre-Shared-Keys (PSK) extension, the Inner Application (TLS/IA)
|
---|
| 48 | extension and X.509 and OpenPGP certificate handling.</para>
|
---|
| 49 |
|
---|
[e79ed72] | 50 | &lfs70_checked;
|
---|
[214718a] | 51 |
|
---|
[d5404360] | 52 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 53 | <itemizedlist spacing="compact">
|
---|
[546b042] | 54 | <listitem>
|
---|
[d5404360] | 55 | <para>Download (HTTP): <ulink url="&gnutls-download-http;"/></para>
|
---|
[546b042] | 56 | </listitem>
|
---|
[d5404360] | 57 | <listitem>
|
---|
| 58 | <para>Download (FTP): <ulink url="&gnutls-download-ftp;"/></para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>Download MD5 sum: &gnutls-md5sum;</para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>Download size: &gnutls-size;</para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>Estimated disk space required: &gnutls-buildsize;</para>
|
---|
| 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
| 70 | <para>Estimated build time: &gnutls-time;</para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">GnuTLS Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[0c6c35d] | 77 | <para role="required"><xref linkend="nettle"/></para>
|
---|
[d5404360] | 78 |
|
---|
| 79 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[0c6c35d] | 80 | <para role="optional">
|
---|
| 81 | <xref linkend="gtk-doc"/>,
|
---|
| 82 | <xref linkend="guile"/>,
|
---|
[546b042] | 83 | <xref linkend="libidn"/>,
|
---|
[0c6c35d] | 84 | <xref linkend="libtasn1"/>,
|
---|
[546b042] | 85 | <xref linkend="p11-kit"/> and
|
---|
[0c6c35d] | 86 | <ulink url="http://valgrind.org/">Valgrind</ulink> (used during the test suite)</para>
|
---|
[d5404360] | 87 |
|
---|
[38b68055] | 88 | <para>Note that if you do not install <xref linkend="libtasn1"/>, an older
|
---|
| 89 | version shipped in the <application>GnuTLS</application> tarball will be
|
---|
| 90 | used instead.</para>
|
---|
| 91 |
|
---|
[d5404360] | 92 | <para condition="html" role="usernotes">User Notes:
|
---|
| 93 | <ulink url="&blfs-wiki;/gnutls"/></para>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of GnuTLS</title>
|
---|
| 99 |
|
---|
| 100 | <para>Install <application>GnuTLS</application> by running the
|
---|
| 101 | following commands:</para>
|
---|
| 102 |
|
---|
| 103 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 104 | make</userinput></screen>
|
---|
| 105 |
|
---|
| 106 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
| 107 |
|
---|
| 108 | <para>Now, as the <systemitem class="username">root</systemitem>
|
---|
| 109 | user:</para>
|
---|
| 110 |
|
---|
| 111 | <screen role="root"><userinput>make install &&
|
---|
[2e81579] | 112 | install -v -m755 -d /usr/share/doc/gnutls-&gnutls-version; &&
|
---|
| 113 | install -v -m644 doc/*.{html,png,eps,pdf,ps} doc/cyclo/*.html \
|
---|
| 114 | /usr/share/doc/gnutls-&gnutls-version; &&
|
---|
| 115 | cp -v -R doc/credentials \
|
---|
[d5404360] | 116 | /usr/share/doc/gnutls-&gnutls-version;</userinput></screen>
|
---|
| 117 |
|
---|
[2e81579] | 118 | <para>If you did not pass the <option>--enable-gtk-doc</option> parameter
|
---|
| 119 | to the <command>configure</command> script, install the API documentation
|
---|
[0c6c35d] | 120 | to the <filename
|
---|
| 121 | class='directory'>/usr/share/gtk-doc/html/gnutls</filename> directory using
|
---|
| 122 | the following command as the <systemitem class="username">root</systemitem>
|
---|
| 123 | user:</para>
|
---|
[2e81579] | 124 |
|
---|
| 125 | <screen role="root"><userinput>make -C doc/reference install-data-local</userinput></screen>
|
---|
| 126 |
|
---|
[d5404360] | 127 | </sect2>
|
---|
| 128 |
|
---|
[d309b21] | 129 | <sect2 role="commands">
|
---|
| 130 | <title>Command Explanations</title>
|
---|
| 131 |
|
---|
[e05cd03f] | 132 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[2e81579] | 133 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[d309b21] | 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
[d5404360] | 137 | <sect2 role="content">
|
---|
| 138 | <title>Contents</title>
|
---|
| 139 |
|
---|
| 140 | <segmentedlist>
|
---|
| 141 | <segtitle>Installed Programs</segtitle>
|
---|
| 142 | <segtitle>Installed Libraries</segtitle>
|
---|
[32dfb13c] | 143 | <segtitle>Installed Directories</segtitle>
|
---|
[d5404360] | 144 |
|
---|
| 145 | <seglistitem>
|
---|
[0c6c35d] | 146 | <seg>certtool, crywrap, gnutls-cli, gnutls-cli-debug, gnutls-serv,
|
---|
[546b042] | 147 | ocsptool, p11tool, psktool, and srptool</seg>
|
---|
| 148 | <seg>libgnutls.{so,a}, libgnutls-openssl.{so,a}, and libgnutlsxx.{so,a}</seg>
|
---|
[2e81579] | 149 | <seg>/usr/include/gnutls,
|
---|
| 150 | /usr/share/doc/gnutls-&gnutls-version;, and
|
---|
| 151 | /usr/share/gtk-doc/html/gnutls</seg>
|
---|
[d5404360] | 152 | </seglistitem>
|
---|
| 153 | </segmentedlist>
|
---|
| 154 |
|
---|
| 155 | <variablelist>
|
---|
| 156 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 157 | <?dbfo list-presentation="list"?>
|
---|
| 158 | <?dbhtml list-presentation="table"?>
|
---|
| 159 |
|
---|
| 160 | <varlistentry id="certtool">
|
---|
| 161 | <term><command>certtool</command></term>
|
---|
| 162 | <listitem>
|
---|
| 163 | <para>is used to generate X.509 certificates, certificate requests,
|
---|
| 164 | and private keys.</para>
|
---|
| 165 | <indexterm zone="gnutls certtool">
|
---|
| 166 | <primary sortas="b-certtool">certtool</primary>
|
---|
| 167 | </indexterm>
|
---|
| 168 | </listitem>
|
---|
| 169 | </varlistentry>
|
---|
| 170 |
|
---|
[0c6c35d] | 171 | <varlistentry id="crywrap">
|
---|
| 172 | <term><command>crywrap</command></term>
|
---|
| 173 | <listitem>
|
---|
| 174 | <para>is a simple wrapper that waits for TLS/SSL connections, and
|
---|
| 175 | proxies them to an unencrypted location.</para>
|
---|
| 176 | <indexterm zone="gnutls crywrap">
|
---|
| 177 | <primary sortas="b-crywrap">crywrap</primary>
|
---|
| 178 | </indexterm>
|
---|
| 179 | </listitem>
|
---|
| 180 | </varlistentry>
|
---|
| 181 |
|
---|
[d5404360] | 182 | <varlistentry id="gnutls-cli">
|
---|
| 183 | <term><command>gnutls-cli</command></term>
|
---|
| 184 | <listitem>
|
---|
| 185 | <para>is a simple client program to set up a TLS connection to some
|
---|
| 186 | other computer.</para>
|
---|
| 187 | <indexterm zone="gnutls gnutls-cli">
|
---|
| 188 | <primary sortas="b-gnutls-cli">gnutls-cli</primary>
|
---|
| 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
| 192 |
|
---|
| 193 | <varlistentry id="gnutls-cli-debug">
|
---|
| 194 | <term><command>gnutls-cli-debug</command></term>
|
---|
| 195 | <listitem>
|
---|
| 196 | <para>is a simple client program to set up a TLS connection to some
|
---|
| 197 | other computer and produces very verbose progress results.</para>
|
---|
| 198 | <indexterm zone="gnutls gnutls-cli-debug">
|
---|
| 199 | <primary sortas="b-gnutls-cli-debug">gnutls-cli-debug</primary>
|
---|
| 200 | </indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="gnutls-serv">
|
---|
| 205 | <term><command>gnutls-serv</command></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>is a simple server program that listens to incoming TLS
|
---|
| 208 | connections.</para>
|
---|
| 209 | <indexterm zone="gnutls gnutls-serv">
|
---|
| 210 | <primary sortas="b-gnutls-serv">gnutls-serv</primary>
|
---|
| 211 | </indexterm>
|
---|
| 212 | </listitem>
|
---|
| 213 | </varlistentry>
|
---|
| 214 |
|
---|
[546b042] | 215 | <varlistentry id="ocsptool">
|
---|
| 216 | <term><command>ocsptool</command></term>
|
---|
| 217 | <listitem>
|
---|
| 218 | <para>is a program that can parse and print information about
|
---|
| 219 | OCSP requests/responses, generate requests and verify responses.</para>
|
---|
| 220 | <indexterm zone="gnutls ocsptool">
|
---|
| 221 | <primary sortas="b-ocsptool">ocsptool</primary>
|
---|
| 222 | </indexterm>
|
---|
| 223 | </listitem>
|
---|
| 224 | </varlistentry>
|
---|
| 225 |
|
---|
| 226 | <varlistentry id="p11tool">
|
---|
| 227 | <term><command>p11tool</command></term>
|
---|
| 228 | <listitem>
|
---|
| 229 | <para>is a program that allows handling data from PKCS #11 smart cards
|
---|
| 230 | and security modules.</para>
|
---|
| 231 | <indexterm zone="gnutls p11tool">
|
---|
| 232 | <primary sortas="b-p11tool">p11tool</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 | </listitem>
|
---|
| 235 | </varlistentry>
|
---|
| 236 |
|
---|
[d5404360] | 237 | <varlistentry id="psktool">
|
---|
| 238 | <term><command>psktool</command></term>
|
---|
| 239 | <listitem>
|
---|
| 240 | <para>is a simple program that generates random keys for use with
|
---|
| 241 | TLS-PSK.</para>
|
---|
| 242 | <indexterm zone="gnutls psktool">
|
---|
| 243 | <primary sortas="b-psktool">psktool</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
| 248 | <varlistentry id="srptool">
|
---|
| 249 | <term><command>srptool</command></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>is a simple program that emulates the programs in the Stanford
|
---|
| 252 | SRP (Secure Remote Password) libraries using GNU TLS.</para>
|
---|
| 253 | <indexterm zone="gnutls srptool">
|
---|
| 254 | <primary sortas="b-srptool">srptool</primary>
|
---|
| 255 | </indexterm>
|
---|
| 256 | </listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
| 259 | <varlistentry id="libgnutls">
|
---|
| 260 | <term><filename class='libraryfile'>libgnutls.{so,a}</filename></term>
|
---|
| 261 | <listitem>
|
---|
[410e228b] | 262 | <para>contains the core API functions and X.509 certificate
|
---|
[d5404360] | 263 | API functions.</para>
|
---|
| 264 | <indexterm zone="gnutls libgnutls">
|
---|
| 265 | <primary sortas="c-libgnutls">libgnutls.{so,a}</primary>
|
---|
| 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
| 269 |
|
---|
| 270 | </variablelist>
|
---|
| 271 |
|
---|
| 272 | </sect2>
|
---|
| 273 |
|
---|
| 274 | </sect1>
|
---|