source: postlfs/security/gnupg2.xml@ ce242f2

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

Update to vala-0.36.1.
Update to mercurial-4.1.2.
Update to libwww-perl-6.25 (perl-module).
Update to gnupg-2.1.20.
Update to qemu-2.8.1.
Update to libsndfile-1.0.28.

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

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