source: postlfs/security/gnupg2.xml@ b44d89e

10.0 10.1 11.0 11.1 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since b44d89e was b44d89e, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

Update to mercurial-4.9.1.
Update to libgpg-error-1.36.
Update to glibmm-2.60.0.
Update to gnupg-2.2.14.

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

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