source: postlfs/security/gnupg2.xml@ 70069a9

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 xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 70069a9 was 70069a9, checked in by Bruce Dubbs <bdubbs@…>, 18 months ago

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