source: postlfs/security/gnupg2.xml@ b3f038c6

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 b3f038c6 was b3f038c6, checked in by Ken Moffat <ken@…>, 8 years ago

tags

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

  • Property mode set to 100644
File size: 15.2 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 "873302c475c4c90badb67daac90ebd5d">
10 <!ENTITY gnupg2-size "5 MB">
11 <!ENTITY gnupg2-buildsize "113 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 &lfs79_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, gpgparsemail, gpgsm,
201 gpgtar, gpgv, gpgv2, kbxutil, symcryptrun, and watchgnupg</seg>
202 <seg>None</seg>
203 <seg>/usr/share/doc/gnupg-&gnupg2-version; and
204 /usr/share/gnupg</seg>
205 </seglistitem>
206 </segmentedlist>
207
208 <variablelist>
209 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
210 <?dbfo list-presentation="list"?>
211 <?dbhtml list-presentation="table"?>
212
213 <varlistentry id="addgnupghome">
214 <term><command>addgnupghome</command></term>
215 <listitem>
216 <para>is used to create and populate user's
217 <filename class='directory'>~/.gnupg</filename> directories</para>
218 <indexterm zone="gnupg2 addgnupghome">
219 <primary sortas="b-addgnupghome">addgnupghome</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="applygnupgdefaults">
225 <term><command>applygnupgdefaults</command></term>
226 <listitem>
227 <para>is a wrapper script used to run <command>gpgconf</command>
228 with the <parameter>--apply-defaults</parameter> parameter on all
229 user's GnuPG home directories.</para>
230 <indexterm zone="gnupg2 applygnupgdefaults">
231 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="dirmngr">
237 <term><command>dirmngr</command></term>
238 <listitem>
239 <para> is a tool that takes care of accessing the OpenPGP keyservers.
240 </para>
241 <indexterm zone="gnupg2 dirmngr">
242 <primary sortas="b-dirmngr">dirmngr</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 <varlistentry id="dirmngr-client">
248 <term><command>dirmngr-client</command></term>
249 <listitem>
250 <para> is a tool to contact a running dirmngr and test whether a
251 certificate has been revoked. </para>
252 <indexterm zone="gnupg2 dirmngr-client">
253 <primary sortas="b-dirmngr-client">dirmngr-client</primary>
254 </indexterm>
255 </listitem>
256 </varlistentry>
257
258 <varlistentry id="g13">
259 <term><command>g13</command></term>
260 <listitem>
261 <para>is a tool to create, mount or unmount an encrypted file system
262 container (optional).</para>
263 <indexterm zone="gnupg2 g13">
264 <primary sortas="b-g13">g13</primary>
265 </indexterm>
266 </listitem>
267 </varlistentry>
268
269 <varlistentry id="gpg-agent">
270 <term><command>gpg-agent</command></term>
271 <listitem>
272 <para>is a daemon used to manage secret (private) keys independently
273 from any protocol. It is used as a backend for <command>gpg2</command>
274 and <command>gpgsm</command> as well as for a couple of other
275 utilities.</para>
276 <indexterm zone="gnupg2 gpg-agent">
277 <primary sortas="b-gpg-agent">gpg-agent</primary>
278 </indexterm>
279 </listitem>
280 </varlistentry>
281
282 <varlistentry id="gpg-connect-agent">
283 <term><command>gpg-connect-agent</command></term>
284 <listitem>
285 <para>is a utility used to communicate with a running
286 <command>gpg-agent</command>.</para>
287 <indexterm zone="gnupg2 gpg-connect-agent">
288 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
289 </indexterm>
290 </listitem>
291 </varlistentry>
292
293 <varlistentry id="gpg">
294 <term><command>gpg</command></term>
295 <listitem>
296 <para>(optional) is a symlink to <command>gpg2</command> for
297 compatibility with the first version of GnuPG.</para>
298 <indexterm zone="gnupg2 gpg">
299 <primary sortas="b-gpg">gpg</primary>
300 </indexterm>
301 </listitem>
302 </varlistentry>
303
304 <varlistentry id="gpg2">
305 <term><command>gpg2</command></term>
306 <listitem>
307 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
308 tool used to provide digital encryption and signing services using
309 the OpenPGP standard.</para>
310 <indexterm zone="gnupg2 gpg2">
311 <primary sortas="b-gpg2">gpg2</primary>
312 </indexterm>
313 </listitem>
314 </varlistentry>
315
316 <varlistentry id="gpgconf">
317 <term><command>gpgconf</command></term>
318 <listitem>
319 <para>is a utility used to automatically and reasonably safely
320 query and modify configuration files in the
321 <filename class='directory'>~/.gnupg</filename> home directory. It is
322 designed not to be invoked manually by the user, but automatically by
323 graphical user interfaces.</para>
324 <indexterm zone="gnupg2 gpgconf">
325 <primary sortas="b-gpgconf">gpgconf</primary>
326 </indexterm>
327 </listitem>
328 </varlistentry>
329
330 <varlistentry id="gpgparsemail">
331 <term><command>gpgparsemail</command></term>
332 <listitem>
333 <para>is a utility currently only useful for debugging. Run it with
334 <parameter>--help</parameter> for usage information.</para>
335 <indexterm zone="gnupg2 gpgparsemail">
336 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
337 </indexterm>
338 </listitem>
339 </varlistentry>
340
341 <varlistentry id="gpgsm">
342 <term><command>gpgsm</command></term>
343 <listitem>
344 <para>is a tool similar to <command>gpg2</command> used to provide
345 digital encryption and signing services on X.509 certificates and the
346 CMS protocol. It is mainly used as a backend for S/MIME mail
347 processing.</para>
348 <indexterm zone="gnupg2 gpgsm">
349 <primary sortas="b-gpgsm">gpgsm</primary>
350 </indexterm>
351 </listitem>
352 </varlistentry>
353
354 <varlistentry id="gpgtar">
355 <term><command>gpgtar</command></term>
356 <listitem>
357 <para> is a tool to encrypt or sign files into an archive.</para>
358 <indexterm zone="gnupg2 gpgtar">
359 <primary sortas="b-gpgtar">gpgtar</primary>
360 </indexterm>
361 </listitem>
362 </varlistentry>
363
364 <varlistentry id="gpgv">
365 <term><command>gpgv</command></term>
366 <listitem>
367 <para>(optional) is a symlink to <command>gpgv2</command> for
368 compatibility with the first version of GnuPG.</para>
369 <indexterm zone="gnupg2 gpgv">
370 <primary sortas="b-gpgv">gpgv</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="gpgv2">
376 <term><command>gpgv2</command></term>
377 <listitem>
378 <para>is a verify only version of <command>gpg2</command>.</para>
379 <indexterm zone="gnupg2 gpgv2">
380 <primary sortas="b-gpgv2">gpgv2</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="kbxutil">
386 <term><command>kbxutil</command></term>
387 <listitem>
388 <para>is used to list, export and import Keybox data.</para>
389 <indexterm zone="gnupg2 kbxutil">
390 <primary sortas="b-kbxutil">kbxutil</primary>
391 </indexterm>
392 </listitem>
393 </varlistentry>
394
395 <varlistentry id="symcryptrun">
396 <term><command>symcryptrun</command></term>
397 <listitem>
398 <para>is a simple symmetric encryption tool.</para>
399 <indexterm zone="gnupg2 symcryptrun">
400 <primary sortas="b-symcryptrun">symcryptrun</primary>
401 </indexterm>
402 </listitem>
403 </varlistentry>
404
405 <varlistentry id="watchgnupg">
406 <term><command>watchgnupg</command></term>
407 <listitem>
408 <para>is used to listen to a Unix Domain socket created by any of
409 the GnuPG tools.</para>
410 <indexterm zone="gnupg2 watchgnupg">
411 <primary sortas="b-watchgnupg">watchgnupg</primary>
412 </indexterm>
413 </listitem>
414 </varlistentry>
415
416 </variablelist>
417
418 </sect2>
419
420</sect1>
Note: See TracBrowser for help on using the repository browser.