source: postlfs/security/gnupg2.xml@ fdaae04

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since fdaae04 was fdaae04, checked in by Bruce Dubbs <bdubbs@…>, 7 years ago

Update to gnupg-2.1.16.
Update to gpgme-1.8.0.
Update to npth-1.3.
Update to pinentry-1.0.0.
Update some package titles to be the same as the tarball name.
Reorder the kf5 build order.

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

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