source: postlfs/security/nettle.xml@ f37eef8b

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY nettle-download-http "http://www.lysator.liu.se/~nisse/archive/nettle-&nettle-version;.tar.gz">
  <!ENTITY nettle-download-ftp  "ftp://ftp.lysator.liu.se/pub/security/lsh/nettle-&nettle-version;.tar.gz">
  <!ENTITY nettle-md5sum        "450be8c4886d46c09f49f568ad6fa013">
  <!ENTITY nettle-size          "1.0 MB">
  <!ENTITY nettle-buildsize     "121 MB">
  <!ENTITY nettle-time          "0.2 SBU">
]>

<sect1 id="nettle" xreflabel="nettle-&nettle-version;">
  <?dbhtml filename="nettle.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>nettle-&nettle-version;</title>

  <indexterm zone="nettle">
    <primary sortas="a-nettle">nettle</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to nettle</title>

    <para>The <application>nettle</application> package is a low-level
    cryptographic library that is designed to fit easily in many contexts.
    </para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&nettle-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&nettle-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &nettle-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &nettle-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &nettle-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &nettle-time;</para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/nettle"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of nettle</title>

    <para>Install <application>nettle</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>
    
    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/nettle-&nettle-version; &amp;&amp;
install -v -m644 nettle.html /usr/share/doc/nettle-&nettle-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><option>--enable-shared</option>: This switch will ensure
    that shared, as well as static, libraries will be built. If you
    have linked the packages which use these libraries
    (<application>gnutls</application> and
    <application>glib-networking</application>, perhaps others) to the
    shared libraries, and ever have to rebuild
    <application>libnettle</application> to fix a vulnerability, you
    will not have to recompile those other applications.</para>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>nettle-hash, nettle-lfib-stream, pkcs1-conv, and sexp-conv</seg>
        <seg>libhogweed.a and libnettle.a : optionally, libhogweed.so and
        libnettle.so</seg>
        <seg>/usr/include/nettle</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="nettle-hash">
        <term><command>nettle-hash</command></term>
        <listitem>
          <para>calulates a hash value using a specified algorithm.</para>
          <indexterm zone="nettle nettle-hash">
            <primary sortas="b-nettle-hash">nettle-hash</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="nettle-lfib-stream">
        <term><command>nettle-lfib-stream</command></term>
        <listitem>
          <para>outputs a sequence of pseudorandom (non-cryptographic)  bytes,  
          using Knuth's lagged fibonacci generator. The stream is useful for 
          testing, but should not be used to generate cryptographic keys or anything  
          else that needs real randomness.</para>
          <indexterm zone="nettle nettle-lfib-stream">
            <primary sortas="b-nettle-lfib-stream">nettle-lfib-stream</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pkcs1-conv">
        <term><command>pkcs1-conv</command></term>
        <listitem>
          <para>converts private and public RSA keys from PKCS #1 format  to
           sexp format.</para>
          <indexterm zone="nettle pkcs1-conv">
            <primary sortas="b-pkcs1-conv">pkcs1-conv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="sexp-conv">
        <term><command>sexp-conv</command></term>
        <listitem>
          <para>converts an s-expression to a different encoding.</para>
          <indexterm zone="nettle sexp-conv">
            <primary sortas="b-sexp-conv">sexp-conv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>