source: postlfs/security/gnupg2.xml@ 65d86241

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.8 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 65d86241 was 65d86241, checked in by Fernando de Oliveira <fernando@…>, 9 years ago

GnuPG-2.1.4: warning about upgrading to gnupg version 2.1 and
remove "--disable-ldap: This switch is necessary, if OpenLDAP-2.4.40
is not installed. Move OpenLDAP-2.4.40 to Optional".

Changelog: replace some tabs by spaces and reformat.

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

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