diff options
| author | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2013-08-22 18:21:58 +0100 |
|---|---|---|
| committer | Simon McVittie <simon.mcvittie@collabora.co.uk> | 2013-08-22 18:21:58 +0100 |
| commit | 4b63567c02022cc3a5dc2f4ef03c7bd344766b43 (patch) | |
| tree | bd40c7484c520b71e4addad9824ff7f47a11561d /doc | |
| parent | 46af309cf5e3f4a0a8c773461b65a7bacb9e87e0 (diff) | |
| download | dbus-4b63567c02022cc3a5dc2f4ef03c7bd344766b43.tar.gz | |
GetConnectionCredentials: add
The initial set of credentials is just UnixUserID and ProcessID.
The rest can follow when someone is sufficiently interested to actually
test them.
Bug: https://bugs.freedesktop.org/show_bug.cgi?id=54445
Reviewed-by: Ralf Habacker <ralf.habacker@freenet.de>
[rename a function that Ralf found unclear -smcv]
Signed-off-by: Simon McVittie <simon.mcvittie@collabora.co.uk>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dbus-specification.xml | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/doc/dbus-specification.xml b/doc/dbus-specification.xml index 324dfd43..f5d8a348 100644 --- a/doc/dbus-specification.xml +++ b/doc/dbus-specification.xml @@ -5579,6 +5579,108 @@ </para> </sect3> + <sect3 id="bus-messages-get-connection-credentials"> + <title><literal>org.freedesktop.DBus.GetConnectionCredentials</literal></title> + <para> + As a method: + <programlisting> + DICT<STRING,VARIANT> GetConnectionCredentials (in STRING bus_name) + </programlisting> + Message arguments: + <informaltable> + <tgroup cols="3"> + <thead> + <row> + <entry>Argument</entry> + <entry>Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>0</entry> + <entry>STRING</entry> + <entry>Unique or well-known bus name of the connection to + query, such as <literal>:12.34</literal> or + <literal>com.example.tea</literal></entry> + </row> + </tbody> + </tgroup> + </informaltable> + Reply arguments: + <informaltable> + <tgroup cols="3"> + <thead> + <row> + <entry>Argument</entry> + <entry>Type</entry> + <entry>Description</entry> + </row> + </thead> + <tbody> + <row> + <entry>0</entry> + <entry>DICT<STRING,VARIANT></entry> + <entry>Credentials</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + + <para> + Returns as many credentials as possible for the process connected to + the server. If unable to determine certain credentials (for instance, + because the process is not on the same machine as the bus daemon, + or because this version of the bus daemon does not support a + particular security framework), or if the values of those credentials + cannot be represented as documented here, then those credentials + are omitted. + </para> + + <para> + Keys in the returned dictionary not containing "." are defined + by this specification. Bus daemon implementors supporting + credentials frameworks not mentioned in this document should either + contribute patches to this specification, or use keys containing + "." and starting with a reversed domain name. + <informaltable> + <tgroup cols="3"> + <thead> + <row> + <entry>Key</entry> + <entry>Value type</entry> + <entry>Value</entry> + </row> + </thead> + <tbody> + <row> + <entry>UnixUserID</entry> + <entry>UINT32</entry> + <entry>The numeric Unix user ID, as defined by POSIX</entry> + </row> + <row> + <entry>ProcessID</entry> + <entry>UINT32</entry> + <entry>The numeric process ID, on platforms that have + this concept. On Unix, this is the process ID defined by + POSIX.</entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + + <para> + This method was added in D-Bus 1.7 to reduce the round-trips + required to list a process's credentials. In older versions, calling + this method will fail: applications should recover by using the + separate methods such as + <xref linkend="bus-messages-get-connection-unix-user"/> + instead. + </para> + </sect3> + <sect3 id="bus-messages-add-match"> <title><literal>org.freedesktop.DBus.AddMatch</literal></title> <para> |