source: postlfs/security/gnupg2.xml@ 287130e

10.0 10.1 11.0 11.1 11.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules plabs/python-mods qt5new trunk upgradedb xry111/intltool xry111/soup3 xry111/test-20220226
Last change on this file since 287130e was 287130e, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Update xfburn dependencies.
Remove obsolete note in gtk+3.
Update to gnupg-2.2.6.
Update gnome-screenshot instructions.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@20076 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 16.0 KB
Line 
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 "&gnupg-http;/gnupg/gnupg-&gnupg2-version;.tar.bz2">
8 <!-- Something is wrong with ftp server and it confuses curl when currency runs it -->
9 <!-- <!ENTITY gnupg2-download-ftp "&gnupg-ftp;/gnupg/gnupg-&gnupg2-version;.tar.bz2"> -->
10 <!ENTITY gnupg2-download-ftp " ">
11 <!ENTITY gnupg2-md5sum "2b13d3b6db10b9e93c828703fd6ff823">
12 <!ENTITY gnupg2-size "6.3 MB">
13 <!ENTITY gnupg2-buildsize "111 MB (with all tests; add 24 MB for docs)">
14 <!ENTITY gnupg2-time "0.3 SBU (using parallelism=4; add 1.9 SBU for tests)">
15]>
16
17<sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
18 <?dbhtml filename="gnupg.html"?>
19
20 <sect1info>
21 <othername>$LastChangedBy$</othername>
22 <date>$Date$</date>
23 </sect1info>
24
25 <title>GnuPG-&gnupg2-version;</title>
26
27 <indexterm zone="gnupg2">
28 <primary sortas="a-GnuPG">GnuPG</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to GnuPG</title>
33
34 <para>The <application>GnuPG</application> package is GNU's tool for
35 secure communication and data storage. It can be used to encrypt data and
36 to create digital signatures. It includes an advanced key management
37 facility and is compliant with the proposed OpenPGP Internet standard as
38 described in RFC2440 and the S/MIME standard as described by several RFCs.
39 GnuPG 2 is the stable version of GnuPG integrating support for OpenPGP and
40 S/MIME.</para>
41
42 &lfs82_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>Download (HTTP): <ulink url="&gnupg2-download-http;"/></para>
48 </listitem>
49 <listitem>
50 <para>Download (FTP): <ulink url="&gnupg2-download-ftp;"/></para>
51 </listitem>
52 <listitem>
53 <para>Download MD5 sum: &gnupg2-md5sum;</para>
54 </listitem>
55 <listitem>
56 <para>Download size: &gnupg2-size;</para>
57 </listitem>
58 <listitem>
59 <para>Estimated disk space required: &gnupg2-buildsize;</para>
60 </listitem>
61 <listitem>
62 <para>Estimated build time: &gnupg2-time;</para>
63 </listitem>
64 </itemizedlist>
65
66 <bridgehead renderas="sect3">GnuPG 2 Dependencies</bridgehead>
67
68 <bridgehead renderas="sect4">Required</bridgehead>
69 <para role="required">
70 <xref linkend="libassuan"/>,
71 <xref linkend="libgcrypt"/>,
72 <xref linkend="libgpg-error"/>,
73 <xref linkend="libksba"/>, and
74 <xref linkend="npth"/>
75 </para>
76
77 <bridgehead renderas="sect4">Recommended</bridgehead>
78 <para role="recommended">
79 <xref linkend="pinentry"/> (Run-time requirement for most of
80 the package's functionality)
81 </para>
82
83 <bridgehead renderas="sect4">Optional</bridgehead>
84 <para role="optional">
85 <xref linkend="curl"/>,
86 <xref linkend="gnutls"/>,
87 <xref linkend="imagemagick"/> (for the <command>convert</command> utility,
88 used for generating the documentation),
89 <xref linkend="libusb-compat"/>,
90 an <xref linkend="server-mail"/>,
91 <xref linkend="openldap"/>,
92 <xref linkend="sqlite"/>,
93 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
94 <ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> (for
95 generating documentation),
96 and <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
97 adns</ulink>
98 </para>
99
100 <para condition="html" role="usernotes">User Notes:
101 <ulink url="&blfs-wiki;/gnupg2"/></para>
102
103 </sect2>
104
105 <sect2 role="installation">
106 <title>Installation of GnuPG</title>
107
108 <warning>
109 <para>
110 If you are upgrading from gnupg prior to version 2.1, upstream
111 developers recommend to backup
112 <filename class="directory">~/.gnupg</filename>, because some additional
113 configuration will probably be necessary, and you could lose your keys.
114 You can find instructions at
115 <ulink url="http://jo-ke.name/wp/?p=111"></ulink> and
116 <ulink url="https://wiki.archlinux.org/index.php/GnuPG#.22Lost.22_keys.2C_upgrading_to_gnupg_version_2.1"></ulink>.
117 </para>
118 </warning>
119
120 <para>If the top directory path where the source is unpacked contains
121 symbolic links, the openpgp tests may fail. If this is your case and
122 you wish to run the test suite, fix that with:</para>
123
124<screen><userinput>sed -e '/noinst_SCRIPTS = gpg-zip/c sbin_SCRIPTS += gpg-zip' \
125 -i tools/Makefile.in</userinput></screen>
126
127 <para>Install <application>GnuPG</application> by running the following
128 commands:</para>
129
130<screen><userinput>./configure --prefix=/usr \
131 --enable-symcryptrun \
132 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
133make &amp;&amp;
134
135makeinfo --html --no-split \
136 -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
137makeinfo --plaintext \
138 -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
139
140 <para>If you have <xref linkend="texlive"/>
141 installed and you wish to create documentation in alternate formats,
142 issue the following commands
143 (<ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> is needed for
144 the ps format):</para>
145
146<screen><userinput>make -C doc pdf ps html</userinput></screen>
147
148 <para>To test the results, issue: <command>make check</command>.</para>
149
150 <para>Note that if you have already installed
151 <application>GnuPG</application>, the instructions below will overwrite
152 <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
153 <systemitem class="username">root</systemitem> user:</para>
154
155<screen role="root"><userinput>make install &amp;&amp;
156
157install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
158install -v -m644 doc/gnupg_nochunks.html \
159 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
160install -v -m644 doc/*.texi doc/gnupg.txt \
161 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
162<!-- Now intalls as gpg, not gpg2. This should be no longer needed.
163 <para>The BLFS editors recommend the creation of symlinks for compatibility
164 with the first version of GnuPG, because some programs or scripts need
165 them. Issue, as <systemitem class="username">root</systemitem> user:</para>
166
167<screen role="root"><userinput>for f in gpg gpgv
168do
169 ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &amp;&amp;
170 ln -svf ${f}2 /usr/bin/$f
171done
172unset f</userinput></screen>
173-->
174 <para>If you created alternate formats of the documentation, install it
175 using the following command as the
176 <systemitem class="username">root</systemitem> user:</para>
177
178<screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
179 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
180install -v -m644 doc/gnupg.{pdf,dvi,ps} \
181 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
182
183 </sect2>
184
185 <sect2 role="commands">
186 <title>Command Explanations</title>
187
188 <para><command>sed ... tools/Makefile.in</command>:
189 This command is needed to build the gpg-zip program.</para>
190
191 <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
192 This switch changes the default docdir to <filename
193 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
194
195 <para><parameter>--enable-symcryptrun</parameter>: This switch enables
196 building the symcryptrun program.</para>
197
198 <para>
199 <option>--enable-all-tests</option>: allows more tests to be run whith
200 <command>make check</command>.
201 </para>
202 <para><option>--enable-g13</option>: This switch enables building the
203 g13 program.</para>
204
205 </sect2>
206
207 <sect2 role="content">
208 <title>Contents</title>
209
210 <segmentedlist>
211 <segtitle>Installed Programs</segtitle>
212 <segtitle>Installed Libraries</segtitle>
213 <segtitle>Installed Directories</segtitle>
214
215 <seglistitem>
216 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13
217 (optional), gpg-agent, gpg-connect-agent, gpg, gpgconf, gpgparsemail,
218 gpgscm, gpgsm, gpgtar, gpgv, gpg-zip, kbxutil, symcryptrun,
219 and watchgnupg</seg>
220 <seg>None</seg>
221 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
222 /usr/share/gnupg</seg>
223 </seglistitem>
224 </segmentedlist>
225
226 <variablelist>
227 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
228 <?dbfo list-presentation="list"?>
229 <?dbhtml list-presentation="table"?>
230
231 <varlistentry id="addgnupghome">
232 <term><command>addgnupghome</command></term>
233 <listitem>
234 <para>is used to create and populate user's
235 <filename class='directory'>~/.gnupg</filename> directories</para>
236 <indexterm zone="gnupg2 addgnupghome">
237 <primary sortas="b-addgnupghome">addgnupghome</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="applygnupgdefaults">
243 <term><command>applygnupgdefaults</command></term>
244 <listitem>
245 <para>is a wrapper script used to run <command>gpgconf</command>
246 with the <parameter>--apply-defaults</parameter> parameter on all
247 user's GnuPG home directories.</para>
248 <indexterm zone="gnupg2 applygnupgdefaults">
249 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
250 </indexterm>
251 </listitem>
252 </varlistentry>
253
254 <varlistentry id="dirmngr">
255 <term><command>dirmngr</command></term>
256 <listitem>
257 <para> is a tool that takes care of accessing the OpenPGP keyservers.
258 </para>
259 <indexterm zone="gnupg2 dirmngr">
260 <primary sortas="b-dirmngr">dirmngr</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="dirmngr-client">
266 <term><command>dirmngr-client</command></term>
267 <listitem>
268 <para> is a tool to contact a running dirmngr and test whether a
269 certificate has been revoked. </para>
270 <indexterm zone="gnupg2 dirmngr-client">
271 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="g13">
277 <term><command>g13</command></term>
278 <listitem>
279 <para>is a tool to create, mount or unmount an encrypted file system
280 container (optional).</para>
281 <indexterm zone="gnupg2 g13">
282 <primary sortas="b-g13">g13</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="gpg-agent">
288 <term><command>gpg-agent</command></term>
289 <listitem>
290 <para>is a daemon used to manage secret (private) keys independently
291 from any protocol. It is used as a backend for <command>gpg2</command>
292 and <command>gpgsm</command> as well as for a couple of other
293 utilities.</para>
294 <indexterm zone="gnupg2 gpg-agent">
295 <primary sortas="b-gpg-agent">gpg-agent</primary>
296 </indexterm>
297 </listitem>
298 </varlistentry>
299
300 <varlistentry id="gpg-connect-agent">
301 <term><command>gpg-connect-agent</command></term>
302 <listitem>
303 <para>is a utility used to communicate with a running
304 <command>gpg-agent</command>.</para>
305 <indexterm zone="gnupg2 gpg-connect-agent">
306 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
307 </indexterm>
308 </listitem>
309 </varlistentry>
310
311 <varlistentry id="gpg">
312 <term><command>gpg</command></term>
313 <listitem>
314 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
315 tool used to provide digital encryption and signing services using
316 the OpenPGP standard.</para>
317 <indexterm zone="gnupg2 gpg">
318 <primary sortas="b-gpg">gpg</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="gpgconf">
324 <term><command>gpgconf</command></term>
325 <listitem>
326 <para>is a utility used to automatically and reasonably safely
327 query and modify configuration files in the
328 <filename class='directory'>~/.gnupg</filename> home directory. It is
329 designed not to be invoked manually by the user, but automatically by
330 graphical user interfaces.</para>
331 <indexterm zone="gnupg2 gpgconf">
332 <primary sortas="b-gpgconf">gpgconf</primary>
333 </indexterm>
334 </listitem>
335 </varlistentry>
336
337 <varlistentry id="gpgparsemail">
338 <term><command>gpgparsemail</command></term>
339 <listitem>
340 <para>is a utility currently only useful for debugging. Run it with
341 <parameter>--help</parameter> for usage information.</para>
342 <indexterm zone="gnupg2 gpgparsemail">
343 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
344 </indexterm>
345 </listitem>
346 </varlistentry>
347
348 <varlistentry id="gpgscm">
349 <term><command>gpgscm</command></term>
350 <listitem>
351 <para>executes the given scheme program or spawns an interactive
352 shell.</para>
353 <indexterm zone="gnupg2 gpgscm">
354 <primary sortas="b-gpgscm">gpgscm</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="gpgsm">
360 <term><command>gpgsm</command></term>
361 <listitem>
362 <para>is a tool similar to <command>gpg2</command> used to provide
363 digital encryption and signing services on X.509 certificates and the
364 CMS protocol. It is mainly used as a backend for S/MIME mail
365 processing.</para>
366 <indexterm zone="gnupg2 gpgsm">
367 <primary sortas="b-gpgsm">gpgsm</primary>
368 </indexterm>
369 </listitem>
370 </varlistentry>
371
372 <varlistentry id="gpgtar">
373 <term><command>gpgtar</command></term>
374 <listitem>
375 <para> is a tool to encrypt or sign files into an archive.</para>
376 <indexterm zone="gnupg2 gpgtar">
377 <primary sortas="b-gpgtar">gpgtar</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="gpgv">
383 <term><command>gpgv</command></term>
384 <listitem>
385 <para>is a verify only version of <command>gpg2</command>.</para>
386 <indexterm zone="gnupg2 gpgv">
387 <primary sortas="b-gpgv">gpgv</primary>
388 </indexterm>
389 </listitem>
390 </varlistentry>
391
392 <varlistentry id="gpg-zip">
393 <term><command>gpg-zip</command></term>
394 <listitem>
395 <para> encrypts or signs files into an archive.</para>
396 <indexterm zone="gnupg2 gpg-zip">
397 <primary sortas="b-gpg-zip">gpg-zip</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="kbxutil">
403 <term><command>kbxutil</command></term>
404 <listitem>
405 <para>is used to list, export and import Keybox data.</para>
406 <indexterm zone="gnupg2 kbxutil">
407 <primary sortas="b-kbxutil">kbxutil</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="symcryptrun">
413 <term><command>symcryptrun</command></term>
414 <listitem>
415 <para>is a simple symmetric encryption tool.</para>
416 <indexterm zone="gnupg2 symcryptrun">
417 <primary sortas="b-symcryptrun">symcryptrun</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="watchgnupg">
423 <term><command>watchgnupg</command></term>
424 <listitem>
425 <para>is used to listen to a Unix Domain socket created by any of
426 the GnuPG tools.</para>
427 <indexterm zone="gnupg2 watchgnupg">
428 <primary sortas="b-watchgnupg">watchgnupg</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 </variablelist>
434
435 </sect2>
436
437</sect1>
Note: See TracBrowser for help on using the repository browser.