source: postlfs/security/gnupg2.xml@ 894d7107

12.0 12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since 894d7107 was b9567b04, checked in by Xi Ruoyao <xry111@…>, 12 months ago

postlfs: Remove non-exist User Notes link

Part of User Notes removal by
https://www.linuxfromscratch.org/~xry111/remove-nonexist-usernote.sh

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