glfs/postlfs/security/gnutls.xml
Randy McMurchy 410e228bb9 Removed extraneous whitespace from the ends of line text
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@7431 af4574ff-66df-0310-9fd7-8a98e5e911e0
2008-05-09 13:00:42 +00:00

250 lines
9.5 KiB
XML

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
<!ENTITY % general-entities SYSTEM "../../general.ent">
%general-entities;
<!ENTITY gnutls-download-http "http://www.gnu.org/software/gnutls/releases/gnutls-&gnutls-version;.tar.bz2">
<!ENTITY gnutls-download-ftp "ftp://ftp.gnutls.org/pub/gnutls/gnutls-&gnutls-version;.tar.bz2">
<!ENTITY gnutls-md5sum "73da68a4248d34c4d38491ce2119af0f">
<!ENTITY gnutls-size "4.2 MB">
<!ENTITY gnutls-buildsize "49 MB">
<!ENTITY gnutls-time "0.5 SBU">
]>
<sect1 id="gnutls" xreflabel="GnuTLS-&gnutls-version;">
<?dbhtml filename="gnutls.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>GnuTLS-&gnutls-version;</title>
<indexterm zone="gnutls">
<primary sortas="a-GnuTLS">GnuTLS</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to GnuTLS</title>
<para>The <application>GnuTLS</application> package contains a library and
userspace tools which provide a secure layer over a reliable transport
layer. Currently the <application>GnuTLS</application> library implements
the proposed standards by the IETF's TLS working group. Quoting from the
TLS protocol specification:</para>
<para><quote>The TLS protocol provides communications privacy over the
Internet. The protocol allows client/server applications to communicate in
a way that is designed to prevent eavesdropping, tampering, or message
forgery.</quote></para>
<para><application>GnuTLS</application> provides support for TLS 1.1, TLS
1.0 and SSL 3.0 protocols, TLS extensions, including server name and max
record size. Additionally, the library supports authentication using the
SRP protocol, X.509 certificates and OpenPGP keys, along with support for
the TLS Pre-Shared-Keys (PSK) extension, the Inner Application (TLS/IA)
extension and X.509 and OpenPGP certificate handling.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<itemizedlist spacing="compact">
<listitem>
<para>Download (HTTP): <ulink url="&gnutls-download-http;"/></para>
</listitem>
<listitem>
<para>Download (FTP): <ulink url="&gnutls-download-ftp;"/></para>
</listitem>
<listitem>
<para>Download MD5 sum: &gnutls-md5sum;</para>
</listitem>
<listitem>
<para>Download size: &gnutls-size;</para>
</listitem>
<listitem>
<para>Estimated disk space required: &gnutls-buildsize;</para>
</listitem>
<listitem>
<para>Estimated build time: &gnutls-time;</para>
</listitem>
</itemizedlist>
<bridgehead renderas="sect3">GnuTLS Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="libgcrypt"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="gtk-doc"/>,
<ulink url="http://www.gnu.org/software/gnutls/download.html">OpenCDK</ulink>,
<ulink url="http://www.gnu.org/software/gnutls/download.html">Tiny ASN.1</ulink>,
<!-- <ulink url="http://platon.sk/projects/libcfg+">libcfg+</ulink>, -->
<ulink url="http://webscripts.softpedia.com/script/Development-Scripts-js/C-C-Library/libcfg--26570.html">libcfg+</ulink>,
<xref linkend="LZO"/>, and
<ulink url="http://valgrind.org/">Valgrind</ulink> (used during the test suite)</para>
<bridgehead renderas="sect4">Optional Debugging Libraries</bridgehead>
<para role="optional"><ulink url="http://dmalloc.com/">Dmalloc</ulink> and
<ulink url="http://perens.com/FreeSoftware/ElectricFence/">Electric Fence</ulink></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/gnutls"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of GnuTLS</title>
<para>Install <application>GnuTLS</application> by running the
following commands:</para>
<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>
<para>To test the results, issue: <command>make check</command>.</para>
<para>Now, as the <systemitem class="username">root</systemitem>
user:</para>
<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/gnutls-&gnutls-version;/reference &amp;&amp;
install -v -m644 doc/reference/html/* \
/usr/share/doc/gnutls-&gnutls-version;/reference &amp;&amp;
install -v -m644 doc/*.{html,png,eps,pdf,ps} \
/usr/share/doc/gnutls-&gnutls-version;</userinput></screen>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directory</segtitle>
<seglistitem>
<seg>certtool, gnutls-cli, gnutls-cli-debug, gnutls-serv,
libgnutls-config, libgnutls-extra-config, psktool, and srptool</seg>
<seg>libgnutls.{so,a}, libgnutls-extra.{so,a},
libgnutls-openssl.{so,a}, and libgnutlsxx.{so,a}</seg>
<seg>/usr/include/gnutls and
/usr/share/doc/gnutls-&gnutls-version;</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<varlistentry id="certtool">
<term><command>certtool</command></term>
<listitem>
<para>is used to generate X.509 certificates, certificate requests,
and private keys.</para>
<indexterm zone="gnutls certtool">
<primary sortas="b-certtool">certtool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gnutls-cli">
<term><command>gnutls-cli</command></term>
<listitem>
<para>is a simple client program to set up a TLS connection to some
other computer.</para>
<indexterm zone="gnutls gnutls-cli">
<primary sortas="b-gnutls-cli">gnutls-cli</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gnutls-cli-debug">
<term><command>gnutls-cli-debug</command></term>
<listitem>
<para>is a simple client program to set up a TLS connection to some
other computer and produces very verbose progress results.</para>
<indexterm zone="gnutls gnutls-cli-debug">
<primary sortas="b-gnutls-cli-debug">gnutls-cli-debug</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gnutls-serv">
<term><command>gnutls-serv</command></term>
<listitem>
<para>is a simple server program that listens to incoming TLS
connections.</para>
<indexterm zone="gnutls gnutls-serv">
<primary sortas="b-gnutls-serv">gnutls-serv</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gnutls-config">
<term><command>gnutls-config</command></term>
<listitem>
<para>is a utility used to configure and build applications based on
the gnutls(3) library. It can be used to query the C compiler and
linker flags which are required to correctly compile and link the
application against the gnutls(3) library.</para>
<indexterm zone="gnutls gnutls-config">
<primary sortas="b-gnutls-config">gnutls-config</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gnutls-extra-config">
<term><command>gnutls-extra-config</command></term>
<listitem>
<para>is a utility used to configure and build applications based on
the gnutls-extra(3) library. It can be used to query the C compiler and
linker flags which are required to correctly compile and link the
application against the gnutls-extra(3) library.</para>
<indexterm zone="gnutls gnutls-extra-config">
<primary sortas="b-gnutls-extra-config">gnutls-extra-config</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="psktool">
<term><command>psktool</command></term>
<listitem>
<para>is a simple program that generates random keys for use with
TLS-PSK.</para>
<indexterm zone="gnutls psktool">
<primary sortas="b-psktool">psktool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="srptool">
<term><command>srptool</command></term>
<listitem>
<para>is a simple program that emulates the programs in the Stanford
SRP (Secure Remote Password) libraries using GNU TLS.</para>
<indexterm zone="gnutls srptool">
<primary sortas="b-srptool">srptool</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgnutls">
<term><filename class='libraryfile'>libgnutls.{so,a}</filename></term>
<listitem>
<para>contains the core API functions and X.509 certificate
API functions.</para>
<indexterm zone="gnutls libgnutls">
<primary sortas="c-libgnutls">libgnutls.{so,a}</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>