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 |
|
---|
7 | <!ENTITY gnutls-download-http "http://mirrors.kernel.org/gnu/gnutls/gnutls-&gnutls-version;.tar.bz2">
|
---|
8 | <!ENTITY gnutls-download-ftp "ftp://ftp.gnutls.org/pub/gnutls/gnutls-&gnutls-version;.tar.bz2">
|
---|
9 | <!ENTITY gnutls-md5sum "eb0a6d7d3cb9ac684d971c14f9f6d3ba">
|
---|
10 | <!ENTITY gnutls-size "6.4 MB">
|
---|
11 | <!ENTITY gnutls-buildsize "96 MB">
|
---|
12 | <!ENTITY gnutls-time "1.0 SBU (additional 1.2 SBU to run the test suite)">
|
---|
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 |
|
---|
50 | &lfs65_checked;
|
---|
51 |
|
---|
52 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
53 | <itemizedlist spacing="compact">
|
---|
54 | <listitem>
|
---|
55 | <para>Download (HTTP): <ulink url="&gnutls-download-http;"/></para>
|
---|
56 | </listitem>
|
---|
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>
|
---|
77 | <para role="required"><xref linkend="libgcrypt"/></para>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
80 | <para role="optional"><xref linkend="gtk-doc"/>,
|
---|
81 | <xref linkend="guile"/>,
|
---|
82 | <xref linkend="libtasn1"/>,
|
---|
83 | <ulink url="http://webscripts.softpedia.com/script/Development-Scripts-js/C-C-Library/libcfg--26570.html">libcfg+</ulink>, and
|
---|
84 | <ulink url="http://valgrind.org/">Valgrind</ulink> (used during the test suite)</para>
|
---|
85 |
|
---|
86 | <para>Note that if you do not install <xref linkend="libtasn1"/>, an older
|
---|
87 | version shipped in the <application>GnuTLS</application> tarball will be
|
---|
88 | used instead.</para>
|
---|
89 |
|
---|
90 | <!-- <bridgehead renderas="sect4">Optional Debugging Libraries</bridgehead>
|
---|
91 | <para role="optional"><ulink url="http://dmalloc.com/">Dmalloc</ulink> and
|
---|
92 | <ulink url="http://perens.com/FreeSoftware/ElectricFence/">Electric Fence</ulink></para> -->
|
---|
93 |
|
---|
94 | <para condition="html" role="usernotes">User Notes:
|
---|
95 | <ulink url="&blfs-wiki;/gnutls"/></para>
|
---|
96 |
|
---|
97 | </sect2>
|
---|
98 |
|
---|
99 | <sect2 role="installation">
|
---|
100 | <title>Installation of GnuTLS</title>
|
---|
101 |
|
---|
102 | <para>Install <application>GnuTLS</application> by running the
|
---|
103 | following commands:</para>
|
---|
104 |
|
---|
105 | <screen><userinput>./configure --prefix=/usr &&
|
---|
106 | make</userinput></screen>
|
---|
107 |
|
---|
108 | <para>To test the results, issue: <command>make check</command>.</para>
|
---|
109 |
|
---|
110 | <para>Now, as the <systemitem class="username">root</systemitem>
|
---|
111 | user:</para>
|
---|
112 |
|
---|
113 | <screen role="root"><userinput>make install &&
|
---|
114 | install -v -m755 -d /usr/share/doc/gnutls-&gnutls-version; &&
|
---|
115 | install -v -m644 doc/*.{html,png,eps,pdf,ps} doc/cyclo/*.html \
|
---|
116 | /usr/share/doc/gnutls-&gnutls-version; &&
|
---|
117 | cp -v -R doc/credentials \
|
---|
118 | /usr/share/doc/gnutls-&gnutls-version;</userinput></screen>
|
---|
119 |
|
---|
120 | <para>If you did not pass the <option>--enable-gtk-doc</option> parameter
|
---|
121 | to the <command>configure</command> script, install the API documentation
|
---|
122 | using the following command as the
|
---|
123 | <systemitem class="username">root</systemitem> user:</para>
|
---|
124 |
|
---|
125 | <screen role="root"><userinput>make -C doc/reference install-data-local</userinput></screen>
|
---|
126 |
|
---|
127 | </sect2>
|
---|
128 |
|
---|
129 | <sect2 role="commands">
|
---|
130 | <title>Command Explanations</title>
|
---|
131 |
|
---|
132 | <!-- There is no need to add this switch. Why would anyone not want to
|
---|
133 | use the system-installed copy instead of the mini-tasn included
|
---|
134 | inthe gnutls sources?
|
---|
135 | <para><option>-with-included-libtasn1</option>: This option forces
|
---|
136 | the use of the shipped version of <application>libtasn1</application>,
|
---|
137 | instead of the system's installed version.</para>
|
---|
138 | -->
|
---|
139 |
|
---|
140 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
141 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
142 |
|
---|
143 | </sect2>
|
---|
144 |
|
---|
145 | <sect2 role="content">
|
---|
146 | <title>Contents</title>
|
---|
147 |
|
---|
148 | <segmentedlist>
|
---|
149 | <segtitle>Installed Programs</segtitle>
|
---|
150 | <segtitle>Installed Libraries</segtitle>
|
---|
151 | <segtitle>Installed Directory</segtitle>
|
---|
152 |
|
---|
153 | <seglistitem>
|
---|
154 | <seg>certtool, gnutls-cli, gnutls-cli-debug, gnutls-serv,
|
---|
155 | psktool, and srptool</seg>
|
---|
156 | <seg>libgnutls.{so,a}, libgnutls-extra.{so,a},
|
---|
157 | libgnutls-openssl.{so,a}, and libgnutlsxx.{so,a}</seg>
|
---|
158 | <seg>/usr/include/gnutls,
|
---|
159 | /usr/share/doc/gnutls-&gnutls-version;, and
|
---|
160 | /usr/share/gtk-doc/html/gnutls</seg>
|
---|
161 | </seglistitem>
|
---|
162 | </segmentedlist>
|
---|
163 |
|
---|
164 | <variablelist>
|
---|
165 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
166 | <?dbfo list-presentation="list"?>
|
---|
167 | <?dbhtml list-presentation="table"?>
|
---|
168 |
|
---|
169 | <varlistentry id="certtool">
|
---|
170 | <term><command>certtool</command></term>
|
---|
171 | <listitem>
|
---|
172 | <para>is used to generate X.509 certificates, certificate requests,
|
---|
173 | and private keys.</para>
|
---|
174 | <indexterm zone="gnutls certtool">
|
---|
175 | <primary sortas="b-certtool">certtool</primary>
|
---|
176 | </indexterm>
|
---|
177 | </listitem>
|
---|
178 | </varlistentry>
|
---|
179 |
|
---|
180 | <varlistentry id="gnutls-cli">
|
---|
181 | <term><command>gnutls-cli</command></term>
|
---|
182 | <listitem>
|
---|
183 | <para>is a simple client program to set up a TLS connection to some
|
---|
184 | other computer.</para>
|
---|
185 | <indexterm zone="gnutls gnutls-cli">
|
---|
186 | <primary sortas="b-gnutls-cli">gnutls-cli</primary>
|
---|
187 | </indexterm>
|
---|
188 | </listitem>
|
---|
189 | </varlistentry>
|
---|
190 |
|
---|
191 | <varlistentry id="gnutls-cli-debug">
|
---|
192 | <term><command>gnutls-cli-debug</command></term>
|
---|
193 | <listitem>
|
---|
194 | <para>is a simple client program to set up a TLS connection to some
|
---|
195 | other computer and produces very verbose progress results.</para>
|
---|
196 | <indexterm zone="gnutls gnutls-cli-debug">
|
---|
197 | <primary sortas="b-gnutls-cli-debug">gnutls-cli-debug</primary>
|
---|
198 | </indexterm>
|
---|
199 | </listitem>
|
---|
200 | </varlistentry>
|
---|
201 |
|
---|
202 | <varlistentry id="gnutls-serv">
|
---|
203 | <term><command>gnutls-serv</command></term>
|
---|
204 | <listitem>
|
---|
205 | <para>is a simple server program that listens to incoming TLS
|
---|
206 | connections.</para>
|
---|
207 | <indexterm zone="gnutls gnutls-serv">
|
---|
208 | <primary sortas="b-gnutls-serv">gnutls-serv</primary>
|
---|
209 | </indexterm>
|
---|
210 | </listitem>
|
---|
211 | </varlistentry>
|
---|
212 |
|
---|
213 | <varlistentry id="psktool">
|
---|
214 | <term><command>psktool</command></term>
|
---|
215 | <listitem>
|
---|
216 | <para>is a simple program that generates random keys for use with
|
---|
217 | TLS-PSK.</para>
|
---|
218 | <indexterm zone="gnutls psktool">
|
---|
219 | <primary sortas="b-psktool">psktool</primary>
|
---|
220 | </indexterm>
|
---|
221 | </listitem>
|
---|
222 | </varlistentry>
|
---|
223 |
|
---|
224 | <varlistentry id="srptool">
|
---|
225 | <term><command>srptool</command></term>
|
---|
226 | <listitem>
|
---|
227 | <para>is a simple program that emulates the programs in the Stanford
|
---|
228 | SRP (Secure Remote Password) libraries using GNU TLS.</para>
|
---|
229 | <indexterm zone="gnutls srptool">
|
---|
230 | <primary sortas="b-srptool">srptool</primary>
|
---|
231 | </indexterm>
|
---|
232 | </listitem>
|
---|
233 | </varlistentry>
|
---|
234 |
|
---|
235 | <varlistentry id="libgnutls">
|
---|
236 | <term><filename class='libraryfile'>libgnutls.{so,a}</filename></term>
|
---|
237 | <listitem>
|
---|
238 | <para>contains the core API functions and X.509 certificate
|
---|
239 | API functions.</para>
|
---|
240 | <indexterm zone="gnutls libgnutls">
|
---|
241 | <primary sortas="c-libgnutls">libgnutls.{so,a}</primary>
|
---|
242 | </indexterm>
|
---|
243 | </listitem>
|
---|
244 | </varlistentry>
|
---|
245 |
|
---|
246 | </variablelist>
|
---|
247 |
|
---|
248 | </sect2>
|
---|
249 |
|
---|
250 | </sect1>
|
---|