source: postlfs/security/polkit.xml@ b9567b04

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since b9567b04 was b9567b04, checked in by Xi Ruoyao <xry111@…>, 11 months ago

postlfs: Remove non-exist User Notes link

Part of User Notes removal by
https://www.linuxfromscratch.org/~xry111/remove-nonexist-usernote.sh

  • Property mode set to 100644
File size: 14.8 KB
Line 
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 polkit-download-http "https://gitlab.freedesktop.org/polkit/polkit/-/archive/&polkit-version;/polkit-&polkit-version;.tar.gz">
8 <!ENTITY polkit-download-ftp " ">
9 <!ENTITY polkit-md5sum "bbe3e745fc5bc1a41f1b5044f09a0f26">
10 <!ENTITY polkit-size "728 KB">
11 <!ENTITY polkit-buildsize "7.0 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 &lfs113_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"/> and
93 <xref linkend="duktape"/>
94 </para>
95
96 <bridgehead renderas="sect4">Recommended</bridgehead>
97 <para role="recommended">
98 <xref linkend="gobject-introspection"/>,
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
118 <!-- Due to the fact that meson will not autodetect g-i and
119 has it set to required unless you pass an option, and the likelihood
120 of users ignoring a command explanation and then sending in mails
121 regarding KDE or GNOME not working after installing polkit, let's move
122 it to recommended. See #15640 for logic
123 <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
124 <para role="optional">
125 <xref linkend="gobject-introspection"/>
126 </para>
127 -->
128
129 <bridgehead renderas="sect4">Optional</bridgehead>
130 <para role="optional">
131 <xref linkend="gtk-doc"/>,
132 <xref linkend="js102"/> (can be used in place of duktape), and
133 <xref linkend="python-dbusmock"/> (for tests)
134 </para>
135
136 <bridgehead renderas="sect4" revision="systemd">Required Runtime Dependencies</bridgehead>
137 <para role="required" revision="systemd">
138 <xref role="runtime" linkend="systemd"/>
139 </para>
140
141 <bridgehead renderas="sect4" id="polkit-agent" xreflabel="Polkit Authentication Agent">
142 Optional Runtime Dependencies
143 </bridgehead>
144 <para role="optional">
145 One polkit authentication agent for using polkit in the graphical
146 environment:
147 <application>polkit-kde-agent</application> in
148 <xref role="runtime" linkend="plasma5-build"/> for KDE,
149 the agent built in
150 <xref role="runtime" linkend="gnome-shell"/> for GNOME3,
151 <xref role="runtime" linkend="polkit-gnome"/> for XFCE, and
152 <application>lxpolkit</application> in
153 <xref role="runtime" linkend="lxsession"/> for LXDE
154 </para>
155
156 <note>
157 <para>
158 If <xref linkend="libxslt"/> is installed,
159 then <xref linkend="DocBook"/> and <xref linkend="docbook-xsl"/> are
160 required. If you have installed <xref linkend="libxslt"/>, but you do
161 not want to install any of the DocBook packages mentioned, you will
162 need to use <option>-Dman=false</option> in the instructions
163 below.
164 </para>
165 </note>
166
167 </sect2>
168
169 <sect2 role="installation">
170 <title>Installation of Polkit</title>
171
172 <para>
173 There should be a dedicated user and group to take control
174 of the <command>polkitd</command> daemon after it is
175 started. Issue the following commands as the
176 <systemitem class="username">root</systemitem> user:
177 </para>
178
179<screen role="root"><userinput>groupadd -fg 27 polkitd &amp;&amp;
180useradd -c "PolicyKit Daemon Owner" -d /etc/polkit-1 -u 27 \
181 -g polkitd -s /bin/false polkitd</userinput></screen>
182
183<!--
184 <para>
185 First, fix problems with setting permissions during installation and with
186 meson-0.60.0:
187 </para>
188
189<screen><userinput remap="pre">sed '/0,/s/^/#/' -i meson_post_install.py &amp;&amp;
190sed '/policy,/d' -i actions/meson.build \
191 -i src/examples/meson.build</userinput></screen>
192
193 <para>
194 Apply a patch to fix two security issues:
195 </para>
196
197<screen><userinput remap="pre">patch -Np1 -i ../polkit-&polkit-version;-security_fixes-1.patch</userinput></screen>
198
199 <para>
200 Port this package to use JS-91:
201 </para>
202
203<screen><userinput remap="pre">patch -Np1 -i ../polkit-&polkit-version;-js91-1.patch</userinput></screen>
204-->
205
206 <para>
207 Install <application>Polkit</application> by running the following
208 commands:
209 </para>
210
211<screen revision="systemd"><userinput>mkdir build &amp;&amp;
212cd build &amp;&amp;
213
214meson setup .. \
215 --prefix=/usr \
216 --buildtype=release \
217 -Dman=true \
218 -Dsession_tracking=libsystemd-login \
219 -Dtests=true &amp;&amp;
220ninja</userinput></screen>
221
222<screen revision="sysv"><userinput>mkdir build &amp;&amp;
223cd build &amp;&amp;
224
225meson setup .. \
226 --prefix=/usr \
227 --buildtype=release \
228 -Dman=true \
229 -Dsession_tracking=libelogind \
230 -Dsystemdsystemunitdir=/tmp \
231 -Dtests=true &amp;&amp;
232ninja</userinput></screen>
233
234 <para>
235 To test the results, first ensure that the system
236 <application>D-Bus</application> daemon is running,
237 and both <xref linkend='dbus-python'/> and
238 <xref linkend='python-dbusmock'/> are installed.
239 Then run <command>ninja test</command>.
240 </para>
241
242 <para>
243 Now, as the <systemitem class="username">root</systemitem> user:
244 </para>
245
246<screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>
247
248<screen role="root" revision="sysv"><userinput>ninja install &amp;&amp;
249rm -v /tmp/*.service</userinput></screen>
250
251 </sect2>
252
253 <sect2 role="commands">
254 <title>Command Explanations</title>
255
256 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
257 href="../../xincludes/meson-buildtype-release.xml"/>
258
259 <para>
260 <parameter>-Dtests=true</parameter>: This switch allows to run the
261 test suite of this package. As <application>Polkit</application> is
262 used for authorizations, its integrity can affect system security.
263 So it's recommended to run the test suite building this package.
264 </para>
265
266 <para>
267 <option>-Djs_engine=mozjs</option>: This switch allows using the
268 <xref linkend="js102"/> JavaScript engine instead of the
269 <xref linkend='duktape'/> JavaScript engine.
270 </para>
271
272 <!--
273 <para revision="sysv">
274 <parameter>- -disable-libsystemd-login</parameter>: This switch forces
275 polkit to build with elogind support (if available) rather than
276 systemd-logind.
277 </para>
278
279
280 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
281 href="../../xincludes/static-libraries.xml"/>
282 -->
283
284 <para>
285 <option>-Dos_type=lfs</option>: Use this switch if you did not create
286 the <filename>/etc/lfs-release</filename> file or distribution auto
287 detection will fail and you will be unable to use
288 <application>Polkit</application>.
289 </para>
290
291 <para>
292 <option>-Dauthfw=shadow</option>: This switch enables the
293 package to use the <application>Shadow</application> rather than the
294 <application>Linux PAM</application> Authentication framework. Use it
295 if you have not installed <application>Linux PAM</application>.
296 </para>
297
298 <!--
299 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
300 href="../../xincludes/gtk-doc-rebuild.xml"/>
301 -->
302
303 <para>
304 <option>-Dintrospection=false</option>: Use this option if you are certain
305 that you do not need gobject-introspection files for polkit, or do not have
306 gobject-introspection installed.
307 </para>
308
309 <para>
310 <option>-Dman=false</option>: Use this option to disable generating and
311 installing manual pages. This is useful if libxslt is not installed.
312 </para>
313
314 <para>
315 <option>-Dexamples=true</option>: Use this option to build the example
316 programs.
317 </para>
318
319 <para>
320 <option>-Dgtk_doc=true</option>: Use this option to enable building and
321 installing the API documentation.
322 </para>
323
324 </sect2>
325
326 <sect2 role="content">
327 <title>Contents</title>
328
329 <segmentedlist>
330 <segtitle>Installed Programs</segtitle>
331 <segtitle>Installed Libraries</segtitle>
332 <segtitle>Installed Directories</segtitle>
333
334 <seglistitem>
335 <seg>
336 pkaction, pkcheck, <!--pk-example-frobnicate,--> pkexec,
337 pkttyagent, and polkitd
338 </seg>
339 <seg>
340 libpolkit-agent-1.so and
341 libpolkit-gobject-1.so
342 </seg>
343 <seg>
344 /etc/polkit-1,
345 /usr/include/polkit-1,
346 /usr/lib/polkit-1,
347 /usr/share/gtk-doc/html/polkit-1, and
348 /usr/share/polkit-1
349 </seg>
350 </seglistitem>
351 </segmentedlist>
352
353 <variablelist>
354 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
355 <?dbfo list-presentation="list"?>
356 <?dbhtml list-presentation="table"?>
357
358 <varlistentry id="pkaction">
359 <term><command>pkaction</command></term>
360 <listitem>
361 <para>
362 is used to obtain information about registered PolicyKit actions
363 </para>
364 <indexterm zone="polkit pkaction">
365 <primary sortas="b-pkaction">pkaction</primary>
366 </indexterm>
367 </listitem>
368 </varlistentry>
369
370 <varlistentry id="pkcheck">
371 <term><command>pkcheck</command></term>
372 <listitem>
373 <para>
374 is used to check whether a process is authorized for action
375 </para>
376 <indexterm zone="polkit pkcheck">
377 <primary sortas="b-pkcheck">pkcheck</primary>
378 </indexterm>
379 </listitem>
380 </varlistentry>
381
382<!--
383 <varlistentry id="pk-example-frobnicate">
384 <term><command>pk-example-frobnicate</command></term>
385 <listitem>
386 <para>
387 is an example program to test the <command>pkexec</command>
388 command
389 </para>
390 <indexterm zone="polkit pk-example-frobnicate">
391 <primary sortas="b-pk-example-frobnicate">pk-example-frobnicate</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395-->
396
397 <varlistentry id="pkexec">
398 <term><command>pkexec</command></term>
399 <listitem>
400 <para>
401 allows an authorized user to execute a command as another user
402 </para>
403 <indexterm zone="polkit pkexec">
404 <primary sortas="b-pkexec">pkexec</primary>
405 </indexterm>
406 </listitem>
407 </varlistentry>
408
409 <varlistentry id="pkttyagent">
410 <term><command>pkttyagent</command></term>
411 <listitem>
412 <para>
413 is used to start a textual authentication agent for the subject
414 </para>
415 <indexterm zone="polkit pkttyagent">
416 <primary sortas="b-pkttyagent">pkttyagent</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="polkitd">
422 <term><command>polkitd</command></term>
423 <listitem>
424 <para>
425 provides the org.freedesktop.PolicyKit1 <application>D-Bus</application>
426 service on the system message bus
427 </para>
428 <indexterm zone="polkit polkitd">
429 <primary sortas="b-polkitd">polkitd</primary>
430 </indexterm>
431 </listitem>
432 </varlistentry>
433
434 <varlistentry id="libpolkit-agent-1">
435 <term><filename class="libraryfile">libpolkit-agent-1.so</filename></term>
436 <listitem>
437 <para>
438 contains the <application>Polkit</application> authentication
439 agent API functions
440 </para>
441 <indexterm zone="polkit libpolkit-agent-1">
442 <primary sortas="c-libpolkit-agent-1">libpolkit-agent-1.so</primary>
443 </indexterm>
444 </listitem>
445 </varlistentry>
446
447 <varlistentry id="libpolkit-gobject-1">
448 <term><filename class="libraryfile">libpolkit-gobject-1.so</filename></term>
449 <listitem>
450 <para>
451 contains the <application>Polkit</application> authorization API functions
452 </para>
453 <indexterm zone="polkit libpolkit-gobject-1">
454 <primary sortas="c-libpolkit-gobject-1">libpolkit-gobject-1.so</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 </variablelist>
460
461 </sect2>
462
463</sect1>
Note: See TracBrowser for help on using the repository browser.