[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 |
|
---|
[d835b55] | 7 | <!ENTITY gnutls-download-http " ">
|
---|
| 8 | <!ENTITY gnutls-download-ftp "ftp://ftp.gnutls.org/gcrypt/gnutls/v3.1/gnutls-&gnutls-version;.tar.xz">
|
---|
| 9 | <!ENTITY gnutls-md5sum "835a5d20def765cd49ad7274ff3e7493">
|
---|
[f18f873] | 10 | <!ENTITY gnutls-size "4.8 MB">
|
---|
| 11 | <!ENTITY gnutls-buildsize "130 MB">
|
---|
| 12 | <!ENTITY gnutls-time "0.8 SBU (additional 3.0 SBU if running the testsuite)">
|
---|
[d5404360] | 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 |
|
---|
[3ee626e] | 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.1, TLS
|
---|
| 49 | 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>
|
---|
[d5404360] | 55 |
|
---|
[60ecc5bb] | 56 | &lfs72_checked;
|
---|
[214718a] | 57 |
|
---|
[d5404360] | 58 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 59 | <itemizedlist spacing="compact">
|
---|
[546b042] | 60 | <listitem>
|
---|
[3ee626e] | 61 | <para>
|
---|
| 62 | Download (HTTP): <ulink url="&gnutls-download-http;"/>
|
---|
| 63 | </para>
|
---|
[546b042] | 64 | </listitem>
|
---|
[d5404360] | 65 | <listitem>
|
---|
[3ee626e] | 66 | <para>
|
---|
| 67 | Download (FTP): <ulink url="&gnutls-download-ftp;"/>
|
---|
| 68 | </para>
|
---|
[d5404360] | 69 | </listitem>
|
---|
| 70 | <listitem>
|
---|
[3ee626e] | 71 | <para>
|
---|
| 72 | Download MD5 sum: &gnutls-md5sum;
|
---|
| 73 | </para>
|
---|
[d5404360] | 74 | </listitem>
|
---|
| 75 | <listitem>
|
---|
[3ee626e] | 76 | <para>
|
---|
| 77 | Download size: &gnutls-size;
|
---|
| 78 | </para>
|
---|
[d5404360] | 79 | </listitem>
|
---|
| 80 | <listitem>
|
---|
[3ee626e] | 81 | <para>
|
---|
| 82 | Estimated disk space required: &gnutls-buildsize;
|
---|
| 83 | </para>
|
---|
[d5404360] | 84 | </listitem>
|
---|
| 85 | <listitem>
|
---|
[3ee626e] | 86 | <para>
|
---|
| 87 | Estimated build time: &gnutls-time;
|
---|
| 88 | </para>
|
---|
[d5404360] | 89 | </listitem>
|
---|
| 90 | </itemizedlist>
|
---|
| 91 |
|
---|
| 92 | <bridgehead renderas="sect3">GnuTLS Dependencies</bridgehead>
|
---|
| 93 |
|
---|
| 94 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[3ee626e] | 95 | <para role="required">
|
---|
| 96 | <xref linkend="nettle"/>
|
---|
| 97 | </para>
|
---|
[d5404360] | 98 |
|
---|
[5eaf9af8] | 99 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 100 | <para role="recommended">
|
---|
| 101 | <xref linkend="libtasn1"/>
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
[d5404360] | 104 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[0c6c35d] | 105 | <para role="optional">
|
---|
| 106 | <xref linkend="gtk-doc"/>,
|
---|
| 107 | <xref linkend="guile"/>,
|
---|
[546b042] | 108 | <xref linkend="libidn"/>,
|
---|
[ba1be62] | 109 | <xref linkend="p11-kit"/>,
|
---|
| 110 | <ulink url="http://unbound.net/">Unbound</ulink> (to build the DANE library and requires
|
---|
| 111 | <ulink url="http://www.nlnetlabs.nl/projects/ldns/">ldns</ulink>), and
|
---|
[3ee626e] | 112 | <ulink url="http://valgrind.org/">Valgrind</ulink> (used during the test suite)
|
---|
| 113 | </para>
|
---|
[d5404360] | 114 |
|
---|
[3ee626e] | 115 | <para>
|
---|
| 116 | Note that if you do not install <xref linkend="libtasn1"/>, an older
|
---|
| 117 | version shipped in the <application>GnuTLS</application> tarball will be
|
---|
| 118 | used instead.
|
---|
| 119 | </para>
|
---|
[38b68055] | 120 |
|
---|
[d5404360] | 121 | <para condition="html" role="usernotes">User Notes:
|
---|
[5eaf9af8] | 122 | <ulink url="&blfs-wiki;/gnutls"/>
|
---|
| 123 | </para>
|
---|
[d5404360] | 124 | </sect2>
|
---|
| 125 |
|
---|
| 126 | <sect2 role="installation">
|
---|
| 127 | <title>Installation of GnuTLS</title>
|
---|
| 128 |
|
---|
[3ee626e] | 129 | <para>
|
---|
| 130 | Install <application>GnuTLS</application> by running the
|
---|
| 131 | following commands:
|
---|
| 132 | </para>
|
---|
[d5404360] | 133 |
|
---|
[5eaf9af8] | 134 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[d5404360] | 135 | make</userinput></screen>
|
---|
| 136 |
|
---|
[3ee626e] | 137 | <para>
|
---|
| 138 | To test the results, issue: <command>make check</command>.
|
---|
| 139 | </para>
|
---|
[d5404360] | 140 |
|
---|
[3ee626e] | 141 | <para>
|
---|
| 142 | Now, as the <systemitem class="username">root</systemitem>
|
---|
| 143 | user:
|
---|
| 144 | </para>
|
---|
[d5404360] | 145 |
|
---|
[73d97caf] | 146 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[d5404360] | 147 |
|
---|
[3ee626e] | 148 | <para>
|
---|
| 149 | If you did not pass the <option>--enable-gtk-doc</option> parameter
|
---|
| 150 | to the <command>configure</command> script, install the API documentation
|
---|
[73d97caf] | 151 | to the <filename class="directory">/usr/share/gtk-doc/html/gnutls</filename>
|
---|
[3ee626e] | 152 | directory using the following command as the
|
---|
| 153 | <systemitem class="username">root</systemitem> user:
|
---|
| 154 | </para>
|
---|
[2e81579] | 155 |
|
---|
| 156 | <screen role="root"><userinput>make -C doc/reference install-data-local</userinput></screen>
|
---|
| 157 |
|
---|
[d5404360] | 158 | </sect2>
|
---|
| 159 |
|
---|
[d309b21] | 160 | <sect2 role="commands">
|
---|
| 161 | <title>Command Explanations</title>
|
---|
| 162 |
|
---|
[3ee626e] | 163 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[5eaf9af8] | 164 | href="../../xincludes/static-libraries.xml"/>
|
---|
[3ee626e] | 165 |
|
---|
[e05cd03f] | 166 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
[5eaf9af8] | 167 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
[d309b21] | 168 |
|
---|
| 169 | </sect2>
|
---|
| 170 |
|
---|
[d5404360] | 171 | <sect2 role="content">
|
---|
| 172 | <title>Contents</title>
|
---|
| 173 |
|
---|
| 174 | <segmentedlist>
|
---|
| 175 | <segtitle>Installed Programs</segtitle>
|
---|
| 176 | <segtitle>Installed Libraries</segtitle>
|
---|
[32dfb13c] | 177 | <segtitle>Installed Directories</segtitle>
|
---|
[d5404360] | 178 |
|
---|
| 179 | <seglistitem>
|
---|
[3ee626e] | 180 | <seg>
|
---|
[f7747d0] | 181 | certtool, crywrap, danetool, gnutls-cli, gnutls-cli-debug,
|
---|
| 182 | gnutls-serv, ocsptool, p11tool, psktool, and srptool
|
---|
[3ee626e] | 183 | </seg>
|
---|
| 184 | <seg>
|
---|
[5eaf9af8] | 185 | libgnutls.so, libgnutls-openssl.so, and libgnutlsxx.so
|
---|
[3ee626e] | 186 | </seg>
|
---|
| 187 | <seg>
|
---|
[73d97caf] | 188 | /usr/include/gnutls and
|
---|
[3ee626e] | 189 | /usr/share/gtk-doc/html/gnutls
|
---|
| 190 | </seg>
|
---|
[d5404360] | 191 | </seglistitem>
|
---|
| 192 | </segmentedlist>
|
---|
| 193 |
|
---|
| 194 | <variablelist>
|
---|
| 195 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 196 | <?dbfo list-presentation="list"?>
|
---|
| 197 | <?dbhtml list-presentation="table"?>
|
---|
| 198 |
|
---|
| 199 | <varlistentry id="certtool">
|
---|
| 200 | <term><command>certtool</command></term>
|
---|
| 201 | <listitem>
|
---|
[3ee626e] | 202 | <para>
|
---|
| 203 | is used to generate X.509 certificates, certificate requests,
|
---|
| 204 | and private keys.
|
---|
| 205 | </para>
|
---|
[d5404360] | 206 | <indexterm zone="gnutls certtool">
|
---|
| 207 | <primary sortas="b-certtool">certtool</primary>
|
---|
| 208 | </indexterm>
|
---|
| 209 | </listitem>
|
---|
| 210 | </varlistentry>
|
---|
| 211 |
|
---|
[0c6c35d] | 212 | <varlistentry id="crywrap">
|
---|
| 213 | <term><command>crywrap</command></term>
|
---|
| 214 | <listitem>
|
---|
[3ee626e] | 215 | <para>
|
---|
| 216 | is a simple wrapper that waits for TLS/SSL connections, and
|
---|
| 217 | proxies them to an unencrypted location.
|
---|
| 218 | </para>
|
---|
[0c6c35d] | 219 | <indexterm zone="gnutls crywrap">
|
---|
| 220 | <primary sortas="b-crywrap">crywrap</primary>
|
---|
| 221 | </indexterm>
|
---|
| 222 | </listitem>
|
---|
| 223 | </varlistentry>
|
---|
| 224 |
|
---|
[d5404360] | 225 | <varlistentry id="gnutls-cli">
|
---|
| 226 | <term><command>gnutls-cli</command></term>
|
---|
| 227 | <listitem>
|
---|
[3ee626e] | 228 | <para>
|
---|
| 229 | is a simple client program to set up a TLS connection to some
|
---|
| 230 | other computer.
|
---|
| 231 | </para>
|
---|
[d5404360] | 232 | <indexterm zone="gnutls gnutls-cli">
|
---|
| 233 | <primary sortas="b-gnutls-cli">gnutls-cli</primary>
|
---|
| 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
| 237 |
|
---|
| 238 | <varlistentry id="gnutls-cli-debug">
|
---|
| 239 | <term><command>gnutls-cli-debug</command></term>
|
---|
| 240 | <listitem>
|
---|
[3ee626e] | 241 | <para>
|
---|
| 242 | is a simple client program to set up a TLS connection to some
|
---|
| 243 | other computer and produces very verbose progress results.
|
---|
| 244 | </para>
|
---|
[d5404360] | 245 | <indexterm zone="gnutls gnutls-cli-debug">
|
---|
| 246 | <primary sortas="b-gnutls-cli-debug">gnutls-cli-debug</primary>
|
---|
| 247 | </indexterm>
|
---|
| 248 | </listitem>
|
---|
| 249 | </varlistentry>
|
---|
| 250 |
|
---|
| 251 | <varlistentry id="gnutls-serv">
|
---|
| 252 | <term><command>gnutls-serv</command></term>
|
---|
| 253 | <listitem>
|
---|
[3ee626e] | 254 | <para>
|
---|
| 255 | is a simple server program that listens to incoming TLS
|
---|
| 256 | connections.
|
---|
| 257 | </para>
|
---|
[d5404360] | 258 | <indexterm zone="gnutls gnutls-serv">
|
---|
| 259 | <primary sortas="b-gnutls-serv">gnutls-serv</primary>
|
---|
| 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
| 263 |
|
---|
[546b042] | 264 | <varlistentry id="ocsptool">
|
---|
| 265 | <term><command>ocsptool</command></term>
|
---|
| 266 | <listitem>
|
---|
[3ee626e] | 267 | <para>
|
---|
| 268 | is a program that can parse and print information about OCSP
|
---|
| 269 | requests/responses, generate requests and verify responses.
|
---|
| 270 | </para>
|
---|
[546b042] | 271 | <indexterm zone="gnutls ocsptool">
|
---|
| 272 | <primary sortas="b-ocsptool">ocsptool</primary>
|
---|
| 273 | </indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
| 277 | <varlistentry id="p11tool">
|
---|
| 278 | <term><command>p11tool</command></term>
|
---|
| 279 | <listitem>
|
---|
[3ee626e] | 280 | <para>
|
---|
| 281 | is a program that allows handling data from PKCS #11 smart cards
|
---|
| 282 | and security modules.
|
---|
| 283 | </para>
|
---|
[546b042] | 284 | <indexterm zone="gnutls p11tool">
|
---|
| 285 | <primary sortas="b-p11tool">p11tool</primary>
|
---|
| 286 | </indexterm>
|
---|
| 287 | </listitem>
|
---|
| 288 | </varlistentry>
|
---|
| 289 |
|
---|
[d5404360] | 290 | <varlistentry id="psktool">
|
---|
| 291 | <term><command>psktool</command></term>
|
---|
| 292 | <listitem>
|
---|
[3ee626e] | 293 | <para>
|
---|
| 294 | is a simple program that generates random keys for use with TLS-PSK.
|
---|
| 295 | </para>
|
---|
[d5404360] | 296 | <indexterm zone="gnutls psktool">
|
---|
| 297 | <primary sortas="b-psktool">psktool</primary>
|
---|
| 298 | </indexterm>
|
---|
| 299 | </listitem>
|
---|
| 300 | </varlistentry>
|
---|
| 301 |
|
---|
| 302 | <varlistentry id="srptool">
|
---|
| 303 | <term><command>srptool</command></term>
|
---|
| 304 | <listitem>
|
---|
[3ee626e] | 305 | <para>
|
---|
| 306 | is a simple program that emulates the programs in the Stanford
|
---|
| 307 | SRP (Secure Remote Password) libraries using GnuTLS.
|
---|
| 308 | </para>
|
---|
[d5404360] | 309 | <indexterm zone="gnutls srptool">
|
---|
| 310 | <primary sortas="b-srptool">srptool</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 |
|
---|
| 315 | <varlistentry id="libgnutls">
|
---|
[73d97caf] | 316 | <term><filename class="libraryfile">libgnutls.so</filename></term>
|
---|
[d5404360] | 317 | <listitem>
|
---|
[3ee626e] | 318 | <para>
|
---|
| 319 | contains the core API functions and X.509 certificate API functions.
|
---|
| 320 | </para>
|
---|
[d5404360] | 321 | <indexterm zone="gnutls libgnutls">
|
---|
[5eaf9af8] | 322 | <primary sortas="c-libgnutls">libgnutls.so</primary>
|
---|
[d5404360] | 323 | </indexterm>
|
---|
| 324 | </listitem>
|
---|
| 325 | </varlistentry>
|
---|
| 326 |
|
---|
| 327 | </variablelist>
|
---|
| 328 |
|
---|
| 329 | </sect2>
|
---|
| 330 |
|
---|
| 331 | </sect1>
|
---|