source: postlfs/security/gnupg2.xml@ 8aeb474

10.0 10.1 11.0 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk upgradedb xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 8aeb474 was 8aeb474, checked in by Bruce Dubbs <bdubbs@…>, 9 years ago

General cleanup. Mostly removing obsolete comments.

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

  • Property mode set to 100644
File size: 12.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 " ">
8 <!ENTITY gnupg2-download-ftp "ftp://ftp.gnupg.org/gcrypt/gnupg/gnupg-&gnupg2-version;.tar.bz2">
9 <!ENTITY gnupg2-md5sum "6a8589381ca1b0c1a921e9955f42b016">
10 <!ENTITY gnupg2-size "4.0 MB">
11 <!ENTITY gnupg2-buildsize "67 MB">
12 <!ENTITY gnupg2-time "1.2 SBU">
13]>
14
15<sect1 id="gnupg2" xreflabel="GnuPG-&gnupg2-version;">
16 <?dbhtml filename="gnupg2.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-2">GnuPG 2</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to GnuPG 2</title>
31
32 <para>The <application>GnuPG 2</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. It does not conflict with an installed <xref linkend="gnupg"/>
39 OpenPGP-only version.</para>
40
41 &lfs72_checked;
42
43 <bridgehead renderas="sect3">Package Information</bridgehead>
44 <itemizedlist spacing="compact">
45 <listitem>
46 <para>Download (HTTP): <ulink url="&gnupg2-download-http;"/></para>
47 </listitem>
48 <listitem>
49 <para>Download (FTP): <ulink url="&gnupg2-download-ftp;"/></para>
50 </listitem>
51 <listitem>
52 <para>Download MD5 sum: &gnupg2-md5sum;</para>
53 </listitem>
54 <listitem>
55 <para>Download size: &gnupg2-size;</para>
56 </listitem>
57 <listitem>
58 <para>Estimated disk space required: &gnupg2-buildsize;</para>
59 </listitem>
60 <listitem>
61 <para>Estimated build time: &gnupg2-time;</para>
62 </listitem>
63 </itemizedlist>
64
65 <!-- <bridgehead renderas="sect3">Additional Downloads</bridgehead>
66 <itemizedlist spacing='compact'>
67 <listitem>
68 <para>Required Patch: <ulink
69 url="&patch-root;/gnupg2-&gnupg2-version;-curl_LDAP-1.patch"/>
70 </para>
71 </listitem>
72 </itemizedlist> -->
73
74 <bridgehead renderas="sect3">GnuPG Dependencies</bridgehead>
75
76 <bridgehead renderas="sect4">Required</bridgehead>
77 <para role="required"><xref linkend="pth"/>,
78 <xref linkend="libassuan"/>,
79 <xref linkend="libgcrypt"/>, and
80 <xref linkend="libksba"/></para>
81
82 <bridgehead renderas="sect4">Recommended</bridgehead>
83 <para role="recommended"><xref linkend="pinentry"/> (Run-time requirement for most of
84 the package's functionality)</para>
85
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional"><xref linkend="openldap"/>,
88 <xref linkend="libusb-compat"/>,
89 <xref linkend="curl"/>,
90 <ulink url="http://www.chiark.greenend.org.uk/~ian/adns/">GNU
91 adns</ulink>, and an
92 <xref linkend="server-mail"/></para>
93
94 <para condition="html" role="usernotes">User Notes:
95 <ulink url="&blfs-wiki;/gnupg2"/></para>
96
97 </sect2>
98
99 <sect2 role="installation">
100 <title>Installation of GnuPG 2</title>
101
102 <para>Install <application>GnuPG 2</application> by running the following
103 commands:</para>
104
105<screen><userinput>./configure --prefix=/usr \
106 --libexecdir=/usr/lib/gnupg2 \
107 --docdir=/usr/share/doc/gnupg-&gnupg2-version; &amp;&amp;
108make
109
110makeinfo --html --no-split -o doc/gnupg_nochunks.html doc/gnupg.texi &amp;&amp;
111makeinfo --plaintext -o doc/gnupg.txt doc/gnupg.texi</userinput></screen>
112
113 <para>If you have <xref linkend="texlive"/>
114 installed and you wish to create documentation in alternate formats,
115 issue the following commands:</para>
116
117<screen><userinput>make -C doc pdf ps html</userinput></screen>
118
119 <para>To test the results, issue: <command>make check</command>.</para>
120
121 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
122
123<screen role="root"><userinput>make install
124
125install -v -m755 -d /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
126install -v -m644 doc/gnupg_nochunks.html \
127 /usr/share/doc/gnupg-&gnupg2-version;/gnupg.html &amp;&amp;
128install -v -m644 doc/*.texi doc/gnupg.txt \
129 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
130
131 <para>If you created alternate formats of the documentation, install it
132 using the following command as the
133 <systemitem class="username">root</systemitem> user:</para>
134
135<screen role="root"><userinput>install -v -m644 doc/gnupg.html/* \
136 /usr/share/doc/gnupg-&gnupg2-version;/html &amp;&amp;
137install -v -m644 doc/gnupg.{pdf,dvi,ps} \
138 /usr/share/doc/gnupg-&gnupg2-version;</userinput></screen>
139
140 </sect2>
141
142 <sect2 role="commands">
143 <title>Command Explanations</title>
144
145 <para><parameter>--libexecdir=/usr/lib/gnupg2</parameter>: This switch
146 creates a <filename class="directory">gnupg</filename> directory in
147 <filename class="directory">/usr/lib</filename> instead of
148 <filename class="directory">/usr/libexec</filename>.</para>
149
150 <para><parameter>--docdir=/usr/share/doc/gnupg-&gnupg2-version;</parameter>:
151 This switch changes the default docdir to <filename
152 class="directory">/usr/share/doc/gnupg-&gnupg2-version;</filename>.</para>
153
154 <para><parameter>--enable-symcryptrun</parameter>: This switch enables
155 building the symcryptrun program.</para>
156
157 <!-- See above why this is no longer included
158 <para><command>chmod -v 4755 /usr/bin/gpg</command>:
159 <command>gpg</command> is installed setuid
160 <systemitem class='username'>root</systemitem> to avoid swapping
161 out sensitive data.</para>
162 -->
163
164 </sect2>
165
166 <sect2 role="content">
167 <title>Contents</title>
168
169 <segmentedlist>
170 <segtitle>Installed Programs</segtitle>
171 <segtitle>Installed Libraries</segtitle>
172 <segtitle>Installed Directories</segtitle>
173
174 <seglistitem>
175 <seg>addgnupghome, applygnupgdefaults, gpg-agent, gpg-connect-agent,
176 gpg2, gpgconf, gpgkey2ssh, gpgparsemail, gpgsm, gpgsm-gencert.sh,
177 gpgv2, kbxutil, scdaemon, symcryptrun, and watchgnupg</seg>
178 <seg>None</seg>
179 <seg>/usr/lib/gnupg2, /usr/share/gnupg and
180 /usr/share/doc/gnupg-&gnupg2-version;</seg>
181 </seglistitem>
182 </segmentedlist>
183
184 <variablelist>
185 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
186 <?dbfo list-presentation="list"?>
187 <?dbhtml list-presentation="table"?>
188
189 <varlistentry id="addgnupghome">
190 <term><command>addgnupghome</command></term>
191 <listitem>
192 <para>is used to create and populate user's
193 <filename class='directory'>~/.gnupg</filename> directories</para>
194 <indexterm zone="gnupg2 addgnupghome">
195 <primary sortas="b-addgnupghome">addgnupghome</primary>
196 </indexterm>
197 </listitem>
198 </varlistentry>
199
200 <varlistentry id="applygnupgdefaults">
201 <term><command>applygnupgdefaults</command></term>
202 <listitem>
203 <para>is a wrapper script used to run <command>gpgconf</command>
204 with the <parameter>--apply-defaults</parameter> parameter on all
205 user's GnuPG home directories.</para>
206 <indexterm zone="gnupg2 applygnupgdefaults">
207 <primary sortas="b-applygnupgdefaults">applygnupgdefaults</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211
212 <varlistentry id="gpg-agent">
213 <term><command>gpg-agent</command></term>
214 <listitem>
215 <para>is a daemon used to manage secret (private) keys independently
216 from any protocol. It is used as a backend for <command>gpg</command>
217 and <command>gpgsm</command> as well as for a couple of other
218 utilities.</para>
219 <indexterm zone="gnupg2 gpg-agent">
220 <primary sortas="b-gpg-agent">gpg-agent</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224
225 <varlistentry id="gpg-connect-agent">
226 <term><command>gpg-connect-agent</command></term>
227 <listitem>
228 <para>is a utility used to communicate with a running
229 <command>gpg-agent</command>.</para>
230 <indexterm zone="gnupg2 gpg-connect-agent">
231 <primary sortas="b-gpg-connect-agent">gpg-connect-agent</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="gpg2">
237 <term><command>gpg2</command></term>
238 <listitem>
239 <para>is the OpenPGP part of the GNU Privacy Guard (GnuPG). It is a
240 tool used to provide digital encryption and signing services using
241 the OpenPGP standard.</para>
242 <indexterm zone="gnupg2 gpg2">
243 <primary sortas="b-gpg2">gpg2</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="gpgconf">
249 <term><command>gpgconf</command></term>
250 <listitem>
251 <para>is a utility used to automatically and reasonable safely
252 query and modify configuration files in the
253 <filename class='directory'>~/.gnupg</filename> home directory. It is
254 designed not to be invoked manually by the user, but automatically by
255 graphical user interfaces.</para>
256 <indexterm zone="gnupg2 gpgconf">
257 <primary sortas="b-gpgconf">gpgconf</primary>
258 </indexterm>
259 </listitem>
260 </varlistentry>
261
262 <varlistentry id="gpgparsemail">
263 <term><command>gpgparsemail</command></term>
264 <listitem>
265 <para>is a utility currently only useful for debugging. Run it with
266 <parameter>--help</parameter> for usage information.</para>
267 <indexterm zone="gnupg2 gpgparsemail">
268 <primary sortas="b-gpgparsemail">gpgparsemail</primary>
269 </indexterm>
270 </listitem>
271 </varlistentry>
272
273 <varlistentry id="gpgsm">
274 <term><command>gpgsm</command></term>
275 <listitem>
276 <para>is a tool similar to <command>gpg</command> used to provide
277 digital encryption and signing services on X.509 certificates and the
278 CMS protocol. It is mainly used as a backend for S/MIME mail
279 processing.</para>
280 <indexterm zone="gnupg2 gpgsm">
281 <primary sortas="b-gpgsm">gpgsm</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="gpgsm-gencert.sh">
287 <term><command>gpgsm-gencert.sh</command></term>
288 <listitem>
289 <para>is a simple tool used to interactively generate a certificate
290 request which will be printed to stdout.</para>
291 <indexterm zone="gnupg2 gpgsm-gencert.sh">
292 <primary sortas="b-gpgsm-gencert.sh">gpgsm-gencert.sh</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="gpgv2">
298 <term><command>gpgv2</command></term>
299 <listitem>
300 <para>is a verify only version of <command>gpg2</command>.</para>
301 <indexterm zone="gnupg2 gpgv2">
302 <primary sortas="b-gpgv2">gpgv2</primary>
303 </indexterm>
304 </listitem>
305 </varlistentry>
306
307 <varlistentry id="kbxutil">
308 <term><command>kbxutil</command></term>
309 <listitem>
310 <para>is used to list, export and import Keybox data.</para>
311 <indexterm zone="gnupg2 kbxutil">
312 <primary sortas="b-kbxutil">kbxutil</primary>
313 </indexterm>
314 </listitem>
315 </varlistentry>
316
317 <varlistentry id="scdaemon">
318 <term><command>scdaemon</command></term>
319 <listitem>
320 <para>is a daemon used to manage smartcards. It is usually invoked by
321 <command>gpg-agent</command> and in general not used directly.</para>
322 <indexterm zone="gnupg2 scdaemon">
323 <primary sortas="b-scdaemon">scdaemon</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="symcryptrun">
329 <term><command>symcryptrun</command></term>
330 <listitem>
331 <para>is a simple symmetric encryption tool.</para>
332 <indexterm zone="gnupg2 symcryptrun">
333 <primary sortas="b-symcryptrun">symcryptrun</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338 <varlistentry id="watchgnupg">
339 <term><command>watchgnupg</command></term>
340 <listitem>
341 <para>is used to listen to a Unix Domain socket created by any of
342 the GnuPG tools.</para>
343 <indexterm zone="gnupg2 watchgnupg">
344 <primary sortas="b-watchgnupg">watchgnupg</primary>
345 </indexterm>
346 </listitem>
347 </varlistentry>
348
349 </variablelist>
350
351 </sect2>
352
353</sect1>
Note: See TracBrowser for help on using the repository browser.