diff options
author | Lennart Poettering <lennart@poettering.net> | 2014-11-26 02:20:28 +0100 |
---|---|---|
committer | Lennart Poettering <lennart@poettering.net> | 2014-11-26 02:20:55 +0100 |
commit | b5dae4c7f77f7c87b91e0afb60a31c690dda4a1f (patch) | |
tree | 0bc1ce84ed97884bae8f4c332074c532c28f6470 /man | |
parent | f3c0588651927ebac691130aa861b878fa22e527 (diff) |
sd-bus: add suppot for renegotiating message credential attach flags
Diffstat (limited to 'man')
-rw-r--r-- | man/sd_bus_negotiate_fds.xml | 45 |
1 files changed, 28 insertions, 17 deletions
diff --git a/man/sd_bus_negotiate_fds.xml b/man/sd_bus_negotiate_fds.xml index 3d7a20b2ff..4fbffdf38c 100644 --- a/man/sd_bus_negotiate_fds.xml +++ b/man/sd_bus_negotiate_fds.xml @@ -70,6 +70,7 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <funcdef>int <function>sd_bus_negotiate_creds</function></funcdef> <paramdef>sd_bus *<parameter>bus</parameter></paramdef> <paramdef>int <parameter>b</parameter></paramdef> + <paramdef>uint64_t <parameter>flags</parameter></paramdef> </funcprototype> </funcsynopsis> </refsynopsisdiv> @@ -107,25 +108,34 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry><refentrytitle>sd_bus_message_get_seqno</refentrytitle><manvolnum>3</manvolnum></citerefentry> fail with <constant>-ENODATA</constant> on incoming messages. Note that not all transports support timestamping of messages. On local - transports, the timestamping is applied by the kernel and cannot be - manipulated by userspace.</para> + transports, the timestamping is applied by the kernel and cannot + be manipulated by userspace. By default, message timestamping is + not negotiated for all connections.</para> <para><function>sd_bus_negotiate_creds()</function> controls whether implicit sender credentials shall be attached - automatically to all incoming messages. Takes a bus object and a - bit mask value, which controls which credential parameters are - attached. If this is not used, - <citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry> - fails with <constant>-ENODATA</constant> on incoming - messages. Note that not all transports support attaching sender - credentials to messages, or do not support all types of sender - credential parameters. On local transports, the sender credentials - are attached by the kernel and cannot be manipulated by - userspace. By default, no sender credentials are attached.</para> - - <para>These functions may be called only before the connection has - been started with - <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>.</para> + automatically to all incoming messages. Takes a bus object, a + boolean indicating wether to enable or disable the credential + parts encoded in the bit mask value argument. Note that not all + transports support attaching sender credentials to messages, or do + not support all types of sender credential parameters, or might + suppress them under certain circumstances for individual + messages. On local transports, the sender credentials are attached + by the kernel and cannot be manipulated by userspace. By default, + no sender credentials are attached.</para> + + <para>The <function>sd_bus_negotiate_fds()</function> function may + be called only before the connection has been started with + <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>. Both + <function>sd_bus_negotiate_timestamp()</function> and + <function>sd_bus_negotiate_creds()</function> also may be called + after a connection has been set up. Note that when operating on a + connection that is shared between multiple components of the same + program (for example via + <citerefentry><refentrytitle>sd_bus_default</refentrytitle><manvolnum>3</manvolnum></citerefentry>) + it is highly recommended to only enable additional per message + metadata fields, but never disable them again, in order not to + disable functionality needed by other components.</para> </refsect1> <refsect1> @@ -169,7 +179,8 @@ along with systemd; If not, see <http://www.gnu.org/licenses/>. <citerefentry><refentrytitle>sd_bus_start</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_can_send</refentrytitle><manvolnum>3</manvolnum></citerefentry>, <citerefentry><refentrytitle>sd_bus_message_get_monotonic_usec</refentrytitle><manvolnum>3</manvolnum></citerefentry>, - <citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry> + <citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>, + <citerefentry><refentrytitle>systemd.busname</refentrytitle><manvolnum>5</manvolnum></citerefentry> </para> </refsect1> |