source: postlfs/security/policykit.xml@ 875b4070

<?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 policykit-download-http "http://hal.freedesktop.org/releases/PolicyKit-&policykit-version;.tar.gz">
  <!ENTITY policykit-download-ftp  " ">
  <!ENTITY policykit-md5sum        "802fd13ae41f73d79359e5ecb0a98716">
  <!ENTITY policykit-size          "1.2 MB">
  <!ENTITY policykit-buildsize     "14 MB">
  <!ENTITY policykit-time          "0.4 SBU">
]>

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

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

  <title>PolicyKit-&policykit-version;</title>

  <indexterm zone="policykit">
    <primary sortas="a-PolicyKit">PolicyKit</primary>
  </indexterm>

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

    <para>The <application>PolicyKit</application> package is an
    application-level toolkit for defining and handling the policy that allows
    unprivileged processes to speak to privileged processes.</para>

    &lfs65_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="dbus-glib"/>,
    <xref linkend="linux-pam"/>,
    <xref linkend="intltool"/>, and
    <xref linkend="docbook-xsl"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="gtk-doc"/></para>

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

  </sect2>

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

    <para>It is a requirement to have a dedicated user and group for
    <application>PolicyKit</application> to function correctly. Issue the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>groupadd -fg 27 polkituser &amp;&amp;
useradd -c "Policy Kit Daemon User" -d /dev/null -u 27 \
    -g polkituser -s /bin/false polkituser || [ $? == 9 ]</userinput></screen>

    <para>Install <application>PolicyKit</application> by running the following
    commands as an unprivileged user:</para>

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
    --libexecdir=/usr/lib/PolicyKit --localstatedir=/var &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 &amp;&amp;
