source: postlfs/security/volume_key.xml@ cfd4fa8

<?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 volume_key-download-http "https://github.com/felixonmars/volume_key/archive/volume_key-&volume_key-version;.tar.gz">
  <!ENTITY volume_key-download-ftp  " ">
  <!ENTITY volume_key-md5sum        "d1c76f24e08ddd8c1787687d0af5a814">
  <!ENTITY volume_key-size          "196 KB">
  <!ENTITY volume_key-buildsize     "11 MB">
  <!ENTITY volume_key-time          "0.2 SBU">
]>

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


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

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

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

    <para>
      The <application>volume_key</application> package provides
      a library for manipulating storage volume encryption keys and storing
      them separately from volumes to handle forgotten passphrases.
    </para>

    &lfs113_checked;

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

    <bridgehead renderas="sect3">volume_key Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cryptsetup"/>,
      <xref linkend="glib2"/>,
      <!-- To editors: if GnuPG is not installed, a wrong path to gpg will
           be hard-coded into the library.  Even if GnuPG is installed, we
           still need the 's/gpg2/gpg/' sed below.  I can't find an elegant
           way to specify the path manually (so I can't make it a runtime
           dependency).  -->
          <xref linkend="gnupg2"/>,
      <xref linkend="gpgme"/>, and
      <xref linkend="nss"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="swig"/>
    </para>
<!-- We prevent using Python2, so do not advertise it
    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="python2"/>
    </para>
-->
    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/volume_key"/>
    </para>
  </sect2>

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

    <note>
      <para>
        This package expands to the directory
        volume_key-volume_key-&volume_key-version;.
      </para>
    </note>

    <para>
      Tell the building system how to locate GPGME and GnuPG correctly:
    </para>

<screen><userinput remap='pre'>sed -e '/AM_PATH_GPGME/iAM_PATH_GPG_ERROR' \
    -e 's/gpg2/gpg/' -i configure.ac</userinput></screen>

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

<screen><userinput>autoreconf -fiv              &amp;&amp;
./configure --prefix=/usr    \
            --without-python &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</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--without-python</parameter>: This parameter prevents building
      the <application>Python 2</application> bindings, if <xref
      linkend="python2"/> is installed.
    </para>

    <para>
      <option>--without-python3</option>: Use this option if you do not want
      to build the <application>Python 3</application> bindings. In this case,
      <xref linkend="swig"/> is not needed.
    </para>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>
          volume_key
        </seg>
        <seg>
          libvolume_key.so
        </seg>
        <seg>
          /usr/include/volume_key
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="volume_key-prog">
        <term><command>volume_key</command></term>
        <listitem>
          <para>
            manages encrypted volume keys and passphrases
          </para>
          <indexterm zone="volume_key volume_key-prog">
            <primary sortas="b-volume_key">volume_key</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="volume_key-lib">
        <term><filename class="libraryfile">volume_key.so</filename></term>
        <listitem>
          <para>
            contains API functions for managing encrypted volume keys
          </para>
          <indexterm zone="volume_key volume_key-lib">
            <primary sortas="c-volume_key">volume_key.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>