| 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
|---|
| 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 |
|
|---|
| 7 | <!ENTITY gnupg2-download-http " ">
|
|---|
| 8 | <!ENTITY gnupg2-download-ftp "ftp://ftp.gnupg.org/gcrypt/gnupg/gnupg-&gnupg2-version;.tar.bz2">
|
|---|
| 9 | <!ENTITY gnupg2-md5sum "fa7e704aad33eb114d1840164455aec1">
|
|---|
| 10 | <!ENTITY gnupg2-size "4.2 MB">
|
|---|
| 11 | <!ENTITY gnupg2-buildsize "68 MB">
|
|---|
| 12 | <!ENTITY gnupg2-time "0.6 SBU (additional 0.5 SBU for the tests)">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
|
|---|
| 16 | <?dbhtml filename="gnupg.html"?>
|
|---|
| 17 |
|
|---|
| 18 | <sect1info>
|
|---|
| 19 | <othername>$LastChangedBy$</othername>
|
|---|
| 20 | <date>$Date$</date>
|
|---|
| 21 | </sect1info>
|
|---|
| 22 |
|
|---|
| 23 | <title>GnuPG-&gnupg2-version;</title>
|
|---|
| 24 |
|
|---|
| 25 | <indexterm zone="gnupg2">
|
|---|
| 26 | <primary sortas="a-GnuPG">GnuPG</primary>
|
|---|
| 27 | </indexterm>
|
|---|
| 28 |
|
|---|
| 29 | <sect2 role="package">
|
|---|
| 30 | <title>Introduction to GnuPG</title>
|
|---|
| 31 |
|
|---|
| 32 | <para>
|
|---|
| 33 | The <application>GnuPG</application> package is GNU's tool for secure
|
|---|
| 34 | communication and data storage. It can be used to encrypt data and to
|
|---|
| 35 | create digital signatures. It includes an advanced key management
|
|---|
| 36 | facility and is compliant with the proposed OpenPGP Internet standard
|
|---|
| 37 | as described in RFC2440 and the S/MIME standard as described by several
|
|---|
| 38 | RFCs. GnuPG 2 is the stable version of GnuPG integrating support for
|
|---|
| 39 | OpenPGP and S/MIME.
|
|---|
| 40 | </para>
|
|---|
| 41 |
|
|---|
| 42 | &lfs76_checked;
|
|---|
| 43 |
|
|---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 45 | <itemizedlist spacing="compact">
|
|---|
| 46 | <listitem>
|
|---|
| 47 | <para>
|
|---|
| 48 | Download (HTTP): <ulink url="&gnupg2-download-http;"/>
|
|---|
| 49 | </para>
|
|---|
| 50 | </listitem>
|
|---|
| 51 | <listitem>
|
|---|
| 52 | <para>
|
|---|
| 53 | Download (FTP): <ulink url="&gnupg2-download-ftp;"/>
|
|---|
| 54 | </para>
|
|---|
| 55 | </listitem>
|
|---|
| 56 | <listitem>
|
|---|
| 57 | <para>
|
|---|
| 58 | Download MD5 sum: &gnupg2-md5sum;
|
|---|
| 59 | </para>
|
|---|
| 60 | </listitem>
|
|---|
| 61 | <listitem>
|
|---|
| 62 | <para>
|
|---|
| 63 | Download size: &gnupg2-size;
|
|---|
| 64 | </para>
|
|---|
| 65 | </listitem>
|
|---|
| 66 | <listitem>
|
|---|
| 67 | <para>
|
|---|
| 68 | Estimated disk space required: &gnupg2-buildsize;
|
|---|
| 69 | </para>
|
|---|
| 70 | </listitem>
|
|---|
| 71 | <listitem>
|
|---|
| 72 | <para>
|
|---|
| 73 | Estimated build time: &gnupg2-time;
|
|---|
| 74 | </para>
|
|---|
| 75 | </listitem>
|
|---|
| 76 | </itemizedlist>
|
|---|
| 77 |
|
|---|
| 78 | <bridgehead renderas="sect3">GnuPG Dependencies</bridgehead>
|
|---|
| 79 |
|
|---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 81 | <para role="required">
|
|---|
| 82 | <xref linkend="libassuan"/>,
|
|---|
| 83 | <xref linkend="libgcrypt"/>,
|
|---|
| 84 | <xref linkend="libksba"/> and
|
|---|
| 85 | <xref linkend="pth"/>
|
|---|
| 86 | </para>
|
|---|
| 87 |
|
|---|
| 88 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 89 | <para role="recommended">
|
|---|
| 90 | <xref linkend="pinentry"/> (Run-time requirement for
|
|---|
| 91 | most of the package's functionality)
|
|---|
| 92 | </para>
|
|---|
| 93 |
|
|---|
| 94 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 95 | <para role="optional">
|
|---|
| 96 | <xref linkend="curl"/>,
|
|---|
| 97 | <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
|
|---|
| 98 | ADNS</ulink>,
|
|---|
| 99 | <xref linkend="libusb-compat"/>,
|
|---|
| 100 | an <xref linkend="server-mail"/> and
|
|---|
| 101 | <xref linkend="openldap"/>
|
|---|
| 102 | </para>
|
|---|
| 103 |
|
|---|
| 104 | <para condition="html" role="usernotes">User Notes:
|
|---|
| 105 | <ulink url="&blfs-wiki;/gnupg2"/>
|
|---|
| 106 | </para>
|
|---|
| 107 | </sect2>
|
|---|
| 108 |
|
|---|
| 109 | <sect2 role="installation">
|
|---|
| 110 | <title>Installation of GnuPG</title>
|
|---|
| 111 |
|
|---|
| 112 | <para>
|
|---|
| 113 | Install <application>GnuPG</application> by running the following
|
|---|
| 114 | commands:
|
|---|
| 115 | </para>
|
|---|
| 116 |
|
|---|
| 117 | <screen><userinput>./configure --prefix=/usr \
|
|---|
| 118 | --sysconfdir=/etc \
|
|---|
| 119 | --enable-symcryptrun \
|
|---|
| 120 | --docdir=/usr/share/doc/gnupg-&gnupg2-version; &&
|
|---|
| 121 | make &&
|
|---|
| 122 |
|
|---|
| 123 | makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &&
|
|---|
| 124 | makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
|
|---|
| 125 |
|
|---|
| 126 | <para>
|
|---|
| 127 | If you have <xref linkend="texlive"/> installed and you wish
|
|---|
| 128 | to create documentation in alternate formats, issue the
|
|---|
| 129 | following commands:
|
|---|
| 130 | </para>
|
|---|
| 131 |
|
|---|
| 132 | <screen><userinput>make -C doc pdf ps html</userinput></screen>
|
|---|
| 133 |
|
|---|
| 134 | <para>
|
|---|
| 135 | To test the results, issue: <command>make check</command>.
|
|---|
| 136 | </para>
|
|---|
| 137 |
|
|---|
| 138 | <para>
|
|---|
| 139 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 140 | </para>
|
|---|
| 141 |
|
|---|
| 142 | <screen role="root"><userinput>make install &&
|
|---|
| 143 |
|
|---|
| 144 | for f in gpg gpgv ; do
|
|---|
| 145 | ln -sfv ${f}2 /usr/bin/${f} &&
|
|---|
| 146 | ln -sfv ${f}2.1 /usr/share/man/man1/${f}.1
|
|---|
| 147 | done &&
|
|---|
| 148 |
|
|---|
| 149 | install -v -dm755 /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
|---|
| 150 | install -v -m644 doc/gnupg_nochunks.html \
|
|---|
| 151 | /usr/share/doc/gnupg-&gnupg2-version;/gnupg.html &&
|
|---|
| 152 | install -v -m644 doc/*.texi doc/gnupg.txt \
|
|---|
| 153 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
|---|
| 154 |
|
|---|
| 155 | <para>
|
|---|
| 156 | If you created alternate formats of the documentation, install
|
|---|
| 157 | it using the following command as the
|
|---|
| 158 | <systemitem class="username">root</systemitem> user:
|
|---|
| 159 | </para>
|
|---|
| 160 |
|
|---|
| 161 | <screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
|
|---|
| 162 | /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
|---|
| 163 | install -v -m644 doc/gnupg.{pdf,dvi,ps} \
|
|---|
| 164 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
|---|
| 165 |
|
|---|
| 166 | </sect2>
|
|---|
| 167 |
|
|---|
| 168 | <sect2 role="commands">
|
|---|
| 169 | <title>Command Explanations</title>
|
|---|
| 170 |
|
|---|
| 171 | <para>
|
|---|
| 172 | <parameter>--enable-symcryptrun</parameter>: This switch enables
|
|---|
| 173 | building the symcryptrun program.
|
|---|
| 174 | </para>
|
|---|
| 175 |
|
|---|
| 176 | <para>
|
|---|
| 177 | <command>ln -sfv ...</command>: This command creates symlinks for
|
|---|
| 178 | compatibility with the first version of
|
|---|
| 179 | <application>GnuPG</application>.
|
|---|
| 180 | </para>
|
|---|
| 181 |
|
|---|
| 182 | </sect2>
|
|---|
| 183 |
|
|---|
| 184 | <sect2 role="content">
|
|---|
| 185 | <title>Contents</title>
|
|---|
| 186 |
|
|---|
| 187 | <segmentedlist>
|
|---|
| 188 | <segtitle>Installed Programs</segtitle>
|
|---|
| 189 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 190 | <segtitle>Installed Directories</segtitle>
|
|---|
| 191 |
|
|---|
| 192 | <seglistitem>
|
|---|
| 193 | <seg>
|
|---|
| 194 | addgnupghome, applygnupgdefaults, gpg, gpg2, gpg-agent,
|
|---|
| 195 | gpgconf, gpg-connect-agent, gpgkey2ssh, gpgparsemail,
|
|---|
| 196 | gpgsm, gpgsm-gencert.sh, gpgtar, gpgv, gpgv2, kbxutil,
|
|---|
| 197 | scdaemon, symcryptrun and watchgnupg
|
|---|
| 198 | </seg>
|
|---|
| 199 | <seg>
|
|---|
| 200 | None
|
|---|
| 201 | </seg>
|
|---|
| 202 | <seg>
|
|---|
| 203 | /usr/share/doc/gnupg-&gnupg2-version; and
|
|---|
| 204 | /usr/share/gnupg
|
|---|
| 205 | </seg>
|
|---|
| 206 | </seglistitem>
|
|---|
| 207 | </segmentedlist>
|
|---|
| 208 |
|
|---|
| 209 | <variablelist>
|
|---|
| 210 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 211 | <?dbfo list-presentation="list"?>
|
|---|
| 212 | <?dbhtml list-presentation="table"?>
|
|---|
| 213 |
|
|---|
| 214 | <varlistentry id="addgnupghome">
|
|---|
| 215 | <term><command>addgnupghome</command></term>
|
|---|
| 216 | <listitem>
|
|---|
| 217 | <para>
|
|---|
| 218 | is used to create and populate user's
|
|---|
| 219 | <filename class="directory">~/.gnupg</filename> directories.
|
|---|
| 220 | </para>
|
|---|
| 221 | <indexterm zone="gnupg2 addgnupghome">
|
|---|
| 222 | <primary sortas="b-addgnupghome">addgnupghome</primary>
|
|---|
| 223 | </indexterm>
|
|---|
| 224 | </listitem>
|
|---|
| 225 | </varlistentry>
|
|---|
| 226 |
|
|---|
| 227 | <varlistentry id="applygnupgdefaults">
|
|---|
| 228 | <term><command>applygnupgdefaults</command></term>
|
|---|
| 229 | <listitem>
|
|---|
| 230 | <para>
|
|---|
| 231 | is a wrapper script used to run <command>gpgconf</command>
|
|---|
| 232 | with the <parameter>--apply-defaults</parameter> parameter
|
|---|
| 233 | on all user's GnuPG home directories.
|
|---|
| 234 | </para>
|
|---|
| 235 | <indexterm zone="gnupg2 applygnupgdefaults">
|
|---|
| 236 | <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
|
|---|
| 237 | </indexterm>
|
|---|
| 238 | </listitem>
|
|---|
| 239 | </varlistentry>
|
|---|
| 240 |
|
|---|
| 241 | <varlistentry id="gpg-agent">
|
|---|
| 242 | <term><command>gpg-agent</command></term>
|
|---|
| 243 | <listitem>
|
|---|
| 244 | <para>
|
|---|
| 245 | is a daemon used to manage secret (private) keys independently
|
|---|
| 246 | from any protocol. It is used as a backend for
|
|---|
| 247 | <command>gpg</command> and <command>gpgsm</command> as well as
|
|---|
| 248 | for a couple of other utilities.
|
|---|
| 249 | </para>
|
|---|
| 250 | <indexterm zone="gnupg2 gpg-agent">
|
|---|
| 251 | <primary sortas="b-gpg-agent">gpg-agent</primary>
|
|---|
| 252 | </indexterm>
|
|---|
| 253 | </listitem>
|
|---|
| 254 | </varlistentry>
|
|---|
| 255 |
|
|---|
| 256 | <varlistentry id="gpg-connect-agent">
|
|---|
| 257 | <term><command>gpg-connect-agent</command></term>
|
|---|
| 258 | <listitem>
|
|---|
| 259 | <para>
|
|---|
| 260 | is a utility used to communicate with a running
|
|---|
| 261 | <command>gpg-agent</command>.
|
|---|
| 262 | </para>
|
|---|
| 263 | <indexterm zone="gnupg2 gpg-connect-agent">
|
|---|
| 264 | <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
|
|---|
| 265 | </indexterm>
|
|---|
| 266 | </listitem>
|
|---|
| 267 | </varlistentry>
|
|---|
| 268 |
|
|---|
| 269 | <varlistentry id="gpg">
|
|---|
| 270 | <term><command>gpg</command></term>
|
|---|
| 271 | <listitem>
|
|---|
| 272 | <para>
|
|---|
| 273 | is a symlink to <command>gpg2</command> for compatibility
|
|---|
| 274 | with the first version of <application>GnuPG</application>.
|
|---|
| 275 | </para>
|
|---|
| 276 | <indexterm zone="gnupg2 gpg">
|
|---|
| 277 | <primary sortas="b-gpg">gpg</primary>
|
|---|
| 278 | </indexterm>
|
|---|
| 279 | </listitem>
|
|---|
| 280 | </varlistentry>
|
|---|
| 281 |
|
|---|
| 282 | <varlistentry id="gpg2">
|
|---|
| 283 | <term><command>gpg2</command></term>
|
|---|
| 284 | <listitem>
|
|---|
| 285 | <para>
|
|---|
| 286 | is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
|
|---|
| 287 | tool used to provide digital encryption and signing services
|
|---|
| 288 | using the OpenPGP standard.
|
|---|
| 289 | </para>
|
|---|
| 290 | <indexterm zone="gnupg2 gpg2">
|
|---|
| 291 | <primary sortas="b-gpg2">gpg2</primary>
|
|---|
| 292 | </indexterm>
|
|---|
| 293 | </listitem>
|
|---|
| 294 | </varlistentry>
|
|---|
| 295 |
|
|---|
| 296 | <varlistentry id="gpgconf">
|
|---|
| 297 | <term><command>gpgconf</command></term>
|
|---|
| 298 | <listitem>
|
|---|
| 299 | <para>
|
|---|
| 300 | is a utility used to automatically and reasonable safely
|
|---|
| 301 | query and modify configuration files in the
|
|---|
| 302 | <filename class="directory">~/.gnupg</filename> home
|
|---|
| 303 | directory. It is designed not to be invoked manually by
|
|---|
| 304 | the user, but automatically by graphical user interfaces.
|
|---|
| 305 | </para>
|
|---|
| 306 | <indexterm zone="gnupg2 gpgconf">
|
|---|
| 307 | <primary sortas="b-gpgconf">gpgconf</primary>
|
|---|
| 308 | </indexterm>
|
|---|
| 309 | </listitem>
|
|---|
| 310 | </varlistentry>
|
|---|
| 311 |
|
|---|
| 312 | <varlistentry id="gpgparsemail">
|
|---|
| 313 | <term><command>gpgparsemail</command></term>
|
|---|
| 314 | <listitem>
|
|---|
| 315 | <para>
|
|---|
| 316 | is a utility currently only useful for debugging. Run it with
|
|---|
| 317 | <parameter>--help</parameter> for usage information.
|
|---|
| 318 | </para>
|
|---|
| 319 | <indexterm zone="gnupg2 gpgparsemail">
|
|---|
| 320 | <primary sortas="b-gpgparsemail">gpgparsemail</primary>
|
|---|
| 321 | </indexterm>
|
|---|
| 322 | </listitem>
|
|---|
| 323 | </varlistentry>
|
|---|
| 324 |
|
|---|
| 325 | <varlistentry id="gpgsm">
|
|---|
| 326 | <term><command>gpgsm</command></term>
|
|---|
| 327 | <listitem>
|
|---|
| 328 | <para>
|
|---|
| 329 | is a tool similar to <command>gpg</command> used to provide digital
|
|---|
| 330 | encryption and signing services on X.509 certificates and the CMS
|
|---|
| 331 | protocol. It is mainly used as a backend for S/MIME mail processing.
|
|---|
| 332 | </para>
|
|---|
| 333 | <indexterm zone="gnupg2 gpgsm">
|
|---|
| 334 | <primary sortas="b-gpgsm">gpgsm</primary>
|
|---|
| 335 | </indexterm>
|
|---|
| 336 | </listitem>
|
|---|
| 337 | </varlistentry>
|
|---|
| 338 |
|
|---|
| 339 | <varlistentry id="gpgsm-gencert.sh">
|
|---|
| 340 | <term><command>gpgsm-gencert.sh</command></term>
|
|---|
| 341 | <listitem>
|
|---|
| 342 | <para>
|
|---|
| 343 | is a simple tool used to interactively generate a certificate
|
|---|
| 344 | request which will be printed to stdout.
|
|---|
| 345 | </para>
|
|---|
| 346 | <indexterm zone="gnupg2 gpgsm-gencert.sh">
|
|---|
| 347 | <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
|
|---|
| 348 | </indexterm>
|
|---|
| 349 | </listitem>
|
|---|
| 350 | </varlistentry>
|
|---|
| 351 |
|
|---|
| 352 | <varlistentry id="gpgv">
|
|---|
| 353 | <term><command>gpgv</command></term>
|
|---|
| 354 | <listitem>
|
|---|
| 355 | <para>
|
|---|
| 356 | is a symlink to <command>gpgv2</command> for compatibility
|
|---|
| 357 | with the first version of <application>GnuPG</application>.
|
|---|
| 358 | </para>
|
|---|
| 359 | <indexterm zone="gnupg2 gpgv">
|
|---|
| 360 | <primary sortas="b-gpgv">gpgv</primary>
|
|---|
| 361 | </indexterm>
|
|---|
| 362 | </listitem>
|
|---|
| 363 | </varlistentry>
|
|---|
| 364 |
|
|---|
| 365 | <varlistentry id="gpgv2">
|
|---|
| 366 | <term><command>gpgv2</command></term>
|
|---|
| 367 | <listitem>
|
|---|
| 368 | <para>
|
|---|
| 369 | is a verify only version of <command>gpg2</command>.
|
|---|
| 370 | </para>
|
|---|
| 371 | <indexterm zone="gnupg2 gpgv2">
|
|---|
| 372 | <primary sortas="b-gpgv2">gpgv2</primary>
|
|---|
| 373 | </indexterm>
|
|---|
| 374 | </listitem>
|
|---|
| 375 | </varlistentry>
|
|---|
| 376 |
|
|---|
| 377 | <varlistentry id="kbxutil">
|
|---|
| 378 | <term><command>kbxutil</command></term>
|
|---|
| 379 | <listitem>
|
|---|
| 380 | <para>
|
|---|
| 381 | is used to list, export and import Keybox data.
|
|---|
| 382 | </para>
|
|---|
| 383 | <indexterm zone="gnupg2 kbxutil">
|
|---|
| 384 | <primary sortas="b-kbxutil">kbxutil</primary>
|
|---|
| 385 | </indexterm>
|
|---|
| 386 | </listitem>
|
|---|
| 387 | </varlistentry>
|
|---|
| 388 |
|
|---|
| 389 | <varlistentry id="scdaemon">
|
|---|
| 390 | <term><command>scdaemon</command></term>
|
|---|
| 391 | <listitem>
|
|---|
| 392 | <para>
|
|---|
| 393 | is a daemon used to manage smartcards. It is usually invoked by
|
|---|
| 394 | <command>gpg-agent</command> and in general not used directly.
|
|---|
| 395 | </para>
|
|---|
| 396 | <indexterm zone="gnupg2 scdaemon">
|
|---|
| 397 | <primary sortas="b-scdaemon">scdaemon</primary>
|
|---|
| 398 | </indexterm>
|
|---|
| 399 | </listitem>
|
|---|
| 400 | </varlistentry>
|
|---|
| 401 |
|
|---|
| 402 | <varlistentry id="symcryptrun">
|
|---|
| 403 | <term><command>symcryptrun</command></term>
|
|---|
| 404 | <listitem>
|
|---|
| 405 | <para>
|
|---|
| 406 | is a simple symmetric encryption tool.
|
|---|
| 407 | </para>
|
|---|
| 408 | <indexterm zone="gnupg2 symcryptrun">
|
|---|
| 409 | <primary sortas="b-symcryptrun">symcryptrun</primary>
|
|---|
| 410 | </indexterm>
|
|---|
| 411 | </listitem>
|
|---|
| 412 | </varlistentry>
|
|---|
| 413 |
|
|---|
| 414 | <varlistentry id="watchgnupg">
|
|---|
| 415 | <term><command>watchgnupg</command></term>
|
|---|
| 416 | <listitem>
|
|---|
| 417 | <para>
|
|---|
| 418 | is used to listen to a Unix Domain socket created by any of
|
|---|
| 419 | the GnuPG tools.
|
|---|
| 420 | </para>
|
|---|
| 421 | <indexterm zone="gnupg2 watchgnupg">
|
|---|
| 422 | <primary sortas="b-watchgnupg">watchgnupg</primary>
|
|---|
| 423 | </indexterm>
|
|---|
| 424 | </listitem>
|
|---|
| 425 | </varlistentry>
|
|---|
| 426 |
|
|---|
| 427 | </variablelist>
|
|---|
| 428 |
|
|---|
| 429 | </sect2>
|
|---|
| 430 |
|
|---|
| 431 | </sect1>
|
|---|
