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