[012cdc8] | 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 policykit-download-http "http://hal.freedesktop.org/releases/PolicyKit-&policykit-version;.tar.gz">
|
---|
| 8 | <!ENTITY policykit-download-ftp " ">
|
---|
| 9 | <!ENTITY policykit-md5sum "802fd13ae41f73d79359e5ecb0a98716">
|
---|
| 10 | <!ENTITY policykit-size "1.2 MB">
|
---|
| 11 | <!ENTITY policykit-buildsize "11 MB">
|
---|
| 12 | <!ENTITY policykit-time "0.4 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="policykit" xreflabel="PolicyKit-&policykit-version;">
|
---|
| 16 | <?dbhtml filename="policykit.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>PolicyKit-&policykit-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="policykit">
|
---|
| 26 | <primary sortas="a-PolicyKit">PolicyKit</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to PolicyKit</title>
|
---|
| 31 |
|
---|
| 32 | <para>The <application>PolicyKit</application> package is an
|
---|
| 33 | application-level toolkit for defining and handling the policy that allows
|
---|
| 34 | unprivileged processes to speak to privileged processes.</para>
|
---|
| 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>Download (HTTP): <ulink url="&policykit-download-http;"/></para>
|
---|
| 40 | </listitem>
|
---|
| 41 | <listitem>
|
---|
| 42 | <para>Download (FTP): <ulink url="&policykit-download-ftp;"/></para>
|
---|
| 43 | </listitem>
|
---|
| 44 | <listitem>
|
---|
| 45 | <para>Download MD5 sum: &policykit-md5sum;</para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>Download size: &policykit-size;</para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>Estimated disk space required: &policykit-buildsize;</para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>Estimated build time: &policykit-time;</para>
|
---|
| 55 | </listitem>
|
---|
| 56 | </itemizedlist>
|
---|
| 57 |
|
---|
| 58 | <bridgehead renderas="sect3">PolicyKit Dependencies</bridgehead>
|
---|
| 59 |
|
---|
| 60 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[07f0c976] | 61 | <para role="required"><xref linkend="dbus-glib"/>,
|
---|
[012cdc8] | 62 | <xref linkend="linux-pam"/>,
|
---|
| 63 | <xref linkend="intltool"/>, and
|
---|
| 64 | <xref linkend="docbook-xsl"/></para>
|
---|
| 65 |
|
---|
| 66 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[07f0c976] | 67 | <para role="optional"><xref linkend="gtk-doc"/></para>
|
---|
[012cdc8] | 68 |
|
---|
| 69 | <para condition="html" role="usernotes">User Notes:
|
---|
| 70 | <ulink url="&blfs-wiki;/policykit"/></para>
|
---|
| 71 |
|
---|
| 72 | </sect2>
|
---|
| 73 |
|
---|
| 74 | <sect2 role="installation">
|
---|
| 75 | <title>Installation of PolicyKit</title>
|
---|
| 76 |
|
---|
[07f0c976] | 77 | <para>It is a requirement to have a dedicated user and group for
|
---|
| 78 | <application>PolicyKit</application> to function correctly. Issue the
|
---|
| 79 | following commands as the <systemitem class="username">root</systemitem>
|
---|
| 80 | user:</para>
|
---|
[012cdc8] | 81 |
|
---|
[07f0c976] | 82 | <screen><userinput>groupadd -g 27 polkituser &&
|
---|
[012cdc8] | 83 | useradd -c "Policy Kit Daemon User" -d /dev/null \
|
---|
[07f0c976] | 84 | -u 27 -g polkituser -s /bin/false polkituser</userinput></screen>
|
---|
| 85 |
|
---|
| 86 | <para>Install <application>PolicyKit</application> by running the following
|
---|
| 87 | commands as an unprivileged user:</para>
|
---|
| 88 |
|
---|
| 89 | <screen><userinput>./configure --prefix=/usr --sysconfdir=/etc \
|
---|
| 90 | --libexecdir=/usr/lib/PolicyKit --localstatedir=/var &&
|
---|
[012cdc8] | 91 | make</userinput></screen>
|
---|
| 92 |
|
---|
| 93 | <para>This package does not come with a test suite.</para>
|
---|
| 94 |
|
---|
| 95 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
| 96 |
|
---|
| 97 | <screen role="root"><userinput>make install &&
|
---|
| 98 | install -v -d -m755 /usr/share/doc/PolicyKit-&policykit-version; &&
|
---|
| 99 | cp -v -r doc/html /usr/share/doc/PolicyKit-&policykit-version;</userinput></screen>
|
---|
| 100 |
|
---|
| 101 | </sect2>
|
---|
| 102 |
|
---|
| 103 | <sect2 role="commands">
|
---|
| 104 | <title>Command Explanations</title>
|
---|
| 105 |
|
---|
| 106 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
| 107 | href="../../xincludes/gtk-doc-rebuild.xml"/>
|
---|
| 108 |
|
---|
| 109 | </sect2>
|
---|
| 110 |
|
---|
| 111 | <sect2 role="configuration">
|
---|
| 112 | <title>Configuring PolicyKit</title>
|
---|
| 113 |
|
---|
| 114 | <sect3 id="PolicyKit-config">
|
---|
| 115 | <title>Config Files</title>
|
---|
| 116 | <para><filename>/etc/PolicyKit/PolicyKit.conf</filename></para>
|
---|
| 117 |
|
---|
| 118 | <indexterm zone="policykit PolicyKit-config">
|
---|
| 119 | <primary sortas="e-etc-PolicyKit-PolicyKit.conf">/etc/PolicyKit/PolicyKit.conf</primary>
|
---|
| 120 | </indexterm>
|
---|
| 121 | </sect3>
|
---|
| 122 |
|
---|
| 123 | <sect3><title>Configuration Information</title>
|
---|
| 124 |
|
---|
| 125 | <para>See manual page PolicyKit.conf(5).</para>
|
---|
| 126 |
|
---|
| 127 | </sect3>
|
---|
| 128 |
|
---|
| 129 | </sect2>
|
---|
| 130 |
|
---|
| 131 | <sect2 role="content">
|
---|
| 132 | <title>Contents</title>
|
---|
| 133 |
|
---|
| 134 | <segmentedlist>
|
---|
| 135 | <segtitle>Installed Programs</segtitle>
|
---|
| 136 | <segtitle>Installed Libraries</segtitle>
|
---|
| 137 | <segtitle>Installed Directories</segtitle>
|
---|
| 138 |
|
---|
| 139 | <seglistitem>
|
---|
| 140 | <seg>polkit-auth, polkit-policy-file-validate,
|
---|
| 141 | polkit-config-file-validate, polkit-action, polkit-read-auth-helper,
|
---|
| 142 | polkit-grant-helper-pam, polkit-grant-helper, polkit-revoke-helper,
|
---|
| 143 | polkitd, polkit-explicit-grant-helper, polkit-set-default-helper,
|
---|
| 144 | and polkit-resolve-exe-helper</seg>
|
---|
| 145 | <seg>libpolkit.{so,a}, libpolkit-dbus.{so,a}, and libpolkit-grant.{so,a}</seg>
|
---|
| 146 | <seg>/etc/PolicyKit, /usr/lib/PolicyKit, /usr/include/PolicyKit/polkit,
|
---|
| 147 | /usr/include/PolicyKit/polkit-dbus, /usr/include/PolicyKit/polkit-grant,
|
---|
| 148 | /usr/share/PolicyKit/policy, /var/lib/misc, /var/lib/PolicyKit,
|
---|
| 149 | /var/lib/PolicyKit-public, and /usr/share/doc/PolicyKit-&policykit-version;</seg>
|
---|
| 150 | </seglistitem>
|
---|
| 151 | </segmentedlist>
|
---|
| 152 |
|
---|
| 153 | <variablelist>
|
---|
| 154 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 155 | <?dbfo list-presentation="list"?>
|
---|
| 156 | <?dbhtml list-presentation="table"?>
|
---|
| 157 |
|
---|
| 158 | <varlistentry id="polkit-auth">
|
---|
| 159 | <term><command>polkit-auth</command></term>
|
---|
| 160 | <listitem>
|
---|
| 161 | <para>is used to inspect, obtain, grant and revoke
|
---|
| 162 | <application>PolicyKit</application> authorizations.</para>
|
---|
| 163 | <indexterm zone="policykit polkit-auth">
|
---|
| 164 | <primary sortas="b-polkit-auth">polkit-auth</primary>
|
---|
| 165 | </indexterm>
|
---|
| 166 | </listitem>
|
---|
| 167 | </varlistentry>
|
---|
| 168 |
|
---|
| 169 | <varlistentry id="polkit-policy-file-validate">
|
---|
| 170 | <term><command>polkit-policy-file-validate</command></term>
|
---|
| 171 | <listitem>
|
---|
| 172 | <para>is used to verify that one or more
|
---|
| 173 | <application>PolicyKit</application> .policy files are valid.</para>
|
---|
| 174 | <indexterm zone="policykit polkit-policy-file-validate">
|
---|
| 175 | <primary sortas="b-polkit-policy-file-validate">polkit-policy-file-validate</primary>
|
---|
| 176 | </indexterm>
|
---|
| 177 | </listitem>
|
---|
| 178 | </varlistentry>
|
---|
| 179 |
|
---|
| 180 | <varlistentry id="polkit-config-file-validate">
|
---|
| 181 | <term><command>polkit-config-file-validate</command></term>
|
---|
| 182 | <listitem>
|
---|
| 183 | <para>is used to verify that a given <application>PolicyKit</application>
|
---|
| 184 | configuration file is valid.</para>
|
---|
| 185 | <indexterm zone="policykit polkit-config-file-validate">
|
---|
| 186 | <primary sortas="b-polkit-config-file-validate">polkit-config-file-validate</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
| 191 | <varlistentry id="polkit-action">
|
---|
| 192 | <term><command>polkit-action</command></term>
|
---|
| 193 | <listitem>
|
---|
| 194 | <para>is used to list and modify the <application>PolicyKit</application>
|
---|
| 195 | actions that are registered on the system.</para>
|
---|
| 196 | <indexterm zone="policykit polkit-action">
|
---|
| 197 | <primary sortas="b-polkit-action">polkit-action</primary>
|
---|
| 198 | </indexterm>
|
---|
| 199 | </listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
| 202 | <varlistentry id="polkit-read-auth-helper">
|
---|
| 203 | <term><command>polkit-read-auth-helper</command></term>
|
---|
| 204 | <listitem>
|
---|
| 205 | <para>is the setgid polkituser helper for
|
---|
| 206 | <application>PolicyKit</application> to read authorizations.</para>
|
---|
| 207 | <indexterm zone="policykit polkit-read-auth-helper">
|
---|
| 208 | <primary sortas="b-polkit-read-auth-helper">polkit-read-auth-helper</primary>
|
---|
| 209 | </indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="polkit-grant-helper-pam">
|
---|
| 214 | <term><command>polkit-grant-helper-pam</command></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>is the setuid root pam grant helper for <application>PolicyKit</application>.</para>
|
---|
| 217 | <indexterm zone="policykit polkit-grant-helper-pam">
|
---|
| 218 | <primary sortas="b-polkit-grant-helper-pam">polkit-grant-helper-pam</primary>
|
---|
| 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
| 223 | <varlistentry id="polkit-grant-helper">
|
---|
| 224 | <term><command>polkit-grant-helper</command></term>
|
---|
| 225 | <listitem>
|
---|
| 226 | <para>is the setgid polkituser grant helper for <application>PolicyKit</application>.</para>
|
---|
| 227 | <indexterm zone="policykit polkit-grant-helper">
|
---|
| 228 | <primary sortas="b-polkit-grant-helper">polkit-grant-helper</primary>
|
---|
| 229 | </indexterm>
|
---|
| 230 | </listitem>
|
---|
| 231 | </varlistentry>
|
---|
| 232 |
|
---|
| 233 | <varlistentry id="polkit-revoke-helper">
|
---|
| 234 | <term><command>polkit-revoke-helper</command></term>
|
---|
| 235 | <listitem>
|
---|
| 236 | <para>is used to revoke authorizations.</para>
|
---|
| 237 | <indexterm zone="policykit polkit-revoke-helper">
|
---|
| 238 | <primary sortas="b-polkit-revoke-helper">polkit-revoke-helper</primary>
|
---|
| 239 | </indexterm>
|
---|
| 240 | </listitem>
|
---|
| 241 | </varlistentry>
|
---|
| 242 |
|
---|
| 243 | <varlistentry id="polkitd">
|
---|
| 244 | <term><command>polkitd</command></term>
|
---|
| 245 | <listitem>
|
---|
| 246 | <para>is the <application>PolicyKit</application> daemon.</para>
|
---|
| 247 | <indexterm zone="policykit polkitd">
|
---|
| 248 | <primary sortas="b-polkitd">polkitd</primary>
|
---|
| 249 | </indexterm>
|
---|
| 250 | </listitem>
|
---|
| 251 | </varlistentry>
|
---|
| 252 |
|
---|
| 253 | <varlistentry id="polkit-explicit-grant-helper">
|
---|
| 254 | <term><command>polkit-explicit-grant-helper</command></term>
|
---|
| 255 | <listitem>
|
---|
| 256 | <para>is used to grant authorizations.</para>
|
---|
| 257 | <indexterm zone="policykit polkit-explicit-grant-helper">
|
---|
| 258 | <primary sortas="b-polkit-explicit-grant-helper">polkit-explicit-grant-helper</primary>
|
---|
| 259 | </indexterm>
|
---|
| 260 | </listitem>
|
---|
| 261 | </varlistentry>
|
---|
| 262 |
|
---|
| 263 | <varlistentry id="polkit-set-default-helper">
|
---|
| 264 | <term><command>polkit-set-default-helper</command></term>
|
---|
| 265 | <listitem>
|
---|
| 266 | <para>is the setgid polkituser helper for <application>PolicyKit</application>.</para>
|
---|
| 267 | <indexterm zone="policykit polkit-set-default-helper">
|
---|
| 268 | <primary sortas="b-polkit-set-default-helper">polkit-set-default-helper</primary>
|
---|
| 269 | </indexterm>
|
---|
| 270 | </listitem>
|
---|
| 271 | </varlistentry>
|
---|
| 272 |
|
---|
| 273 | <varlistentry id="polkit-resolve-exe-helper">
|
---|
| 274 | <term><command>polkit-resolve-exe-helper</command></term>
|
---|
| 275 | <listitem>
|
---|
| 276 | <para>is used to find the executable name for a process.</para>
|
---|
| 277 | <indexterm zone="policykit polkit-resolve-exe-helper">
|
---|
| 278 | <primary sortas="b-polkit-resolve-exe-helper">polkit-resolve-exe-helper</primary>
|
---|
| 279 | </indexterm>
|
---|
| 280 | </listitem>
|
---|
| 281 | </varlistentry>
|
---|
| 282 |
|
---|
| 283 | <varlistentry id="libpolkit">
|
---|
| 284 | <term><filename class='libraryfile'>libpolkit.{so,a}</filename></term>
|
---|
| 285 | <listitem>
|
---|
| 286 | <para>contains the <application>PolicyKit</application> API functions.</para>
|
---|
| 287 | <indexterm zone="policykit libpolkit">
|
---|
| 288 | <primary sortas="c-libpolkit">libpolkit.{so,a}</primary>
|
---|
| 289 | </indexterm>
|
---|
| 290 | </listitem>
|
---|
| 291 | </varlistentry>
|
---|
| 292 |
|
---|
| 293 | <varlistentry id="libpolkit-dbus">
|
---|
| 294 | <term><filename class='libraryfile'>libpolkit-dbus.{so,a}</filename></term>
|
---|
| 295 | <listitem>
|
---|
| 296 | <para>contains functions for obtaining seat, session and caller
|
---|
| 297 | information via <application>D-Bus</application> and
|
---|
| 298 | <application>ConsoleKit</application>.</para>
|
---|
| 299 | <indexterm zone="policykit libpolkit-dbus">
|
---|
| 300 | <primary sortas="c-libpolkit-dbus">libpolkit-dbus.{so,a}</primary>
|
---|
| 301 | </indexterm>
|
---|
| 302 | </listitem>
|
---|
| 303 | </varlistentry>
|
---|
| 304 |
|
---|
| 305 | <varlistentry id="libpolkit-grant">
|
---|
| 306 | <term><filename class='libraryfile'>libpolkit-grant.{so,a}</filename></term>
|
---|
| 307 | <listitem>
|
---|
| 308 | <para>contains functions for obtaining authorizations through authentication.</para>
|
---|
| 309 | <indexterm zone="policykit libpolkit-grant">
|
---|
| 310 | <primary sortas="c-libpolkit-grant">libpolkit-grant.{so,a}</primary>
|
---|
| 311 | </indexterm>
|
---|
| 312 | </listitem>
|
---|
| 313 | </varlistentry>
|
---|
| 314 |
|
---|
| 315 | </variablelist>
|
---|
| 316 |
|
---|
| 317 | </sect2>
|
---|
| 318 |
|
---|
| 319 | </sect1>
|
---|