source: postlfs/security/gnupg2.xml@ 10023bb

10.0 10.1 11.0 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind ken/refactor-virt lazarus perl-modules qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 10023bb was 10023bb, checked in by Pierre Labastie <pieere@…>, 4 years ago

Updates:
gnupg-2.2.5
php-7.2.3
dovecot-2.3.0.1

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

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