source: postlfs/security/gnupg2.xml@ ee77a2cd

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 9.0 9.1 kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt 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 ee77a2cd was ee77a2cd, checked in by Xi Ruoyao <xry111@…>, 5 years ago

Update to gnupg-2.2.15

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

  • Property mode set to 100644
File size: 15.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 "3ab87e377aa0af2f463649515bf66508">
10 <!ENTITY gnupg2-size "6.4 MB">
11 <!ENTITY gnupg2-buildsize "117 MB (with all tests; add 24 MB for docs)">
12 <!ENTITY gnupg2-time "0.4 SBU (using parallelism=4; add 0.5 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 &lfs84_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="imagemagick"/> (for the <command>convert</command> utility,
86 used for generating the documentation),
87 <xref linkend="libusb"/>,
88 an <xref linkend="server-mail"/>,
89 <xref linkend="openldap"/>,
90 <xref linkend="sqlite"/>,
91 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>),
92 <ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> (for
93 generating documentation),
94 and <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
95 adns</ulink>
96 </para>
97
98 <para condition="html" role="usernotes">User Notes:
99 <ulink url="&blfs-wiki;/gnupg2"/></para>
100
101 </sect2>
102
103 <sect2 role="installation">
104 <title>Installation of GnuPG</title>
105
106 <warning>
107 <para>
108 If you are upgrading from gnupg prior to version 2.1, upstream
109 developers recommend backing up
110 <filename class="directory">~/.gnupg</filename> because some additional
111 configuration will probably be necessary and you could lose your keys.
112 You can find instructions at
113 <ulink url="http://jo-ke.name/wp/?p=111"></ulink> and
114 <ulink url="https://wiki.archlinux.org/index.php/GnuPG#.22Lost.22_keys.2C_upgrading_to_gnupg_version_2.1"></ulink>.
115 </para>
116 </warning>
117
118 <para>By default GnuPG doesn't install the deprecated gpg-zip script.
119 But it is still needed by some programs. Make GnuPG install it with:
120 </para>
121
122<screen><userinput>sed -e '/noinst_SCRIPTS = gpg-zip/c sbin_SCRIPTS += gpg-zip' \
123 -i tools/Makefile.in</userinput></screen>
124
125 <para>Install <application>GnuPG</application> by running the following
126 commands:</para>
127
128<screen><userinput>./configure --prefix=/usr \
129 --enable-symcryptrun \
130 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
131make &amp;&amp;
132
133makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
134makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
135
136 <para>If you have <xref linkend="texlive"/>
137 installed and you wish to create documentation in alternate formats,
138 issue the following commands
139 (<ulink url="http://mcj.sourceforge.net/">fig2dev</ulink> is needed for
140 the ps format):</para>
141
142<screen><userinput>make -C doc pdf ps html</userinput></screen>
143
144 <para>To test the results, issue: <command>make check</command>.</para>
145
146 <para>Note that if you have already installed
147 <application>GnuPG</application>, the instructions below will overwrite
148 <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
149 <systemitem class="username">root</systemitem> user:</para>
150
151<screen role="root"><userinput>make install &amp;&amp;
152
153install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
154install -v -m644 doc/gnupg_nochunks.html \
155 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
156install -v -m644 doc/*.texi doc/gnupg.txt \
157 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
158<!-- Now intalls as gpg, not gpg2. This should be no longer needed.
159 <para>The BLFS editors recommend the creation of symlinks for compatibility
160 with the first version of GnuPG, because some programs or scripts need
161 them. Issue, as <systemitem class="username">root</systemitem> user:</para>
162
163<screen role="root"><userinput>for f in gpg gpgv
164do
165 ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &amp;&amp;
166 ln -svf ${f}2 /usr/bin/$f
167done
168unset f</userinput></screen>
169-->
170 <para>If you created alternate formats of the documentation, install it
171 using the following command as the
172 <systemitem class="username">root</systemitem> user:</para>
173
174<screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
175 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
176install -v -m644 doc/gnupg.{pdf,dvi,ps} \
177 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
178
179 </sect2>
180
181 <sect2 role="commands">
182 <title>Command Explanations</title>
183
184 <para><command>sed ... tools/Makefile.in</command>:
185 This command is needed to build the gpg-zip program.</para>
186
187 <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
188 This switch changes the default docdir to <filename
189 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
190
191 <para><parameter>--enable-symcryptrun</parameter>: This switch enables
192 building the symcryptrun program.</para>
193
194 <para>
195 <option>--enable-all-tests</option>: allows more tests to be run with
196 <command>make check</command>.
197 </para>
198
199 <para>
200 <option>--enable-g13</option>: This switch enables building the
201 g13 program.
202 </para>
203
204 </sect2>
205
206 <sect2 role="content">
207 <title>Contents</title>
208
209 <segmentedlist>
210 <segtitle>Installed Programs</segtitle>
211 <segtitle>Installed Libraries</segtitle>
212 <segtitle>Installed Directories</segtitle>
213
214 <seglistitem>
215 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13
216 (optional), gpg-agent, gpg-connect-agent, gpg, gpgconf, gpgparsemail,
217 gpgscm, gpgsm, gpgtar, gpgv, gpg-zip, kbxutil, symcryptrun,
218 and watchgnupg</seg>
219 <seg>None</seg>
220 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
221 /usr/share/gnupg</seg>
222 </seglistitem>
223 </segmentedlist>
224
225 <variablelist>
226 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
227 <?dbfo list-presentation="list"?>
228 <?dbhtml list-presentation="table"?>
229
230 <varlistentry id="addgnupghome">
231 <term><command>addgnupghome</command></term>
232 <listitem>
233 <para>is used to create and populate user's
234 <filename class='directory'>~/.gnupg</filename> directories</para>
235 <indexterm zone="gnupg2 addgnupghome">
236 <primary sortas="b-addgnupghome">addgnupghome</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="applygnupgdefaults">
242 <term><command>applygnupgdefaults</command></term>
243 <listitem>
244 <para>is a wrapper script used to run <command>gpgconf</command>
245 with the <parameter>--apply-defaults</parameter> parameter on all
246 user's GnuPG home directories.</para>
247 <indexterm zone="gnupg2 applygnupgdefaults">
248 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="dirmngr">
254 <term><command>dirmngr</command></term>
255 <listitem>
256 <para> is a tool that takes care of accessing the OpenPGP keyservers.
257 </para>
258 <indexterm zone="gnupg2 dirmngr">
259 <primary sortas="b-dirmngr">dirmngr</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="dirmngr-client">
265 <term><command>dirmngr-client</command></term>
266 <listitem>
267 <para> is a tool to contact a running dirmngr and test whether a
268 certificate has been revoked. </para>
269 <indexterm zone="gnupg2 dirmngr-client">
270 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="g13">
276 <term><command>g13</command></term>
277 <listitem>
278 <para>is a tool to create, mount or unmount an encrypted file system
279 container (optional).</para>
280 <indexterm zone="gnupg2 g13">
281 <primary sortas="b-g13">g13</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="gpg-agent">
287 <term><command>gpg-agent</command></term>
288 <listitem>
289 <para>is a daemon used to manage secret (private) keys independently
290 from any protocol. It is used as a backend for <command>gpg2</command>
291 and <command>gpgsm</command> as well as for a couple of other
292 utilities.</para>
293 <indexterm zone="gnupg2 gpg-agent">
294 <primary sortas="b-gpg-agent">gpg-agent</primary>
295 </indexterm>
296 </listitem>
297 </varlistentry>
298
299 <varlistentry id="gpg-connect-agent">
300 <term><command>gpg-connect-agent</command></term>
301 <listitem>
302 <para>is a utility used to communicate with a running
303 <command>gpg-agent</command>.</para>
304 <indexterm zone="gnupg2 gpg-connect-agent">
305 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
306 </indexterm>
307 </listitem>
308 </varlistentry>
309
310 <varlistentry id="gpg">
311 <term><command>gpg</command></term>
312 <listitem>
313 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
314 tool used to provide digital encryption and signing services using
315 the OpenPGP standard.</para>
316 <indexterm zone="gnupg2 gpg">
317 <primary sortas="b-gpg">gpg</primary>
318 </indexterm>
319 </listitem>
320 </varlistentry>
321
322 <varlistentry id="gpgconf">
323 <term><command>gpgconf</command></term>
324 <listitem>
325 <para>is a utility used to automatically and reasonably safely
326 query and modify configuration files in the
327 <filename class='directory'>~/.gnupg</filename> home directory. It is
328 designed not to be invoked manually by the user, but automatically by
329 graphical user interfaces.</para>
330 <indexterm zone="gnupg2 gpgconf">
331 <primary sortas="b-gpgconf">gpgconf</primary>
332 </indexterm>
333 </listitem>
334 </varlistentry>
335
336 <varlistentry id="gpgparsemail">
337 <term><command>gpgparsemail</command></term>
338 <listitem>
339 <para>is a utility currently only useful for debugging. Run it with
340 <parameter>--help</parameter> for usage information.</para>
341 <indexterm zone="gnupg2 gpgparsemail">
342 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
343 </indexterm>
344 </listitem>
345 </varlistentry>
346
347 <varlistentry id="gpgscm">
348 <term><command>gpgscm</command></term>
349 <listitem>
350 <para>executes the given scheme program or spawns an interactive
351 shell.</para>
352 <indexterm zone="gnupg2 gpgscm">
353 <primary sortas="b-gpgscm">gpgscm</primary>
354 </indexterm>
355 </listitem>
356 </varlistentry>
357
358 <varlistentry id="gpgsm">
359 <term><command>gpgsm</command></term>
360 <listitem>
361 <para>is a tool similar to <command>gpg2</command> used to provide
362 digital encryption and signing services on X.509 certificates and the
363 CMS protocol. It is mainly used as a backend for S/MIME mail
364 processing.</para>
365 <indexterm zone="gnupg2 gpgsm">
366 <primary sortas="b-gpgsm">gpgsm</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="gpgtar">
372 <term><command>gpgtar</command></term>
373 <listitem>
374 <para> is a tool to encrypt or sign files into an archive.</para>
375 <indexterm zone="gnupg2 gpgtar">
376 <primary sortas="b-gpgtar">gpgtar</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="gpgv">
382 <term><command>gpgv</command></term>
383 <listitem>
384 <para>is a verify only version of <command>gpg2</command>.</para>
385 <indexterm zone="gnupg2 gpgv">
386 <primary sortas="b-gpgv">gpgv</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="gpg-zip">
392 <term><command>gpg-zip</command></term>
393 <listitem>
394 <para> encrypts or signs files into an archive.</para>
395 <indexterm zone="gnupg2 gpg-zip">
396 <primary sortas="b-gpg-zip">gpg-zip</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="kbxutil">
402 <term><command>kbxutil</command></term>
403 <listitem>
404 <para>is used to list, export and import Keybox data.</para>
405 <indexterm zone="gnupg2 kbxutil">
406 <primary sortas="b-kbxutil">kbxutil</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410
411 <varlistentry id="symcryptrun">
412 <term><command>symcryptrun</command></term>
413 <listitem>
414 <para>is a simple symmetric encryption tool.</para>
415 <indexterm zone="gnupg2 symcryptrun">
416 <primary sortas="b-symcryptrun">symcryptrun</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="watchgnupg">
422 <term><command>watchgnupg</command></term>
423 <listitem>
424 <para>is used to listen to a Unix Domain socket created by any of
425 the GnuPG tools.</para>
426 <indexterm zone="gnupg2 watchgnupg">
427 <primary sortas="b-watchgnupg">watchgnupg</primary>
428 </indexterm>
429 </listitem>
430 </varlistentry>
431
432 </variablelist>
433
434 </sect2>
435
436</sect1>
Note: See TracBrowser for help on using the repository browser.