[8250d8e] | 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 |
|
---|
[4af8cb5] | 7 | <!ENTITY libgcrypt-download-http " ">
|
---|
[8250d8e] | 8 | <!ENTITY libgcrypt-download-ftp "ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-&libgcrypt-version;.tar.bz2">
|
---|
[b09ed46a] | 9 | <!ENTITY libgcrypt-md5sum "3babc8af8978eeafa1bdbfef066ea943">
|
---|
| 10 | <!ENTITY libgcrypt-size "2.5 MB">
|
---|
| 11 | <!ENTITY libgcrypt-buildsize "46 MB (with tests and building docs)">
|
---|
| 12 | <!ENTITY libgcrypt-time "0.6 SBU (with tests and building docs)">
|
---|
[8250d8e] | 13 | ]>
|
---|
| 14 |
|
---|
[e79ed72] | 15 | <sect1 id="libgcrypt" xreflabel="libgcrypt-&libgcrypt-version;">
|
---|
[8250d8e] | 16 | <?dbhtml filename="libgcrypt.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
[e79ed72] | 23 | <title>libgcrypt-&libgcrypt-version;</title>
|
---|
[8250d8e] | 24 |
|
---|
| 25 | <indexterm zone="libgcrypt">
|
---|
[e79ed72] | 26 | <primary sortas="a-libgcrypt">libgcrypt</primary>
|
---|
[8250d8e] | 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
[e79ed72] | 30 | <title>Introduction to libgcrypt</title>
|
---|
[8250d8e] | 31 |
|
---|
[6d8f6dc] | 32 | <para>
|
---|
| 33 | The <application>libgcrypt</application> package contains a general
|
---|
| 34 | purpose crypto library based on the code used in
|
---|
| 35 | <application>GnuPG</application>. The library provides a high level
|
---|
| 36 | interface to cryptographic building blocks using an extendable and flexible
|
---|
| 37 | API.
|
---|
| 38 | </para>
|
---|
[8250d8e] | 39 |
|
---|
[fea7a37] | 40 | &lfs79_checked;
|
---|
[43c1385] | 41 |
|
---|
[8250d8e] | 42 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 43 | <itemizedlist spacing="compact">
|
---|
| 44 | <listitem>
|
---|
[6d8f6dc] | 45 | <para>
|
---|
| 46 | Download (HTTP): <ulink url="&libgcrypt-download-http;"/>
|
---|
| 47 | </para>
|
---|
[8250d8e] | 48 | </listitem>
|
---|
| 49 | <listitem>
|
---|
[6d8f6dc] | 50 | <para>
|
---|
| 51 | Download (FTP): <ulink url="&libgcrypt-download-ftp;"/>
|
---|
| 52 | </para>
|
---|
[8250d8e] | 53 | </listitem>
|
---|
| 54 | <listitem>
|
---|
[6d8f6dc] | 55 | <para>
|
---|
| 56 | Download MD5 sum: &libgcrypt-md5sum;
|
---|
| 57 | </para>
|
---|
[8250d8e] | 58 | </listitem>
|
---|
| 59 | <listitem>
|
---|
[6d8f6dc] | 60 | <para>
|
---|
| 61 | Download size: &libgcrypt-size;
|
---|
| 62 | </para>
|
---|
[8250d8e] | 63 | </listitem>
|
---|
| 64 | <listitem>
|
---|
[6d8f6dc] | 65 | <para>
|
---|
| 66 | Estimated disk space required: &libgcrypt-buildsize;
|
---|
| 67 | </para>
|
---|
[8250d8e] | 68 | </listitem>
|
---|
| 69 | <listitem>
|
---|
[6d8f6dc] | 70 | <para>
|
---|
| 71 | Estimated build time: &libgcrypt-time;
|
---|
| 72 | </para>
|
---|
[8250d8e] | 73 | </listitem>
|
---|
| 74 | </itemizedlist>
|
---|
| 75 |
|
---|
[e79ed72] | 76 | <bridgehead renderas="sect3">libgcrypt Dependencies</bridgehead>
|
---|
[8250d8e] | 77 |
|
---|
| 78 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[6d8f6dc] | 79 | <para role="required">
|
---|
| 80 | <xref linkend="libgpg-error"/>
|
---|
| 81 | </para>
|
---|
[8250d8e] | 82 |
|
---|
[390e0d7] | 83 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[6d8f6dc] | 84 | <para role="optional">
|
---|
[56605b9] | 85 | <xref linkend="libcap-pam"/> and
|
---|
[d2da67c] | 86 | <xref linkend="pth"/>,
|
---|
| 87 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
|
---|
[6d8f6dc] | 88 | </para>
|
---|
[390e0d7] | 89 |
|
---|
[8250d8e] | 90 | <para condition="html" role="usernotes">User Notes:
|
---|
[6d8f6dc] | 91 | <ulink url="&blfs-wiki;/libgcrypt"/>
|
---|
| 92 | </para>
|
---|
[8250d8e] | 93 | </sect2>
|
---|
| 94 |
|
---|
| 95 | <sect2 role="installation">
|
---|
[e79ed72] | 96 | <title>Installation of libgcrypt</title>
|
---|
[8250d8e] | 97 |
|
---|
[6d8f6dc] | 98 | <para>
|
---|
| 99 | Install <application>libgcrypt</application> by running the
|
---|
| 100 | following commands:
|
---|
| 101 | </para>
|
---|
[8250d8e] | 102 |
|
---|
[9a19f1b] | 103 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[8250d8e] | 104 | make</userinput></screen>
|
---|
| 105 |
|
---|
[6d8f6dc] | 106 | <para>
|
---|
| 107 | Only <command>info</command> documentation is shipped in the package
|
---|
| 108 | tarball. If you wish to build alternate formats of the documentation,
|
---|
| 109 | (you must have <xref linkend="texlive"/> installed to build the PDF
|
---|
| 110 | and PostScript documentation), then issue the following commands:
|
---|
| 111 | </para>
|
---|
[8250d8e] | 112 |
|
---|
[b09ed46a] | 113 | <screen><userinput>make -C doc pdf ps html &&
|
---|
[8250d8e] | 114 | makeinfo --html --no-split -o doc/gcrypt_nochunks.html doc/gcrypt.texi &&
|
---|
| 115 | makeinfo --plaintext -o doc/gcrypt.txt doc/gcrypt.texi</userinput></screen>
|
---|
| 116 |
|
---|
[6d8f6dc] | 117 | <para>
|
---|
| 118 | To test the results, issue: <command>make check</command>.
|
---|
| 119 | </para>
|
---|
[8250d8e] | 120 |
|
---|
[6d8f6dc] | 121 | <para>
|
---|
| 122 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 123 | </para>
|
---|
[8250d8e] | 124 |
|
---|
| 125 | <screen role="root"><userinput>make install &&
|
---|
[6d8f6dc] | 126 | install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
[acb57a0] | 127 | install -v -m644 README doc/{README.apichanges,fips*,libgcrypt*} \
|
---|
| 128 | /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
|
---|
[8250d8e] | 129 |
|
---|
[6d8f6dc] | 130 | <para>
|
---|
| 131 | If you built the additional documentation, install it by issuing the
|
---|
| 132 | following commands as the <systemitem class="username">root</systemitem>
|
---|
| 133 | user:
|
---|
| 134 | </para>
|
---|
[8250d8e] | 135 |
|
---|
[6d8f6dc] | 136 | <screen role="root"><userinput>install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version;/html &&
|
---|
[8250d8e] | 137 | install -v -m644 doc/gcrypt.html/* \
|
---|
| 138 | /usr/share/doc/libgcrypt-&libgcrypt-version;/html &&
|
---|
[390e0d7] | 139 | install -v -m644 doc/gcrypt_nochunks.html \
|
---|
[8250d8e] | 140 | /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
| 141 | install -v -m644 doc/gcrypt.{pdf,ps,dvi,txt,texi} \
|
---|
| 142 | /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
|
---|
| 143 |
|
---|
| 144 | </sect2>
|
---|
| 145 |
|
---|
[1bac96e3] | 146 | <sect2 role="commands">
|
---|
| 147 | <title>Command Explanations</title>
|
---|
| 148 |
|
---|
| 149 | <para>
|
---|
| 150 | <option>--with-capabilities</option>: This option enables libcap2 support.
|
---|
[10a9447] | 151 | Note that this breaks <ulink
|
---|
| 152 | url="https://gitlab.com/cryptsetup/cryptsetup">Cryptsetup</ulink>.
|
---|
[1bac96e3] | 153 | </para>
|
---|
| 154 |
|
---|
| 155 | </sect2>
|
---|
| 156 |
|
---|
[8250d8e] | 157 | <sect2 role="content">
|
---|
| 158 | <title>Contents</title>
|
---|
| 159 |
|
---|
| 160 | <segmentedlist>
|
---|
[390e0d7] | 161 | <segtitle>Installed Programs</segtitle>
|
---|
[d284bee] | 162 | <segtitle>Installed Library</segtitle>
|
---|
[8250d8e] | 163 | <segtitle>Installed Directory</segtitle>
|
---|
| 164 |
|
---|
| 165 | <seglistitem>
|
---|
[6d8f6dc] | 166 | <seg>
|
---|
[9a19f1b] | 167 | dumpsexp, hmac256, libgcrypt-config, and mpicalc
|
---|
[6d8f6dc] | 168 | </seg>
|
---|
| 169 | <seg>
|
---|
| 170 | libgcrypt.so
|
---|
| 171 | </seg>
|
---|
| 172 | <seg>
|
---|
| 173 | /usr/share/doc/libgcrypt-&libgcrypt-version;
|
---|
| 174 | </seg>
|
---|
[8250d8e] | 175 | </seglistitem>
|
---|
| 176 | </segmentedlist>
|
---|
| 177 |
|
---|
| 178 | <variablelist>
|
---|
| 179 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 180 | <?dbfo list-presentation="list"?>
|
---|
| 181 | <?dbhtml list-presentation="table"?>
|
---|
| 182 |
|
---|
[e23d8fcb] | 183 | <varlistentry id="dumpsexp">
|
---|
| 184 | <term><command>dumpsexp</command></term>
|
---|
| 185 | <listitem>
|
---|
| 186 | <para>
|
---|
| 187 | is a debug tool for S-expressions.
|
---|
| 188 | </para>
|
---|
| 189 | <indexterm zone="libgcrypt dumpsexp">
|
---|
| 190 | <primary sortas="b-dumpsexp">dumpsexp</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
[39dd48b] | 195 | <varlistentry id="hmac256">
|
---|
| 196 | <term><command>hmac256</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
| 199 | is a standalone HMAC-SHA-256 implementation used to compute
|
---|
| 200 | an HMAC-SHA-256 authentication code.
|
---|
| 201 | </para>
|
---|
| 202 | <indexterm zone="libgcrypt hmac256">
|
---|
| 203 | <primary sortas="b-hmac256">hmac256</primary>
|
---|
| 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 |
|
---|
[e23d8fcb] | 208 | <varlistentry id="libgcrypt-config">
|
---|
| 209 | <term><command>libgcrypt-config</command></term>
|
---|
| 210 | <listitem>
|
---|
| 211 | <para>
|
---|
| 212 | determines the compile and linker flags that should be used to
|
---|
| 213 | compile and link programs that use <filename class="libraryfile">libgcrypt</filename>.
|
---|
| 214 | </para>
|
---|
| 215 | <indexterm zone="libgcrypt libgcrypt-config">
|
---|
| 216 | <primary sortas="b-libgcrypt-config">libgcrypt-config</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="mpicalc">
|
---|
| 222 | <term><command>mpicalc</command></term>
|
---|
| 223 | <listitem>
|
---|
| 224 | <para>
|
---|
| 225 | is a RPN (Reverse Polish Notation) calculator.
|
---|
| 226 | </para>
|
---|
| 227 | <indexterm zone="libgcrypt mpicalc">
|
---|
| 228 | <primary sortas="b-mpicalc">mpicalc</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
| 232 |
|
---|
[8250d8e] | 233 | <varlistentry id="libgcrypt-lib">
|
---|
[6d8f6dc] | 234 | <term><filename class="libraryfile">libgcrypt.so</filename></term>
|
---|
[8250d8e] | 235 | <listitem>
|
---|
[6d8f6dc] | 236 | <para>
|
---|
| 237 | contains the cryptographic API functions.
|
---|
| 238 | </para>
|
---|
[8250d8e] | 239 | <indexterm zone="libgcrypt libgcrypt-lib">
|
---|
[6d8f6dc] | 240 | <primary sortas="c-libgcrypt">libgcrypt.so</primary>
|
---|
[8250d8e] | 241 | </indexterm>
|
---|
| 242 | </listitem>
|
---|
| 243 | </varlistentry>
|
---|
| 244 |
|
---|
| 245 | </variablelist>
|
---|
| 246 |
|
---|
| 247 | </sect2>
|
---|
| 248 |
|
---|
| 249 | </sect1>
|
---|