source: postlfs/security/consolekit.xml@ 954be3a

perl-modules
Last change on this file since 954be3a was 954be3a, checked in by Ken Moffat <ken@…>, 5 years ago

perl modules branch: merge trunk r20657:20669

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