source: postlfs/security/gnupg2-systemd.xml@ 2325e9ba

systemd-13485
Last change on this file since 2325e9ba was 2325e9ba, checked in by Douglas R. Reno <renodr@…>, 8 years ago

Update to GnuPG-2.1.10 (merged from trunk r16709)
Update copyright year
Toggle DJ Lucas to a current systemd editor

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/systemd@16826 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 16.5 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.0 MB">
11 <!ENTITY gnupg2-buildsize "112 MB (with tests and documentation included. Add an additional 8 MB for more formats.">
12 <!ENTITY gnupg2-time "0.9 SBU (with tests and documentation)">
13]>
14
15<sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
16 <?dbhtml filename="gnupg.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy: krejzi $</othername>
20 <date>$Date: 2014-10-26 14:56:10 +0100 (Sun, 26 Oct 2014) $</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>
33 The <application>GnuPG</application> package is GNU's tool for secure
34 communication and data storage. It can be used to encrypt data and to
35 create digital signatures. It includes an advanced key management
36 facility and is compliant with the proposed OpenPGP Internet standard
37 as described in RFC2440 and the S/MIME standard as described by several
38 RFCs. GnuPG 2 is the stable version of GnuPG integrating support for
39 OpenPGP and S/MIME.
40 </para>
41
42 &lfs77_checked;
43
44 <bridgehead renderas="sect3">Package Information</bridgehead>
45 <itemizedlist spacing="compact">
46 <listitem>
47 <para>
48 Download (HTTP): <ulink url="&gnupg2-download-http;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download (FTP): <ulink url="&gnupg2-download-ftp;"/>
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download MD5 sum: &gnupg2-md5sum;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Download size: &gnupg2-size;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated disk space required: &gnupg2-buildsize;
69 </para>
70 </listitem>
71 <listitem>
72 <para>
73 Estimated build time: &gnupg2-time;
74 </para>
75 </listitem>
76 </itemizedlist>
77
78 <bridgehead renderas="sect3">GnuPG Dependencies</bridgehead>
79
80 <bridgehead renderas="sect4">Required</bridgehead>
81 <para role="required">
82 <xref linkend="libassuan"/>,
83 <xref linkend="libgcrypt"/>,
84 <xref linkend="libksba"/> and
85 <xref linkend="npth"/>
86 </para>
87
88 <bridgehead renderas="sect4">Recommended</bridgehead>
89 <para role="recommended">
90 <xref linkend="pinentry"/> (Run-time requirement for
91 most of the package's functionality)
92 </para>
93
94 <bridgehead renderas="sect4">Optional</bridgehead>
95 <para role="optional">
96 <xref linkend="curl"/>,
97 <xref linkend="libusb-compat"/>,
98 an <xref linkend="server-mail"/>,
99 <xref linkend="openldap"/>,
100 <xref linkend="sqlite"/>,
101 <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>) and
102 <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
103 ADNS</ulink>
104 </para>
105
106 <para condition="html" role="usernotes">User Notes:
107 <ulink url="&blfs-wiki;/gnupg2"/>
108 </para>
109 </sect2>
110
111 <sect2 role="installation">
112 <title>Installation of GnuPG</title>
113
114 <warning>
115 <para>
116 If you are upgrading from a version of GnuPG prior to 2.1, upstream
117 developers recommend to backup
118 <filename class="directory">~/.gnupg</filename>, because some additional
119 configuration will likely be necessary, and you may lose your keys.
120 You can find instructions for this at
121 <ulink url="http://go-ke.name/wp/?p=111"></ulink>, and
122 <ulink url="https://wiki.archlinux.org/index.php/GnuPG#.22Lost.22_keys.2C_upgrading_to_gnupg_version_2.1"></ulink>.
123 </para>
124 </warning>
125
126 <para>
127 If the directory path where the source is unpacked contains
128 symlinks, the openpgp tests will very likely fail. If this is the case,
129 and you wish to run the test suite, run the following command to fix it:
130 </para>
131
132<screen><userinput>sed -e 's|\(GNUPGHOME\)=\$(abs_builddir)|\1=`/bin/pwd`|' \
133 -i tests/openpgp/Makefile.in</userinput></screen>
134
135 <para>
136 Install <application>GnuPG</application> by running the following
137 commands:
138 </para>
139
140<screen><userinput>./configure --prefix=/usr \
141 --sysconfdir=/etc \
142 --enable-symcryptrun \
143 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
144make &amp;&amp;
145
146makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
147makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
148
149 <para>
150 If you have <xref linkend="texlive"/> installed and you wish
151 to create documentation in alternate formats, issue the
152 following commands:
153 </para>
154
155<screen><userinput>make -C doc pdf ps html</userinput></screen>
156
157 <para>
158 To test the results, issue: <command>make check</command>.
159 </para>
160
161 <para>
162 Now, as the <systemitem class="username">root</systemitem> user:
163 </para>
164
165<screen role="root"><userinput>make install &amp;&amp;
166
167for f in gpg gpgv ; do
168ln -sfv ${f}2 /usr/bin/${f} &amp;&amp;
169ln -sfv ${f}2.1 /usr/share/man/man1/${f}.1
170done &amp;&amp;
171
172install -v -dm755 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
173install -v -m644 doc/gnupg_nochunks.html \
174 /usr/share/doc/gnupg-&gnupg2-version;/gnupg.html &amp;&amp;
175install -v -m644 doc/*.texi doc/gnupg.txt \
176 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
177
178 <para>
179 If you created alternate formats of the documentation, install
180 it using the following command as the
181 <systemitem class="username">root</systemitem> user:
182 </para>
183
184<screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
185 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
186install -v -m644 doc/gnupg.{pdf,dvi,ps} \
187 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
188
189 </sect2>
190
191 <sect2 role="commands">
192 <title>Command Explanations</title>
193
194 <para>
195 <parameter>--enable-symcryptrun</parameter>: This switch enables
196 building the symcryptrun program.
197 </para>
198
199 <para>
200 <parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
201 This switch changes the default documentation directory to
202 <filename class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.
203 </para>
204
205 <para>
206 <parameter>--enable-gl3</parameter>: This switch enables building the
207 gl3 program.
208 </para>
209
210 <para>
211 <command>ln -sfv ...</command>: This command creates symlinks for
212 compatibility with the first version of
213 <application>GnuPG</application>.
214 </para>
215
216 </sect2>
217
218 <sect2 role="content">
219 <title>Contents</title>
220
221 <segmentedlist>
222 <segtitle>Installed Programs</segtitle>
223 <segtitle>Installed Libraries</segtitle>
224 <segtitle>Installed Directories</segtitle>
225
226 <seglistitem>
227 <seg>
228 addgnupghome,
229 applygnupgdefaults,
230 dirmngr,
231 dirmngr-client,
232 gl3,
233 gpg,
234 gpg2,
235 gpg-agent,
236 gpgconf,
237 gpgkey2ssh,
238 gpgparsemail,
239 gpgsm,
240 gpgtar,
241 gpgv,
242 gpgv2,
243 kbxutil,
244 symcryptrun,
245 and watchgnupg
246 </seg>
247 <seg>
248 None
249 </seg>
250 <seg>
251 /usr/share/doc/gnupg-&gnupg2-version; and
252 /usr/share/gnupg
253 </seg>
254 </seglistitem>
255 </segmentedlist>
256
257 <variablelist>
258 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
259 <?dbfo list-presentation="list"?>
260 <?dbhtml list-presentation="table"?>
261
262 <varlistentry id="addgnupghome">
263 <term><command>addgnupghome</command></term>
264 <listitem>
265 <para>
266 is used to create and populate user's
267 <filename class="directory">~/.gnupg</filename> directories.
268 </para>
269 <indexterm zone="gnupg2 addgnupghome">
270 <primary sortas="b-addgnupghome">addgnupghome</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="applygnupgdefaults">
276 <term><command>applygnupgdefaults</command></term>
277 <listitem>
278 <para>
279 is a wrapper script used to run <command>gpgconf</command>
280 with the <parameter>--apply-defaults</parameter> parameter
281 on all user's GnuPG home directories.
282 </para>
283 <indexterm zone="gnupg2 applygnupgdefaults">
284 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
285 </indexterm>
286 </listitem>
287 </varlistentry>
288
289 <varlistentry id="dirmngr">
290 <term><command>dirmngr</command></term>
291 <listitem>
292 <para>
293 is a tool that takes care of accessing the OpenPGP keyservers.
294 </para>
295 <indexterm zone="gnupg2 dirmngr">
296 <primary sortas="b-dirmngr">dirmngr</primary>
297 </indexterm>
298 </listitem>
299 </varlistentry>
300
301 <varlistentry id="dirmngr-client">
302 <term><command>dirmngr-client</command></term>
303 <listitem>
304 <para>
305 is a tool to contact a running dirmngr and test whether a
306 certificate has been revoked.
307 </para>
308 <indexterm zone="gnupg2 dirmngr-client">
309 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
310 </indexterm>
311 </listitem>
312 </varlistentry>
313
314 <varlistentry id="gl3">
315 <term><command>gl3</command></term>
316 <listitem>
317 <para>
318 is a tool to create, mount, or unomunt an encrypted filesystem
319 container (optional).
320 </para>
321 <indexterm zone="gnupg2 gl3">
322 <primary sortas="b-gl3">gl3</primary>
323 </indexterm>
324 </listitem>
325 </varlistentry>
326
327 <varlistentry id="gpg-agent">
328 <term><command>gpg-agent</command></term>
329 <listitem>
330 <para>
331 is a daemon used to manage secret (private) keys independently
332 from any protocol. It is used as a backend for
333 <command>gpg</command> and <command>gpgsm</command> as well as
334 for a couple of other utilities.
335 </para>
336 <indexterm zone="gnupg2 gpg-agent">
337 <primary sortas="b-gpg-agent">gpg-agent</primary>
338 </indexterm>
339 </listitem>
340 </varlistentry>
341
342 <varlistentry id="gpg-connect-agent">
343 <term><command>gpg-connect-agent</command></term>
344 <listitem>
345 <para>
346 is a utility used to communicate with a running
347 <command>gpg-agent</command>.
348 </para>
349 <indexterm zone="gnupg2 gpg-connect-agent">
350 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="gpg">
356 <term><command>gpg</command></term>
357 <listitem>
358 <para>
359 is a symlink to <command>gpg2</command> for compatibility
360 with the first version of <application>GnuPG</application>.
361 </para>
362 <indexterm zone="gnupg2 gpg">
363 <primary sortas="b-gpg">gpg</primary>
364 </indexterm>
365 </listitem>
366 </varlistentry>
367
368 <varlistentry id="gpg2">
369 <term><command>gpg2</command></term>
370 <listitem>
371 <para>
372 is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
373 tool used to provide digital encryption and signing services
374 using the OpenPGP standard.
375 </para>
376 <indexterm zone="gnupg2 gpg2">
377 <primary sortas="b-gpg2">gpg2</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382 <varlistentry id="gpgconf">
383 <term><command>gpgconf</command></term>
384 <listitem>
385 <para>
386 is a utility used to automatically and reasonable safely
387 query and modify configuration files in the
388 <filename class="directory">~/.gnupg</filename> home
389 directory. It is designed not to be invoked manually by
390 the user, but automatically by graphical user interfaces.
391 </para>
392 <indexterm zone="gnupg2 gpgconf">
393 <primary sortas="b-gpgconf">gpgconf</primary>
394 </indexterm>
395 </listitem>
396 </varlistentry>
397
398 <varlistentry id="gpgkey2ssh">
399 <term><command>gpgkey2ssh</command></term>
400 <listitem>
401 <para>is a utility used to get the correctly formated key for
402 ssh usage.</para>
403 <indexterm zone="gnupg2 gpgkey2ssh">
404 <primary sortas="b-gpgkey2ssh">gpgkey2ssh</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="gpgparsemail">
410 <term><command>gpgparsemail</command></term>
411 <listitem>
412 <para>
413 is a utility currently only useful for debugging. Run it with
414 <parameter>--help</parameter> for usage information.
415 </para>
416 <indexterm zone="gnupg2 gpgparsemail">
417 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
418 </indexterm>
419 </listitem>
420 </varlistentry>
421
422 <varlistentry id="gpgsm">
423 <term><command>gpgsm</command></term>
424 <listitem>
425 <para>
426 is a tool similar to <command>gpg</command> used to provide digital
427 encryption and signing services on X.509 certificates and the CMS
428 protocol. It is mainly used as a backend for S/MIME mail processing.
429 </para>
430 <indexterm zone="gnupg2 gpgsm">
431 <primary sortas="b-gpgsm">gpgsm</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="gpgsm-gencert.sh">
437 <term><command>gpgsm-gencert.sh</command></term>
438 <listitem>
439 <para>
440 is a simple tool used to interactively generate a certificate
441 request which will be printed to stdout.
442 </para>
443 <indexterm zone="gnupg2 gpgsm-gencert.sh">
444 <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
445 </indexterm>
446 </listitem>
447 </varlistentry>
448
449 <varlistentry id="gpgv">
450 <term><command>gpgv</command></term>
451 <listitem>
452 <para>
453 is a symlink to <command>gpgv2</command> for compatibility
454 with the first version of <application>GnuPG</application>.
455 </para>
456 <indexterm zone="gnupg2 gpgv">
457 <primary sortas="b-gpgv">gpgv</primary>
458 </indexterm>
459 </listitem>
460 </varlistentry>
461
462 <varlistentry id="gpgv2">
463 <term><command>gpgv2</command></term>
464 <listitem>
465 <para>
466 is a verify only version of <command>gpg2</command>.
467 </para>
468 <indexterm zone="gnupg2 gpgv2">
469 <primary sortas="b-gpgv2">gpgv2</primary>
470 </indexterm>
471 </listitem>
472 </varlistentry>
473
474 <varlistentry id="kbxutil">
475 <term><command>kbxutil</command></term>
476 <listitem>
477 <para>
478 is used to list, export and import Keybox data.
479 </para>
480 <indexterm zone="gnupg2 kbxutil">
481 <primary sortas="b-kbxutil">kbxutil</primary>
482 </indexterm>
483 </listitem>
484 </varlistentry>
485
486 <varlistentry id="symcryptrun">
487 <term><command>symcryptrun</command></term>
488 <listitem>
489 <para>
490 is a simple symmetric encryption tool.
491 </para>
492 <indexterm zone="gnupg2 symcryptrun">
493 <primary sortas="b-symcryptrun">symcryptrun</primary>
494 </indexterm>
495 </listitem>
496 </varlistentry>
497
498 <varlistentry id="watchgnupg">
499 <term><command>watchgnupg</command></term>
500 <listitem>
501 <para>
502 is used to listen to a Unix Domain socket created by any of
503 the GnuPG tools.
504 </para>
505 <indexterm zone="gnupg2 watchgnupg">
506 <primary sortas="b-watchgnupg">watchgnupg</primary>
507 </indexterm>
508 </listitem>
509 </varlistentry>
510
511 </variablelist>
512
513 </sect2>
514
515</sect1>
Note: See TracBrowser for help on using the repository browser.