1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 "&gnupg-http;/gnutls/v3.8/gnutls-&gnutls-version;.tar.xz">
|
---|
8 | <!ENTITY gnutls-download-ftp " ">
|
---|
9 | <!ENTITY gnutls-md5sum "46777802233eb7203d47a8b8880c8c90">
|
---|
10 | <!ENTITY gnutls-size "6.4 MB">
|
---|
11 | <!ENTITY gnutls-buildsize "154 MB (add 115 MB for tests)">
|
---|
12 | <!ENTITY gnutls-time "0.5 SBU (add 1.5 SBU for tests; both using parallelism=8)">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="gnutls" xreflabel="GnuTLS-&gnutls-version;">
|
---|
16 | <?dbhtml filename="gnutls.html"?>
|
---|
17 |
|
---|
18 |
|
---|
19 | <title>GnuTLS-&gnutls-version;</title>
|
---|
20 |
|
---|
21 | <indexterm zone="gnutls">
|
---|
22 | <primary sortas="a-GnuTLS">GnuTLS</primary>
|
---|
23 | </indexterm>
|
---|
24 |
|
---|
25 | <sect2 role="package">
|
---|
26 | <title>Introduction to GnuTLS</title>
|
---|
27 |
|
---|
28 | <para>
|
---|
29 | The <application>GnuTLS</application> package contains libraries and
|
---|
30 | userspace tools which provide a secure layer over a reliable transport
|
---|
31 | layer. Currently the <application>GnuTLS</application> library implements
|
---|
32 | the proposed standards by the IETF's TLS working group. Quoting from the
|
---|
33 | <ulink url="https://datatracker.ietf.org/doc/rfc8446/">
|
---|
34 | TLS 1.3 protocol specification
|
---|
35 | </ulink>:
|
---|
36 | </para>
|
---|
37 |
|
---|
38 | <para>
|
---|
39 | <quote>
|
---|
40 | TLS allows client/server applications to communicate over the Internet
|
---|
41 | in a way that is designed to prevent eavesdropping, tampering, and
|
---|
42 | message forgery.
|
---|
43 | </quote>
|
---|
44 | </para>
|
---|
45 |
|
---|
46 | <para>
|
---|
47 | <application>GnuTLS</application> provides support for TLS 1.3, TLS 1.2,
|
---|
48 | TLS 1.1, TLS 1.0, and (optionally) SSL 3.0 protocols. It also supports
|
---|
49 | TLS extensions, including server name and max record size. Additionally,
|
---|
50 | the library supports authentication using the SRP protocol, X.509
|
---|
51 | certificates, and OpenPGP keys, along with support for the TLS
|
---|
52 | Pre-Shared-Keys (PSK) extension, the Inner Application (TLS/IA)
|
---|
53 | extension, and X.509 and OpenPGP certificate handling.
|
---|
54 | </para>
|
---|
55 |
|
---|
56 | &lfs122_checked;
|
---|
57 |
|
---|
58 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
59 | <itemizedlist spacing="compact">
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Download (HTTP): <ulink url="&gnutls-download-http;"/>
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Download (FTP): <ulink url="&gnutls-download-ftp;"/>
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Download MD5 sum: &gnutls-md5sum;
|
---|
73 | </para>
|
---|
74 | </listitem>
|
---|
75 | <listitem>
|
---|
76 | <para>
|
---|
77 | Download size: &gnutls-size;
|
---|
78 | </para>
|
---|
79 | </listitem>
|
---|
80 | <listitem>
|
---|
81 | <para>
|
---|
82 | Estimated disk space required: &gnutls-buildsize;
|
---|
83 | </para>
|
---|
84 | </listitem>
|
---|
85 | <listitem>
|
---|
86 | <para>
|
---|
87 | Estimated build time: &gnutls-time;
|
---|
88 | </para>
|
---|
89 | </listitem>
|
---|
90 | </itemizedlist>
|
---|
91 |
|
---|
92 | <note>
|
---|
93 | <para>
|
---|
94 | When extracting this package tarball, it expands to the gnutls-3.8.7
|
---|
95 | directory, instead of the expected gnutls-3.8.7.1 directory.
|
---|
96 | </para>
|
---|
97 | </note>
|
---|
98 |
|
---|
99 | <bridgehead renderas="sect3">GnuTLS Dependencies</bridgehead>
|
---|
100 |
|
---|
101 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
102 | <para role="required">
|
---|
103 | <xref linkend="nettle"/>
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
107 | <para role="recommended">
|
---|
108 | <xref linkend="make-ca"/>,
|
---|
109 | <xref linkend="libunistring"/>,
|
---|
110 | <xref linkend="libtasn1"/>, and
|
---|
111 | <xref linkend="p11-kit"/>
|
---|
112 | </para>
|
---|
113 |
|
---|
114 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
115 | <para role="optional">
|
---|
116 | <xref linkend="brotli"/>,
|
---|
117 | <xref linkend="doxygen"/>,
|
---|
118 | <xref linkend="gtk-doc"/>,
|
---|
119 | <xref linkend="libidn"/> or
|
---|
120 | <xref linkend="libidn2"/>,
|
---|
121 | <xref linkend="libseccomp"/>,
|
---|
122 | <xref linkend="net-tools"/> (used during the test suite),
|
---|
123 | <xref linkend="texlive"/> or <xref linkend="tl-installer"/>,
|
---|
124 | <xref linkend="unbound"/> (to build the DANE library),
|
---|
125 | <xref linkend="valgrind"/> (used during the test suite),
|
---|
126 | <ulink url="&gnu-http;/autogen/">autogen</ulink>,
|
---|
127 | <ulink url="https://cmocka.org/">cmocka</ulink> and
|
---|
128 | <ulink url="https://ftp.debian.org/debian/pool/main/d/datefudge/">datefudge</ulink> (used during the test suite if the DANE library is built), and
|
---|
129 | <ulink url="&sourceforge-dl;/trousers/">Trousers</ulink> (Trusted Platform Module support)
|
---|
130 | </para>
|
---|
131 |
|
---|
132 | <note><para>
|
---|
133 | <!-- Note that if you do not install <xref linkend="libtasn1"/>, an older
|
---|
134 | 3.8.0 includes minitasn1 4.19 which is current at the moment. ken -->
|
---|
135 | Note that if you do not install <xref linkend="libtasn1"/>, a
|
---|
136 | version shipped in the <application>GnuTLS</application> tarball will be
|
---|
137 | used instead.
|
---|
138 | </para></note>
|
---|
139 |
|
---|
140 | </sect2>
|
---|
141 |
|
---|
142 | <sect2 role="installation">
|
---|
143 | <title>Installation of GnuTLS</title>
|
---|
144 |
|
---|
145 | <para>
|
---|
146 | Install <application>GnuTLS</application> by running the
|
---|
147 | following commands:
|
---|
148 | </para>
|
---|
149 |
|
---|
150 | <screen><userinput>./configure --prefix=/usr \
|
---|
151 | --docdir=/usr/share/doc/gnutls-&gnutls-version; \
|
---|
152 | --with-default-trust-store-pkcs11="pkcs11:" &&
|
---|
153 | make</userinput></screen>
|
---|
154 | <!-- - -disable-rpath \
|
---|
155 | Old gnutls versions (around 3.5) had a problem with rpath, because
|
---|
156 | libraries in the build tree were linked with rpath pointing to the
|
---|
157 | system libraries, so that tests failed. Present versions don't have
|
---|
158 | this problem, and do exactly what is expected without using the
|
---|
159 | disable-rpath option: rpath pointing to the build tree when libraries
|
---|
160 | are first linked, but rpath removed when libraries are relinked at
|
---|
161 | install time. -->
|
---|
162 |
|
---|
163 | <para>
|
---|
164 | One test hangs the test procedure. Disable it:
|
---|
165 | <command>sed '/ocsp-must-staple-connection/d' -i tests/Makefile</command>.
|
---|
166 | To test the results, now issue: <command>make check</command>.
|
---|
167 | </para>
|
---|
168 |
|
---|
169 | <para>
|
---|
170 | Now, install the package as the &root; user:
|
---|
171 | </para>
|
---|
172 |
|
---|
173 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
174 |
|
---|
175 | </sect2>
|
---|
176 |
|
---|
177 | <sect2 role="commands">
|
---|
178 | <title>Command Explanations</title>
|
---|
179 |
|
---|
180 | <para>
|
---|
181 | <parameter>--with-default-trust-store-pkcs11="pkcs11:"</parameter>: This
|
---|
182 | switch tells gnutls to use the PKCS #11 trust store as the default trust.
|
---|
183 | Omit this switch if <xref linkend="p11-kit"/> is not installed.
|
---|
184 | </para>
|
---|
185 | <!-- see above
|
---|
186 | <para>
|
---|
187 | <parameter>- -disable-rpath</parameter>: This switch prevents building
|
---|
188 | GnuTLS utilities and tests with hardcoded runtime library search path.
|
---|
189 | Hardcoded rpath is unneeded for BLFS, and it causes test failures if
|
---|
190 | an old version of GnuTLS is installed.
|
---|
191 | </para>
|
---|
192 | -->
|
---|
193 | <para>
|
---|
194 | <option>--with-default-trust-store-file=/etc/pki/tls/certs/ca-bundle.crt</option>:
|
---|
195 | This switch tells <command>configure</command> where to find the
|
---|
196 | legacy CA certificate bundle and to use it instead of PKCS #11 module
|
---|
197 | by default. Use this if <xref linkend="p11-kit"/> is not installed.
|
---|
198 | </para>
|
---|
199 |
|
---|
200 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
201 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
202 |
|
---|
203 | <para>
|
---|
204 | <option>--enable-openssl-compatibility</option>:
|
---|
205 | Use this switch if you wish to build the OpenSSL compatibility library.
|
---|
206 | </para>
|
---|
207 |
|
---|
208 | <para>
|
---|
209 | <option>--without-p11-kit</option>: use this switch if you have not
|
---|
210 | installed <application>p11-kit</application>.
|
---|
211 | </para>
|
---|
212 |
|
---|
213 | <para>
|
---|
214 | <option>--with-included-unistring</option>: uses the bundled version of
|
---|
215 | libunistring, instead of the system one. Use this switch if you have not
|
---|
216 | installed <xref linkend="libunistring"/>.
|
---|
217 | </para>
|
---|
218 |
|
---|
219 | <para>
|
---|
220 | <option>--disable-dsa</option>: completely disables DSA algorithm support.
|
---|
221 | </para>
|
---|
222 |
|
---|
223 | </sect2>
|
---|
224 |
|
---|
225 | <sect2 role="content">
|
---|
226 | <title>Contents</title>
|
---|
227 |
|
---|
228 | <segmentedlist>
|
---|
229 | <segtitle>Installed Programs</segtitle>
|
---|
230 | <segtitle>Installed Libraries</segtitle>
|
---|
231 | <segtitle>Installed Directories</segtitle>
|
---|
232 |
|
---|
233 | <seglistitem>
|
---|
234 | <seg>
|
---|
235 | certtool,
|
---|
236 | danetool,
|
---|
237 | gnutls-cli,
|
---|
238 | gnutls-cli-debug,
|
---|
239 | gnutls-serv,
|
---|
240 | ocsptool,
|
---|
241 | p11tool,
|
---|
242 | psktool, and
|
---|
243 | srptool
|
---|
244 | </seg>
|
---|
245 | <seg>
|
---|
246 | libgnutls.so,
|
---|
247 | libgnutls-dane.so,
|
---|
248 | libgnutlsxx.so, and
|
---|
249 | libgnutls-openssl.so (optional)
|
---|
250 | </seg>
|
---|
251 | <seg>
|
---|
252 | /usr/include/gnutls and
|
---|
253 | /usr/share/doc/gnutls-&gnutls-version;
|
---|
254 | </seg>
|
---|
255 | </seglistitem>
|
---|
256 | </segmentedlist>
|
---|
257 |
|
---|
258 | <variablelist>
|
---|
259 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
260 | <?dbfo list-presentation="list"?>
|
---|
261 | <?dbhtml list-presentation="table"?>
|
---|
262 |
|
---|
263 | <varlistentry id="certtool">
|
---|
264 | <term><command>certtool</command></term>
|
---|
265 | <listitem>
|
---|
266 | <para>
|
---|
267 | is used to generate X.509 certificates, certificate requests,
|
---|
268 | and private keys
|
---|
269 | </para>
|
---|
270 | <indexterm zone="gnutls certtool">
|
---|
271 | <primary sortas="b-certtool">certtool</primary>
|
---|
272 | </indexterm>
|
---|
273 | </listitem>
|
---|
274 | </varlistentry>
|
---|
275 |
|
---|
276 | <varlistentry id="danetool">
|
---|
277 | <term><command>danetool</command></term>
|
---|
278 | <listitem>
|
---|
279 | <para>
|
---|
280 | is a tool used to generate and check DNS resource records
|
---|
281 | for the DANE protocol
|
---|
282 | </para>
|
---|
283 | <indexterm zone="gnutls danetool">
|
---|
284 | <primary sortas="b-danetool">danetool</primary>
|
---|
285 | </indexterm>
|
---|
286 | </listitem>
|
---|
287 | </varlistentry>
|
---|
288 |
|
---|
289 | <varlistentry id="gnutls-cli">
|
---|
290 | <term><command>gnutls-cli</command></term>
|
---|
291 | <listitem>
|
---|
292 | <para>
|
---|
293 | is a simple client program to set up a TLS connection to some
|
---|
294 | other computer
|
---|
295 | </para>
|
---|
296 | <indexterm zone="gnutls gnutls-cli">
|
---|
297 | <primary sortas="b-gnutls-cli">gnutls-cli</primary>
|
---|
298 | </indexterm>
|
---|
299 | </listitem>
|
---|
300 | </varlistentry>
|
---|
301 |
|
---|
302 | <varlistentry id="gnutls-cli-debug">
|
---|
303 | <term><command>gnutls-cli-debug</command></term>
|
---|
304 | <listitem>
|
---|
305 | <para>
|
---|
306 | is a simple client program to set up a TLS connection to some
|
---|
307 | other computer and produces very verbose progress results
|
---|
308 | </para>
|
---|
309 | <indexterm zone="gnutls gnutls-cli-debug">
|
---|
310 | <primary sortas="b-gnutls-cli-debug">gnutls-cli-debug</primary>
|
---|
311 | </indexterm>
|
---|
312 | </listitem>
|
---|
313 | </varlistentry>
|
---|
314 |
|
---|
315 | <varlistentry id="gnutls-serv">
|
---|
316 | <term><command>gnutls-serv</command></term>
|
---|
317 | <listitem>
|
---|
318 | <para>
|
---|
319 | is a simple server program that listens to incoming TLS
|
---|
320 | connections
|
---|
321 | </para>
|
---|
322 | <indexterm zone="gnutls gnutls-serv">
|
---|
323 | <primary sortas="b-gnutls-serv">gnutls-serv</primary>
|
---|
324 | </indexterm>
|
---|
325 | </listitem>
|
---|
326 | </varlistentry>
|
---|
327 |
|
---|
328 | <varlistentry id="ocsptool">
|
---|
329 | <term><command>ocsptool</command></term>
|
---|
330 | <listitem>
|
---|
331 | <para>
|
---|
332 | is a program that can parse and print information about OCSP
|
---|
333 | requests/responses, generate requests and verify responses
|
---|
334 | </para>
|
---|
335 | <indexterm zone="gnutls ocsptool">
|
---|
336 | <primary sortas="b-ocsptool">ocsptool</primary>
|
---|
337 | </indexterm>
|
---|
338 | </listitem>
|
---|
339 | </varlistentry>
|
---|
340 |
|
---|
341 | <varlistentry id="p11tool">
|
---|
342 | <term><command>p11tool</command></term>
|
---|
343 | <listitem>
|
---|
344 | <para>
|
---|
345 | is a program that allows handling data from PKCS #11 smart cards
|
---|
346 | and security modules
|
---|
347 | </para>
|
---|
348 | <indexterm zone="gnutls p11tool">
|
---|
349 | <primary sortas="b-p11tool">p11tool</primary>
|
---|
350 | </indexterm>
|
---|
351 | </listitem>
|
---|
352 | </varlistentry>
|
---|
353 |
|
---|
354 | <varlistentry id="psktool">
|
---|
355 | <term><command>psktool</command></term>
|
---|
356 | <listitem>
|
---|
357 | <para>
|
---|
358 | is a simple program that generates random keys for use with TLS-PSK
|
---|
359 | </para>
|
---|
360 | <indexterm zone="gnutls psktool">
|
---|
361 | <primary sortas="b-psktool">psktool</primary>
|
---|
362 | </indexterm>
|
---|
363 | </listitem>
|
---|
364 | </varlistentry>
|
---|
365 |
|
---|
366 | <varlistentry id="srptool">
|
---|
367 | <term><command>srptool</command></term>
|
---|
368 | <listitem>
|
---|
369 | <para>
|
---|
370 | is a simple program that emulates the programs in the Stanford
|
---|
371 | SRP (Secure Remote Password) libraries using GnuTLS
|
---|
372 | </para>
|
---|
373 | <indexterm zone="gnutls srptool">
|
---|
374 | <primary sortas="b-srptool">srptool</primary>
|
---|
375 | </indexterm>
|
---|
376 | </listitem>
|
---|
377 | </varlistentry>
|
---|
378 |
|
---|
379 | <varlistentry id="libgnutls">
|
---|
380 | <term><filename class="libraryfile">libgnutls.so</filename></term>
|
---|
381 | <listitem>
|
---|
382 | <para>
|
---|
383 | contains the core API functions and X.509 certificate API functions
|
---|
384 | </para>
|
---|
385 | <indexterm zone="gnutls libgnutls">
|
---|
386 | <primary sortas="c-libgnutls">libgnutls.so</primary>
|
---|
387 | </indexterm>
|
---|
388 | </listitem>
|
---|
389 | </varlistentry>
|
---|
390 |
|
---|
391 | </variablelist>
|
---|
392 |
|
---|
393 | </sect2>
|
---|
394 |
|
---|
395 | </sect1>
|
---|