source: postlfs/security/gnupg2.xml@ d4bfff1f

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt perl-modules 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 d4bfff1f was a9603c8, checked in by DJ Lucas <dj@…>, 7 years ago

s/We/The BLFS editors/

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@18475 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="libusb-compat"/>,
85 an <xref linkend="server-mail"/>,
86 <xref linkend="openldap"/>,
87 <xref linkend="sqlite"/>,
88 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>), and
89 <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
90 adns</ulink>
91 </para>
92
93 <para condition="html" role="usernotes">User Notes:
94 <ulink url="&blfs-wiki;/gnupg2"/></para>
95
96 </sect2>
97
98 <sect2 role="installation">
99 <title>Installation of GnuPG</title>
100
101 <warning>
102 <para>
103 If you are upgrading from gnupg prior to version 2.1, upstream
104 developers recommend to backup
105 <filename class="directory">~/.gnupg</filename>, because some additional
106 configuration will probably be necessary, and you could lose your keys.
107 You can find instructions at
108 <ulink url="http://jo-ke.name/wp/?p=111"></ulink> and
109 <ulink url="https://wiki.archlinux.org/index.php/GnuPG#.22Lost.22_keys.2C_upgrading_to_gnupg_version_2.1"></ulink>.
110 </para>
111 </warning>
112
113 <para>If the top directory path where the source is unpacked contains
114 symbolic links, the openpgp tests may fail. If this is your case and
115 you wish to run the test suite, fix that with:</para>
116
117<screen><userinput>sed -e '/noinst_SCRIPTS = gpg-zip/c sbin_SCRIPTS += gpg-zip' \
118 -i tools/Makefile.in</userinput></screen>
119
120 <para>Some tests will hang infinitely without modifications. If you will
121 run the tests, comment the failing portions of the tests:</para>
122
123<screen><userinput>sed -i -e '/^ test_agent_protect/s:^://:' agent/t-protect.c &amp;&amp;
124sed -i -e '174,186 s/^/;;/' tests/openpgp/ecc.scm</userinput></screen>
125
126 <para>Install <application>GnuPG</application> by running the following
127 commands:</para>
128
129<screen><userinput>./configure --prefix=/usr \
130 --enable-symcryptrun \
131 --enable-maintainer-mode \
132 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
133make &amp;&amp;
134
135makeinfo --html --no-split \
136 -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
137makeinfo --plaintext \
138 -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
139
140 <para>If you have <xref linkend="texlive"/>
141 installed and you wish to create documentation in alternate formats,
142 issue the following commands:</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
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><parameter>--enable-maintainer-mode</parameter>: This switch is
197 needed for proper completion of the tests.</para>
198
199 <para><option>--enable-g13</option>: This switch enables building the
200 g13 program.</para>
201
202 </sect2>
203
204 <sect2 role="content">
205 <title>Contents</title>
206
207 <segmentedlist>
208 <segtitle>Installed Programs</segtitle>
209 <segtitle>Installed Libraries</segtitle>
210 <segtitle>Installed Directories</segtitle>
211
212 <seglistitem>
213 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13,
214 gpg-agent, gpg-connect-agent, gpg, gpg2, gpgconf, gpgparsemail,
215 gpgscm, gpgsm, gpgtar, gpgv, gpgv2, igpg-zip, kbxutil, symcryptrun,
216 and watchgnupg</seg>
217 <seg>None</seg>
218 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
219 /usr/share/gnupg</seg>
220 </seglistitem>
221 </segmentedlist>
222
223 <variablelist>
224 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
225 <?dbfo list-presentation="list"?>
226 <?dbhtml list-presentation="table"?>
227
228 <varlistentry id="addgnupghome">
229 <term><command>addgnupghome</command></term>
230 <listitem>
231 <para>is used to create and populate user's
232 <filename class='directory'>~/.gnupg</filename> directories</para>
233 <indexterm zone="gnupg2 addgnupghome">
234 <primary sortas="b-addgnupghome">addgnupghome</primary>
235 </indexterm>
236 </listitem>
237 </varlistentry>
238
239 <varlistentry id="applygnupgdefaults">
240 <term><command>applygnupgdefaults</command></term>
241 <listitem>
242 <para>is a wrapper script used to run <command>gpgconf</command>
243 with the <parameter>--apply-defaults</parameter> parameter on all
244 user's GnuPG home directories.</para>
245 <indexterm zone="gnupg2 applygnupgdefaults">
246 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 <varlistentry id="dirmngr">
252 <term><command>dirmngr</command></term>
253 <listitem>
254 <para> is a tool that takes care of accessing the OpenPGP keyservers.
255 </para>
256 <indexterm zone="gnupg2 dirmngr">
257 <primary sortas="b-dirmngr">dirmngr</primary>
258 </indexterm>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry id="dirmngr-client">
263 <term><command>dirmngr-client</command></term>
264 <listitem>
265 <para> is a tool to contact a running dirmngr and test whether a
266 certificate has been revoked. </para>
267 <indexterm zone="gnupg2 dirmngr-client">
268 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="g13">
274 <term><command>g13</command></term>
275 <listitem>
276 <para>is a tool to create, mount or unmount an encrypted file system
277 container (optional).</para>
278 <indexterm zone="gnupg2 g13">
279 <primary sortas="b-g13">g13</primary>
280 </indexterm>
281 </listitem>
282 </varlistentry>
283
284 <varlistentry id="gpg-agent">
285 <term><command>gpg-agent</command></term>
286 <listitem>
287 <para>is a daemon used to manage secret (private) keys independently
288 from any protocol. It is used as a backend for <command>gpg2</command>
289 and <command>gpgsm</command> as well as for a couple of other
290 utilities.</para>
291 <indexterm zone="gnupg2 gpg-agent">
292 <primary sortas="b-gpg-agent">gpg-agent</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="gpg-connect-agent">
298 <term><command>gpg-connect-agent</command></term>
299 <listitem>
300 <para>is a utility used to communicate with a running
301 <command>gpg-agent</command>.</para>
302 <indexterm zone="gnupg2 gpg-connect-agent">
303 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="gpg">
309 <term><command>gpg</command></term>
310 <listitem>
311 <para>(optional) is a symlink to <command>gpg2</command> for
312 compatibility with the first version of GnuPG.</para>
313 <indexterm zone="gnupg2 gpg">
314 <primary sortas="b-gpg">gpg</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="gpg2">
320 <term><command>gpg2</command></term>
321 <listitem>
322 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
323 tool used to provide digital encryption and signing services using
324 the OpenPGP standard.</para>
325 <indexterm zone="gnupg2 gpg2">
326 <primary sortas="b-gpg2">gpg2</primary>
327 </indexterm>
328 </listitem>
329 </varlistentry>
330
331 <varlistentry id="gpgconf">
332 <term><command>gpgconf</command></term>
333 <listitem>
334 <para>is a utility used to automatically and reasonably safely
335 query and modify configuration files in the
336 <filename class='directory'>~/.gnupg</filename> home directory. It is
337 designed not to be invoked manually by the user, but automatically by
338 graphical user interfaces.</para>
339 <indexterm zone="gnupg2 gpgconf">
340 <primary sortas="b-gpgconf">gpgconf</primary>
341 </indexterm>
342 </listitem>
343 </varlistentry>
344
345 <varlistentry id="gpgparsemail">
346 <term><command>gpgparsemail</command></term>
347 <listitem>
348 <para>is a utility currently only useful for debugging. Run it with
349 <parameter>--help</parameter> for usage information.</para>
350 <indexterm zone="gnupg2 gpgparsemail">
351 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
352 </indexterm>
353 </listitem>
354 </varlistentry>
355
356 <varlistentry id="gpgscm">
357 <term><command>gpgscm</command></term>
358 <listitem>
359 <para>executes the given scheme program or spawns an interactive
360 shell.</para>
361 <indexterm zone="gnupg2 gpgscm">
362 <primary sortas="b-gpgscm">gpgscm</primary>
363 </indexterm>
364 </listitem>
365 </varlistentry>
366
367 <varlistentry id="gpgsm">
368 <term><command>gpgsm</command></term>
369 <listitem>
370 <para>is a tool similar to <command>gpg2</command> used to provide
371 digital encryption and signing services on X.509 certificates and the
372 CMS protocol. It is mainly used as a backend for S/MIME mail
373 processing.</para>
374 <indexterm zone="gnupg2 gpgsm">
375 <primary sortas="b-gpgsm">gpgsm</primary>
376 </indexterm>
377 </listitem>
378 </varlistentry>
379
380 <varlistentry id="gpgtar">
381 <term><command>gpgtar</command></term>
382 <listitem>
383 <para> is a tool to encrypt or sign files into an archive.</para>
384 <indexterm zone="gnupg2 gpgtar">
385 <primary sortas="b-gpgtar">gpgtar</primary>
386 </indexterm>
387 </listitem>
388 </varlistentry>
389
390 <varlistentry id="gpgv">
391 <term><command>gpgv</command></term>
392 <listitem>
393 <para>(optional) is a symlink to <command>gpgv2</command> for
394 compatibility with the first version of GnuPG.</para>
395 <indexterm zone="gnupg2 gpgv">
396 <primary sortas="b-gpgv">gpgv</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="gpgv2">
402 <term><command>gpgv2</command></term>
403 <listitem>
404 <para>is a verify only version of <command>gpg2</command>.</para>
405 <indexterm zone="gnupg2 gpgv2">
406 <primary sortas="b-gpgv2">gpgv2</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="gpg-zip">
412 <term><command>gpg-zip</command></term>
413 <listitem>
414 <para> encrypts or signs files into an archive.</para>
415 <indexterm zone="gnupg2 gpg-zip">
416 <primary sortas="b-gpg-zip">gpg-zip</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="kbxutil">
422 <term><command>kbxutil</command></term>
423 <listitem>
424 <para>is used to list, export and import Keybox data.</para>
425 <indexterm zone="gnupg2 kbxutil">
426 <primary sortas="b-kbxutil">kbxutil</primary>
427 </indexterm>
428 </listitem>
429 </varlistentry>
430
431 <varlistentry id="symcryptrun">
432 <term><command>symcryptrun</command></term>
433 <listitem>
434 <para>is a simple symmetric encryption tool.</para>
435 <indexterm zone="gnupg2 symcryptrun">
436 <primary sortas="b-symcryptrun">symcryptrun</primary>
437 </indexterm>
438 </listitem>
439 </varlistentry>
440
441 <varlistentry id="watchgnupg">
442 <term><command>watchgnupg</command></term>
443 <listitem>
444 <para>is used to listen to a Unix Domain socket created by any of
445 the GnuPG tools.</para>
446 <indexterm zone="gnupg2 watchgnupg">
447 <primary sortas="b-watchgnupg">watchgnupg</primary>
448 </indexterm>
449 </listitem>
450 </varlistentry>
451
452 </variablelist>
453
454 </sect2>
455
456</sect1>
Note: See TracBrowser for help on using the repository browser.