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