[ac38e9dc] | 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 "d5cbb97673b99ca234507b74bfe8a29e">
|
---|
| 10 | <!ENTITY gnupg2-size "4.3 MB">
|
---|
| 11 | <!ENTITY gnupg2-buildsize "97 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: krejzi $</othername>
|
---|
| 20 | <date>$Date: 2014-10-26 14:56:10 +0100 (Sun, 26 Oct 2014) $</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 | &lfs77_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 | <xref linkend="libusb-compat"/>,
|
---|
| 98 | an <xref linkend="server-mail"/>,
|
---|
| 99 | <xref linkend="openldap"/>,
|
---|
| 100 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>) and
|
---|
| 101 | <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
|
---|
| 102 | ADNS</ulink>
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <para condition="html" role="usernotes">User Notes:
|
---|
| 106 | <ulink url="&blfs-wiki;/gnupg2"/>
|
---|
| 107 | </para>
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="installation">
|
---|
| 111 | <title>Installation of GnuPG</title>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | Install <application>GnuPG</application> by running the following
|
---|
| 115 | commands:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
| 118 | <screen><userinput>./configure --prefix=/usr \
|
---|
| 119 | --sysconfdir=/etc \
|
---|
| 120 | --enable-symcryptrun \
|
---|
| 121 | --docdir=/usr/share/doc/gnupg-&gnupg2-version; &&
|
---|
| 122 | make &&
|
---|
| 123 |
|
---|
| 124 | makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &&
|
---|
| 125 | makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
|
---|
| 126 |
|
---|
| 127 | <para>
|
---|
| 128 | If you have <xref linkend="texlive"/> installed and you wish
|
---|
| 129 | to create documentation in alternate formats, issue the
|
---|
| 130 | following commands:
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
| 133 | <screen><userinput>make -C doc pdf ps html</userinput></screen>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
| 136 | To test the results, issue: <command>make check</command>.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 141 | </para>
|
---|
| 142 |
|
---|
| 143 | <screen role="root"><userinput>make install &&
|
---|
| 144 |
|
---|
| 145 | for f in gpg gpgv ; do
|
---|
| 146 | ln -sfv ${f}2 /usr/bin/${f} &&
|
---|
| 147 | ln -sfv ${f}2.1 /usr/share/man/man1/${f}.1
|
---|
| 148 | done &&
|
---|
| 149 |
|
---|
| 150 | install -v -dm755 /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
---|
| 151 | install -v -m644 doc/gnupg_nochunks.html \
|
---|
| 152 | /usr/share/doc/gnupg-&gnupg2-version;/gnupg.html &&
|
---|
| 153 | install -v -m644 doc/*.texi doc/gnupg.txt \
|
---|
| 154 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
---|
| 155 |
|
---|
| 156 | <para>
|
---|
| 157 | If you created alternate formats of the documentation, install
|
---|
| 158 | it using the following command as the
|
---|
| 159 | <systemitem class="username">root</systemitem> user:
|
---|
| 160 | </para>
|
---|
| 161 |
|
---|
| 162 | <screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
|
---|
| 163 | /usr/share/doc/gnupg-&gnupg2-version;/html &&
|
---|
| 164 | install -v -m644 doc/gnupg.{pdf,dvi,ps} \
|
---|
| 165 | /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
|
---|
| 166 |
|
---|
| 167 | </sect2>
|
---|
| 168 |
|
---|
| 169 | <sect2 role="commands">
|
---|
| 170 | <title>Command Explanations</title>
|
---|
| 171 |
|
---|
| 172 | <para>
|
---|
| 173 | <parameter>--enable-symcryptrun</parameter>: This switch enables
|
---|
| 174 | building the symcryptrun program.
|
---|
| 175 | </para>
|
---|
| 176 |
|
---|
| 177 | <para>
|
---|
| 178 | <command>ln -sfv ...</command>: This command creates symlinks for
|
---|
| 179 | compatibility with the first version of
|
---|
| 180 | <application>GnuPG</application>.
|
---|
| 181 | </para>
|
---|
| 182 |
|
---|
| 183 | </sect2>
|
---|
| 184 |
|
---|
| 185 | <sect2 role="content">
|
---|
| 186 | <title>Contents</title>
|
---|
| 187 |
|
---|
| 188 | <segmentedlist>
|
---|
| 189 | <segtitle>Installed Programs</segtitle>
|
---|
| 190 | <segtitle>Installed Libraries</segtitle>
|
---|
| 191 | <segtitle>Installed Directories</segtitle>
|
---|
| 192 |
|
---|
| 193 | <seglistitem>
|
---|
| 194 | <seg>
|
---|
| 195 | addgnupghome, applygnupgdefaults, gpg, gpg2, gpg-agent,
|
---|
| 196 | gpgconf, gpg-connect-agent, gpgkey2ssh, gpgparsemail,
|
---|
| 197 | gpgsm, gpgsm-gencert.sh, gpgtar, gpgv, gpgv2, kbxutil,
|
---|
| 198 | scdaemon, symcryptrun and watchgnupg
|
---|
| 199 | </seg>
|
---|
| 200 | <seg>
|
---|
| 201 | None
|
---|
| 202 | </seg>
|
---|
| 203 | <seg>
|
---|
| 204 | /usr/share/doc/gnupg-&gnupg2-version; and
|
---|
| 205 | /usr/share/gnupg
|
---|
| 206 | </seg>
|
---|
| 207 | </seglistitem>
|
---|
| 208 | </segmentedlist>
|
---|
| 209 |
|
---|
| 210 | <variablelist>
|
---|
| 211 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 212 | <?dbfo list-presentation="list"?>
|
---|
| 213 | <?dbhtml list-presentation="table"?>
|
---|
| 214 |
|
---|
| 215 | <varlistentry id="addgnupghome">
|
---|
| 216 | <term><command>addgnupghome</command></term>
|
---|
| 217 | <listitem>
|
---|
| 218 | <para>
|
---|
| 219 | is used to create and populate user's
|
---|
| 220 | <filename class="directory">~/.gnupg</filename> directories.
|
---|
| 221 | </para>
|
---|
| 222 | <indexterm zone="gnupg2 addgnupghome">
|
---|
| 223 | <primary sortas="b-addgnupghome">addgnupghome</primary>
|
---|
| 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
| 227 |
|
---|
| 228 | <varlistentry id="applygnupgdefaults">
|
---|
| 229 | <term><command>applygnupgdefaults</command></term>
|
---|
| 230 | <listitem>
|
---|
| 231 | <para>
|
---|
| 232 | is a wrapper script used to run <command>gpgconf</command>
|
---|
| 233 | with the <parameter>--apply-defaults</parameter> parameter
|
---|
| 234 | on all user's GnuPG home directories.
|
---|
| 235 | </para>
|
---|
| 236 | <indexterm zone="gnupg2 applygnupgdefaults">
|
---|
| 237 | <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
| 242 | <varlistentry id="gpg-agent">
|
---|
| 243 | <term><command>gpg-agent</command></term>
|
---|
| 244 | <listitem>
|
---|
| 245 | <para>
|
---|
| 246 | is a daemon used to manage secret (private) keys independently
|
---|
| 247 | from any protocol. It is used as a backend for
|
---|
| 248 | <command>gpg</command> and <command>gpgsm</command> as well as
|
---|
| 249 | for a couple of other utilities.
|
---|
| 250 | </para>
|
---|
| 251 | <indexterm zone="gnupg2 gpg-agent">
|
---|
| 252 | <primary sortas="b-gpg-agent">gpg-agent</primary>
|
---|
| 253 | </indexterm>
|
---|
| 254 | </listitem>
|
---|
| 255 | </varlistentry>
|
---|
| 256 |
|
---|
| 257 | <varlistentry id="gpg-connect-agent">
|
---|
| 258 | <term><command>gpg-connect-agent</command></term>
|
---|
| 259 | <listitem>
|
---|
| 260 | <para>
|
---|
| 261 | is a utility used to communicate with a running
|
---|
| 262 | <command>gpg-agent</command>.
|
---|
| 263 | </para>
|
---|
| 264 | <indexterm zone="gnupg2 gpg-connect-agent">
|
---|
| 265 | <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
|
---|
| 266 | </indexterm>
|
---|
| 267 | </listitem>
|
---|
| 268 | </varlistentry>
|
---|
| 269 |
|
---|
| 270 | <varlistentry id="gpg">
|
---|
| 271 | <term><command>gpg</command></term>
|
---|
| 272 | <listitem>
|
---|
| 273 | <para>
|
---|
| 274 | is a symlink to <command>gpg2</command> for compatibility
|
---|
| 275 | with the first version of <application>GnuPG</application>.
|
---|
| 276 | </para>
|
---|
| 277 | <indexterm zone="gnupg2 gpg">
|
---|
| 278 | <primary sortas="b-gpg">gpg</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
| 283 | <varlistentry id="gpg2">
|
---|
| 284 | <term><command>gpg2</command></term>
|
---|
| 285 | <listitem>
|
---|
| 286 | <para>
|
---|
| 287 | is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
|
---|
| 288 | tool used to provide digital encryption and signing services
|
---|
| 289 | using the OpenPGP standard.
|
---|
| 290 | </para>
|
---|
| 291 | <indexterm zone="gnupg2 gpg2">
|
---|
| 292 | <primary sortas="b-gpg2">gpg2</primary>
|
---|
| 293 | </indexterm>
|
---|
| 294 | </listitem>
|
---|
| 295 | </varlistentry>
|
---|
| 296 |
|
---|
| 297 | <varlistentry id="gpgconf">
|
---|
| 298 | <term><command>gpgconf</command></term>
|
---|
| 299 | <listitem>
|
---|
| 300 | <para>
|
---|
| 301 | is a utility used to automatically and reasonable safely
|
---|
| 302 | query and modify configuration files in the
|
---|
| 303 | <filename class="directory">~/.gnupg</filename> home
|
---|
| 304 | directory. It is designed not to be invoked manually by
|
---|
| 305 | the user, but automatically by graphical user interfaces.
|
---|
| 306 | </para>
|
---|
| 307 | <indexterm zone="gnupg2 gpgconf">
|
---|
| 308 | <primary sortas="b-gpgconf">gpgconf</primary>
|
---|
| 309 | </indexterm>
|
---|
| 310 | </listitem>
|
---|
| 311 | </varlistentry>
|
---|
| 312 |
|
---|
| 313 | <varlistentry id="gpgkey2ssh">
|
---|
| 314 | <term><command>gpgkey2ssh</command></term>
|
---|
| 315 | <listitem>
|
---|
| 316 | <para>is a utility used to get the correctly formated key for
|
---|
| 317 | ssh usage.</para>
|
---|
| 318 | <indexterm zone="gnupg2 gpgkey2ssh">
|
---|
| 319 | <primary sortas="b-gpgkey2ssh">gpgkey2ssh</primary>
|
---|
| 320 | </indexterm>
|
---|
| 321 | </listitem>
|
---|
| 322 | </varlistentry>
|
---|
| 323 |
|
---|
| 324 | <varlistentry id="gpgparsemail">
|
---|
| 325 | <term><command>gpgparsemail</command></term>
|
---|
| 326 | <listitem>
|
---|
| 327 | <para>
|
---|
| 328 | is a utility currently only useful for debugging. Run it with
|
---|
| 329 | <parameter>--help</parameter> for usage information.
|
---|
| 330 | </para>
|
---|
| 331 | <indexterm zone="gnupg2 gpgparsemail">
|
---|
| 332 | <primary sortas="b-gpgparsemail">gpgparsemail</primary>
|
---|
| 333 | </indexterm>
|
---|
| 334 | </listitem>
|
---|
| 335 | </varlistentry>
|
---|
| 336 |
|
---|
| 337 | <varlistentry id="gpgsm">
|
---|
| 338 | <term><command>gpgsm</command></term>
|
---|
| 339 | <listitem>
|
---|
| 340 | <para>
|
---|
| 341 | is a tool similar to <command>gpg</command> used to provide digital
|
---|
| 342 | encryption and signing services on X.509 certificates and the CMS
|
---|
| 343 | protocol. It is mainly used as a backend for S/MIME mail processing.
|
---|
| 344 | </para>
|
---|
| 345 | <indexterm zone="gnupg2 gpgsm">
|
---|
| 346 | <primary sortas="b-gpgsm">gpgsm</primary>
|
---|
| 347 | </indexterm>
|
---|
| 348 | </listitem>
|
---|
| 349 | </varlistentry>
|
---|
| 350 |
|
---|
| 351 | <varlistentry id="gpgsm-gencert.sh">
|
---|
| 352 | <term><command>gpgsm-gencert.sh</command></term>
|
---|
| 353 | <listitem>
|
---|
| 354 | <para>
|
---|
| 355 | is a simple tool used to interactively generate a certificate
|
---|
| 356 | request which will be printed to stdout.
|
---|
| 357 | </para>
|
---|
| 358 | <indexterm zone="gnupg2 gpgsm-gencert.sh">
|
---|
| 359 | <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
|
---|
| 360 | </indexterm>
|
---|
| 361 | </listitem>
|
---|
| 362 | </varlistentry>
|
---|
| 363 |
|
---|
| 364 | <varlistentry id="gpgv">
|
---|
| 365 | <term><command>gpgv</command></term>
|
---|
| 366 | <listitem>
|
---|
| 367 | <para>
|
---|
| 368 | is a symlink to <command>gpgv2</command> for compatibility
|
---|
| 369 | with the first version of <application>GnuPG</application>.
|
---|
| 370 | </para>
|
---|
| 371 | <indexterm zone="gnupg2 gpgv">
|
---|
| 372 | <primary sortas="b-gpgv">gpgv</primary>
|
---|
| 373 | </indexterm>
|
---|
| 374 | </listitem>
|
---|
| 375 | </varlistentry>
|
---|
| 376 |
|
---|
| 377 | <varlistentry id="gpgv2">
|
---|
| 378 | <term><command>gpgv2</command></term>
|
---|
| 379 | <listitem>
|
---|
| 380 | <para>
|
---|
| 381 | is a verify only version of <command>gpg2</command>.
|
---|
| 382 | </para>
|
---|
| 383 | <indexterm zone="gnupg2 gpgv2">
|
---|
| 384 | <primary sortas="b-gpgv2">gpgv2</primary>
|
---|
| 385 | </indexterm>
|
---|
| 386 | </listitem>
|
---|
| 387 | </varlistentry>
|
---|
| 388 |
|
---|
| 389 | <varlistentry id="kbxutil">
|
---|
| 390 | <term><command>kbxutil</command></term>
|
---|
| 391 | <listitem>
|
---|
| 392 | <para>
|
---|
| 393 | is used to list, export and import Keybox data.
|
---|
| 394 | </para>
|
---|
| 395 | <indexterm zone="gnupg2 kbxutil">
|
---|
| 396 | <primary sortas="b-kbxutil">kbxutil</primary>
|
---|
| 397 | </indexterm>
|
---|
| 398 | </listitem>
|
---|
| 399 | </varlistentry>
|
---|
| 400 |
|
---|
| 401 | <varlistentry id="scdaemon">
|
---|
| 402 | <term><command>scdaemon</command></term>
|
---|
| 403 | <listitem>
|
---|
| 404 | <para>
|
---|
| 405 | is a daemon used to manage smartcards. It is usually invoked by
|
---|
| 406 | <command>gpg-agent</command> and in general not used directly.
|
---|
| 407 | </para>
|
---|
| 408 | <indexterm zone="gnupg2 scdaemon">
|
---|
| 409 | <primary sortas="b-scdaemon">scdaemon</primary>
|
---|
| 410 | </indexterm>
|
---|
| 411 | </listitem>
|
---|
| 412 | </varlistentry>
|
---|
| 413 |
|
---|
| 414 | <varlistentry id="symcryptrun">
|
---|
| 415 | <term><command>symcryptrun</command></term>
|
---|
| 416 | <listitem>
|
---|
| 417 | <para>
|
---|
| 418 | is a simple symmetric encryption tool.
|
---|
| 419 | </para>
|
---|
| 420 | <indexterm zone="gnupg2 symcryptrun">
|
---|
| 421 | <primary sortas="b-symcryptrun">symcryptrun</primary>
|
---|
| 422 | </indexterm>
|
---|
| 423 | </listitem>
|
---|
| 424 | </varlistentry>
|
---|
| 425 |
|
---|
| 426 | <varlistentry id="watchgnupg">
|
---|
| 427 | <term><command>watchgnupg</command></term>
|
---|
| 428 | <listitem>
|
---|
| 429 | <para>
|
---|
| 430 | is used to listen to a Unix Domain socket created by any of
|
---|
| 431 | the GnuPG tools.
|
---|
| 432 | </para>
|
---|
| 433 | <indexterm zone="gnupg2 watchgnupg">
|
---|
| 434 | <primary sortas="b-watchgnupg">watchgnupg</primary>
|
---|
| 435 | </indexterm>
|
---|
| 436 | </listitem>
|
---|
| 437 | </varlistentry>
|
---|
| 438 |
|
---|
| 439 | </variablelist>
|
---|
| 440 |
|
---|
| 441 | </sect2>
|
---|
| 442 |
|
---|
| 443 | </sect1>
|
---|