source: postlfs/security/gnupg2.xml@ 48bcac9

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 48bcac9 was 48bcac9, checked in by Bruce Dubbs <bdubbs@…>, 2 years ago

Tag dependencies for kf5

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

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