source: postlfs/security/gnupg2.xml@ c5353a8

10.0 10.1 11.0 11.1 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind lazarus perl-modules qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since c5353a8 was c5353a8, checked in by Bruce Dubbs <bdubbs@…>, 5 years ago

Add GnuTLS as an optional dependency of GnuPG.
Update libcdio aux file to libcdio-paranoia-10.2+0.94+1.
Update to Text-BibTeX-0.80 (Perl Mopdule).
Update to Net-DNS-1.09 (Perl Module).
Update to git 2.12.2.
Update to nspr 4.14.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18535 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • 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 "https://gnupg.org/ftp/gcrypt/gnupg/gnupg-&gnupg2-version;.tar.bz2">
8 <!ENTITY gnupg2-download-ftp "ftp://ftp.gnupg.org/gcrypt/gnupg/gnupg-&gnupg2-version;.tar.bz2">
9 <!ENTITY gnupg2-md5sum "57b16a11951d408ce995e34dd8852285">
10 <!ENTITY gnupg2-size "6.1 MB">
11 <!ENTITY gnupg2-buildsize "107 MB (with makeinfo docs)">
12 <!ENTITY gnupg2-time "0.8 SBU (with makeinfo docs, add 1.2 SBU for tests)">
13]>
14
15<sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
16 <?dbhtml filename="gnupg.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>GnuPG-&gnupg2-version;</title>
24
25 <indexterm zone="gnupg2">
26 <primary sortas="a-GnuPG">GnuPG</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to GnuPG</title>
31
32 <para>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.</para>
39
40 &lfs80_checked;
41
42 <bridgehead renderas="sect3">Package Information</bridgehead>
43 <itemizedlist spacing="compact">
44 <listitem>
45 <para>Download (HTTP): <ulink url="&gnupg2-download-http;"/></para>
46 </listitem>
47 <listitem>
48 <para>Download (FTP): <ulink url="&gnupg2-download-ftp;"/></para>
49 </listitem>
50 <listitem>
51 <para>Download MD5 sum: &gnupg2-md5sum;</para>
52 </listitem>
53 <listitem>
54 <para>Download size: &gnupg2-size;</para>
55 </listitem>
56 <listitem>
57 <para>Estimated disk space required: &gnupg2-buildsize;</para>
58 </listitem>
59 <listitem>
60 <para>Estimated build time: &gnupg2-time;</para>
61 </listitem>
62 </itemizedlist>
63
64 <bridgehead renderas="sect3">GnuPG 2 Dependencies</bridgehead>
65
66 <bridgehead renderas="sect4">Required</bridgehead>
67 <para role="required">
68 <xref linkend="libassuan"/>,
69 <xref linkend="libgcrypt"/>,
70 <xref linkend="libgpg-error"/>,
71 <xref linkend="libksba"/>, and
72 <xref linkend="npth"/>
73 </para>
74
75 <bridgehead renderas="sect4">Recommended</bridgehead>
76 <para role="recommended">
77 <xref linkend="pinentry"/> (Run-time requirement for most of
78 the package's functionality)
79 </para>
80
81 <bridgehead renderas="sect4">Optional</bridgehead>
82 <para role="optional">
83 <xref linkend="curl"/>,
84 <xref linkend="gnutls"/>,
85 <xref linkend="libusb-compat"/>,
86 an <xref linkend="server-mail"/>,
87 <xref linkend="openldap"/>,
88 <xref linkend="sqlite"/>,
89 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>), and
90 <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
91 adns</ulink>
92 </para>
93
94 <para condition="html" role="usernotes">User Notes:
95 <ulink url="&blfs-wiki;/gnupg2"/></para>
96
97 </sect2>
98
99 <sect2 role="installation">
100 <title>Installation of GnuPG</title>
101
102 <warning>
103 <para>
104 If you are upgrading from gnupg prior to version 2.1, upstream
105 developers recommend to backup
106 <filename class="directory">~/.gnupg</filename>, because some additional
107 configuration will probably be necessary, and you could lose your keys.
108 You can find instructions at
109 <ulink url="http://jo-ke.name/wp/?p=111"></ulink> and
110 <ulink url="https://wiki.archlinux.org/index.php/GnuPG#.22Lost.22_keys.2C_upgrading_to_gnupg_version_2.1"></ulink>.
111 </para>
112 </warning>
113
114 <para>If the top directory path where the source is unpacked contains
115 symbolic links, the openpgp tests may fail. If this is your case and
116 you wish to run the test suite, fix that with:</para>
117
118<screen><userinput>sed -e '/noinst_SCRIPTS = gpg-zip/c sbin_SCRIPTS += gpg-zip' \
119 -i tools/Makefile.in</userinput></screen>
120
121 <para>Some tests will hang infinitely without modifications. If you will
122 run the tests, comment the failing portions of the tests:</para>
123
124<screen><userinput>sed -i -e '/^ test_agent_protect/s:^://:' agent/t-protect.c &amp;&amp;
125sed -i -e '174,186 s/^/;;/' tests/openpgp/ecc.scm</userinput></screen>
126
127 <para>Install <application>GnuPG</application> by running the following
128 commands:</para>
129
130<screen><userinput>./configure --prefix=/usr \
131 --enable-symcryptrun \
132 --enable-maintainer-mode \
133 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
134make &amp;&amp;
135
136makeinfo --html --no-split \
137 -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
138makeinfo --plaintext \
139 -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
140
141 <para>If you have <xref linkend="texlive"/>
142 installed and you wish to create documentation in alternate formats,
143 issue the following commands:</para>
144
145<screen><userinput>make -C doc pdf ps html</userinput></screen>
146
147 <para>To test the results, issue: <command>make check</command>.</para>
148
149 <para>Note that if you have already installed
150 <application>GnuPG</application>, the instructions below will overwrite
151 <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
152 <systemitem class="username">root</systemitem> user:</para>
153
154<screen role="root"><userinput>make install &amp;&amp;
155
156install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
157install -v -m644 doc/gnupg_nochunks.html \
158 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
159install -v -m644 doc/*.texi doc/gnupg.txt \
160 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
161
162 <para>The BLFS editors recommend the creation of symlinks for compatibility
163 with the first version of GnuPG, because some programs or scripts need
164 them. Issue, as <systemitem class="username">root</systemitem> user:</para>
165
166<screen role="root"><userinput>for f in gpg gpgv
167do
168 ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &amp;&amp;
169 ln -svf ${f}2 /usr/bin/$f
170done
171unset f</userinput></screen>
172
173 <para>If you created alternate formats of the documentation, install it
174 using the following command as the
175 <systemitem class="username">root</systemitem> user:</para>
176
177<screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
178 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
179install -v -m644 doc/gnupg.{pdf,dvi,ps} \
180 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
181
182 </sect2>
183
184 <sect2 role="commands">
185 <title>Command Explanations</title>
186
187 <para><command>sed ... tools/Makefile.in</command>:
188 This command is needed to build the gpg-zip program.</para>
189
190 <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
191 This switch changes the default docdir to <filename
192 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
193
194 <para><parameter>--enable-symcryptrun</parameter>: This switch enables
195 building the symcryptrun program.</para>
196
197 <para><parameter>--enable-maintainer-mode</parameter>: This switch is
198 needed for proper completion of the tests.</para>
199
200 <para><option>--enable-g13</option>: This switch enables building the
201 g13 program.</para>
202
203 </sect2>
204
205 <sect2 role="content">
206 <title>Contents</title>
207
208 <segmentedlist>
209 <segtitle>Installed Programs</segtitle>
210 <segtitle>Installed Libraries</segtitle>
211 <segtitle>Installed Directories</segtitle>
212
213 <seglistitem>
214 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13,
215 gpg-agent, gpg-connect-agent, gpg, gpg2, gpgconf, gpgparsemail,
216 gpgscm, gpgsm, gpgtar, gpgv, gpgv2, igpg-zip, kbxutil, symcryptrun,
217 and watchgnupg</seg>
218 <seg>None</seg>
219 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
220 /usr/share/gnupg</seg>
221 </seglistitem>
222 </segmentedlist>
223
224 <variablelist>
225 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
226 <?dbfo list-presentation="list"?>
227 <?dbhtml list-presentation="table"?>
228
229 <varlistentry id="addgnupghome">
230 <term><command>addgnupghome</command></term>
231 <listitem>
232 <para>is used to create and populate user's
233 <filename class='directory'>~/.gnupg</filename> directories</para>
234 <indexterm zone="gnupg2 addgnupghome">
235 <primary sortas="b-addgnupghome">addgnupghome</primary>
236 </indexterm>
237 </listitem>
238 </varlistentry>
239
240 <varlistentry id="applygnupgdefaults">
241 <term><command>applygnupgdefaults</command></term>
242 <listitem>
243 <para>is a wrapper script used to run <command>gpgconf</command>
244 with the <parameter>--apply-defaults</parameter> parameter on all
245 user's GnuPG home directories.</para>
246 <indexterm zone="gnupg2 applygnupgdefaults">
247 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
248 </indexterm>
249 </listitem>
250 </varlistentry>
251
252 <varlistentry id="dirmngr">
253 <term><command>dirmngr</command></term>
254 <listitem>
255 <para> is a tool that takes care of accessing the OpenPGP keyservers.
256 </para>
257 <indexterm zone="gnupg2 dirmngr">
258 <primary sortas="b-dirmngr">dirmngr</primary>
259 </indexterm>
260 </listitem>
261 </varlistentry>
262
263 <varlistentry id="dirmngr-client">
264 <term><command>dirmngr-client</command></term>
265 <listitem>
266 <para> is a tool to contact a running dirmngr and test whether a
267 certificate has been revoked. </para>
268 <indexterm zone="gnupg2 dirmngr-client">
269 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="g13">
275 <term><command>g13</command></term>
276 <listitem>
277 <para>is a tool to create, mount or unmount an encrypted file system
278 container (optional).</para>
279 <indexterm zone="gnupg2 g13">
280 <primary sortas="b-g13">g13</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="gpg-agent">
286 <term><command>gpg-agent</command></term>
287 <listitem>
288 <para>is a daemon used to manage secret (private) keys independently
289 from any protocol. It is used as a backend for <command>gpg2</command>
290 and <command>gpgsm</command> as well as for a couple of other
291 utilities.</para>
292 <indexterm zone="gnupg2 gpg-agent">
293 <primary sortas="b-gpg-agent">gpg-agent</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="gpg-connect-agent">
299 <term><command>gpg-connect-agent</command></term>
300 <listitem>
301 <para>is a utility used to communicate with a running
302 <command>gpg-agent</command>.</para>
303 <indexterm zone="gnupg2 gpg-connect-agent">
304 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
305 </indexterm>
306 </listitem>
307 </varlistentry>
308
309 <varlistentry id="gpg">
310 <term><command>gpg</command></term>
311 <listitem>
312 <para>(optional) is a symlink to <command>gpg2</command> for
313 compatibility with the first version of GnuPG.</para>
314 <indexterm zone="gnupg2 gpg">
315 <primary sortas="b-gpg">gpg</primary>
316 </indexterm>
317 </listitem>
318 </varlistentry>
319
320 <varlistentry id="gpg2">
321 <term><command>gpg2</command></term>
322 <listitem>
323 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
324 tool used to provide digital encryption and signing services using
325 the OpenPGP standard.</para>
326 <indexterm zone="gnupg2 gpg2">
327 <primary sortas="b-gpg2">gpg2</primary>
328 </indexterm>
329 </listitem>
330 </varlistentry>
331
332 <varlistentry id="gpgconf">
333 <term><command>gpgconf</command></term>
334 <listitem>
335 <para>is a utility used to automatically and reasonably safely
336 query and modify configuration files in the
337 <filename class='directory'>~/.gnupg</filename> home directory. It is
338 designed not to be invoked manually by the user, but automatically by
339 graphical user interfaces.</para>
340 <indexterm zone="gnupg2 gpgconf">
341 <primary sortas="b-gpgconf">gpgconf</primary>
342 </indexterm>
343 </listitem>
344 </varlistentry>
345
346 <varlistentry id="gpgparsemail">
347 <term><command>gpgparsemail</command></term>
348 <listitem>
349 <para>is a utility currently only useful for debugging. Run it with
350 <parameter>--help</parameter> for usage information.</para>
351 <indexterm zone="gnupg2 gpgparsemail">
352 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
353 </indexterm>
354 </listitem>
355 </varlistentry>
356
357 <varlistentry id="gpgscm">
358 <term><command>gpgscm</command></term>
359 <listitem>
360 <para>executes the given scheme program or spawns an interactive
361 shell.</para>
362 <indexterm zone="gnupg2 gpgscm">
363 <primary sortas="b-gpgscm">gpgscm</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="gpgsm">
369 <term><command>gpgsm</command></term>
370 <listitem>
371 <para>is a tool similar to <command>gpg2</command> used to provide
372 digital encryption and signing services on X.509 certificates and the
373 CMS protocol. It is mainly used as a backend for S/MIME mail
374 processing.</para>
375 <indexterm zone="gnupg2 gpgsm">
376 <primary sortas="b-gpgsm">gpgsm</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="gpgtar">
382 <term><command>gpgtar</command></term>
383 <listitem>
384 <para> is a tool to encrypt or sign files into an archive.</para>
385 <indexterm zone="gnupg2 gpgtar">
386 <primary sortas="b-gpgtar">gpgtar</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="gpgv">
392 <term><command>gpgv</command></term>
393 <listitem>
394 <para>(optional) is a symlink to <command>gpgv2</command> for
395 compatibility with the first version of GnuPG.</para>
396 <indexterm zone="gnupg2 gpgv">
397 <primary sortas="b-gpgv">gpgv</primary>
398 </indexterm>
399 </listitem>
400 </varlistentry>
401
402 <varlistentry id="gpgv2">
403 <term><command>gpgv2</command></term>
404 <listitem>
405 <para>is a verify only version of <command>gpg2</command>.</para>
406 <indexterm zone="gnupg2 gpgv2">
407 <primary sortas="b-gpgv2">gpgv2</primary>
408 </indexterm>
409 </listitem>
410 </varlistentry>
411
412 <varlistentry id="gpg-zip">
413 <term><command>gpg-zip</command></term>
414 <listitem>
415 <para> encrypts or signs files into an archive.</para>
416 <indexterm zone="gnupg2 gpg-zip">
417 <primary sortas="b-gpg-zip">gpg-zip</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="kbxutil">
423 <term><command>kbxutil</command></term>
424 <listitem>
425 <para>is used to list, export and import Keybox data.</para>
426 <indexterm zone="gnupg2 kbxutil">
427 <primary sortas="b-kbxutil">kbxutil</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 <varlistentry id="symcryptrun">
433 <term><command>symcryptrun</command></term>
434 <listitem>
435 <para>is a simple symmetric encryption tool.</para>
436 <indexterm zone="gnupg2 symcryptrun">
437 <primary sortas="b-symcryptrun">symcryptrun</primary>
438 </indexterm>
439 </listitem>
440 </varlistentry>
441
442 <varlistentry id="watchgnupg">
443 <term><command>watchgnupg</command></term>
444 <listitem>
445 <para>is used to listen to a Unix Domain socket created by any of
446 the GnuPG tools.</para>
447 <indexterm zone="gnupg2 watchgnupg">
448 <primary sortas="b-watchgnupg">watchgnupg</primary>
449 </indexterm>
450 </listitem>
451 </varlistentry>
452
453 </variablelist>
454
455 </sect2>
456
457</sect1>
Note: See TracBrowser for help on using the repository browser.