source: postlfs/security/gnupg2.xml@ da54a62

11.0 11.1 11.2 11.3 12.0 12.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 da54a62 was da54a62, checked in by Pierre Labastie <pierre.labastie@…>, 3 years ago

Tags for kde and some deps

  • 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 "&gnupg-http;/gnupg/gnupg-&gnupg2-version;.tar.bz2">
8 <!ENTITY gnupg2-download-ftp "&gnupg-ftp;/gnupg/gnupg-&gnupg2-version;.tar.bz2">
9 <!ENTITY gnupg2-md5sum "5db3334b528cf756b1e583db01319a24">
10 <!ENTITY gnupg2-size "6.9 MB">
11 <!ENTITY gnupg2-buildsize "143 MB (with all tests; add 25 MB for docs)">
12 <!ENTITY gnupg2-time "0.4 SBU (using parallelism=4; add 1.5 SBU for tests)">
13]>
14
15<sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
16 <?dbhtml filename="gnupg.html"?>
17
18 <sect1info>
19 <date>$Date$</date>
20 </sect1info>
21
22 <title>GnuPG-&gnupg2-version;</title>
23
24 <indexterm zone="gnupg2">
25 <primary sortas="a-GnuPG">GnuPG</primary>
26 </indexterm>
27
28 <sect2 role="package">
29 <title>Introduction to GnuPG</title>
30
31 <para>
32 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.
39 </para>
40
41 &lfs110a_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>
47 Download (HTTP): <ulink url="&gnupg2-download-http;"/>
48 </para>
49 </listitem>
50 <listitem>
51 <para>
52 Download (FTP): <ulink url="&gnupg2-download-ftp;"/>
53 </para>
54 </listitem>
55 <listitem>
56 <para>
57 Download MD5 sum: &gnupg2-md5sum;
58 </para>
59 </listitem>
60 <listitem>
61 <para>
62 Download size: &gnupg2-size;
63 </para>
64 </listitem>
65 <listitem>
66 <para>
67 Estimated disk space required: &gnupg2-buildsize;
68 </para>
69 </listitem>
70 <listitem>
71 <para>
72 Estimated build time: &gnupg2-time;
73 </para>
74 </listitem>
75 </itemizedlist>
76
77 <bridgehead renderas="sect3">GnuPG 2 Dependencies</bridgehead>
78
79 <bridgehead renderas="sect4">Required</bridgehead>
80 <para role="required">
81 <xref linkend="libassuan"/>,
82 <xref linkend="libgcrypt"/>,
83 <xref linkend="libksba"/>, and
84 <xref linkend="npth"/>
85 </para>
86
87 <bridgehead renderas="sect4">Recommended</bridgehead>
88 <para role="recommended">
89 <xref linkend="gnutls"/> (required to communicate with keyservers
90 using https or hkps protocol) and
91 <xref linkend="pinentry"/> (Run-time requirement for most of
92 the package's functionality)
93 </para>
94
95 <bridgehead renderas="sect4">Optional</bridgehead>
96 <para role="optional">
97 <xref linkend="curl"/>,
98 <xref linkend="fuse3"/>,
99 <xref linkend="imagemagick"/> (for the <command>convert</command> utility,
100 used for generating the documentation),
101 <xref linkend="libusb"/>,
102 an <xref linkend="server-mail"/>,
103 <xref linkend="openldap"/>,
104 <xref linkend="sqlite"/>,
105 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
106 <ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> (for
107 generating documentation),
108 and <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
109 adns</ulink>
110 </para>
111
112 <para condition="html" role="usernotes">User Notes:
113 <ulink url="&blfs-wiki;/gnupg2"/></para>
114
115 </sect2>
116
117 <sect2 role="installation">
118 <title>Installation of GnuPG</title>
119
120 <para>
121 By default GnuPG doesn't install the deprecated gpg-zip script,
122 but it is still needed by some programs. Make GnuPG install it with:
123 </para>
124
125<screen><userinput>sed -e '/noinst_SCRIPTS = gpg-zip/c sbin_SCRIPTS += gpg-zip' \
126 -i tools/Makefile.in</userinput></screen>
127
128<!-- Seems to be resolved in 2.2.29
129 <para>
130 Fix a issue causing build failure if
131 <application>OpenLDAP</application> is not installed:
132 </para>
133
134<screen><userinput>sed -e '737a #if USE_LDAP' \
135 -e '760a #endif' \
136 -i dirmngr/dirmngr.c</userinput></screen>
137-->
138
139 <para>
140 Install <application>GnuPG</application> by running the following
141 commands:
142 </para>
143
144<screen><userinput>./configure --prefix=/usr \
145 --localstatedir=/var \
146 --sysconfdir=/etc \
147 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
148make &amp;&amp;
149
150makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
151makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi &amp;&amp;
152make -C doc html</userinput></screen>
153
154 <para>
155 If you have <xref linkend="texlive"/>
156 installed and you wish to create documentation in alternate formats,
157 issue the following commands
158 (<ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> is needed for
159 the ps format):
160 </para>
161
162<screen remap="doc"><userinput>make -C doc pdf ps</userinput></screen>
163
164 <para>
165 To test the results, issue: <command>make check</command>.
166 </para>
167
168 <para>
169 Note that if you have already installed
170 <application>GnuPG</application>, the instructions below will overwrite
171 <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
172 <systemitem class="username">root</systemitem> user:
173 </para>
174
175<screen role="root"><userinput>make install &amp;&amp;
176
177install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
178install -v -m644 doc/gnupg_nochunks.html \
179 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
180install -v -m644 doc/*.texi doc/gnupg.txt \
181 /usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
182install -v -m644 doc/gnupg.html/* \
183 /usr/share/doc/gnupg-&gnupg2-version;/html</userinput></screen>
184 <para>
185 If you created alternate formats of the documentation, install them
186 using the following command as the
187 <systemitem class="username">root</systemitem> user:
188 </para>
189
190<screen role="root"
191 remap="doc"><userinput>install -v -m644 doc/gnupg.{pdf,dvi,ps} \
192 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
193
194 </sect2>
195
196 <sect2 role="commands">
197 <title>Command Explanations</title>
198
199 <para>
200 <command>sed ... tools/Makefile.in</command>:
201 This command is needed to build the gpg-zip program.
202 </para>
203
204 <para>
205 <parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
206 This switch changes the default docdir to <filename
207 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.
208 </para>
209
210<!-- Unrecognized in 2.2.26, seems to get built automatically now.
211 <para>
212 <parameter>- -enable-symcryptrun</parameter>: This switch enables
213 building the symcryptrun program.
214 </para>
215-->
216 <para>
217 <option>--enable-all-tests</option>: This switch allows more tests to be
218 run with <command>make check</command>.
219 </para>
220
221 <para>
222 <option>--enable-g13</option>: This switch enables building the
223 g13 program.
224 </para>
225
226 </sect2>
227
228 <sect2 role="content">
229 <title>Contents</title>
230
231 <segmentedlist>
232 <segtitle>Installed Programs</segtitle>
233 <segtitle>Installed Libraries</segtitle>
234 <segtitle>Installed Directories</segtitle>
235
236 <seglistitem>
237 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13
238 (optional), gpg-agent, gpg-connect-agent, gpg, gpgconf, gpgparsemail,
239 gpgscm, gpgsm, gpgsplit, gpgtar, gpgv, gpg-wks-server, gpg-zip, kbxutil,
240 <!--symcryptrun,--> and watchgnupg</seg>
241 <seg>None</seg>
242 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
243 /usr/share/gnupg</seg>
244 </seglistitem>
245 </segmentedlist>
246
247 <variablelist>
248 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
249 <?dbfo list-presentation="list"?>
250 <?dbhtml list-presentation="table"?>
251
252 <varlistentry id="addgnupghome">
253 <term><command>addgnupghome</command></term>
254 <listitem>
255 <para>
256 is used to create and populate a user's
257 <filename class="directory">~/.gnupg</filename> directories
258 </para>
259 <indexterm zone="gnupg2 addgnupghome">
260 <primary sortas="b-addgnupghome">addgnupghome</primary>
261 </indexterm>
262 </listitem>
263 </varlistentry>
264
265 <varlistentry id="applygnupgdefaults">
266 <term><command>applygnupgdefaults</command></term>
267 <listitem>
268 <para>
269 is a wrapper script used to run <command>gpgconf</command>
270 with the <parameter>--apply-defaults</parameter> parameter on all
271 user's GnuPG home directories
272 </para>
273 <indexterm zone="gnupg2 applygnupgdefaults">
274 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
275 </indexterm>
276 </listitem>
277 </varlistentry>
278
279 <varlistentry id="dirmngr">
280 <term><command>dirmngr</command></term>
281 <listitem>
282 <para>
283 is a tool that takes care of accessing the OpenPGP keyservers
284 </para>
285 <indexterm zone="gnupg2 dirmngr">
286 <primary sortas="b-dirmngr">dirmngr</primary>
287 </indexterm>
288 </listitem>
289 </varlistentry>
290
291 <varlistentry id="dirmngr-client">
292 <term><command>dirmngr-client</command></term>
293 <listitem>
294 <para>
295 is a tool to contact a running dirmngr and test whether a
296 certificate has been revoked
297 </para>
298 <indexterm zone="gnupg2 dirmngr-client">
299 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="g13">
305 <term><command>g13</command></term>
306 <listitem>
307 <para>
308 is a tool to create, mount or unmount an encrypted file system
309 container (optional)
310 </para>
311 <indexterm zone="gnupg2 g13">
312 <primary sortas="b-g13">g13</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="gpg-agent">
318 <term><command>gpg-agent</command></term>
319 <listitem>
320 <para>
321 is a daemon used to manage secret (private) keys independently
322 from any protocol. It is used as a backend for
323 <command>gpg</command> and <command>gpgsm</command> as well as
324 for a couple of other utilities
325 </para>
326 <indexterm zone="gnupg2 gpg-agent">
327 <primary sortas="b-gpg-agent">gpg-agent</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="gpg-connect-agent">
333 <term><command>gpg-connect-agent</command></term>
334 <listitem>
335 <para>
336 is a utility used to communicate with a running
337 <command>gpg-agent</command>
338 </para>
339 <indexterm zone="gnupg2 gpg-connect-agent">
340 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="gpg">
346 <term><command>gpg</command></term>
347 <listitem>
348 <para>
349 is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
350 tool used to provide digital encryption and signing services using
351 the OpenPGP standard
352 </para>
353 <indexterm zone="gnupg2 gpg">
354 <primary sortas="b-gpg">gpg</primary>
355 </indexterm>
356 </listitem>
357 </varlistentry>
358
359 <varlistentry id="gpgconf">
360 <term><command>gpgconf</command></term>
361 <listitem>
362 <para>
363 is a utility used to automatically and reasonably safely
364 query and modify configuration files in the
365 <filename class="directory">~/.gnupg</filename> home directory. It
366 is designed not to be invoked manually by the user, but
367 automatically by graphical user interfaces
368 </para>
369 <indexterm zone="gnupg2 gpgconf">
370 <primary sortas="b-gpgconf">gpgconf</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="gpgparsemail">
376 <term><command>gpgparsemail</command></term>
377 <listitem>
378 <para>
379 is a utility currently only useful for debugging. Run it with
380 <parameter>--help</parameter> for usage information
381 </para>
382 <indexterm zone="gnupg2 gpgparsemail">
383 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="gpgscm">
389 <term><command>gpgscm</command></term>
390 <listitem>
391 <para>
392 executes the given scheme program or spawns an interactive shell
393 </para>
394 <indexterm zone="gnupg2 gpgscm">
395 <primary sortas="b-gpgscm">gpgscm</primary>
396 </indexterm>
397 </listitem>
398 </varlistentry>
399
400 <varlistentry id="gpgsm">
401 <term><command>gpgsm</command></term>
402 <listitem>
403 <para>
404 is a tool similar to <command>gpg</command> used to provide
405 digital encryption and signing services on X.509 certificates and
406 the CMS protocol. It is mainly used as a backend for S/MIME mail
407 processing
408 </para>
409 <indexterm zone="gnupg2 gpgsm">
410 <primary sortas="b-gpgsm">gpgsm</primary>
411 </indexterm>
412 </listitem>
413 </varlistentry>
414
415 <varlistentry id="gpgsplit">
416 <term><command>gpgsplit</command></term>
417 <listitem>
418 <para>
419 splits an OpenPGP message into packets
420 </para>
421 <indexterm zone="gnupg2 gpgsplit">
422 <primary sortas="b-gpgsplit">gpgsplit</primary>
423 </indexterm>
424 </listitem>
425 </varlistentry>
426
427 <varlistentry id="gpgtar">
428 <term><command>gpgtar</command></term>
429 <listitem>
430 <para>
431 is a tool to encrypt or sign files into an archive
432 </para>
433 <indexterm zone="gnupg2 gpgtar">
434 <primary sortas="b-gpgtar">gpgtar</primary>
435 </indexterm>
436 </listitem>
437 </varlistentry>
438
439 <varlistentry id="gpgv">
440 <term><command>gpgv</command></term>
441 <listitem>
442 <para>
443 is a verify only version of <command>gpg</command>
444 </para>
445 <indexterm zone="gnupg2 gpgv">
446 <primary sortas="b-gpgv">gpgv</primary>
447 </indexterm>
448 </listitem>
449 </varlistentry>
450
451 <varlistentry id="gpg-wks-server">
452 <term><command>gpg-wks-server</command></term>
453 <listitem>
454 <para>
455 provides a server for the
456 <application>Web Key Service</application> protocol
457 </para>
458 <indexterm zone="gnupg2 gpg-wks-server">
459 <primary sortas="b-gpg-wks-server">gpg-wks-server</primary>
460 </indexterm>
461 </listitem>
462 </varlistentry>
463
464 <varlistentry id="gpg-zip">
465 <term><command>gpg-zip</command></term>
466 <listitem>
467 <para>
468 encrypts or signs files into an archive
469 </para>
470 <indexterm zone="gnupg2 gpg-zip">
471 <primary sortas="b-gpg-zip">gpg-zip</primary>
472 </indexterm>
473 </listitem>
474 </varlistentry>
475
476 <varlistentry id="kbxutil">
477 <term><command>kbxutil</command></term>
478 <listitem>
479 <para>
480 is used to list, export and import Keybox data
481 </para>
482 <indexterm zone="gnupg2 kbxutil">
483 <primary sortas="b-kbxutil">kbxutil</primary>
484 </indexterm>
485 </listitem>
486 </varlistentry>
487
488 <!--
489 <varlistentry id="symcryptrun">
490 <term><command>symcryptrun</command></term>
491 <listitem>
492 <para>
493 is a simple symmetric encryption tool.
494 </para>
495 <indexterm zone="gnupg2 symcryptrun">
496 <primary sortas="b-symcryptrun">symcryptrun</primary>
497 </indexterm>
498 </listitem>
499 </varlistentry>
500-->
501 <varlistentry id="watchgnupg">
502 <term><command>watchgnupg</command></term>
503 <listitem>
504 <para>
505 is used to listen to a Unix Domain socket created by any of
506 the GnuPG tools
507 </para>
508 <indexterm zone="gnupg2 watchgnupg">
509 <primary sortas="b-watchgnupg">watchgnupg</primary>
510 </indexterm>
511 </listitem>
512 </varlistentry>
513
514 </variablelist>
515
516 </sect2>
517
518</sect1>
Note: See TracBrowser for help on using the repository browser.