[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[0c6c35d] | 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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY nettle-download-http "&gnu-http;/nettle/nettle-&nettle-version;.tar.gz">
|
---|
[e1e58be] | 8 | <!ENTITY nettle-download-ftp " ">
|
---|
[934ef294] | 9 | <!ENTITY nettle-md5sum "c61453139d5fb44e9cdcc5b684b26e55">
|
---|
| 10 | <!ENTITY nettle-size "2.5 MB">
|
---|
| 11 | <!ENTITY nettle-buildsize "100 MB (with tests)">
|
---|
| 12 | <!ENTITY nettle-time "0.3 SBU (with tests; both using parallelism=4)">
|
---|
[0c6c35d] | 13 | ]>
|
---|
| 14 |
|
---|
[5eaf9af8] | 15 | <sect1 id="nettle" xreflabel="Nettle-&nettle-version;">
|
---|
[0c6c35d] | 16 | <?dbhtml filename="nettle.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
[5eaf9af8] | 19 | <title>Nettle-&nettle-version;</title>
|
---|
[0c6c35d] | 20 |
|
---|
| 21 | <indexterm zone="nettle">
|
---|
[5eaf9af8] | 22 | <primary sortas="a-Nettle">Nettle</primary>
|
---|
[0c6c35d] | 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
[5eaf9af8] | 26 | <title>Introduction to Nettle</title>
|
---|
[0c6c35d] | 27 |
|
---|
[5eaf9af8] | 28 | <para>
|
---|
[4e0e3828] | 29 | The <application>Nettle</application> package contains a low-level
|
---|
[5eaf9af8] | 30 | cryptographic library that is designed to fit easily in many contexts.
|
---|
[0c6c35d] | 31 | </para>
|
---|
| 32 |
|
---|
[e320358] | 33 | &lfs122_checked;
|
---|
[0c6c35d] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
[5eaf9af8] | 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&nettle-download-http;"/>
|
---|
| 40 | </para>
|
---|
[0c6c35d] | 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
[5eaf9af8] | 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&nettle-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
[0c6c35d] | 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
[5eaf9af8] | 48 | <para>
|
---|
| 49 | Download MD5 sum: &nettle-md5sum;
|
---|
| 50 | </para>
|
---|
[0c6c35d] | 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
[5eaf9af8] | 53 | <para>
|
---|
| 54 | Download size: &nettle-size;
|
---|
| 55 | </para>
|
---|
[0c6c35d] | 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
[5eaf9af8] | 58 | <para>
|
---|
| 59 | Estimated disk space required: &nettle-buildsize;
|
---|
| 60 | </para>
|
---|
[0c6c35d] | 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
[5eaf9af8] | 63 | <para>
|
---|
| 64 | Estimated build time: &nettle-time;
|
---|
| 65 | </para>
|
---|
[0c6c35d] | 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
[a2ce753] | 68 |
|
---|
[4890200] | 69 | <bridgehead renderas="sect3">Nettle Dependencies</bridgehead>
|
---|
| 70 |
|
---|
| 71 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 72 | <para role="optional">
|
---|
[a2ce753] | 73 | <xref linkend="valgrind"/> (optional for the tests)
|
---|
[4890200] | 74 | </para>
|
---|
[a2ce753] | 75 |
|
---|
[0c6c35d] | 76 | </sect2>
|
---|
| 77 |
|
---|
| 78 | <sect2 role="installation">
|
---|
[5eaf9af8] | 79 | <title>Installation of Nettle</title>
|
---|
[0c6c35d] | 80 |
|
---|
[47274444] | 81 | <para>
|
---|
| 82 | Install <application>Nettle</application> by running the following
|
---|
| 83 | commands:
|
---|
| 84 | </para>
|
---|
[0c6c35d] | 85 |
|
---|
[d45a8367] | 86 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[0c6c35d] | 87 | make</userinput></screen>
|
---|
| 88 |
|
---|
[5eaf9af8] | 89 | <para>
|
---|
| 90 | To test the results, issue: <command>make check</command>.
|
---|
| 91 | </para>
|
---|
[0d7900a] | 92 |
|
---|
[5eaf9af8] | 93 | <para>
|
---|
| 94 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 95 | </para>
|
---|
[0c6c35d] | 96 |
|
---|
| 97 | <screen role="root"><userinput>make install &&
|
---|
[fd8f285] | 98 | chmod -v 755 /usr/lib/lib{hogweed,nettle}.so &&
|
---|
[d45a8367] | 99 | install -v -m755 -d /usr/share/doc/nettle-&nettle-version; &&
|
---|
[875f1208] | 100 | install -v -m644 nettle.{html,pdf} /usr/share/doc/nettle-&nettle-version;</userinput></screen>
|
---|
[0c6c35d] | 101 |
|
---|
| 102 | </sect2>
|
---|
| 103 |
|
---|
[d45a8367] | 104 | <sect2 role="commands">
|
---|
| 105 | <title>Command Explanations</title>
|
---|
| 106 |
|
---|
| 107 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 108 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 109 |
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
[0c6c35d] | 112 | <sect2 role="content">
|
---|
| 113 | <title>Contents</title>
|
---|
| 114 |
|
---|
| 115 | <segmentedlist>
|
---|
| 116 | <segtitle>Installed Programs</segtitle>
|
---|
[5eaf9af8] | 117 | <segtitle>Installed Libraries</segtitle>
|
---|
| 118 | <segtitle>Installed Directory</segtitle>
|
---|
[0c6c35d] | 119 |
|
---|
| 120 | <seglistitem>
|
---|
[5eaf9af8] | 121 | <seg>
|
---|
[b9abcb5] | 122 | nettle-hash, nettle-lfib-stream, nettle-pbkdf2,
|
---|
| 123 | pkcs1-conv and sexp-conv
|
---|
[5eaf9af8] | 124 | </seg>
|
---|
| 125 | <seg>
|
---|
[d45a8367] | 126 | libhogweed.so and libnettle.so
|
---|
[5eaf9af8] | 127 | </seg>
|
---|
| 128 | <seg>
|
---|
[b9abcb5] | 129 | /usr/include/nettle and /usr/share/doc/nettle-&nettle-version;
|
---|
[5eaf9af8] | 130 | </seg>
|
---|
[0c6c35d] | 131 | </seglistitem>
|
---|
| 132 | </segmentedlist>
|
---|
| 133 |
|
---|
| 134 | <variablelist>
|
---|
| 135 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 136 | <?dbfo list-presentation="list"?>
|
---|
| 137 | <?dbhtml list-presentation="table"?>
|
---|
| 138 |
|
---|
| 139 | <varlistentry id="nettle-hash">
|
---|
| 140 | <term><command>nettle-hash</command></term>
|
---|
| 141 | <listitem>
|
---|
[5eaf9af8] | 142 | <para>
|
---|
[4c24eb0a] | 143 | calculates a hash value using a specified algorithm
|
---|
[5eaf9af8] | 144 | </para>
|
---|
[0c6c35d] | 145 | <indexterm zone="nettle nettle-hash">
|
---|
| 146 | <primary sortas="b-nettle-hash">nettle-hash</primary>
|
---|
| 147 | </indexterm>
|
---|
| 148 | </listitem>
|
---|
| 149 | </varlistentry>
|
---|
| 150 |
|
---|
| 151 | <varlistentry id="nettle-lfib-stream">
|
---|
| 152 | <term><command>nettle-lfib-stream</command></term>
|
---|
| 153 | <listitem>
|
---|
[5eaf9af8] | 154 | <para>
|
---|
[b9abcb5] | 155 | outputs a sequence of pseudorandom (non-cryptographic) bytes,
|
---|
| 156 | using Knuth's lagged fibonacci generator. The stream is useful for
|
---|
| 157 | testing, but should not be used to generate cryptographic keys or
|
---|
[4c24eb0a] | 158 | anything else that needs real randomness
|
---|
[5eaf9af8] | 159 | </para>
|
---|
[0c6c35d] | 160 | <indexterm zone="nettle nettle-lfib-stream">
|
---|
| 161 | <primary sortas="b-nettle-lfib-stream">nettle-lfib-stream</primary>
|
---|
| 162 | </indexterm>
|
---|
| 163 | </listitem>
|
---|
| 164 | </varlistentry>
|
---|
| 165 |
|
---|
[b9abcb5] | 166 | <varlistentry id="nettle-pbkdf2">
|
---|
| 167 | <term><command>nettle-pbkdf2</command></term>
|
---|
| 168 | <listitem>
|
---|
| 169 | <para>
|
---|
[a2ce753] | 170 | is a password-based key derivation function that takes a password
|
---|
| 171 | or a passphrase as input and returns a strengthened password,
|
---|
| 172 | which is protected against pre-computation attacks by using
|
---|
| 173 | salting and other expensive computations.
|
---|
[b9abcb5] | 174 | </para>
|
---|
| 175 | <indexterm zone="nettle nettle-pbkdf2">
|
---|
| 176 | <primary sortas="b-nettle-pbkdf2">nettle-pbkdf2</primary>
|
---|
| 177 | </indexterm>
|
---|
| 178 | </listitem>
|
---|
| 179 | </varlistentry>
|
---|
| 180 |
|
---|
[0c6c35d] | 181 | <varlistentry id="pkcs1-conv">
|
---|
| 182 | <term><command>pkcs1-conv</command></term>
|
---|
| 183 | <listitem>
|
---|
[5eaf9af8] | 184 | <para>
|
---|
| 185 | converts private and public RSA keys from PKCS #1 format to
|
---|
[4c24eb0a] | 186 | sexp format
|
---|
[5eaf9af8] | 187 | </para>
|
---|
[0c6c35d] | 188 | <indexterm zone="nettle pkcs1-conv">
|
---|
| 189 | <primary sortas="b-pkcs1-conv">pkcs1-conv</primary>
|
---|
| 190 | </indexterm>
|
---|
| 191 | </listitem>
|
---|
| 192 | </varlistentry>
|
---|
| 193 |
|
---|
| 194 | <varlistentry id="sexp-conv">
|
---|
| 195 | <term><command>sexp-conv</command></term>
|
---|
| 196 | <listitem>
|
---|
[5eaf9af8] | 197 | <para>
|
---|
[4c24eb0a] | 198 | converts an s-expression to a different encoding
|
---|
[5eaf9af8] | 199 | </para>
|
---|
[0c6c35d] | 200 | <indexterm zone="nettle sexp-conv">
|
---|
| 201 | <primary sortas="b-sexp-conv">sexp-conv</primary>
|
---|
| 202 | </indexterm>
|
---|
| 203 | </listitem>
|
---|
| 204 | </varlistentry>
|
---|
| 205 |
|
---|
| 206 | </variablelist>
|
---|
| 207 |
|
---|
| 208 | </sect2>
|
---|
| 209 |
|
---|
| 210 | </sect1>
|
---|