install -v -d -m755 /usr/share/doc/PolicyKit-&policykit-version; &amp;&amp;
cp -v -r doc/html /usr/share/doc/PolicyKit-&policykit-version;</userinput></screen>

  </sect2>

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

    <sect3 id="PolicyKit-config">
      <title>Config Files</title>
      <para><filename>/etc/PolicyKit/PolicyKit.conf</filename></para>

      <indexterm zone="policykit PolicyKit-config">
        <primary sortas="e-etc-PolicyKit-PolicyKit.conf">/etc/PolicyKit/PolicyKit.conf</primary>
      </indexterm>
    </sect3>

    <sect3><title>Configuration Information</title>

      <para>See manual page PolicyKit.conf(5).</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>polkit-auth, polkit-policy-file-validate,
        polkit-config-file-validate, polkit-action, polkit-read-auth-helper,
        polkit-grant-helper-pam, polkit-grant-helper, polkit-revoke-helper,
        polkitd, polkit-explicit-grant-helper, polkit-set-default-helper,
        and polkit-resolve-exe-helper</seg>
        <seg>libpolkit.{so,a}, libpolkit-dbus.{so,a}, and libpolkit-grant.{so,a}</seg>
        <seg>/etc/PolicyKit, /usr/lib/PolicyKit, /usr/include/PolicyKit/polkit,
        /usr/include/PolicyKit/polkit-dbus, /usr/include/PolicyKit/polkit-grant,
        /usr/share/PolicyKit/policy, /var/lib/misc, /var/lib/PolicyKit,
        /var/lib/PolicyKit-public, and /usr/share/doc/PolicyKit-&policykit-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="polkit-auth">
        <term><command>polkit-auth</command></term>
        <listitem>
          <para>is used to inspect, obtain, grant and revoke
          <application>PolicyKit</application> authorizations.</para>
          <indexterm zone="policykit polkit-auth">
            <primary sortas="b-polkit-auth">polkit-auth</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-policy-file-validate">
        <term><command>polkit-policy-file-validate</command></term>
        <listitem>
          <para>is used to verify that one or more
          <application>PolicyKit</application> .policy files are valid.</para>
          <indexterm zone="policykit polkit-policy-file-validate">
            <primary sortas="b-polkit-policy-file-validate">polkit-policy-file-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-config-file-validate">
        <term><command>polkit-config-file-validate</command></term>
        <listitem>
          <para>is used to verify that a given <application>PolicyKit</application>
          configuration file is valid.</para>
          <indexterm zone="policykit polkit-config-file-validate">
            <primary sortas="b-polkit-config-file-validate">polkit-config-file-validate</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-action">
        <term><command>polkit-action</command></term>
        <listitem>
          <para>is used to list and modify the <application>PolicyKit</application>
          actions that are registered on the system.</para>
          <indexterm zone="policykit polkit-action">
            <primary sortas="b-polkit-action">polkit-action</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-read-auth-helper">
        <term><command>polkit-read-auth-helper</command></term>
        <listitem>
          <para>is the setgid polkituser helper for
          <application>PolicyKit</application> to read authorizations.</para>
          <indexterm zone="policykit polkit-read-auth-helper">
            <primary sortas="b-polkit-read-auth-helper">polkit-read-auth-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-grant-helper-pam">
        <term><command>polkit-grant-helper-pam</command></term>
        <listitem>
          <para>is the setuid root pam grant helper for <application>PolicyKit</application>.</para>
          <indexterm zone="policykit polkit-grant-helper-pam">
            <primary sortas="b-polkit-grant-helper-pam">polkit-grant-helper-pam</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-grant-helper">
        <term><command>polkit-grant-helper</command></term>
        <listitem>
          <para>is the setgid polkituser grant helper for <application>PolicyKit</application>.</para>
          <indexterm zone="policykit polkit-grant-helper">
            <primary sortas="b-polkit-grant-helper">polkit-grant-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-revoke-helper">
        <term><command>polkit-revoke-helper</command></term>
        <listitem>
          <para>is used to revoke authorizations.</para>
          <indexterm zone="policykit polkit-revoke-helper">
            <primary sortas="b-polkit-revoke-helper">polkit-revoke-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkitd-0.9">
        <term><command>polkitd</command></term>
        <listitem>
          <para>is the <application>PolicyKit</application> daemon.</para>
          <indexterm zone="policykit polkitd-0.9">
            <primary sortas="b-polkitd">polkitd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-explicit-grant-helper">
        <term><command>polkit-explicit-grant-helper</command></term>
        <listitem>
          <para>is used to grant authorizations.</para>
          <indexterm zone="policykit polkit-explicit-grant-helper">
            <primary sortas="b-polkit-explicit-grant-helper">polkit-explicit-grant-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-set-default-helper">
        <term><command>polkit-set-default-helper</command></term>
        <listitem>
          <para>is the setgid polkituser helper for <application>PolicyKit</application>.</para>
          <indexterm zone="policykit polkit-set-default-helper">
            <primary sortas="b-polkit-set-default-helper">polkit-set-default-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="polkit-resolve-exe-helper">
        <term><command>polkit-resolve-exe-helper</command></term>
        <listitem>
          <para>is used to find the executable name for a process.</para>
          <indexterm zone="policykit polkit-resolve-exe-helper">
            <primary sortas="b-polkit-resolve-exe-helper">polkit-resolve-exe-helper</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpolkit">
        <term><filename class='libraryfile'>libpolkit.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>PolicyKit</application> API functions.</para>
          <indexterm zone="policykit libpolkit">
            <primary sortas="c-libpolkit">libpolkit.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpolkit-dbus">
        <term><filename class='libraryfile'>libpolkit-dbus.{so,a}</filename></term>
        <listitem>
          <para>contains functions for obtaining seat, session and caller
          information via <application>D-Bus</application> and
          <application>ConsoleKit</application>.</para>
          <indexterm zone="policykit libpolkit-dbus">
            <primary sortas="c-libpolkit-dbus">libpolkit-dbus.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libpolkit-grant">
        <term><filename class='libraryfile'>libpolkit-grant.{so,a}</filename></term>
        <listitem>
          <para>contains functions for obtaining authorizations through authentication.</para>
          <indexterm zone="policykit libpolkit-grant">
            <primary sortas="c-libpolkit-grant">libpolkit-grant.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>