source: general/genlib/keyutils.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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