source: postlfs/security/consolekit.xml@ c2de366

10.0 10.1 11.0 11.1 11.2 11.3 12.0 12.1 7.10 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind kea ken/TL2024 ken/inkscape-core-mods ken/tuningfonts lazarus lxqt nosym perl-modules plabs/newcss plabs/python-mods python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk upgradedb xry111/intltool xry111/llvm18 xry111/soup3 xry111/test-20220226 xry111/xf86-video-removal
Last change on this file since c2de366 was c2de366, checked in by Douglas R. Reno <renodr@…>, 9 years ago

More short descriptions. Thanks to myou for the patch.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@16168 af4574ff-66df-0310-9fd7-8a98e5e911e0
  • Property mode set to 100644
File size: 13.6 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 consolekit-download-http "&sources-anduin-http;/c/ConsoleKit-&consolekit-version;.tar.xz">
8 <!ENTITY consolekit-download-ftp " ">
9 <!ENTITY consolekit-md5sum "6aaadf5627d2f7587aa116727e2fc1da">
10 <!ENTITY consolekit-size "356 KB">
11 <!ENTITY consolekit-buildsize "8.0 MB">
12 <!ENTITY consolekit-time "0.3 SBU">
13]>
14
15<sect1 id="consolekit" xreflabel="ConsoleKit-&consolekit-version;">
16 <?dbhtml filename="consolekit.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>ConsoleKit-&consolekit-version;</title>
24
25 <indexterm zone="consolekit">
26 <primary sortas="a-ConsoleKit">ConsoleKit</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to ConsoleKit</title>
31
32 <para>
33 The <application>ConsoleKit</application> package is a framework for
34 keeping track of the various users, sessions, and seats present on a system.
35 It provides a mechanism for software to react to changes of any of these
36 items or of any of the metadata associated with them.
37 </para>
38
39 &lfs77_checked; &gcc5_built;
40
41 <bridgehead renderas="sect3">Package Information</bridgehead>
42 <itemizedlist spacing="compact">
43 <listitem>
44 <para>
45 Download (HTTP): <ulink url="&consolekit-download-http;"/>
46 </para>
47 </listitem>
48 <listitem>
49 <para>
50 Download (FTP): <ulink url="&consolekit-download-ftp;"/>
51 </para>
52 </listitem>
53 <listitem>
54 <para>
55 Download MD5 sum: &consolekit-md5sum;
56 </para>
57 </listitem>
58 <listitem>
59 <para>
60 Download size: &consolekit-size;
61 </para>
62 </listitem>
63 <listitem>
64 <para>
65 Estimated disk space required: &consolekit-buildsize;
66 </para>
67 </listitem>
68 <listitem>
69 <para>
70 Estimated build time: &consolekit-time;
71 </para>
72 </listitem>
73 </itemizedlist>
74
75 <bridgehead renderas="sect3">ConsoleKit Dependencies</bridgehead>
76
77 <bridgehead renderas="sect4">Required</bridgehead>
78 <para role="required">
79 <xref linkend="dbus-glib"/> and
80 <xref linkend="xorg7-lib"/>
81 </para>
82
83 <bridgehead renderas="sect4">Recommended</bridgehead>
84 <para role="recommended">
85 <xref linkend="linux-pam"/> and
86 <xref linkend="polkit"/>
87 </para>
88
89 <warning>
90 <para>
91 If you intend <emphasis role="strong">NOT</emphasis> to install
92 <application>polkit</application>, you will need to manually edit the
93 ConsoleKit.conf file to lock down the service. Failure to do so may be a
94 huge SECURITY HOLE.
95 </para>
96 </warning>
97
98 <bridgehead renderas="sect4">Optional</bridgehead>
99 <para role="optional">
100 <xref linkend="xmlto"/>
101 </para>
102
103 <para condition="html" role="usernotes">User Notes:
104 <ulink url="&blfs-wiki;/consolekit"/>
105 </para>
106 </sect2>
107
108 <sect2 role="installation">
109 <title>Installation of ConsoleKit</title>
110
111 <para>
112 Install <application>ConsoleKit</application> by running the following
113 commands:
114 </para>
115
116<screen><userinput>./configure --prefix=/usr \
117 --sysconfdir=/etc \
118 --localstatedir=/var \
119 --enable-udev-acl \
120 --enable-pam-module \
121 --with-systemdsystemunitdir=no &amp;&amp;
122make</userinput></screen>
123
124 <para>
125 This package does not come with a test suite.
126 </para>
127
128 <para>
129 Now, as the <systemitem class="username">root</systemitem> user:
130 </para>
131
132<screen role="root"><userinput>make install</userinput></screen>
133
134 </sect2>
135
136 <sect2 role="commands">
137 <title>Command Explanations</title>
138
139 <para>
140 <parameter>--enable-udev-acl</parameter>: This switch enables building of
141 the <command>udev-acl</command> tool, which is used to allow normal users
142 to access device nodes normally only accessible to
143 <systemitem class="username">root</systemitem>.
144 </para>
145
146 <para>
147 <parameter>--enable-pam-module</parameter>: This switch enables building
148 of the <application>ConsoleKit</application>
149 <application>PAM</application> module which is needed for
150 <application>ConsoleKit</application> to work correctly with
151 <application>PAM</application>. Remove if
152 <application>Linux PAM</application> is
153 <emphasis role="strong">NOT</emphasis> installed.
154 </para>
155
156 <para>
157 <parameter>--with-systemdsystemunitdir=no</parameter>: Disable
158 attempting to build with systemd libraries.
159 </para>
160
161 <para>
162 <option>--enable-docbook-docs</option>: Use this switch if
163 <application>xmlto</application> is installed and you wish to
164 build the API documentation.
165 </para>
166
167 </sect2>
168
169 <sect2 role="configuration">
170 <title>Configuring ConsoleKit</title>
171
172 <sect3>
173 <title>PAM Module Configuration</title>
174
175 <para>
176 If you use <application>Linux PAM</application>, it needs to be
177 configured to activate <application>ConsoleKit</application> upon user
178 login. This can be achieved by editing the
179 <filename>/etc/pam.d/system-session</filename> file as the <systemitem
180 class="username">root</systemitem> user:
181 </para>
182
183<screen role="root"><userinput>cat &gt;&gt; /etc/pam.d/system-session &lt;&lt; "EOF"
184<literal># Begin ConsoleKit addition
185
186session optional pam_loginuid.so
187session optional pam_ck_connector.so nox11
188
189# End ConsoleKit addition</literal>
190EOF</userinput></screen>
191
192 <para>
193 You will also need a helper script that creates a file in
194 <filename class="directory">/var/run/console</filename>
195 named as the currently logged in user and that contains the
196 <application>D-Bus</application> address of the session. You
197 can create the script by running the following commands as
198 the <systemitem class="username">root</systemitem> user:
199 </para>
200
201<screen role="root"><userinput>cat &gt; /usr/lib/ConsoleKit/run-session.d/pam-foreground-compat.ck &lt;&lt; "EOF"
202#!/bin/sh
203TAGDIR=/var/run/console
204
205[ -n "$CK_SESSION_USER_UID" ] || exit 1
206[ "$CK_SESSION_IS_LOCAL" = "true" ] || exit 0
207
208TAGFILE="$TAGDIR/`getent passwd $CK_SESSION_USER_UID | cut -f 1 -d:`"
209
210if [ "$1" = "session_added" ]; then
211 mkdir -p "$TAGDIR"
212 echo "$CK_SESSION_ID" &gt;&gt; "$TAGFILE"
213fi
214
215if [ "$1" = "session_removed" ] &amp;&amp; [ -e "$TAGFILE" ]; then
216 sed -i "\%^$CK_SESSION_ID\$%d" "$TAGFILE"
217 [ -s "$TAGFILE" ] || rm -f "$TAGFILE"
218fi
219EOF
220chmod -v 755 /usr/lib/ConsoleKit/run-session.d/pam-foreground-compat.ck</userinput></screen>
221
222 <para>
223 See /usr/share/doc/ConsoleKit/spec/ConsoleKit.html for more
224 configuration.
225 </para>
226
227 </sect3>
228
229 </sect2>
230
231 <sect2 role="content">
232 <title>Contents</title>
233
234 <segmentedlist>
235 <segtitle>Installed Programs</segtitle>
236 <segtitle>Installed Libraries</segtitle>
237 <segtitle>Installed Directories</segtitle>
238
239 <seglistitem>
240 <seg>
241 ck-history, ck-launch-session, ck-list-sessions,
242 ck-log-system-restart, ck-log-system-start,
243 ck-log-system-stop and console-kit-daemon
244 </seg>
245 <seg>
246 libck-connector.so and pam_ck_connector.so
247 </seg>
248 <seg>
249 /etc/ConsoleKit,
250 /usr/include/ConsoleKit,
251 /usr/lib/ConsoleKit,
252 /usr/share/doc/ConsoleKit and
253 /var/log/ConsoleKit
254 </seg>
255 </seglistitem>
256 </segmentedlist>
257
258 <variablelist>
259 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
260 <?dbfo list-presentation="list"?>
261 <?dbhtml list-presentation="table"?>
262
263
264 <varlistentry id="ck-history">
265 <term><command>ck-history</command></term>
266 <listitem>
267 <para>is a utility that provides information from the ConsoleKit
268 database about what users have logged into the system.</para>
269 <indexterm zone="consolekit ck-history">
270 <primary sortas="b-ck-history">ck-history</primary>
271 </indexterm>
272 </listitem>
273 </varlistentry>
274
275 <varlistentry id="ck-launch-session">
276 <term><command>ck-launch-session</command></term>
277 <listitem>
278 <para>is a utility for starting a command in its own ConsoleKit
279 session.
280 </para>
281 <indexterm zone="consolekit ck-launch-session">
282 <primary sortas="b-ck-launch-session">ck-launch-session</primary>
283 </indexterm>
284 </listitem>
285 </varlistentry>
286
287 <varlistentry id="ck-list-sessions">
288 <term><command>ck-list-sessions</command></term>
289 <listitem>
290 <para>list sessions with respective properties. Also good for
291 debugging purposes.</para>
292 <indexterm zone="consolekit ck-list-sessions">
293 <primary sortas="b-ck-list-sessions">ck-list-sessions</primary>
294 </indexterm>
295 </listitem>
296 </varlistentry>
297
298 <varlistentry id="ck-log-system-restart">
299 <term><command>ck-log-system-restart</command></term>
300 <listitem>
301 <para>write system restart to log.</para>
302 <indexterm zone="consolekit ck-log-system-restart">
303 <primary sortas="b-ck-log-system-restart">ck-log-system-restart</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="ck-log-system-start">
309 <term><command>ck-log-system-start</command></term>
310 <listitem>
311 <para>write system start to log.</para>
312 <indexterm zone="consolekit ck-log-system-start">
313 <primary sortas="b-ck-log-system-start">ck-log-system-start</primary>
314 </indexterm>
315 </listitem>
316 </varlistentry>
317
318 <varlistentry id="ck-log-system-stop">
319 <term><command>ck-log-system-stop</command></term>
320 <listitem>
321 <para>write system stop to log.</para>
322 <indexterm zone="consolekit ck-log-system-stop">
323 <primary sortas="b-ck-log-system-stop">ck-log-system-stop</primary>
324 </indexterm>
325 </listitem>
326 </varlistentry>
327
328 <varlistentry id="console-kit-daemon">
329 <term><command>console-kit-daemon</command></term>
330 <listitem>
331 <para>is the <application>ConsoleKit</application> daemon.</para>
332 <indexterm zone="consolekit console-kit-daemon">
333 <primary sortas="b-console-kit-daemon">console-kit-daemon</primary>
334 </indexterm>
335 </listitem>
336 </varlistentry>
337
338<!-- Note (Denis): I don't know if theses programs are installed by the current version of consolekit.
339 Must be validate before uncomment
340
341 <varlistentry id="ck-collect-session-info">
342 <term><command>ck-collect-session-info</command></term>
343 <listitem>
344 <para>displays session informations about the current session.</para>
345 <indexterm zone="consolekit ck-collect-session-info">
346 <primary sortas="b-ck-collect-session-info">ck-collect-session-info</primary>
347 </indexterm>
348 </listitem>
349 </varlistentry>
350
351 <varlistentry id="ck-get-x11-display-device">
352 <term><command>ck-get-x11-display-device</command></term>
353 <listitem>
354 <para>displays the x11 display device of the current session.</para>
355 <indexterm zone="consolekit ck-get-x11-display-device">
356 <primary sortas="b-ck-get-x11-display-device">ck-get-x11-display-device</primary>
357 </indexterm>
358 </listitem>
359 </varlistentry>
360
361 <varlistentry id="ck-get-x11-server-pid">
362 <term><command>ck-get-x11-server-pid</command></term>
363 <listitem>
364 <para>displays the x11 server pid of the current session.</para>
365 <indexterm zone="consolekit ck-get-x11-server-pid">
366 <primary sortas="b-ck-get-x11-server-pid">ck-get-x11-server-pid</primary>
367 </indexterm>
368 </listitem>
369 </varlistentry>
370
371 <varlistentry id="ck-system-restart">
372 <term><command>ck-system-restart</command></term>
373 <listitem>
374 <para>is the system restart script.</para>
375 <indexterm zone="consolekit ck-system-restart">
376 <primary sortas="b-ck-system-restart">ck-system-restart</primary>
377 </indexterm>
378 </listitem>
379 </varlistentry>
380
381 <varlistentry id="ck-system-stop">
382 <term><command>ck-system-stop</command></term>
383 <listitem>
384 <para>is the system stop script.</para>
385 <indexterm zone="consolekit ck-system-stop">
386 <primary sortas="b-ck-system-stop">ck-system-stop</primary>
387 </indexterm>
388 </listitem>
389 </varlistentry>
390
391 <varlistentry id="libck-connector">
392 <term><filename class='libraryfile'>libck-connector.so</filename></term>
393 <listitem>
394 <para>contains functions that .....</para>
395 <indexterm zone="consolekit libck-connector">
396 <primary sortas="c-libck-connector">libck-connector.so</primary>
397 </indexterm>
398 </listitem>
399 </varlistentry>
400
401 <varlistentry id="pam_ck_connector">
402 <term><filename class='libraryfile'>pam_ck_connector.so</filename></term>
403 <listitem>
404 <para>contains functions that .....</para>
405 <indexterm zone="consolekit pam_ck_connector">
406 <primary sortas="c-pam_ck_connector">pam_ck_connector.so</primary>
407 </indexterm>
408 </listitem>
409 </varlistentry>
410-->
411 </variablelist>
412
413 </sect2>
414
415</sect1>
Note: See TracBrowser for help on using the repository browser.