source: postlfs/security/gnupg2.xml@ 45fc41c7

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 45fc41c7 was 45fc41c7, checked in by Xi Ruoyao <xry111@…>, 3 years ago

gpg: raise gnutls to recommended

It's needed to access https or hkps keyserver. And, it does not make
any sense to retrieve a pubkey from a plain HTTP server (plain HTTP is
insecure by its nature!) and use it to "authenticate" a pacakge.

  • Property mode set to 100644
File size: 16.7 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 &lfs101_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 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
147make &amp;&amp;
148
149makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
150makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi &amp;&amp;
151make -C doc html</userinput></screen>
152
153 <para>
154 If you have <xref linkend="texlive"/>
155 installed and you wish to create documentation in alternate formats,
156 issue the following commands
157 (<ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> is needed for
158 the ps format):
159 </para>
160
161<screen remap="doc"><userinput>make -C doc pdf ps</userinput></screen>
162
163 <para>
164 To test the results, issue: <command>make check</command>.
165 </para>
166
167 <para>
168 Note that if you have already installed
169 <application>GnuPG</application>, the instructions below will overwrite
170 <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
171 <systemitem class="username">root</systemitem> user:
172 </para>
173
174<screen role="root"><userinput>make install &amp;&amp;
175
176install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
177install -v -m644 doc/gnupg_nochunks.html \
178 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
179install -v -m644 doc/*.texi doc/gnupg.txt \
180 /usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
181install -v -m644 doc/gnupg.html/* \
182 /usr/share/doc/gnupg-&gnupg2-version;/html</userinput></screen>
183 <para>
184 If you created alternate formats of the documentation, install them
185 using the following command as the
186 <systemitem class="username">root</systemitem> user:
187 </para>
188
189<screen role="root"
190 remap="doc"><userinput>install -v -m644 doc/gnupg.{pdf,dvi,ps} \
191 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
192
193 </sect2>
194
195 <sect2 role="commands">
196 <title>Command Explanations</title>
197
198 <para>
199 <command>sed ... tools/Makefile.in</command>:
200 This command is needed to build the gpg-zip program.
201 </para>
202
203 <para>
204 <parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
205 This switch changes the default docdir to <filename
206 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.
207 </para>
208
209<!-- Unrecognized in 2.2.26, seems to get built automatically now.
210 <para>
211 <parameter>- -enable-symcryptrun</parameter>: This switch enables
212 building the symcryptrun program.
213 </para>
214-->
215 <para>
216 <option>--enable-all-tests</option>: This switch allows more tests to be
217 run with <command>make check</command>.
218 </para>
219
220 <para>
221 <option>--enable-g13</option>: This switch enables building the
222 g13 program.
223 </para>
224
225 </sect2>
226
227 <sect2 role="content">
228 <title>Contents</title>
229
230 <segmentedlist>
231 <segtitle>Installed Programs</segtitle>
232 <segtitle>Installed Libraries</segtitle>
233 <segtitle>Installed Directories</segtitle>
234
235 <seglistitem>
236 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13
237 (optional), gpg-agent, gpg-connect-agent, gpg, gpgconf, gpgparsemail,
238 gpgscm, gpgsm, gpgsplit, gpgtar, gpgv, gpg-wks-server, gpg-zip, kbxutil,
239 <!--symcryptrun,--> and watchgnupg</seg>
240 <seg>None</seg>
241 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
242 /usr/share/gnupg</seg>
243 </seglistitem>
244 </segmentedlist>
245
246 <variablelist>
247 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
248 <?dbfo list-presentation="list"?>
249 <?dbhtml list-presentation="table"?>
250
251 <varlistentry id="addgnupghome">
252 <term><command>addgnupghome</command></term>
253 <listitem>
254 <para>
255 is used to create and populate a user's
256 <filename class="directory">~/.gnupg</filename> directories
257 </para>
258 <indexterm zone="gnupg2 addgnupghome">
259 <primary sortas="b-addgnupghome">addgnupghome</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="applygnupgdefaults">
265 <term><command>applygnupgdefaults</command></term>
266 <listitem>
267 <para>
268 is a wrapper script used to run <command>gpgconf</command>
269 with the <parameter>--apply-defaults</parameter> parameter on all
270 user's GnuPG home directories
271 </para>
272 <indexterm zone="gnupg2 applygnupgdefaults">
273 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
274 </indexterm>
275 </listitem>
276 </varlistentry>
277
278 <varlistentry id="dirmngr">
279 <term><command>dirmngr</command></term>
280 <listitem>
281 <para>
282 is a tool that takes care of accessing the OpenPGP keyservers
283 </para>
284 <indexterm zone="gnupg2 dirmngr">
285 <primary sortas="b-dirmngr">dirmngr</primary>
286 </indexterm>
287 </listitem>
288 </varlistentry>
289
290 <varlistentry id="dirmngr-client">
291 <term><command>dirmngr-client</command></term>
292 <listitem>
293 <para>
294 is a tool to contact a running dirmngr and test whether a
295 certificate has been revoked
296 </para>
297 <indexterm zone="gnupg2 dirmngr-client">
298 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
299 </indexterm>
300 </listitem>
301 </varlistentry>
302
303 <varlistentry id="g13">
304 <term><command>g13</command></term>
305 <listitem>
306 <para>
307 is a tool to create, mount or unmount an encrypted file system
308 container (optional)
309 </para>
310 <indexterm zone="gnupg2 g13">
311 <primary sortas="b-g13">g13</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="gpg-agent">
317 <term><command>gpg-agent</command></term>
318 <listitem>
319 <para>
320 is a daemon used to manage secret (private) keys independently
321 from any protocol. It is used as a backend for
322 <command>gpg</command> and <command>gpgsm</command> as well as
323 for a couple of other utilities
324 </para>
325 <indexterm zone="gnupg2 gpg-agent">
326 <primary sortas="b-gpg-agent">gpg-agent</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="gpg-connect-agent">
332 <term><command>gpg-connect-agent</command></term>
333 <listitem>
334 <para>
335 is a utility used to communicate with a running
336 <command>gpg-agent</command>
337 </para>
338 <indexterm zone="gnupg2 gpg-connect-agent">
339 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="gpg">
345 <term><command>gpg</command></term>
346 <listitem>
347 <para>
348 is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
349 tool used to provide digital encryption and signing services using
350 the OpenPGP standard
351 </para>
352 <indexterm zone="gnupg2 gpg">
353 <primary sortas="b-gpg">gpg</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="gpgconf">
359 <term><command>gpgconf</command></term>
360 <listitem>
361 <para>
362 is a utility used to automatically and reasonably safely
363 query and modify configuration files in the
364 <filename class="directory">~/.gnupg</filename> home directory. It
365 is designed not to be invoked manually by the user, but
366 automatically by graphical user interfaces
367 </para>
368 <indexterm zone="gnupg2 gpgconf">
369 <primary sortas="b-gpgconf">gpgconf</primary>
370 </indexterm>
371 </listitem>
372 </varlistentry>
373
374 <varlistentry id="gpgparsemail">
375 <term><command>gpgparsemail</command></term>
376 <listitem>
377 <para>
378 is a utility currently only useful for debugging. Run it with
379 <parameter>--help</parameter> for usage information
380 </para>
381 <indexterm zone="gnupg2 gpgparsemail">
382 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
383 </indexterm>
384 </listitem>
385 </varlistentry>
386
387 <varlistentry id="gpgscm">
388 <term><command>gpgscm</command></term>
389 <listitem>
390 <para>
391 executes the given scheme program or spawns an interactive shell
392 </para>
393 <indexterm zone="gnupg2 gpgscm">
394 <primary sortas="b-gpgscm">gpgscm</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="gpgsm">
400 <term><command>gpgsm</command></term>
401 <listitem>
402 <para>
403 is a tool similar to <command>gpg</command> used to provide
404 digital encryption and signing services on X.509 certificates and
405 the CMS protocol. It is mainly used as a backend for S/MIME mail
406 processing
407 </para>
408 <indexterm zone="gnupg2 gpgsm">
409 <primary sortas="b-gpgsm">gpgsm</primary>
410 </indexterm>
411 </listitem>
412 </varlistentry>
413
414 <varlistentry id="gpgsplit">
415 <term><command>gpgsplit</command></term>
416 <listitem>
417 <para>
418 splits an OpenPGP message into packets
419 </para>
420 <indexterm zone="gnupg2 gpgsplit">
421 <primary sortas="b-gpgsplit">gpgsplit</primary>
422 </indexterm>
423 </listitem>
424 </varlistentry>
425
426 <varlistentry id="gpgtar">
427 <term><command>gpgtar</command></term>
428 <listitem>
429 <para>
430 is a tool to encrypt or sign files into an archive
431 </para>
432 <indexterm zone="gnupg2 gpgtar">
433 <primary sortas="b-gpgtar">gpgtar</primary>
434 </indexterm>
435 </listitem>
436 </varlistentry>
437
438 <varlistentry id="gpgv">
439 <term><command>gpgv</command></term>
440 <listitem>
441 <para>
442 is a verify only version of <command>gpg</command>
443 </para>
444 <indexterm zone="gnupg2 gpgv">
445 <primary sortas="b-gpgv">gpgv</primary>
446 </indexterm>
447 </listitem>
448 </varlistentry>
449
450 <varlistentry id="gpg-wks-server">
451 <term><command>gpg-wks-server</command></term>
452 <listitem>
453 <para>
454 provides a server for the
455 <application>Web Key Service</application> protocol
456 </para>
457 <indexterm zone="gnupg2 gpg-wks-server">
458 <primary sortas="b-gpg-wks-server">gpg-wks-server</primary>
459 </indexterm>
460 </listitem>
461 </varlistentry>
462
463 <varlistentry id="gpg-zip">
464 <term><command>gpg-zip</command></term>
465 <listitem>
466 <para>
467 encrypts or signs files into an archive
468 </para>
469 <indexterm zone="gnupg2 gpg-zip">
470 <primary sortas="b-gpg-zip">gpg-zip</primary>
471 </indexterm>
472 </listitem>
473 </varlistentry>
474
475 <varlistentry id="kbxutil">
476 <term><command>kbxutil</command></term>
477 <listitem>
478 <para>
479 is used to list, export and import Keybox data
480 </para>
481 <indexterm zone="gnupg2 kbxutil">
482 <primary sortas="b-kbxutil">kbxutil</primary>
483 </indexterm>
484 </listitem>
485 </varlistentry>
486
487 <!--
488 <varlistentry id="symcryptrun">
489 <term><command>symcryptrun</command></term>
490 <listitem>
491 <para>
492 is a simple symmetric encryption tool.
493 </para>
494 <indexterm zone="gnupg2 symcryptrun">
495 <primary sortas="b-symcryptrun">symcryptrun</primary>
496 </indexterm>
497 </listitem>
498 </varlistentry>
499-->
500 <varlistentry id="watchgnupg">
501 <term><command>watchgnupg</command></term>
502 <listitem>
503 <para>
504 is used to listen to a Unix Domain socket created by any of
505 the GnuPG tools
506 </para>
507 <indexterm zone="gnupg2 watchgnupg">
508 <primary sortas="b-watchgnupg">watchgnupg</primary>
509 </indexterm>
510 </listitem>
511 </varlistentry>
512
513 </variablelist>
514
515 </sect2>
516
517</sect1>
Note: See TracBrowser for help on using the repository browser.