source: general/genlib/keyutils.xml@ 06908bf6

10.0 10.1 11.0 9.0 9.1 ken/refactor-virt lazarus qt5new trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since 06908bf6 was 06908bf6, checked in by Pierre Labastie <pieere@…>, 2 years ago

Add remap="doc", remap="test", or just realign them

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

  • Property mode set to 100644
File size: 6.8 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 keyutils-download-http "http://people.redhat.com/~dhowells/keyutils/keyutils-&keyutils-version;.tar.bz2">
8 <!ENTITY keyutils-download-ftp " ">
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)">
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>
36
37 &lfs84_checked;
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
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
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
83 <para>To test the results, issue, as the
84 <systemitem class="username">root</systemitem> user: </para>
85
86<screen role="root"
87 remap="test"><userinput>sed -i '/find/s:/usr/bin/::' tests/Makefile &amp;&amp;
88make -k test </userinput></screen>
89
90 <para>Note that several tests will fail if certain uncommon kernel options
91 were not used when the kernel was built. These include CONFIG_BIG_KEYS,
92 CONFIG_KEY_DH_OPERATIONS, and CONFIG_CRYPTO_DH.</para>
93
94 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
95
96<screen role="root"><userinput>make NO_ARLIB=1 install</userinput></screen>
97
98 </sect2>
99
100 <sect2 role="commands">
101 <title>Command Explanations</title>
102
103 <para>
104 <parameter>NO_ARLIB=1</parameter>: This make flag disables installing the
105 static library.
106 </para>
107
108 </sect2>
109
110 <sect2 role="configuration">
111 <title>Configuring keyutils</title>
112
113 <sect3 id="keyutils-config">
114 <title>Config Files</title>
115
116 <para>
117 <filename>/etc/request-key.conf</filename> and
118 <filename>/etc/request-key.d/*</filename>
119 </para>
120
121 <indexterm zone="keyutils keyutils-config">
122 <primary sortas="e-etc-request-key.conf">/etc/request-key.conf</primary>
123 </indexterm>
124
125 <indexterm zone="keyutils keyutils-config">
126 <primary sortas="e-etc-request-key.d">/etc/request-key.d/*</primary>
127 </indexterm>
128
129 </sect3>
130
131 </sect2>
132
133 <sect2 role="content">
134 <title>Contents</title>
135
136 <segmentedlist>
137 <segtitle>Installed Programs</segtitle>
138 <segtitle>Installed Library</segtitle>
139 <segtitle>Installed Directory</segtitle>
140
141 <seglistitem>
142 <seg>keyctl, key.dns_resolver, and request-key</seg>
143 <seg>libkeyutils.so</seg>
144 <seg>/etc/request-key.d and /usr/share/keyutils</seg>
145 </seglistitem>
146 </segmentedlist>
147
148 <variablelist>
149 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
150 <?dbfo list-presentation="list"?>
151 <?dbhtml list-presentation="table"?>
152
153 <varlistentry id="keyctl">
154 <term><command>keyctl</command></term>
155 <listitem>
156 <para>is to control the key management facility in various ways
157 using a variety of subcommands.</para>
158 <indexterm zone="keyutils keyctl">
159 <primary sortas="b-keyctl">keyctl</primary>
160 </indexterm>
161 </listitem>
162 </varlistentry>
163
164 <varlistentry id="key.dns_resolver">
165 <term><command>key.dns_resolver</command></term>
166 <listitem>
167 <para>
168 is invoked by <command>request-key</command> on behalf of the
169 kernel when kernel services (such as NFS, CIFS and AFS) need to
170 perform a hostname lookup and the kernel does not have the key
171 cached. It is not ordinarily intended to be called directly.
172 </para>
173 <indexterm zone="keyutils key.dns_resolver">
174 <primary sortas="b-key.dns_resolver">key.dns_resolver</primary>
175 </indexterm>
176 </listitem>
177 </varlistentry>
178
179 <varlistentry id="request-key">
180 <term><command>request-key</command></term>
181 <listitem>
182 <para>
183 is invoked by the kernel when the kernel is asked for a key that it
184 doesn't have immediately available. The kernel creates a temporary
185 key and then calls out to this program to instantiate it. It is
186 not intended to be called directly.
187 </para>
188 <indexterm zone="keyutils request-key">
189 <primary sortas="b-request-keyt-key">request-key</primary>
190 </indexterm>
191 </listitem>
192 </varlistentry>
193
194 <varlistentry id="libkeyutils">
195 <term><filename class='libraryfile'>libkeyutils.so</filename></term>
196 <listitem>
197 <para>
198 contains the keyutils library API instantiation.
199 </para>
200 <indexterm zone="keyutils libkeyutils">
201 <primary sortas="c-libkeyutils">libkeyutils.so</primary>
202 </indexterm>
203 </listitem>
204 </varlistentry>
205
206 </variablelist>
207
208 </sect2>
209
210</sect1>
Note: See TracBrowser for help on using the repository browser.