summaryrefslogtreecommitdiff
path: root/docs/polkit
diff options
context:
space:
mode:
authorDavid Zeuthen <davidz@redhat.com>2011-02-21 17:12:17 -0500
committerDavid Zeuthen <davidz@redhat.com>2011-02-21 17:12:17 -0500
commit719585f1aecdc79598a6cecff936bd50e0f6a2f8 (patch)
treef583b66f018cbae817f2a8d73551530606d87585 /docs/polkit
parent8f3e92e81753059b858c9c7ea5c7f198e39bb54f (diff)
downloadpolkit-719585f1aecdc79598a6cecff936bd50e0f6a2f8.tar.gz
Pass caller and subject pid to authentication agent
The authentication agent can use information this to inform the user about the UI application that triggered the authentication request (if any). Signed-off-by: David Zeuthen <davidz@redhat.com>
Diffstat (limited to 'docs/polkit')
-rw-r--r--docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml4
1 files changed, 3 insertions, 1 deletions
diff --git a/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml b/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml
index 85bbcf0..663169e 100644
--- a/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml
+++ b/docs/polkit/docbook-interface-org.freedesktop.PolicyKit1.AuthenticationAgent.xml
@@ -71,7 +71,9 @@ The themed icon describing the action or the empty string if no icon is set.
<term><literal>IN Dict&lt;String,String&gt; <parameter>details</parameter></literal>:</term>
<listitem>
<para>
-Details about the authentication request. This is a dictionary of key/value pairs where both key and value are strings. These strings are translated into the locale passed when registering the authentication agent using <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent()</link>.
+Details about the authentication request. This is a dictionary of key/value pairs where both key and value are strings. These strings are translated into the locale passed when registering the authentication agent using <link linkend="eggdbus-method-org.freedesktop.PolicyKit1.Authority.RegisterAuthenticationAgent">RegisterAuthenticationAgent().</link>.
+Keys starting with <literal>polkit.</literal> are reserved for internal use and should never be displayed in the UI.
+Known key/value-pairs include <literal>polkit.caller-pid</literal> (the process id of the mechanism making the authorization check) and <literal>polkit.subject-pid</literal> (the process id of the subject the check is for).
</para>
</listitem>
</varlistentry>