source: postlfs/security/gnupg2.xml@ 77aeb6b

<?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 gnupg2-download-http " ">
  <!ENTITY gnupg2-download-ftp  "ftp://ftp.gnupg.org/gcrypt/gnupg/gnupg-&gnupg2-version;.tar.bz2">
  <!ENTITY gnupg2-md5sum        "ebdf92b15b8bcd8579b643c7f41a3238">
  <!ENTITY gnupg2-size          "4.7 MB">
  <!ENTITY gnupg2-buildsize     "101 MB (with tests and optional documentation)">
  <!ENTITY gnupg2-time          "1.0 SBU (with tests)">
]>

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

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

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

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

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

    <para>
      The <application>GnuPG</application> package is GNU's tool for secure
      communication and data storage. It can be used to encrypt data and to
      create digital signatures. It includes an advanced key management
      facility and is compliant with the proposed OpenPGP Internet standard
      as described in RFC2440 and the S/MIME standard as described by several
      RFCs. GnuPG 2 is the stable version of GnuPG integrating support for
      OpenPGP and S/MIME.
    </para>

    &lfs76_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libassuan"/>,
      <xref linkend="libgcrypt"/>,
      <xref linkend="libksba"/> and
      <xref linkend="npth"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="pinentry"/> (Run-time requirement for
      most of the package's functionality)
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="curl"/>,
      <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
      ADNS</ulink>,
      <xref linkend="libusb-compat"/>,
      an <xref linkend="server-mail"/> and
      <xref linkend="openldap"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/gnupg2"/>
    </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        \
            --sysconfdir=/etc    \
            --enable-symcryptrun \
            --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
make &amp;&amp;

makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
makeinfo --plaintext       -o doc/gnupg.txt           doc/gnupg.texi</userinput></screen>

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

<screen><userinput>make -C doc pdf ps 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;

for f in gpg gpgv ; do
ln -sfv ${f}2   /usr/bin/${f} &amp;&amp;
ln -sfv ${f}2.1 /usr/share/man/man1/${f}.1
done &amp;&amp;

install -v -dm755 /usr/share/doc/gnupg-&gnupg2-version;/html       &amp;&amp;
install -v -m644  doc/gnupg_nochunks.html \
                  /usr/share/doc/gnupg-&gnupg2-version;/gnupg.html &amp;&amp;
install -v -m644  doc/*.texi doc/gnupg.txt \
                  /usr/share/doc/gnupg-&gnupg2-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>install -v -m644 doc/gnupg.html/* \
                 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
install -v -m644 doc/gnupg.{pdf,dvi,ps} \
                 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>

  </sect2>

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

    <para>
      <parameter>--enable-symcryptrun</parameter>: This switch enables
      building the symcryptrun program.
    </para>

    <para>
      <command>ln -sfv ...</command>: This command creates symlinks for
      compatibility with the first version of
      <application>GnuPG</application>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, gpg, gpg2,
          gpg-agent, gpgconf, gpg-connect-agent, gpgkey2ssh, gpgparsemail,
          gpgsm, gpgsm-gencert.sh, gpgtar, gpgv, gpgv2, kbxutil,
          symcryptrun and watchgnupg
        </seg>
        <seg>
          None
        </seg>
        <seg>
          /usr/share/doc/gnupg-&gnupg2-version; and
          /usr/share/gnupg
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="addgnupghome">
        <term><command>addgnupghome</command></term>
        <listitem>
          <para>
            is used to create and populate user's
            <filename class="directory">~/.gnupg</filename> directories.
          </para>
          <indexterm zone="gnupg2 addgnupghome">
            <primary sortas="b-addgnupghome">addgnupghome</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="applygnupgdefaults">
        <term><command>applygnupgdefaults</command></term>
        <listitem>
          <para>
            is a wrapper script used to run <command>gpgconf</command>
            with the <parameter>--apply-defaults</parameter> parameter
            on all user's GnuPG home directories.
          </para>
          <indexterm zone="gnupg2 applygnupgdefaults">
            <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="dirmngr">
        <term><command>dirmngr</command></term>
        <listitem>
          <para> is a tool that takes care of accessing the OpenPGP keyservers.
          </para>
          <indexterm zone="gnupg2 dirmngr">
            <primary sortas="b-dirmngr">dirmngr</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="dirmngr-client">
        <term><command>dirmngr-client</command></term>
        <listitem>
          <para> is a tool to contact a running dirmngr and test whether a
          certificate has been revoked. </para>
          <indexterm zone="gnupg2 dirmngr-client">
            <primary sortas="b-dirmngr-client">dirmngr-client</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpg-agent">
        <term><command>gpg-agent</command></term>
        <listitem>
          <para>
            is a daemon used to manage secret (private) keys independently
            from any protocol. It is used as a backend for
            <command>gpg</command> and <command>gpgsm</command> as well as
            for a couple of other utilities.
          </para>
          <indexterm zone="gnupg2 gpg-agent">
            <primary sortas="b-gpg-agent">gpg-agent</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpg-connect-agent">
        <term><command>gpg-connect-agent</command></term>
        <listitem>
          <para>
            is a utility used to communicate with a running
            <command>gpg-agent</command>.
          </para>
          <indexterm zone="gnupg2 gpg-connect-agent">
            <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpg2">
        <term><command>gpg2</command></term>
        <listitem>
          <para>
            is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
            tool used to provide digital encryption and signing services
            using the OpenPGP standard.
          </para>
          <indexterm zone="gnupg2 gpg2">
            <primary sortas="b-gpg2">gpg2</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgconf">
        <term><command>gpgconf</command></term>
        <listitem>
          <para>
            is a utility used to automatically and reasonable safely
            query and modify configuration files in the
            <filename class="directory">~/.gnupg</filename> home
            directory. It is designed not to be invoked manually by
            the user, but automatically by graphical user interfaces.
          </para>
          <indexterm zone="gnupg2 gpgconf">
            <primary sortas="b-gpgconf">gpgconf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgkey2ssh">
        <term><command>gpgkey2ssh</command></term>
        <listitem>
          <para>is a utility used to get the correctly formated key for
          ssh usage.</para>
          <indexterm zone="gnupg2 gpgkey2ssh">
            <primary sortas="b-gpgkey2ssh">gpgkey2ssh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgparsemail">
        <term><command>gpgparsemail</command></term>
        <listitem>
          <para>
            is a utility currently only useful for debugging. Run it with
            <parameter>--help</parameter> for usage information.
          </para>
          <indexterm zone="gnupg2 gpgparsemail">
            <primary sortas="b-gpgparsemail">gpgparsemail</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgsm">
        <term><command>gpgsm</command></term>
        <listitem>
          <para>
            is a tool similar to <command>gpg</command> used to provide digital
            encryption and signing services on X.509 certificates and the CMS
            protocol. It is mainly used as a backend for S/MIME mail processing.
          </para>
          <indexterm zone="gnupg2 gpgsm">
            <primary sortas="b-gpgsm">gpgsm</primary>
          </indexterm>
        </listitem>
      </varlistentry>

<!--
      <varlistentry id="gpgsm-gencert.sh">
        <term><command>gpgsm-gencert.sh</command></term>
        <listitem>
          <para>
            is a simple tool used to interactively generate a certificate
            request which will be printed to stdout.
          </para>
          <indexterm zone="gnupg2 gpgsm-gencert.sh">
            <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

      <varlistentry id="kbxutil">
        <term><command>kbxutil</command></term>
        <listitem>
          <para>
            is used to list, export and import Keybox data.
          </para>
          <indexterm zone="gnupg2 kbxutil">
            <primary sortas="b-kbxutil">kbxutil</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="symcryptrun">
        <term><command>symcryptrun</command></term>
        <listitem>
          <para>
            is a simple symmetric encryption tool.
          </para>
          <indexterm zone="gnupg2 symcryptrun">
            <primary sortas="b-symcryptrun">symcryptrun</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="watchgnupg">
        <term><command>watchgnupg</command></term>
        <listitem>
          <para>
            is used to listen to a Unix Domain socket created by any of
            the GnuPG tools.
          </para>
          <indexterm zone="gnupg2 watchgnupg">
            <primary sortas="b-watchgnupg">watchgnupg</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>