| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 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 polkit-download-http "https://github.com/polkit-org/polkit/archive/&polkit-version;/polkit-&polkit-version;.tar.gz">
|
|---|
| 8 | <!ENTITY polkit-download-ftp " ">
|
|---|
| 9 | <!ENTITY polkit-md5sum "8e9f2377fc7b4010bd29b97d2e288b4f">
|
|---|
| 10 | <!ENTITY polkit-size "444 KB">
|
|---|
| 11 | <!ENTITY polkit-buildsize "7.2 MB (with tests)">
|
|---|
| 12 | <!ENTITY polkit-time "0.3 SBU (with tests; using parallelism=4)">
|
|---|
| 13 | ]>
|
|---|
| 14 |
|
|---|
| 15 | <sect1 id="polkit" xreflabel="Polkit-&polkit-version;">
|
|---|
| 16 | <?dbhtml filename="polkit.html"?>
|
|---|
| 17 |
|
|---|
| 18 |
|
|---|
| 19 | <title>Polkit-&polkit-version;</title>
|
|---|
| 20 |
|
|---|
| 21 | <indexterm zone="polkit">
|
|---|
| 22 | <primary sortas="a-Polkit">Polkit</primary>
|
|---|
| 23 | </indexterm>
|
|---|
| 24 |
|
|---|
| 25 | <sect2 role="package">
|
|---|
| 26 | <title>Introduction to Polkit</title>
|
|---|
| 27 |
|
|---|
| 28 | <para>
|
|---|
| 29 | <application>Polkit</application> is a toolkit for defining and handling
|
|---|
| 30 | authorizations. It is used for allowing unprivileged processes to
|
|---|
| 31 | communicate with privileged processes.
|
|---|
| 32 | </para>
|
|---|
| 33 |
|
|---|
| 34 | &lfs122_checked;
|
|---|
| 35 |
|
|---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
|---|
| 37 | <itemizedlist spacing="compact">
|
|---|
| 38 | <listitem>
|
|---|
| 39 | <para>
|
|---|
| 40 | Download (HTTP): <ulink url="&polkit-download-http;"/>
|
|---|
| 41 | </para>
|
|---|
| 42 | </listitem>
|
|---|
| 43 | <listitem>
|
|---|
| 44 | <para>
|
|---|
| 45 | Download (FTP): <ulink url="&polkit-download-ftp;"/>
|
|---|
| 46 | </para>
|
|---|
| 47 | </listitem>
|
|---|
| 48 | <listitem>
|
|---|
| 49 | <para>
|
|---|
| 50 | Download MD5 sum: &polkit-md5sum;
|
|---|
| 51 | </para>
|
|---|
| 52 | </listitem>
|
|---|
| 53 | <listitem>
|
|---|
| 54 | <para>
|
|---|
| 55 | Download size: &polkit-size;
|
|---|
| 56 | </para>
|
|---|
| 57 | </listitem>
|
|---|
| 58 | <listitem>
|
|---|
| 59 | <para>
|
|---|
| 60 | Estimated disk space required: &polkit-buildsize;
|
|---|
| 61 | </para>
|
|---|
| 62 | </listitem>
|
|---|
| 63 | <listitem>
|
|---|
| 64 | <para>
|
|---|
| 65 | Estimated build time: &polkit-time;
|
|---|
| 66 | </para>
|
|---|
| 67 | </listitem>
|
|---|
| 68 | </itemizedlist>
|
|---|
| 69 |
|
|---|
| 70 | <!--
|
|---|
| 71 | <bridgehead renderas="sect3">Additional Downloads</bridgehead>
|
|---|
| 72 | <itemizedlist spacing="compact">
|
|---|
| 73 | <listitem>
|
|---|
| 74 | <para>
|
|---|
| 75 | Required patch:
|
|---|
| 76 | <ulink url="&patch-root;/polkit-&polkit-version;-security_fixes-1.patch"/>
|
|---|
| 77 | </para>
|
|---|
| 78 | </listitem>
|
|---|
| 79 | <listitem>
|
|---|
| 80 | <para>
|
|---|
| 81 | Required patch:
|
|---|
| 82 | <ulink url="&patch-root;/polkit-&polkit-version;-js91-1.patch"/>
|
|---|
| 83 | </para>
|
|---|
| 84 | </listitem>
|
|---|
| 85 | </itemizedlist>
|
|---|
| 86 | -->
|
|---|
| 87 |
|
|---|
| 88 | <bridgehead renderas="sect3">Polkit Dependencies</bridgehead>
|
|---|
| 89 |
|
|---|
| 90 | <bridgehead renderas="sect4">Required</bridgehead>
|
|---|
| 91 | <para role="required">
|
|---|
| 92 | <xref linkend="glib2"/> (GObject Introspection recommended)
|
|---|
| 93 | </para>
|
|---|
| 94 |
|
|---|
| 95 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
|---|
| 96 | <para role="recommended">
|
|---|
| 97 | <!-- For jhalfs just make it required to avoid over-complexity. -->
|
|---|
| 98 | <xref role="required" linkend="duktape"/>,
|
|---|
| 99 | <xref linkend="libxslt"/>,<phrase revision="systemd"> and</phrase>
|
|---|
| 100 | <xref linkend="linux-pam"/><phrase revision="sysv">, and
|
|---|
| 101 | <xref linkend="elogind"/>
|
|---|
| 102 | </phrase>
|
|---|
| 103 | </para>
|
|---|
| 104 |
|
|---|
| 105 | <note>
|
|---|
| 106 | <para>
|
|---|
| 107 | Since <phrase revision="sysv"><command>elogind</command></phrase>
|
|---|
| 108 | <phrase revision="systemd"><command>systemd-logind</command></phrase>
|
|---|
| 109 | uses PAM to register user sessions, it is a good idea to build
|
|---|
| 110 | <application>Polkit</application> with PAM support so
|
|---|
| 111 | <phrase revision="sysv"><command>elogind</command></phrase>
|
|---|
| 112 | <phrase revision="systemd"><command>systemd-logind</command></phrase>
|
|---|
| 113 | can track <application>Polkit</application> sessions.
|
|---|
| 114 | </para>
|
|---|
| 115 | </note>
|
|---|
| 116 |
|
|---|
| 117 | <bridgehead renderas="sect4">Optional</bridgehead>
|
|---|
| 118 | <para role="optional">
|
|---|
| 119 | <xref linkend="gtk-doc"/>,
|
|---|
| 120 | <xref linkend="python-dbusmock"/> (required for tests), and
|
|---|
| 121 | <xref linkend="spidermonkey"/> (can be used in place of duktape)
|
|---|
| 122 | </para>
|
|---|
| 123 |
|
|---|
| 124 | <bridgehead renderas="sect4" revision="systemd">Required Runtime Dependencies</bridgehead>
|
|---|
| 125 | <para role="required" revision="systemd">
|
|---|
| 126 | <xref role="runtime" linkend="systemd"/>
|
|---|
| 127 | </para>
|
|---|
| 128 |
|
|---|
| 129 | <bridgehead renderas="sect4" id="polkit-agent" xreflabel="Polkit Authentication Agent">
|
|---|
| 130 | Optional Runtime Dependencies
|
|---|
| 131 | </bridgehead>
|
|---|
| 132 | <para role="optional">
|
|---|
| 133 | One polkit authentication agent for using polkit in the graphical
|
|---|
| 134 | environment:
|
|---|
| 135 | <application>polkit-kde-agent</application> in
|
|---|
| 136 | <xref role="runtime" linkend="plasma-build"/> for KDE,
|
|---|
| 137 | the agent built in
|
|---|
| 138 | <xref role="runtime" linkend="gnome-shell"/> for GNOME3,
|
|---|
| 139 | <xref role="runtime" linkend="polkit-gnome"/> for XFCE, and
|
|---|
| 140 | <xref role="runtime" linkend="lxqt-policykit"/> for LXQt
|
|---|
| 141 | </para>
|
|---|
| 142 |
|
|---|
| 143 | <note>
|
|---|
| 144 | <para>
|
|---|
| 145 | If <xref linkend="libxslt"/> is installed,
|
|---|
| 146 | then <xref linkend="DocBook"/> and <xref linkend="docbook-xsl"/> are
|
|---|
| 147 | required. If you have installed <xref linkend="libxslt"/>, but you do
|
|---|
| 148 | not want to install any of the DocBook packages mentioned, you will
|
|---|
| 149 | need to use <option>-D man=false</option> in the instructions
|
|---|
| 150 | below.
|
|---|
| 151 | </para>
|
|---|
| 152 | </note>
|
|---|
| 153 |
|
|---|
| 154 | </sect2>
|
|---|
| 155 |
|
|---|
| 156 | <sect2 role="kernel" id="polkit-test-kernel">
|
|---|
| 157 | <title>Kernel Configuration</title>
|
|---|
| 158 |
|
|---|
| 159 | <para>
|
|---|
| 160 | Some tests need user namespace. If running the test suite, enable it:
|
|---|
| 161 | </para>
|
|---|
| 162 |
|
|---|
| 163 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 164 | href="polkit-test-kernel.xml"/>
|
|---|
| 165 |
|
|---|
| 166 | <indexterm zone="polkit polkit-test-kernel">
|
|---|
| 167 | <primary sortas="d-polkit">polkit (testing)</primary>
|
|---|
| 168 | </indexterm>
|
|---|
| 169 | </sect2>
|
|---|
| 170 |
|
|---|
| 171 | <sect2 role="installation">
|
|---|
| 172 | <title>Installation of Polkit</title>
|
|---|
| 173 |
|
|---|
| 174 | <para>
|
|---|
| 175 | There should be a dedicated user and group to take control
|
|---|
| 176 | of the <command>polkitd</command> daemon after it is
|
|---|
| 177 | started. Issue the following commands as the
|
|---|
| 178 | <systemitem class="username">root</systemitem> user:
|
|---|
| 179 | </para>
|
|---|
| 180 |
|
|---|
| 181 | <screen role="root"><userinput>groupadd -fg 27 polkitd &&
|
|---|
| 182 | useradd -c "PolicyKit Daemon Owner" -d /etc/polkit-1 -u 27 \
|
|---|
| 183 | -g polkitd -s /bin/false polkitd</userinput></screen>
|
|---|
| 184 |
|
|---|
| 185 | <para revision='sysv'>
|
|---|
| 186 | First fix a build problem for sysV based systems:
|
|---|
| 187 | </para>
|
|---|
| 188 |
|
|---|
| 189 | <screen revision="sysv"><userinput>sed -i '/systemd_sysusers_dir/s/^/#/' meson.build</userinput></screen>
|
|---|
| 190 |
|
|---|
| 191 | <para>
|
|---|
| 192 | Install <application>Polkit</application> by running the following
|
|---|
| 193 | commands:
|
|---|
| 194 | </para>
|
|---|
| 195 |
|
|---|
| 196 | <screen revision="systemd"><userinput>mkdir build &&
|
|---|
| 197 | cd build &&
|
|---|
| 198 |
|
|---|
| 199 | meson setup .. \
|
|---|
| 200 | --prefix=/usr \
|
|---|
| 201 | --buildtype=release \
|
|---|
| 202 | -D man=true \
|
|---|
| 203 | -D session_tracking=logind \
|
|---|
| 204 | -D tests=true</userinput></screen>
|
|---|
| 205 |
|
|---|
| 206 | <screen revision="sysv"><userinput>mkdir build &&
|
|---|
| 207 | cd build &&
|
|---|
| 208 |
|
|---|
| 209 | meson setup .. \
|
|---|
| 210 | --prefix=/usr \
|
|---|
| 211 | --buildtype=release \
|
|---|
| 212 | -D man=true \
|
|---|
| 213 | -D session_tracking=elogind \
|
|---|
| 214 | -D tests=true</userinput></screen>
|
|---|
| 215 |
|
|---|
| 216 | <para>
|
|---|
| 217 | Build the package:
|
|---|
| 218 | </para>
|
|---|
| 219 |
|
|---|
| 220 | <screen><userinput>ninja</userinput></screen>
|
|---|
| 221 |
|
|---|
| 222 | <para>
|
|---|
| 223 | To test the results, first ensure that the system
|
|---|
| 224 | <application>D-Bus</application> daemon is running,
|
|---|
| 225 | and both <xref linkend='dbus-python'/> and
|
|---|
| 226 | <xref linkend='python-dbusmock'/> are installed.
|
|---|
| 227 | Then run <command>ninja test</command>.
|
|---|
| 228 | </para>
|
|---|
| 229 |
|
|---|
| 230 | <para>
|
|---|
| 231 | Now, as the <systemitem class="username">root</systemitem> user:
|
|---|
| 232 | </para>
|
|---|
| 233 |
|
|---|
| 234 | <screen role="root"><userinput>ninja install</userinput></screen>
|
|---|
| 235 |
|
|---|
| 236 | </sect2>
|
|---|
| 237 |
|
|---|
| 238 | <sect2 role="commands">
|
|---|
| 239 | <title>Command Explanations</title>
|
|---|
| 240 |
|
|---|
| 241 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
|---|
| 242 | href="../../xincludes/meson-buildtype-release.xml"/>
|
|---|
| 243 |
|
|---|
| 244 | <para>
|
|---|
| 245 | <parameter>-D tests=true</parameter>: This switch allows to run the
|
|---|
| 246 | test suite of this package. As <application>Polkit</application> is
|
|---|
| 247 | used for authorizations, its integrity can affect system security.
|
|---|
| 248 | So it's recommended to run the test suite building this package.
|
|---|
| 249 | </para>
|
|---|
| 250 |
|
|---|
| 251 | <para>
|
|---|
| 252 | <option>-D js_engine=mozjs</option>: This switch allows using the
|
|---|
| 253 | <xref linkend="spidermonkey"/> JavaScript engine instead of the
|
|---|
| 254 | <xref linkend='duktape'/> JavaScript engine.
|
|---|
| 255 | </para>
|
|---|
| 256 |
|
|---|
| 257 | <para>
|
|---|
| 258 | <option>-D os_type=lfs</option>: Use this switch if you did not create
|
|---|
| 259 | the <filename>/etc/lfs-release</filename> file or distribution auto
|
|---|
| 260 | detection will fail and you will be unable to use
|
|---|
| 261 | <application>Polkit</application>.
|
|---|
| 262 | </para>
|
|---|
| 263 |
|
|---|
| 264 | <para>
|
|---|
| 265 | <option>-D authfw=shadow</option>: This switch enables the
|
|---|
| 266 | package to use the <application>Shadow</application> rather than the
|
|---|
| 267 | <application>Linux PAM</application> Authentication framework. Use it
|
|---|
| 268 | if you have not installed <application>Linux PAM</application>.
|
|---|
| 269 | </para>
|
|---|
| 270 |
|
|---|
| 271 | <para>
|
|---|
| 272 | <option>-D introspection=false</option>: Use this option if you are certain
|
|---|
| 273 | that you do not need gobject-introspection files for polkit, or do not have
|
|---|
| 274 | installed <xref linkend='glib2'/> with GObject Introspection.
|
|---|
| 275 | </para>
|
|---|
| 276 |
|
|---|
| 277 | <para>
|
|---|
| 278 | <option>-D man=false</option>: Use this option to disable generating and
|
|---|
| 279 | installing manual pages. This is useful if libxslt is not installed.
|
|---|
| 280 | </para>
|
|---|
| 281 |
|
|---|
| 282 | <para>
|
|---|
| 283 | <option>-D examples=true</option>: Use this option to build the example
|
|---|
| 284 | programs.
|
|---|
| 285 | </para>
|
|---|
| 286 |
|
|---|
| 287 | <para>
|
|---|
| 288 | <option>-D gtk_doc=true</option>: Use this option to enable building and
|
|---|
| 289 | installing the API documentation.
|
|---|
| 290 | </para>
|
|---|
| 291 |
|
|---|
| 292 | </sect2>
|
|---|
| 293 |
|
|---|
| 294 | <sect2 role="content">
|
|---|
| 295 | <title>Contents</title>
|
|---|
| 296 |
|
|---|
| 297 | <segmentedlist>
|
|---|
| 298 | <segtitle>Installed Programs</segtitle>
|
|---|
| 299 | <segtitle>Installed Libraries</segtitle>
|
|---|
| 300 | <segtitle>Installed Directories</segtitle>
|
|---|
| 301 |
|
|---|
| 302 | <seglistitem>
|
|---|
| 303 | <seg>
|
|---|
| 304 | pkaction, pkcheck, <!--pk-example-frobnicate,--> pkexec,
|
|---|
| 305 | pkttyagent, and polkitd
|
|---|
| 306 | </seg>
|
|---|
| 307 | <seg>
|
|---|
| 308 | libpolkit-agent-1.so and
|
|---|
| 309 | libpolkit-gobject-1.so
|
|---|
| 310 | </seg>
|
|---|
| 311 | <seg>
|
|---|
| 312 | /etc/polkit-1,
|
|---|
| 313 | /usr/include/polkit-1,
|
|---|
| 314 | /usr/lib/polkit-1,
|
|---|
| 315 | /usr/share/gtk-doc/html/polkit-1, and
|
|---|
| 316 | /usr/share/polkit-1
|
|---|
| 317 | </seg>
|
|---|
| 318 | </seglistitem>
|
|---|
| 319 | </segmentedlist>
|
|---|
| 320 |
|
|---|
| 321 | <variablelist>
|
|---|
| 322 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
|---|
| 323 | <?dbfo list-presentation="list"?>
|
|---|
| 324 | <?dbhtml list-presentation="table"?>
|
|---|
| 325 |
|
|---|
| 326 | <varlistentry id="pkaction">
|
|---|
| 327 | <term><command>pkaction</command></term>
|
|---|
| 328 | <listitem>
|
|---|
| 329 | <para>
|
|---|
| 330 | is used to obtain information about registered PolicyKit actions
|
|---|
| 331 | </para>
|
|---|
| 332 | <indexterm zone="polkit pkaction">
|
|---|
| 333 | <primary sortas="b-pkaction">pkaction</primary>
|
|---|
| 334 | </indexterm>
|
|---|
| 335 | </listitem>
|
|---|
| 336 | </varlistentry>
|
|---|
| 337 |
|
|---|
| 338 | <varlistentry id="pkcheck">
|
|---|
| 339 | <term><command>pkcheck</command></term>
|
|---|
| 340 | <listitem>
|
|---|
| 341 | <para>
|
|---|
| 342 | is used to check whether a process is authorized for action
|
|---|
| 343 | </para>
|
|---|
| 344 | <indexterm zone="polkit pkcheck">
|
|---|
| 345 | <primary sortas="b-pkcheck">pkcheck</primary>
|
|---|
| 346 | </indexterm>
|
|---|
| 347 | </listitem>
|
|---|
| 348 | </varlistentry>
|
|---|
| 349 |
|
|---|
| 350 | <!--
|
|---|
| 351 | <varlistentry id="pk-example-frobnicate">
|
|---|
| 352 | <term><command>pk-example-frobnicate</command></term>
|
|---|
| 353 | <listitem>
|
|---|
| 354 | <para>
|
|---|
| 355 | is an example program to test the <command>pkexec</command>
|
|---|
| 356 | command
|
|---|
| 357 | </para>
|
|---|
| 358 | <indexterm zone="polkit pk-example-frobnicate">
|
|---|
| 359 | <primary sortas="b-pk-example-frobnicate">pk-example-frobnicate</primary>
|
|---|
| 360 | </indexterm>
|
|---|
| 361 | </listitem>
|
|---|
| 362 | </varlistentry>
|
|---|
| 363 | -->
|
|---|
| 364 |
|
|---|
| 365 | <varlistentry id="pkexec">
|
|---|
| 366 | <term><command>pkexec</command></term>
|
|---|
| 367 | <listitem>
|
|---|
| 368 | <para>
|
|---|
| 369 | allows an authorized user to execute a command as another user
|
|---|
| 370 | </para>
|
|---|
| 371 | <indexterm zone="polkit pkexec">
|
|---|
| 372 | <primary sortas="b-pkexec">pkexec</primary>
|
|---|
| 373 | </indexterm>
|
|---|
| 374 | </listitem>
|
|---|
| 375 | </varlistentry>
|
|---|
| 376 |
|
|---|
| 377 | <varlistentry id="pkttyagent">
|
|---|
| 378 | <term><command>pkttyagent</command></term>
|
|---|
| 379 | <listitem>
|
|---|
| 380 | <para>
|
|---|
| 381 | is used to start a textual authentication agent for the subject
|
|---|
| 382 | </para>
|
|---|
| 383 | <indexterm zone="polkit pkttyagent">
|
|---|
| 384 | <primary sortas="b-pkttyagent">pkttyagent</primary>
|
|---|
| 385 | </indexterm>
|
|---|
| 386 | </listitem>
|
|---|
| 387 | </varlistentry>
|
|---|
| 388 |
|
|---|
| 389 | <varlistentry id="polkitd">
|
|---|
| 390 | <term><command>polkitd</command></term>
|
|---|
| 391 | <listitem>
|
|---|
| 392 | <para>
|
|---|
| 393 | provides the org.freedesktop.PolicyKit1 <application>D-Bus</application>
|
|---|
| 394 | service on the system message bus
|
|---|
| 395 | </para>
|
|---|
| 396 | <indexterm zone="polkit polkitd">
|
|---|
| 397 | <primary sortas="b-polkitd">polkitd</primary>
|
|---|
| 398 | </indexterm>
|
|---|
| 399 | </listitem>
|
|---|
| 400 | </varlistentry>
|
|---|
| 401 |
|
|---|
| 402 | <varlistentry id="libpolkit-agent-1">
|
|---|
| 403 | <term><filename class="libraryfile">libpolkit-agent-1.so</filename></term>
|
|---|
| 404 | <listitem>
|
|---|
| 405 | <para>
|
|---|
| 406 | contains the <application>Polkit</application> authentication
|
|---|
| 407 | agent API functions
|
|---|
| 408 | </para>
|
|---|
| 409 | <indexterm zone="polkit libpolkit-agent-1">
|
|---|
| 410 | <primary sortas="c-libpolkit-agent-1">libpolkit-agent-1.so</primary>
|
|---|
| 411 | </indexterm>
|
|---|
| 412 | </listitem>
|
|---|
| 413 | </varlistentry>
|
|---|
| 414 |
|
|---|
| 415 | <varlistentry id="libpolkit-gobject-1">
|
|---|
| 416 | <term><filename class="libraryfile">libpolkit-gobject-1.so</filename></term>
|
|---|
| 417 | <listitem>
|
|---|
| 418 | <para>
|
|---|
| 419 | contains the <application>Polkit</application> authorization API functions
|
|---|
| 420 | </para>
|
|---|
| 421 | <indexterm zone="polkit libpolkit-gobject-1">
|
|---|
| 422 | <primary sortas="c-libpolkit-gobject-1">libpolkit-gobject-1.so</primary>
|
|---|
| 423 | </indexterm>
|
|---|
| 424 | </listitem>
|
|---|
| 425 | </varlistentry>
|
|---|
| 426 |
|
|---|
| 427 | </variablelist>
|
|---|
| 428 |
|
|---|
| 429 | </sect2>
|
|---|
| 430 |
|
|---|
| 431 | </sect1>
|
|---|
