source: postlfs/security/consolekit.xml@ 4c2be438

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY consolekit-download-http "http://www.freedesktop.org/software/ConsoleKit/dist/ConsoleKit-&consolekit-version;.tar.bz2">
  <!ENTITY consolekit-download-ftp  " ">
  <!ENTITY consolekit-md5sum        "f2657f93761206922d558471a936fbc3">
  <!ENTITY consolekit-size          "416 KB">
  <!ENTITY consolekit-buildsize     "8.1 MB">
  <!ENTITY consolekit-time          "0.3 SBU">
]>

<sect1 id="consolekit" xreflabel="ConsoleKit-&consolekit-version;">
  <?dbhtml filename="consolekit.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>ConsoleKit-&consolekit-version;</title>

  <indexterm zone="consolekit">
    <primary sortas="a-ConsoleKit">ConsoleKit</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ConsoleKit</title>

    <para>The <application>ConsoleKit</application> package is a framework for
    keeping track of the various users, sessions, and seats present on a system.
    It provides a mechanism for software to react to changes of any of these
    items or of any of the metadata associated with them.</para>

    &lfs70_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&consolekit-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&consolekit-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &consolekit-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &consolekit-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &consolekit-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &consolekit-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">ConsoleKit Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="dbus-glib"/> and
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="linux-pam"/> and 
      <xref linkend="polkit"/>
    </para>

    <warning>
      <para>If you intend <emphasis role="strong">NOT</emphasis> to install
      <application>polkit</application>, you will need to manually edit the
      ConsoleKit.conf file to lock down the service. Failure to do so may be a
      huge SECURITY HOLE.</para>
    </warning>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="xmlto"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/consolekit"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of ConsoleKit</title>

    <para>Install <application>ConsoleKit</application> by running the following
    commands:</para>

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
            --localstatedir=/var --libexecdir=/usr/lib/ConsoleKit \
            --enable-pam-module &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><parameter>--enable-pam-module</parameter>: This switch enables
    <application>ConsoleKit</application> to use
    <application>Linux-PAM</application> authentication. Remove this option if
    <application>Linux-PAM</application> is
    <emphasis role="strong">NOT</emphasis> installed.</para>

    <para><option>--enable-docbook-docs</option>: Use this parameter if
    <application>xmlto</application> is installed and you wish to build the API
    documentation.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring ConsoleKit</title>

    <sect3 id="ConsoleKit-config">
      <title>Config Files</title>
      <para><filename>/etc/dbus-1/system.d/ConsoleKit.conf</filename></para>

      <indexterm zone="consolekit ConsoleKit-config">
        <primary sortas="e-etc-ConsoleKit-ConsoleKit.conf">/etc/dbus-1/system.d/ConsoleKit.conf</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>
    
      <para>If you use <application>PAM</application> you need to configure 
      <application>PAM</application> to activate <application>ConsoleKit
      </application> upon user login. This can be achieved by editing the 
      <filename>/etc/pam.d/system-session</filename> file as the 
      <systemitem class="username">root</systemitem> user:</para>
   
<screen role="root"><userinput>cat &gt;&gt; /etc/pam.d/system-session &lt;&lt; "EOF"
# Begin ConsoleKit addition

session   optional    pam_loginuid.so
session   optional    pam_ck_connector.so nox11

# End ConsoleKit addition
EOF</userinput></screen>
   
      <para>See /usr/share/doc/ConsoleKit/spec/ConsoleKit.html for more
      configuration.</para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>ck-history, ck-launch-session, ck-list-sessions,
        ck-log-system-restart, ck-log-system-start, ck-log-system-stop,
        console-kit-daemon, ck-collect-session-info, ck-get-x11-display-device,
        ck-get-x11-server-pid, ck-system-restart, and ck-system-stop</seg>
        <seg>libck-connector.so and pam_ck_connector.so</seg>
        <seg>/etc/ConsoleKit/{run-seat.d,run-session.d,seats.d},
        /usr/{include/ConsoleKit/ck-connector,lib/ConsoleKit/{run-seat.d,
        run-session.d,scripts},share/doc/ConsoleKit/spec}</seg>
      </seglistitem>
    </segmentedlist>

<!--
    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="ck-history">
        <term><command>ck-history</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-history">
            <primary sortas="b-ck-history">ck-history</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-launch-session">
        <term><command>ck-launch-session</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-launch-session">
            <primary sortas="b-ck-launch-session">ck-launch-session</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-list-sessions">
        <term><command>ck-list-sessions</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-list-sessions">
            <primary sortas="b-ck-list-sessions">ck-list-sessions</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-log-system-restart">
        <term><command>ck-log-system-restart</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-log-system-restart">
            <primary sortas="b-ck-log-system-restart">ck-log-system-restart</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-log-system-start">
        <term><command>ck-log-system-start</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-log-system-start">
            <primary sortas="b-ck-log-system-start">ck-log-system-start</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-log-system-stop">
        <term><command>ck-log-system-stop</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-log-system-stop">
            <primary sortas="b-ck-log-system-stop">ck-log-system-stop</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="console-kit-daemon">
        <term><command>console-kit-daemon</command></term>
        <listitem>
          <para>is the <application>ConsoleKit</application> daemon.</para>
          <indexterm zone="consolekit console-kit-daemon">
            <primary sortas="b-console-kit-daemon">console-kit-daemon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-collect-session-info">
        <term><command>ck-collect-session-info</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-collect-session-info">
            <primary sortas="b-ck-collect-session-info">ck-collect-session-info</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-get-x11-display-device">
        <term><command>ck-get-x11-display-device</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-get-x11-display-device">
            <primary sortas="b-ck-get-x11-display-device">ck-get-x11-display-device</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-get-x11-server-pid">
        <term><command>ck-get-x11-server-pid</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-get-x11-server-pid">
            <primary sortas="b-ck-get-x11-server-pid">ck-get-x11-server-pid</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-system-restart">
        <term><command>ck-system-restart</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-system-restart">
            <primary sortas="b-ck-system-restart">ck-system-restart</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="ck-system-stop">
        <term><command>ck-system-stop</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="consolekit ck-system-stop">
            <primary sortas="b-ck-system-stop">ck-system-stop</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libck-connector">
        <term><filename class='libraryfile'>libck-connector.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="consolekit libck-connector">
            <primary sortas="c-libck-connector">libck-connector.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pam_ck_connector">
        <term><filename class='libraryfile'>pam_ck_connector.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="consolekit pam_ck_connector">
            <primary sortas="c-pam_ck_connector">pam_ck_connector.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>
-->

  </sect2>

</sect1>