source: postlfs/security/gnupg2.xml@ 28152d6

trunk
Last change on this file since 28152d6 was 28152d6, checked in by Douglas R. Reno <renodr@…>, 7 weeks ago

Update to gnupg-2.2.28

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