source: postlfs/security/gnupg2.xml@ e2d7eb4

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 e2d7eb4 was e2d7eb4, checked in by Douglas R. Reno <renodr@…>, 7 years ago

Tags up to WebKitGTK+

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@19107 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 "86c2304ead54b74a422e76c3f1bc7a91">
10 <!ENTITY gnupg2-size "6.2 MB">
11 <!ENTITY gnupg2-buildsize "107 MB (with makeinfo docs)">
12 <!ENTITY gnupg2-time "0.8 SBU (with makeinfo docs, add 1.4 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 &lfs81_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-compat"/>,
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 to backup
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>If the top directory path where the source is unpacked contains
119 symbolic links, the openpgp tests may fail. If this is your case and
120 you wish to run the test suite, fix that with:</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 --enable-maintainer-mode \
131 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
132make &amp;&amp;
133
134makeinfo --html --no-split \
135 -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
136makeinfo --plaintext \
137 -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
138
139 <para>If you have <xref linkend="texlive"/>
140 installed and you wish to create documentation in alternate formats,
141 issue the following commands:</para>
142
143<screen><userinput>make -C doc pdf ps html</userinput></screen>
144
145 <para>To test the results, issue: <command>make check</command>.</para>
146
147 <para>Note that if you have already installed
148 <application>GnuPG</application>, the instructions below will overwrite
149 <filename>/usr/share/man/man1/gpg-zip.1</filename>. Now, as the
150 <systemitem class="username">root</systemitem> user:</para>
151
152<screen role="root"><userinput>make install &amp;&amp;
153
154install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
155install -v -m644 doc/gnupg_nochunks.html \
156 /usr/share/doc/gnupg-&gnupg2-version;/html/gnupg.html &amp;&amp;
157install -v -m644 doc/*.texi doc/gnupg.txt \
158 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
159<!-- Now intalls as gpg, not gpg2. This should be no longer needed.
160 <para>The BLFS editors recommend the creation of symlinks for compatibility
161 with the first version of GnuPG, because some programs or scripts need
162 them. Issue, as <systemitem class="username">root</systemitem> user:</para>
163
164<screen role="root"><userinput>for f in gpg gpgv
165do
166 ln -svf ${f}2.1 /usr/share/man/man1/$f.1 &amp;&amp;
167 ln -svf ${f}2 /usr/bin/$f
168done
169unset f</userinput></screen>
170-->
171 <para>If you created alternate formats of the documentation, install it
172 using the following command as the
173 <systemitem class="username">root</systemitem> user:</para>
174
175<screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
176 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
177install -v -m644 doc/gnupg.{pdf,dvi,ps} \
178 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
179
180 </sect2>
181
182 <sect2 role="commands">
183 <title>Command Explanations</title>
184
185 <para><command>sed ... tools/Makefile.in</command>:
186 This command is needed to build the gpg-zip program.</para>
187
188 <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
189 This switch changes the default docdir to <filename
190 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
191
192 <para><parameter>--enable-symcryptrun</parameter>: This switch enables
193 building the symcryptrun program.</para>
194
195 <para><parameter>--enable-maintainer-mode</parameter>: This switch is
196 needed for proper completion of the tests.</para>
197
198 <para><option>--enable-g13</option>: This switch enables building the
199 g13 program.</para>
200
201 </sect2>
202
203 <sect2 role="content">
204 <title>Contents</title>
205
206 <segmentedlist>
207 <segtitle>Installed Programs</segtitle>
208 <segtitle>Installed Libraries</segtitle>
209 <segtitle>Installed Directories</segtitle>
210
211 <seglistitem>
212 <seg>addgnupghome, applygnupgdefaults, dirmngr, dirmngr-client, g13,
213 gpg-agent, gpg-connect-agent, gpg, gpgconf, gpgparsemail,
214 gpgscm, gpgsm, gpgtar, gpgv, igpg-zip, kbxutil, symcryptrun,
215 and watchgnupg</seg>
216 <seg>None</seg>
217 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
218 /usr/share/gnupg</seg>
219 </seglistitem>
220 </segmentedlist>
221
222 <variablelist>
223 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
224 <?dbfo list-presentation="list"?>
225 <?dbhtml list-presentation="table"?>
226
227 <varlistentry id="addgnupghome">
228 <term><command>addgnupghome</command></term>
229 <listitem>
230 <para>is used to create and populate user's
231 <filename class='directory'>~/.gnupg</filename> directories</para>
232 <indexterm zone="gnupg2 addgnupghome">
233 <primary sortas="b-addgnupghome">addgnupghome</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237
238 <varlistentry id="applygnupgdefaults">
239 <term><command>applygnupgdefaults</command></term>
240 <listitem>
241 <para>is a wrapper script used to run <command>gpgconf</command>
242 with the <parameter>--apply-defaults</parameter> parameter on all
243 user's GnuPG home directories.</para>
244 <indexterm zone="gnupg2 applygnupgdefaults">
245 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
246 </indexterm>
247 </listitem>
248 </varlistentry>
249
250 <varlistentry id="dirmngr">
251 <term><command>dirmngr</command></term>
252 <listitem>
253 <para> is a tool that takes care of accessing the OpenPGP keyservers.
254 </para>
255 <indexterm zone="gnupg2 dirmngr">
256 <primary sortas="b-dirmngr">dirmngr</primary>
257 </indexterm>
258 </listitem>
259 </varlistentry>
260
261 <varlistentry id="dirmngr-client">
262 <term><command>dirmngr-client</command></term>
263 <listitem>
264 <para> is a tool to contact a running dirmngr and test whether a
265 certificate has been revoked. </para>
266 <indexterm zone="gnupg2 dirmngr-client">
267 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
268 </indexterm>
269 </listitem>
270 </varlistentry>
271
272 <varlistentry id="g13">
273 <term><command>g13</command></term>
274 <listitem>
275 <para>is a tool to create, mount or unmount an encrypted file system
276 container (optional).</para>
277 <indexterm zone="gnupg2 g13">
278 <primary sortas="b-g13">g13</primary>
279 </indexterm>
280 </listitem>
281 </varlistentry>
282
283 <varlistentry id="gpg-agent">
284 <term><command>gpg-agent</command></term>
285 <listitem>
286 <para>is a daemon used to manage secret (private) keys independently
287 from any protocol. It is used as a backend for <command>gpg2</command>
288 and <command>gpgsm</command> as well as for a couple of other
289 utilities.</para>
290 <indexterm zone="gnupg2 gpg-agent">
291 <primary sortas="b-gpg-agent">gpg-agent</primary>
292 </indexterm>
293 </listitem>
294 </varlistentry>
295
296 <varlistentry id="gpg-connect-agent">
297 <term><command>gpg-connect-agent</command></term>
298 <listitem>
299 <para>is a utility used to communicate with a running
300 <command>gpg-agent</command>.</para>
301 <indexterm zone="gnupg2 gpg-connect-agent">
302 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="gpg">
308 <term><command>gpg</command></term>
309 <listitem>
310 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
311 tool used to provide digital encryption and signing services using
312 the OpenPGP standard.</para>
313 <indexterm zone="gnupg2 gpg">
314 <primary sortas="b-gpg">gpg</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 <varlistentry id="gpgconf">
320 <term><command>gpgconf</command></term>
321 <listitem>
322 <para>is a utility used to automatically and reasonably safely
323 query and modify configuration files in the
324 <filename class='directory'>~/.gnupg</filename> home directory. It is
325 designed not to be invoked manually by the user, but automatically by
326 graphical user interfaces.</para>
327 <indexterm zone="gnupg2 gpgconf">
328 <primary sortas="b-gpgconf">gpgconf</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="gpgparsemail">
334 <term><command>gpgparsemail</command></term>
335 <listitem>
336 <para>is a utility currently only useful for debugging. Run it with
337 <parameter>--help</parameter> for usage information.</para>
338 <indexterm zone="gnupg2 gpgparsemail">
339 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="gpgscm">
345 <term><command>gpgscm</command></term>
346 <listitem>
347 <para>executes the given scheme program or spawns an interactive
348 shell.</para>
349 <indexterm zone="gnupg2 gpgscm">
350 <primary sortas="b-gpgscm">gpgscm</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="gpgsm">
356 <term><command>gpgsm</command></term>
357 <listitem>
358 <para>is a tool similar to <command>gpg2</command> used to provide
359 digital encryption and signing services on X.509 certificates and the
360 CMS protocol. It is mainly used as a backend for S/MIME mail
361 processing.</para>
362 <indexterm zone="gnupg2 gpgsm">
363 <primary sortas="b-gpgsm">gpgsm</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="gpgtar">
369 <term><command>gpgtar</command></term>
370 <listitem>
371 <para> is a tool to encrypt or sign files into an archive.</para>
372 <indexterm zone="gnupg2 gpgtar">
373 <primary sortas="b-gpgtar">gpgtar</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="gpgv">
379 <term><command>gpgv</command></term>
380 <listitem>
381 <para>is a verify only version of <command>gpg2</command>.</para>
382 <indexterm zone="gnupg2 gpgv">
383 <primary sortas="b-gpgv">gpgv</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="gpg-zip">
389 <term><command>gpg-zip</command></term>
390 <listitem>
391 <para> encrypts or signs files into an archive.</para>
392 <indexterm zone="gnupg2 gpg-zip">
393 <primary sortas="b-gpg-zip">gpg-zip</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="kbxutil">
399 <term><command>kbxutil</command></term>
400 <listitem>
401 <para>is used to list, export and import Keybox data.</para>
402 <indexterm zone="gnupg2 kbxutil">
403 <primary sortas="b-kbxutil">kbxutil</primary>
404 </indexterm>
405 </listitem>
406 </varlistentry>
407
408 <varlistentry id="symcryptrun">
409 <term><command>symcryptrun</command></term>
410 <listitem>
411 <para>is a simple symmetric encryption tool.</para>
412 <indexterm zone="gnupg2 symcryptrun">
413 <primary sortas="b-symcryptrun">symcryptrun</primary>
414 </indexterm>
415 </listitem>
416 </varlistentry>
417
418 <varlistentry id="watchgnupg">
419 <term><command>watchgnupg</command></term>
420 <listitem>
421 <para>is used to listen to a Unix Domain socket created by any of
422 the GnuPG tools.</para>
423 <indexterm zone="gnupg2 watchgnupg">
424 <primary sortas="b-watchgnupg">watchgnupg</primary>
425 </indexterm>
426 </listitem>
427 </varlistentry>
428
429 </variablelist>
430
431 </sect2>
432
433</sect1>
Note: See TracBrowser for help on using the repository browser.