source: postlfs/security/gnutls.xml@ dd9e0c3

systemd-13485
Last change on this file since dd9e0c3 was dd9e0c3, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Sync with trunk r17367
Typo fix in glib-networking build size
GCC6 tag

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@17371 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 12.1 KB
Line 
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 " ">
8 <!ENTITY gnutls-download-ftp "ftp://ftp.gnutls.org/gcrypt/gnutls/v3.5/gnutls-&gnutls-version;.tar.xz">
9 <!ENTITY gnutls-md5sum "173154d0b41f6c58881e3fbd88f7e6e4">
10 <!ENTITY gnutls-size "6.4 MB">
11 <!ENTITY gnutls-buildsize "118 MB (add 22 MB for tests)">
12 <!ENTITY gnutls-time "0.8 SBU (add 6.7 SBU for tests)">
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>
33 The <application>GnuTLS</application> package contains libraries 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:
38 </para>
39
40 <para>
41 <quote>The TLS protocol provides communications privacy over the
42 Internet. The protocol allows client/server applications to communicate in
43 a way that is designed to prevent eavesdropping, tampering, or message
44 forgery.</quote>
45 </para>
46
47 <para>
48 <application>GnuTLS</application> provides support for TLS 1.2, TLS 1.1,
49 TLS 1.0, and SSL 3.0 protocols, TLS extensions, including server name and max
50 record size. Additionally, the library supports authentication using the
51 SRP protocol, X.509 certificates and OpenPGP keys, along with support for
52 the TLS Pre-Shared-Keys (PSK) extension, the Inner Application (TLS/IA)
53 extension and X.509 and OpenPGP certificate handling.
54 </para>
55
56 &lfs79_checked;
57
58 &gcc6_checked;
59
60 <bridgehead renderas="sect3">Package Information</bridgehead>
61 <itemizedlist spacing="compact">
62 <listitem>
63 <para>
64 Download (HTTP): <ulink url="&gnutls-download-http;"/>
65 </para>
66 </listitem>
67 <listitem>
68 <para>
69 Download (FTP): <ulink url="&gnutls-download-ftp;"/>
70 </para>
71 </listitem>
72 <listitem>
73 <para>
74 Download MD5 sum: &gnutls-md5sum;
75 </para>
76 </listitem>
77 <listitem>
78 <para>
79 Download size: &gnutls-size;
80 </para>
81 </listitem>
82 <listitem>
83 <para>
84 Estimated disk space required: &gnutls-buildsize;
85 </para>
86 </listitem>
87 <listitem>
88 <para>
89 Estimated build time: &gnutls-time;
90 </para>
91 </listitem>
92 </itemizedlist>
93
94 <bridgehead renderas="sect3">GnuTLS Dependencies</bridgehead>
95
96 <bridgehead renderas="sect4">Required</bridgehead>
97 <para role="required">
98 <xref linkend="nettle"/>
99 </para>
100
101 <bridgehead renderas="sect4">Recommended</bridgehead>
102 <para role="recommended">
103 <xref linkend="cacerts"/>,
104 <xref linkend="libtasn1"/> and
105 <xref linkend="p11-kit"/>
106 </para>
107
108 <bridgehead renderas="sect4">Optional</bridgehead>
109 <para role="optional">
110 <xref linkend="doxygen"/>,
111 <xref linkend="gtk-doc"/>,
112 <xref linkend="guile"/>,
113 <xref linkend="libidn"/>,
114 <xref linkend="texlive"/> or <xref linkend="tl-installer"/>,
115 <xref linkend="unbound"/> (to build the DANE library),
116 <xref linkend="valgrind"/> (used during the test suite),
117 <ulink url="http://ftp.gnu.org/gnu/autogen/">autogen</ulink>,
118 <ulink url="http://ftp.debian.org/debian/pool/main/d/datefudge/">datefudge</ulink> (used during the test suite), and
119 <ulink url="http://sourceforge.net/projects/trousers/files/trousers/">Trousers</ulink> (Trusted Platform Module support)
120 </para>
121
122 <note><para>
123 Note that if you do not install <xref linkend="libtasn1"/>, an older
124 version shipped in the <application>GnuTLS</application> tarball will be
125 used instead.
126 </para></note>
127
128 <para condition="html" role="usernotes">User Notes:
129 <ulink url="&blfs-wiki;/gnutls"/>
130 </para>
131 </sect2>
132
133 <sect2 role="installation">
134 <title>Installation of GnuTLS</title>
135
136 <para>
137 Install <application>GnuTLS</application> by running the
138 following commands:
139 </para>
140
141<screen><userinput>./configure --prefix=/usr \
142 --with-default-trust-store-file=/etc/ssl/ca-bundle.crt &amp;&amp;
143make</userinput></screen>
144
145 <para>
146 To test the results, issue: <command>make check</command>. If a prior
147 version of <application>GnuTLS</application> (or the same version but
148 without all of the recommended dependencies) has been installed, some
149 tests may fail. If <filename>/usr/lib/libgnutls.so</filename> and the
150 target of that symlink is moved or renamed so that they cannot be found,
151 all tests should pass and the install procedure will restore
152 <filename>libgnutls.so</filename> and the versioned library it points to.
153 </para>
154
155 <para>
156 Now, as the <systemitem class="username">root</systemitem>
157 user:
158 </para>
159
160<screen role="root"><userinput>make install</userinput></screen>
161
162 <para>
163 If you did not pass the <option>--enable-gtk-doc</option> parameter to
164 the <command>configure</command> script, you can install the API
165 documentation to the <filename
166 class="directory">/usr/share/gtk-doc/html/gnutls</filename> directory
167 using the following command as the
168 <systemitem class="username">root</systemitem> user:
169 </para>
170
171<screen role="root"><userinput>make -C doc/reference install-data-local</userinput></screen>
172
173 </sect2>
174
175 <sect2 role="commands">
176 <title>Command Explanations</title>
177
178 <para>
179 <parameter>--with-default-trust-store-file=/etc/ssl/ca-bundle.crt</parameter>:
180 This switch tells <command>configure</command> where to find the
181 CA Certificates.
182 </para>
183
184 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
185 href="../../xincludes/gtk-doc-rebuild.xml"/>
186
187 <para>
188 <option>--enable-openssl-compatibility</option>:
189 Use this switch if you wish to build the OpenSSL compatibility library.
190 </para>
191
192 <para>
193 <option>--without-p11-kit</option>: use this switch if you have not
194 installed <application>p11-kit</application>.
195 </para>
196
197 </sect2>
198
199 <sect2 role="content">
200 <title>Contents</title>
201
202 <segmentedlist>
203 <segtitle>Installed Programs</segtitle>
204 <segtitle>Installed Libraries</segtitle>
205 <segtitle>Installed Directories</segtitle>
206
207 <seglistitem>
208 <seg>
209 certtool, crywrap, danetool, gnutls-cli, gnutls-cli-debug,
210 gnutls-serv, ocsptool, p11tool, psktool, and srptool
211 </seg>
212 <seg>
213 libgnutls.so, libgnutls-dane.so, libgnutlsxx.so, and
214 /usr/lib/guile/2.0/guile-gnutls-v-2.so
215 </seg>
216 <seg>
217 /usr/{include,share/gtk-doc/html,share/guile/site}/gnutls
218 </seg>
219 </seglistitem>
220 </segmentedlist>
221
222 <variablelist>
223 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
224 <?dbfo list-presentation="list"?>
225 <?dbhtml list-presentation="table"?>
226
227 <varlistentry id="certtool">
228 <term><command>certtool</command></term>
229 <listitem>
230 <para>
231 is used to generate X.509 certificates, certificate requests,
232 and private keys.
233 </para>
234 <indexterm zone="gnutls certtool">
235 <primary sortas="b-certtool">certtool</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="crywrap">
241 <term><command>crywrap</command></term>
242 <listitem>
243 <para>
244 is a simple wrapper that waits for TLS/SSL connections,
245 and proxies them to an unencrypted location. Only installed if
246 <xref linkend="libidn"/> is present.
247 </para>
248 <indexterm zone="gnutls crywrap">
249 <primary sortas="b-crywrap">crywrap</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="danetool">
255 <term><command>danetool</command></term>
256 <listitem>
257 <para>
258 is a tool used to generate and check DNS resource records
259 for the DANE protocol.
260 </para>
261 <indexterm zone="gnutls danetool">
262 <primary sortas="b-danetool">danetool</primary>
263 </indexterm>
264 </listitem>
265 </varlistentry>
266
267 <varlistentry id="gnutls-cli">
268 <term><command>gnutls-cli</command></term>
269 <listitem>
270 <para>
271 is a simple client program to set up a TLS connection to some
272 other computer.
273 </para>
274 <indexterm zone="gnutls gnutls-cli">
275 <primary sortas="b-gnutls-cli">gnutls-cli</primary>
276 </indexterm>
277 </listitem>
278 </varlistentry>
279
280 <varlistentry id="gnutls-cli-debug">
281 <term><command>gnutls-cli-debug</command></term>
282 <listitem>
283 <para>
284 is a simple client program to set up a TLS connection to some
285 other computer and produces very verbose progress results.
286 </para>
287 <indexterm zone="gnutls gnutls-cli-debug">
288 <primary sortas="b-gnutls-cli-debug">gnutls-cli-debug</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="gnutls-serv">
294 <term><command>gnutls-serv</command></term>
295 <listitem>
296 <para>
297 is a simple server program that listens to incoming TLS
298 connections.
299 </para>
300 <indexterm zone="gnutls gnutls-serv">
301 <primary sortas="b-gnutls-serv">gnutls-serv</primary>
302 </indexterm>
303 </listitem>
304 </varlistentry>
305
306 <varlistentry id="ocsptool">
307 <term><command>ocsptool</command></term>
308 <listitem>
309 <para>
310 is a program that can parse and print information about OCSP
311 requests/responses, generate requests and verify responses.
312 </para>
313 <indexterm zone="gnutls ocsptool">
314 <primary sortas="b-ocsptool">ocsptool</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="p11tool">
320 <term><command>p11tool</command></term>
321 <listitem>
322 <para>
323 is a program that allows handling data from PKCS #11 smart cards
324 and security modules.
325 </para>
326 <indexterm zone="gnutls p11tool">
327 <primary sortas="b-p11tool">p11tool</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="psktool">
333 <term><command>psktool</command></term>
334 <listitem>
335 <para>
336 is a simple program that generates random keys for use with TLS-PSK.
337 </para>
338 <indexterm zone="gnutls psktool">
339 <primary sortas="b-psktool">psktool</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="srptool">
345 <term><command>srptool</command></term>
346 <listitem>
347 <para>
348 is a simple program that emulates the programs in the Stanford
349 SRP (Secure Remote Password) libraries using GnuTLS.
350 </para>
351 <indexterm zone="gnutls srptool">
352 <primary sortas="b-srptool">srptool</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="libgnutls">
358 <term><filename class="libraryfile">libgnutls.so</filename></term>
359 <listitem>
360 <para>
361 contains the core API functions and X.509 certificate API functions.
362 </para>
363 <indexterm zone="gnutls libgnutls">
364 <primary sortas="c-libgnutls">libgnutls.so</primary>
365 </indexterm>
366 </listitem>
367 </varlistentry>
368
369 </variablelist>
370
371 </sect2>
372
373</sect1>
Note: See TracBrowser for help on using the repository browser.