source: postlfs/security/gnupg2.xml@ 224c3b2

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.9 8.0 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 nosym 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 224c3b2 was 3af9e1e9, checked in by Fernando de Oliveira <fernando@…>, 8 years ago
  • Update to gnupg-2.1.10.
  • Update to Archive-Zip-1.55 (perl module).
  • Update to XML-Simple-2.22 (perl module).
  • Update to gtk+-3.18.6 (gtk+3.18.6).

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

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