[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 |
|
---|
[8dfc5c3] | 7 | <!ENTITY libgcrypt-download-http "&gnupg-http;/libgcrypt/libgcrypt-&libgcrypt-version;.tar.bz2">
|
---|
[d4e8cd93] | 8 | <!ENTITY libgcrypt-download-ftp "&gnupg-ftp;/libgcrypt/libgcrypt-&libgcrypt-version;.tar.bz2">
|
---|
[14d673a2] | 9 | <!ENTITY libgcrypt-download-ftp " ">
|
---|
[ef37a4d4] | 10 | <!ENTITY libgcrypt-md5sum "663abb395452750522d6797967e2f442">
|
---|
[1f5fd07] | 11 | <!ENTITY libgcrypt-size "3.6 MB">
|
---|
[ef37a4d4] | 12 | <!ENTITY libgcrypt-buildsize "130 MB (with tests)">
|
---|
[a541e080] | 13 | <!ENTITY libgcrypt-time "0.4 SBU (with documentation; add 0.5 SBU for tests)">
|
---|
[8250d8e] | 14 | ]>
|
---|
| 15 |
|
---|
[e79ed72] | 16 | <sect1 id="libgcrypt" xreflabel="libgcrypt-&libgcrypt-version;">
|
---|
[8250d8e] | 17 | <?dbhtml filename="libgcrypt.html"?>
|
---|
| 18 |
|
---|
| 19 |
|
---|
[e79ed72] | 20 | <title>libgcrypt-&libgcrypt-version;</title>
|
---|
[8250d8e] | 21 |
|
---|
| 22 | <indexterm zone="libgcrypt">
|
---|
[e79ed72] | 23 | <primary sortas="a-libgcrypt">libgcrypt</primary>
|
---|
[8250d8e] | 24 | </indexterm>
|
---|
| 25 |
|
---|
| 26 | <sect2 role="package">
|
---|
[e79ed72] | 27 | <title>Introduction to libgcrypt</title>
|
---|
[8250d8e] | 28 |
|
---|
[6d8f6dc] | 29 | <para>
|
---|
| 30 | The <application>libgcrypt</application> package contains a general
|
---|
| 31 | purpose crypto library based on the code used in
|
---|
| 32 | <application>GnuPG</application>. The library provides a high level
|
---|
| 33 | interface to cryptographic building blocks using an extendable and flexible
|
---|
| 34 | API.
|
---|
| 35 | </para>
|
---|
[8250d8e] | 36 |
|
---|
[a9779b9] | 37 | &lfs120_checked;
|
---|
[43c1385] | 38 |
|
---|
[8250d8e] | 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
[6d8f6dc] | 42 | <para>
|
---|
| 43 | Download (HTTP): <ulink url="&libgcrypt-download-http;"/>
|
---|
| 44 | </para>
|
---|
[8250d8e] | 45 | </listitem>
|
---|
| 46 | <listitem>
|
---|
[6d8f6dc] | 47 | <para>
|
---|
| 48 | Download (FTP): <ulink url="&libgcrypt-download-ftp;"/>
|
---|
| 49 | </para>
|
---|
[8250d8e] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[6d8f6dc] | 52 | <para>
|
---|
| 53 | Download MD5 sum: &libgcrypt-md5sum;
|
---|
| 54 | </para>
|
---|
[8250d8e] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[6d8f6dc] | 57 | <para>
|
---|
| 58 | Download size: &libgcrypt-size;
|
---|
| 59 | </para>
|
---|
[8250d8e] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[6d8f6dc] | 62 | <para>
|
---|
| 63 | Estimated disk space required: &libgcrypt-buildsize;
|
---|
| 64 | </para>
|
---|
[8250d8e] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[6d8f6dc] | 67 | <para>
|
---|
| 68 | Estimated build time: &libgcrypt-time;
|
---|
| 69 | </para>
|
---|
[8250d8e] | 70 | </listitem>
|
---|
| 71 | </itemizedlist>
|
---|
| 72 |
|
---|
[e79ed72] | 73 | <bridgehead renderas="sect3">libgcrypt Dependencies</bridgehead>
|
---|
[8250d8e] | 74 |
|
---|
| 75 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[6d8f6dc] | 76 | <para role="required">
|
---|
| 77 | <xref linkend="libgpg-error"/>
|
---|
| 78 | </para>
|
---|
[8250d8e] | 79 |
|
---|
[390e0d7] | 80 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[6d8f6dc] | 81 | <para role="optional">
|
---|
[0a6ba20] | 82 | <!-- <xref linkend="libcap-pam"/> -->
|
---|
| 83 | <xref linkend="pth"/> and
|
---|
[d2da67c] | 84 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
|
---|
[6d8f6dc] | 85 | </para>
|
---|
[390e0d7] | 86 |
|
---|
[8250d8e] | 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 role="installation">
|
---|
[e79ed72] | 90 | <title>Installation of libgcrypt</title>
|
---|
[8250d8e] | 91 |
|
---|
[6d8f6dc] | 92 | <para>
|
---|
| 93 | Install <application>libgcrypt</application> by running the
|
---|
| 94 | following commands:
|
---|
| 95 | </para>
|
---|
[8250d8e] | 96 |
|
---|
[9a19f1b] | 97 | <screen><userinput>./configure --prefix=/usr &&
|
---|
[a42c273] | 98 | make &&
|
---|
| 99 |
|
---|
| 100 | make -C doc html &&
|
---|
| 101 | makeinfo --html --no-split -o doc/gcrypt_nochunks.html doc/gcrypt.texi &&
|
---|
| 102 | makeinfo --plaintext -o doc/gcrypt.txt doc/gcrypt.texi</userinput></screen>
|
---|
[8250d8e] | 103 |
|
---|
[ef37a4d4] | 104 | <!-- The commands for building the pdf and ps formats are broken.
|
---|
[6d8f6dc] | 105 | <para>
|
---|
[a42c273] | 106 | The above commands build the documentation in html and plaintext
|
---|
| 107 | formats. If you wish to build alternate formats of the documentation, you
|
---|
| 108 | need <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>). Issue
|
---|
| 109 | the following command:
|
---|
[6d8f6dc] | 110 | </para>
|
---|
[8250d8e] | 111 |
|
---|
[42d28d7] | 112 | <screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
|
---|
[ef37a4d4] | 113 | -->
|
---|
[6d8f6dc] | 114 | <para>
|
---|
| 115 | To test the results, issue: <command>make check</command>.
|
---|
| 116 | </para>
|
---|
[8250d8e] | 117 |
|
---|
[6d8f6dc] | 118 | <para>
|
---|
| 119 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 120 | </para>
|
---|
[8250d8e] | 121 |
|
---|
| 122 | <screen role="root"><userinput>make install &&
|
---|
[6d8f6dc] | 123 | install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
[acb57a0] | 124 | install -v -m644 README doc/{README.apichanges,fips*,libgcrypt*} \
|
---|
[a42c273] | 125 | /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
| 126 |
|
---|
| 127 | install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version;/html &&
|
---|
| 128 | install -v -m644 doc/gcrypt.html/* \
|
---|
| 129 | /usr/share/doc/libgcrypt-&libgcrypt-version;/html &&
|
---|
| 130 | install -v -m644 doc/gcrypt_nochunks.html \
|
---|
| 131 | /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
| 132 | install -v -m644 doc/gcrypt.{txt,texi} \
|
---|
[acb57a0] | 133 | /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
|
---|
[ef37a4d4] | 134 | <!--
|
---|
[6d8f6dc] | 135 | <para>
|
---|
[a42c273] | 136 | If you built alternate formats of the documentation, install them by
|
---|
| 137 | issuing the following command as the
|
---|
| 138 | <systemitem class="username">root</systemitem> user:
|
---|
[6d8f6dc] | 139 | </para>
|
---|
[8250d8e] | 140 |
|
---|
[a42c273] | 141 | <screen role="root"
|
---|
| 142 | remap="doc"><userinput>install -v -m644 doc/gcrypt.{pdf,ps,dvi} \
|
---|
[8250d8e] | 143 | /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
|
---|
[ef37a4d4] | 144 | -->
|
---|
[8250d8e] | 145 | </sect2>
|
---|
| 146 |
|
---|
[1bac96e3] | 147 | <sect2 role="commands">
|
---|
| 148 | <title>Command Explanations</title>
|
---|
| 149 |
|
---|
| 150 | <para>
|
---|
| 151 | <option>--with-capabilities</option>: This option enables libcap2 support.
|
---|
[b1be08a] | 152 | Note that this breaks <xref linkend="cryptsetup"/>
|
---|
[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>
|
---|
[4c24eb0a] | 187 | is a debug tool for S-expressions
|
---|
[e23d8fcb] | 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
|
---|
[4c24eb0a] | 200 | an HMAC-SHA-256 authentication code
|
---|
[39dd48b] | 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
|
---|
[4c24eb0a] | 213 | compile and link programs that use <filename class="libraryfile">libgcrypt</filename>
|
---|
[e23d8fcb] | 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>
|
---|
[4c24eb0a] | 225 | is a RPN (Reverse Polish Notation) calculator
|
---|
[e23d8fcb] | 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>
|
---|
[4c24eb0a] | 237 | contains the cryptographic API functions
|
---|
[6d8f6dc] | 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>
|
---|