[fcc6d60] | 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 keyutils-download-http "http://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
|
---|
| 8 | <!ENTITY keyutils-download-ftp " ">
|
---|
[50d5132] | 9 | <!ENTITY keyutils-md5sum "191987b0ab46bb5b50efd70a6e6ce808">
|
---|
| 10 | <!ENTITY keyutils-size "92 KB">
|
---|
| 11 | <!ENTITY keyutils-buildsize "2.1 MB (with tests)">
|
---|
| 12 | <!ENTITY keyutils-time "less than 0.1 SBU (add 0.8 SBU for tests)">
|
---|
[fcc6d60] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="keyutils" xreflabel="keyutils-&keyutils-version;">
|
---|
| 16 | <?dbhtml filename="keyutils.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>keyutils-&keyutils-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="keyutils">
|
---|
| 26 | <primary sortas="a-keyutils">keyutils</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to keyutils</title>
|
---|
| 31 |
|
---|
| 32 | <para>Keyutils is a set of utilities for managing the key retention
|
---|
| 33 | facility in the kernel, which can be used by filesystems, block devices and
|
---|
| 34 | more to gain and retain the authorization and encryption keys required to
|
---|
| 35 | perform secure operations.</para>
|
---|
[0d7900a] | 36 |
|
---|
[49a84b87] | 37 | &lfs83_checked;
|
---|
[fcc6d60] | 38 |
|
---|
| 39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 40 | <itemizedlist spacing="compact">
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (HTTP): <ulink url="&keyutils-download-http;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download (FTP): <ulink url="&keyutils-download-ftp;"/></para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download MD5 sum: &keyutils-md5sum;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Download size: &keyutils-size;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated disk space required: &keyutils-buildsize;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>Estimated build time: &keyutils-time;</para>
|
---|
| 58 | </listitem>
|
---|
| 59 | </itemizedlist>
|
---|
| 60 |
|
---|
[0d38b000] | 61 | <bridgehead renderas="sect3">keyutils Dependencies</bridgehead>
|
---|
| 62 |
|
---|
| 63 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 64 | <para role="required">
|
---|
| 65 | <xref linkend="mitkrb"/>
|
---|
| 66 | <!-- Without krb5 installed, a FTBFS occurs while trying to compile dns.afsdb.c.
|
---|
| 67 | It looks for profile.h, which is installed by krb5. -->
|
---|
| 68 | </para>
|
---|
| 69 |
|
---|
[fcc6d60] | 70 | <para condition="html" role="usernotes">User Notes:
|
---|
| 71 | <ulink url="&blfs-wiki;/keyutils"/></para>
|
---|
| 72 |
|
---|
| 73 | </sect2>
|
---|
| 74 |
|
---|
| 75 | <sect2 role="installation">
|
---|
| 76 | <title>Installation of keyutils</title>
|
---|
| 77 |
|
---|
| 78 | <para>Install <application>keyutils</application> by running the following
|
---|
| 79 | commands:</para>
|
---|
| 80 |
|
---|
| 81 | <screen><userinput>make</userinput></screen>
|
---|
| 82 |
|
---|
[f8525af6] | 83 | <para>To test the results, issue, as the
|
---|
| 84 | <systemitem class="username">root</systemitem> user: </para>
|
---|
[864abc6] | 85 |
|
---|
[f8525af6] | 86 | <screen role="root"><userinput>sed -i '/find/s:/usr/bin/::' tests/Makefile &&
|
---|
| 87 | make -k test </userinput></screen>
|
---|
| 88 |
|
---|
| 89 | <para>Note that several tests will fail if certain uncommon kernel options
|
---|
| 90 | were not used when the kernel was built. These include CONFIG_BIG_KEYS,
|
---|
| 91 | CONFIG_KEY_DH_OPERATIONS, and CONFIG_CRYPTO_DH.</para>
|
---|
[fcc6d60] | 92 |
|
---|
| 93 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 94 |
|
---|
[27d214c3] | 95 | <screen role="root"><userinput>make NO_ARLIB=1 install</userinput></screen>
|
---|
| 96 |
|
---|
| 97 | </sect2>
|
---|
| 98 |
|
---|
| 99 | <sect2 role="commands">
|
---|
| 100 | <title>Command Explanations</title>
|
---|
| 101 |
|
---|
| 102 | <para>
|
---|
| 103 | <parameter>NO_ARLIB=1</parameter>: This make flag disables installing the
|
---|
| 104 | static library.
|
---|
| 105 | </para>
|
---|
| 106 |
|
---|
| 107 | </sect2>
|
---|
| 108 |
|
---|
| 109 | <sect2 role="configuration">
|
---|
| 110 | <title>Configuring keyutils</title>
|
---|
| 111 |
|
---|
| 112 | <sect3 id="keyutils-config">
|
---|
| 113 | <title>Config Files</title>
|
---|
| 114 |
|
---|
| 115 | <para>
|
---|
| 116 | <filename>/etc/request-key.conf</filename> and
|
---|
| 117 | <filename>/etc/request-key.d/*</filename>
|
---|
| 118 | </para>
|
---|
| 119 |
|
---|
| 120 | <indexterm zone="keyutils keyutils-config">
|
---|
| 121 | <primary sortas="e-etc-request-key.conf">/etc/request-key.conf</primary>
|
---|
| 122 | </indexterm>
|
---|
| 123 |
|
---|
| 124 | <indexterm zone="keyutils keyutils-config">
|
---|
| 125 | <primary sortas="e-etc-request-key.d">/etc/request-key.d/*</primary>
|
---|
| 126 | </indexterm>
|
---|
| 127 |
|
---|
| 128 | </sect3>
|
---|
[fcc6d60] | 129 |
|
---|
| 130 | </sect2>
|
---|
| 131 |
|
---|
| 132 | <sect2 role="content">
|
---|
| 133 | <title>Contents</title>
|
---|
| 134 |
|
---|
| 135 | <segmentedlist>
|
---|
| 136 | <segtitle>Installed Programs</segtitle>
|
---|
| 137 | <segtitle>Installed Library</segtitle>
|
---|
| 138 | <segtitle>Installed Directory</segtitle>
|
---|
| 139 |
|
---|
| 140 | <seglistitem>
|
---|
| 141 | <seg>keyctl, key.dns_resolver, and request-key</seg>
|
---|
[27d214c3] | 142 | <seg>libkeyutils.so</seg>
|
---|
[d8377ddb] | 143 | <seg>/etc/request-key.d and /usr/share/keyutils</seg>
|
---|
[fcc6d60] | 144 | </seglistitem>
|
---|
| 145 | </segmentedlist>
|
---|
| 146 |
|
---|
| 147 | <variablelist>
|
---|
| 148 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 149 | <?dbfo list-presentation="list"?>
|
---|
| 150 | <?dbhtml list-presentation="table"?>
|
---|
| 151 |
|
---|
| 152 | <varlistentry id="keyctl">
|
---|
| 153 | <term><command>keyctl</command></term>
|
---|
| 154 | <listitem>
|
---|
| 155 | <para>is to control the key management facility in various ways
|
---|
| 156 | using a variety of subcommands.</para>
|
---|
| 157 | <indexterm zone="keyutils keyctl">
|
---|
| 158 | <primary sortas="b-keyctl">keyctl</primary>
|
---|
| 159 | </indexterm>
|
---|
| 160 | </listitem>
|
---|
| 161 | </varlistentry>
|
---|
| 162 |
|
---|
[7e2908c] | 163 | <varlistentry id="key.dns_resolver">
|
---|
| 164 | <term><command>key.dns_resolver</command></term>
|
---|
| 165 | <listitem>
|
---|
| 166 | <para>
|
---|
| 167 | is invoked by <command>request-key</command> on behalf of the
|
---|
| 168 | kernel when kernel services (such as NFS, CIFS and AFS) need to
|
---|
| 169 | perform a hostname lookup and the kernel does not have the key
|
---|
| 170 | cached. It is not ordinarily intended to be called directly.
|
---|
| 171 | </para>
|
---|
| 172 | <indexterm zone="keyutils key.dns_resolver">
|
---|
| 173 | <primary sortas="b-key.dns_resolver">key.dns_resolver</primary>
|
---|
| 174 | </indexterm>
|
---|
| 175 | </listitem>
|
---|
| 176 | </varlistentry>
|
---|
| 177 |
|
---|
| 178 | <varlistentry id="request-key">
|
---|
| 179 | <term><command>request-key</command></term>
|
---|
| 180 | <listitem>
|
---|
| 181 | <para>
|
---|
| 182 | is invoked by the kernel when the kernel is asked for a key that it
|
---|
| 183 | doesn't have immediately available. The kernel creates a temporary
|
---|
| 184 | key and then calls out to this program to instantiate it. It is
|
---|
| 185 | not intended to be called directly.
|
---|
| 186 | </para>
|
---|
| 187 | <indexterm zone="keyutils request-key">
|
---|
| 188 | <primary sortas="b-request-keyt-key">request-key</primary>
|
---|
| 189 | </indexterm>
|
---|
| 190 | </listitem>
|
---|
| 191 | </varlistentry>
|
---|
| 192 |
|
---|
[fcc6d60] | 193 | <varlistentry id="libkeyutils">
|
---|
[27d214c3] | 194 | <term><filename class='libraryfile'>libkeyutils.so</filename></term>
|
---|
[fcc6d60] | 195 | <listitem>
|
---|
[7e2908c] | 196 | <para>
|
---|
| 197 | contains the keyutils library API instantiation.
|
---|
| 198 | </para>
|
---|
[fcc6d60] | 199 | <indexterm zone="keyutils libkeyutils">
|
---|
[27d214c3] | 200 | <primary sortas="c-libkeyutils">libkeyutils.so</primary>
|
---|
[fcc6d60] | 201 | </indexterm>
|
---|
| 202 | </listitem>
|
---|
| 203 | </varlistentry>
|
---|
| 204 |
|
---|
| 205 | </variablelist>
|
---|
| 206 |
|
---|
| 207 | </sect2>
|
---|
| 208 |
|
---|
| 209 | </sect1>
|
---|