source: postlfs/security/polkit.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 polkit-download-http "http://hal.freedesktop.org/releases/polkit-&polkit-version;.tar.gz">
  <!ENTITY polkit-download-ftp  " ">
  <!ENTITY polkit-md5sum        "e380b4c6fb1e7bccf854e92edc0a8ce1">
  <!ENTITY polkit-size          "1.4 MB">
  <!ENTITY polkit-buildsize     "9 MB">
  <!ENTITY polkit-time          "0.3 SBU">
]>

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

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

  <title>polkit-&polkit-version;</title>

  <indexterm zone="polkit">
    <primary sortas="a-polkit">polkit</primary>
  </indexterm>

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

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

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="intltool"/> and
      <xref linkend="pkgconfig"/>
    </para>

    <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
    <para role="optional">
      <xref linkend="gobject-introspection"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="DocBook"/>, 
      <xref linkend="docbook-xsl"/>, 
      <xref linkend="gtk-doc"/>, 
      <xref linkend="libxslt"/> and 
      <xref linkend="linux-pam"/>
    </para>

    <note>
      <para>If <xref linkend="libxslt"/> is installed then <xref
      linkend="DocBook"/> and <xref linkend="docbook-xsl"/> are required.</para>
    </note>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
            --localstatedir=/var --libexecdir=/usr/lib/polkit-1 \
            --with-authfw=shadow &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>--with-authfw=shadow</parameter>: This parameter will use
    the <application>Shadow</application> rather than the
    <application>Linux-PAM</application> Authentication framework. Remove it if
    you would like to use <application>Linux-PAM</application>.</para>
    <para><parameter>--disable-static</parameter>: This will prevent the static 
    libraries from being built.</para>

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

  </sect2>

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

    <sect3 id="polkit-config">
      <title>Config Files</title>

      <para><filename>/etc/polkit-1/localauthority.conf.d/*</filename></para>
    </sect3>

    <sect3>
      <title>PAM Configuration</title>

      <note>
        <para>If you did not build <application>polkit</application> with
        <application>Linux PAM</application> support, you can skip this section.
        </para>
      </note>

      <para>If you built <application>polkit</application> with 
      <application>Linux PAM</application> support, you will need to modify 
      the pam configuration file which was installed by default to get 
      <application>polkit</application> to work correctly with BLFS.</para>

      <para>Issue the following commands as the <systemitem class="username">root</systemitem>
      user to create the configuration file for <application>Linux PAM</application>:
      </para>

<screen role="root"><userinput>cat &gt; /etc/pam.d/polkit-1 &lt;&lt; "EOF"
<literal># Begin /etc/pam.d/polkit-1

auth     include        system-auth
account  include        system-account
password include        system-password
session  include        system-session

# End /etc/pam.d/polkit-1</literal>
EOF</userinput></screen>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>pk-example-frobnicate, pkaction, pkcheck, pkexec,
        polkit-agent-helper-1, and polkitd</seg>
        <seg>libnullbackend.{so,a}, libpolkit-agent-1.{so,a},
        libpolkit-backend-1.{so,a} and libpolkit-gobject-1.{so,a}</seg>
        <seg>/etc/polkit-1, /usr/include/polkit-1, /usr/lib/polkit-1, 
        /usr/share/polkit-1 and /var/lib/polkit-1</seg>
      </seglistitem>
    </segmentedlist>

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

<!--  <varlistentry id="pk-example-frobnicate">
        <term><command>pk-example-frobnicate</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="polkit pk-example-frobnicate">
            <primary sortas="b-pk-example-frobnicate">pk-example-frobnicate</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

      <varlistentry id="pkaction">
        <term><command>pkaction</command></term>
        <listitem>
          <para>is used to obtain information about registered PolicyKit actions.</para>
          <indexterm zone="polkit pkaction">
            <primary sortas="b-pkaction">pkaction</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pkcheck">
        <term><command>pkcheck</command></term>
        <listitem>
          <para>is used to check whether a process is authorized for action.</para>
          <indexterm zone="polkit pkcheck">
            <primary sortas="b-pkcheck">pkcheck</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="pkexec">
        <term><command>pkexec</command></term>
        <listitem>
          <para>allows an authorized user to execute a command as another user.</para>
          <indexterm zone="polkit pkexec">
            <primary sortas="b-pkexec">pkexec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

<!--  <varlistentry id="polkit-agent-helper-1">
        <term><command>polkit-agent-helper-1</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="polkit polkit-agent-helper-1">
            <primary sortas="b-polkit-agent-helper-1">polkit-agent-helper-1</primary>
          </indexterm>
        </listitem>
      </varlistentry>-->

      <varlistentry id="polkitd">
        <term><command>polkitd</command></term>
        <listitem>
          <para>provides the org.freedesktop.PolicyKit1
          <application>D-Bus</application> service on the system message bus.</para>
          <indexterm zone="polkit polkitd">
            <primary sortas="b-polkitd">polkitd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libnullbackend">
        <term><filename class='libraryfile'>libnullbackend.{so,a}</filename></term>
        <listitem>
          <para>PolicyKit null backend</para>
          <indexterm zone="polkit libnullbackend">
            <primary sortas="c-libnullbackend">libnullbackend.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

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

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

    </variablelist>

  </sect2>

</sect1>