source: postlfs/security/gnupg.xml@ acac7412

<?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 gnupg-download-http "http://public.ftp.planetmirror.com/pub/gnupg/gnupg-&gnupg-version;.tar.bz2">
  <!ENTITY gnupg-download-ftp  "ftp://ftp.gnupg.org/gcrypt/gnupg/gnupg-&gnupg-version;.tar.bz2">
  <!ENTITY gnupg-md5sum        "b06a141cca5cd1a55bbdd25ab833303c">
  <!ENTITY gnupg-size          "3.2 MB">
  <!ENTITY gnupg-buildsize     "40 MB">
  <!ENTITY gnupg-time          "0.5 SBU">
]>

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

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

  <title>GnuPG-&gnupg-version;</title>

  <indexterm zone="gnupg">
    <primary sortas="a-GnuPG">GnuPG</primary>
  </indexterm>

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

    <para>The <application>GnuPG</application> package contains a
    public/private key encryptor. This is becoming useful for signing
    files or emails as proof of identity and preventing tampering with
    the contents of the file or email.</para>

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

    <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required Patch: <ulink
        url="&patch-root;/gnupg-&gnupg-version;-curl_LDAP-1.patch"/>
      </para>
      </listitem>
    </itemizedlist> -->

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="openssl"/>,
    <xref linkend="openldap"/>,
    <xref linkend="libusb"/>,
    <xref linkend="curl"/>,
    an <xref linkend="server-mail"/>,
    <xref linkend="docbook-utils"/>, and <ulink
    url="http://www.oasis-open.org/docbook/tools/dtm/">docbook-to-man</ulink></para>

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

  </sect2>

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

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

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

    <para>If you have <xref linkend="tetex"/> installed and you wish to create
    documentation in alternate formats, issue the following command:</para>

<screen><userinput>make -C doc pdf html</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;
chmod -v 4755 /usr/bin/gpg &amp;&amp;

install -v -m755 -d /usr/share/doc/gnupg-&gnupg-version; &amp;&amp;
mv -v /usr/share/gnupg/{FAQ,faq.html} /usr/share/doc/gnupg-&gnupg-version; &amp;&amp;
install -v -m644 \
    doc/{highlights-1.4.txt,OpenPGP,samplekeys.asc,DETAILS,*.texi} \
    /usr/share/doc/gnupg-&gnupg-version;</userinput></screen>

    <para>If you created alternate formats of the documentation, install it
    using the following command as the
    <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>cp -v -R doc/gnupg1.{html,pdf} /usr/share/doc/gnupg-&gnupg-version;</userinput></screen>

  </sect2>

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

    <para><parameter>--libexecdir=/usr/lib</parameter>: This command
    creates a <filename class="directory">gnupg</filename> directory in
    <filename class="directory">/usr/lib</filename> instead of
    <filename class="directory">/usr/libexec</filename>.</para>

    <para><command>chmod -v 4755 /usr/bin/gpg</command>:
    <command>gpg</command> is installed setuid
    <systemitem class='username'>root</systemitem> to avoid swapping
    out sensitive data.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>gpg, gpg-zip, gpgsplit, and gpgv</seg>
        <seg>None</seg>
        <seg>/usr/lib/gnupg, /usr/share/gnupg and
        /usr/share/doc/gnupg-&gnupg-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gpg">
        <term><command>gpg</command></term>
        <listitem>
          <para>is the backend (command-line interface) for
          this OpenPGP implementation.</para>
          <indexterm zone="gnupg gpg">
            <primary sortas="b-gpg">gpg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgsplit">
        <term><command>gpgsplit</command></term>
        <listitem>
          <para>separates key rings.</para>
          <indexterm zone="gnupg gpgsplit">
            <primary sortas="b-gpgsplit">gpgsplit</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgv">
        <term><command>gpgv</command></term>
        <listitem>
          <para>is a verify only version of <command>gpg</command>.</para>
          <indexterm zone="gnupg gpgv">
            <primary sortas="b-gpgv">gpgv</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>