From 425d5cecbecb8b27bc611aad0257d0610d127c66 Mon Sep 17 00:00:00 2001 From: Daan De Meyer Date: Thu, 23 Apr 2020 21:21:58 +0200 Subject: [PATCH] sd-bus: Add sd_bus_get_name/owner_creds docs --- man/rules/meson.build | 1 + man/sd-bus.xml | 2 + man/sd_bus_get_name_creds.xml | 120 ++++++++++++++++++++++++++++++++++ 3 files changed, 123 insertions(+) create mode 100644 man/sd_bus_get_name_creds.xml diff --git a/man/rules/meson.build b/man/rules/meson.build index 9b2e102dd1..ee2096de4d 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -262,6 +262,7 @@ manpages = [ ['sd_bus_get_events', 'sd_bus_get_timeout', 'sd_bus_set_fd'], ''], ['sd_bus_get_n_queued_read', '3', ['sd_bus_get_n_queued_write'], ''], + ['sd_bus_get_name_creds', '3', ['sd_bus_get_owner_creds'], ''], ['sd_bus_is_open', '3', ['sd_bus_is_ready'], ''], ['sd_bus_list_names', '3', [], ''], ['sd_bus_message_append', '3', ['sd_bus_message_appendv'], ''], diff --git a/man/sd-bus.xml b/man/sd-bus.xml index 590998941a..cd1670fa38 100644 --- a/man/sd-bus.xml +++ b/man/sd-bus.xml @@ -82,6 +82,8 @@ sd_bus_get_fd3, sd_bus_get_method_call_timeout3, sd_bus_get_n_queued_read3, +sd_bus_get_name_creds3, +sd_bus_get_owner_creds3, sd_bus_get_scope3, sd_bus_get_tid3, sd_bus_get_unique_name3, diff --git a/man/sd_bus_get_name_creds.xml b/man/sd_bus_get_name_creds.xml new file mode 100644 index 0000000000..3fed66f2c6 --- /dev/null +++ b/man/sd_bus_get_name_creds.xml @@ -0,0 +1,120 @@ + + + + + + + + sd_bus_get_name_creds + systemd + + + + sd_bus_get_name_creds + 3 + + + + sd_bus_get_name_creds + sd_bus_get_owner_creds + + Query bus client credentials + + + + + #include <systemd/sd-bus.h> + + + int sd_bus_get_name_creds + sd_bus *bus + const char *name + uint64_t mask + sd_bus_creds **creds + + + + int sd_bus_get_owner_creds + sd_bus *bus + uint64_t mask + sd_bus_creds **creds + + + + + + Description + + sd_bus_get_name_creds() queries the credentials of the bus client + identified by name. The mask parameter is a combo of + SD_BUS_CREDS_* flags that indicate which credential info the caller is + interested in. See + sd_bus_creds_new_from_pid3 + for a list of possible flags. On success, creds contains a new + sd_bus_creds instance with the requested information. Ownership of this instance + belongs to the caller and it should be freed once no longer needed by calling + sd_bus_creds_unref(). + + sd_bus_get_owner_creds() queries the credentials of the creator of the given + bus. The mask and creds parameters behave the same as in + sd_bus_get_name_creds(). + + + + Return Value + + On success, these functions return a non-negative integer. On failure, they return a negative + errno-style error code. + + + Errors + + Returned errors may indicate the following problems: + + + + -EINVAL + + An argument is invalid. + + + + -ENOPKG + + The bus cannot be resolved. + + + + -EPERM + + The bus has already been started. + + + + -ECHILD + + The bus was created in a different process. + + + + -ENOMEM + + Memory allocation failed. + + + + + + + + + See Also + + + systemd1, + sd-bus3 + + + +