summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorColin Walters <walters@verbum.org>2013-08-19 12:16:11 -0400
committerMiloslav Trmač <mitr@redhat.com>2013-09-18 18:29:25 +0200
commit3968411b0c7ba193f9b9276ec911692aec248608 (patch)
treede9a4f0b3ad64a2f518220f8b5966f2939d7a1bd /docs
parent08291789a1f99d4ab29c74c39344304bcca43023 (diff)
pkcheck: Support --process=pid,start-time,uid syntax too
The uid is a new addition; this allows callers such as libvirt to close a race condition in reading the uid of the process talking to them. They can read it via getsockopt(SO_PEERCRED) or equivalent, rather than having pkcheck look at /proc later after the fact. Programs which invoke pkcheck but need to know beforehand (i.e. at compile time) whether or not it supports passing the uid can use: pkcheck_supports_uid=$($PKG_CONFIG --variable pkcheck_supports_uid polkit-gobject-1) test x$pkcheck_supports_uid = xyes
Diffstat (limited to 'docs')
-rw-r--r--docs/man/pkcheck.xml29
1 files changed, 20 insertions, 9 deletions
diff --git a/docs/man/pkcheck.xml b/docs/man/pkcheck.xml
index fc54054..c856ca4 100644
--- a/docs/man/pkcheck.xml
+++ b/docs/man/pkcheck.xml
@@ -55,6 +55,9 @@
<arg choice="plain">
<replaceable>pid,pid-start-time</replaceable>
</arg>
+ <arg choice="plain">
+ <replaceable>pid,pid-start-time,uid</replaceable>
+ </arg>
</group>
</arg>
<arg choice="plain">
@@ -90,7 +93,7 @@
<title>DESCRIPTION</title>
<para>
<command>pkcheck</command> is used to check whether a process, specified by
- either <option>--process</option> or <option>--system-bus-name</option>,
+ either <option>--process</option> (see below) or <option>--system-bus-name</option>,
is authorized for <replaceable>action</replaceable>. The <option>--detail</option>
option can be used zero or more times to pass details about <replaceable>action</replaceable>.
If <option>--allow-user-interaction</option> is passed, <command>pkcheck</command> blocks
@@ -160,15 +163,23 @@ KEY3=VALUE3
<refsect1 id="pkcheck-notes">
<title>NOTES</title>
<para>
- Since process identifiers can be recycled, the caller should always use
- <replaceable>pid,pid-start-time</replaceable> to specify the process
- to check for authorization when using the <option>--process</option> option.
- The value of <replaceable>pid-start-time</replaceable>
- can be determined by consulting e.g. the
+ Do not use either the bare <replaceable>pid</replaceable> or
+ <replaceable>pid,start-time</replaceable> syntax forms for
+ <option>--process</option>. There are race conditions in both.
+ New code should always use
+ <replaceable>pid,pid-start-time,uid</replaceable>. The value of
+ <replaceable>start-time</replaceable> can be determined by
+ consulting e.g. the
<citerefentry><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>
- file system depending on the operating system. If only <replaceable>pid</replaceable>
- is passed to the <option>--process</option> option, then <command>pkcheck</command>
- will look up the start time itself but note that this may be racy.
+ file system depending on the operating system. If fewer than 3
+ arguments are passed, <command>pkcheck</command> will attempt to
+ look up them up internally, but note that this may be racy.
+ </para>
+ <para>
+ If your program is a daemon with e.g. a custom Unix domain
+ socket, you should determine the <replaceable>uid</replaceable>
+ parameter via operating system mechanisms such as
+ <literal>PEERCRED</literal>.
</para>
</refsect1>