source: postlfs/security/gnupg2.xml@ eede1a3

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

gnupg: fix build failure without LDAP

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