sd_bus_get_name_creds(3) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | NOTES | HISTORY | SEE ALSO | COLOPHON

SD_BUS_GET_NAME_CREDS(3)  sd_bus_get_name_creds SD_BUS_GET_NAME_CREDS(3)

NAME         top

       sd_bus_get_name_creds, sd_bus_get_owner_creds - Query bus client
       credentials

SYNOPSIS         top

       #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         top

       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_pid(3) 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(3).

       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         top

       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.

           Added in version 246.

       -ENOPKG
           The bus cannot be resolved.

           Added in version 246.

       -EPERM
           The bus has already been started.

           Added in version 246.

       -ECHILD
           The bus was created in a different process, library or module
           instance.

           Added in version 246.

       -ENOMEM
           Memory allocation failed.

           Added in version 246.

NOTES         top

       Functions described here are available as a shared library, which
       can be compiled against and linked to with the
       libsystemd pkg-config(1) file.

       The code described here uses getenv(3), which is declared to be
       not multi-thread-safe. This means that the code calling the
       functions described here must not call setenv(3) from a parallel
       thread. It is recommended to only do calls to setenv() from an
       early phase of the program when no other threads have been
       started.

HISTORY         top

       sd_bus_get_name_creds() and sd_bus_get_owner_creds() were added
       in version 246.

SEE ALSO         top

       systemd(1), sd-bus(3), sd_bus_creds_unref(3)

COLOPHON         top

       This page is part of the systemd (systemd system and service
       manager) project.  Information about the project can be found at
       ⟨http://www.freedesktop.org/wiki/Software/systemd⟩.  If you have
       a bug report for this manual page, see
       ⟨http://www.freedesktop.org/wiki/Software/systemd/#bugreports⟩.
       This page was obtained from the project's upstream Git repository
       ⟨https://github.com/systemd/systemd.git⟩ on 2023-12-22.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-12-22.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

systemd 255                                     SD_BUS_GET_NAME_CREDS(3)

Pages that refer to this page: sd-bus(3)sd_bus_creds_get_pid(3)sd_bus_creds_new_from_pid(3)sd_bus_query_sender_creds(3)systemd.directives(7)systemd.index(7)