2018-07-03 05:15:39 +08:00
|
|
|
<?xml version='1.0'?>
|
2019-03-14 21:40:58 +08:00
|
|
|
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
|
|
|
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
2020-11-09 12:23:58 +08:00
|
|
|
<!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2018-06-06 17:59:04 +08:00
|
|
|
<refentry id="sd_bus_creds_get_pid" xmlns:xi="http://www.w3.org/2001/XInclude">
|
2014-01-04 13:08:50 +08:00
|
|
|
|
|
|
|
<refentryinfo>
|
|
|
|
<title>sd_bus_creds_get_pid</title>
|
|
|
|
<productname>systemd</productname>
|
|
|
|
</refentryinfo>
|
|
|
|
|
|
|
|
<refmeta>
|
|
|
|
<refentrytitle>sd_bus_creds_get_pid</refentrytitle>
|
|
|
|
<manvolnum>3</manvolnum>
|
|
|
|
</refmeta>
|
|
|
|
|
|
|
|
<refnamediv>
|
|
|
|
<refname>sd_bus_creds_get_pid</refname>
|
2015-04-30 03:44:55 +08:00
|
|
|
<refname>sd_bus_creds_get_ppid</refname>
|
2014-01-04 13:08:50 +08:00
|
|
|
<refname>sd_bus_creds_get_tid</refname>
|
|
|
|
<refname>sd_bus_creds_get_uid</refname>
|
2015-04-30 03:44:55 +08:00
|
|
|
<refname>sd_bus_creds_get_euid</refname>
|
|
|
|
<refname>sd_bus_creds_get_suid</refname>
|
|
|
|
<refname>sd_bus_creds_get_fsuid</refname>
|
2014-01-04 13:08:50 +08:00
|
|
|
<refname>sd_bus_creds_get_gid</refname>
|
2015-04-30 03:44:55 +08:00
|
|
|
<refname>sd_bus_creds_get_egid</refname>
|
|
|
|
<refname>sd_bus_creds_get_sgid</refname>
|
|
|
|
<refname>sd_bus_creds_get_fsgid</refname>
|
|
|
|
<refname>sd_bus_creds_get_supplementary_gids</refname>
|
2014-01-04 13:08:50 +08:00
|
|
|
<refname>sd_bus_creds_get_comm</refname>
|
|
|
|
<refname>sd_bus_creds_get_tid_comm</refname>
|
|
|
|
<refname>sd_bus_creds_get_exe</refname>
|
|
|
|
<refname>sd_bus_creds_get_cmdline</refname>
|
|
|
|
<refname>sd_bus_creds_get_cgroup</refname>
|
|
|
|
<refname>sd_bus_creds_get_unit</refname>
|
|
|
|
<refname>sd_bus_creds_get_slice</refname>
|
2015-06-24 02:42:57 +08:00
|
|
|
<refname>sd_bus_creds_get_user_unit</refname>
|
|
|
|
<refname>sd_bus_creds_get_user_slice</refname>
|
2014-01-04 13:08:50 +08:00
|
|
|
<refname>sd_bus_creds_get_session</refname>
|
|
|
|
<refname>sd_bus_creds_get_owner_uid</refname>
|
|
|
|
<refname>sd_bus_creds_has_effective_cap</refname>
|
|
|
|
<refname>sd_bus_creds_has_permitted_cap</refname>
|
|
|
|
<refname>sd_bus_creds_has_inheritable_cap</refname>
|
|
|
|
<refname>sd_bus_creds_has_bounding_cap</refname>
|
|
|
|
<refname>sd_bus_creds_get_selinux_context</refname>
|
|
|
|
<refname>sd_bus_creds_get_audit_session_id</refname>
|
|
|
|
<refname>sd_bus_creds_get_audit_login_uid</refname>
|
2015-04-30 03:44:55 +08:00
|
|
|
<refname>sd_bus_creds_get_tty</refname>
|
2014-01-04 13:08:50 +08:00
|
|
|
<refname>sd_bus_creds_get_unique_name</refname>
|
|
|
|
<refname>sd_bus_creds_get_well_known_names</refname>
|
2015-04-30 03:44:55 +08:00
|
|
|
<refname>sd_bus_creds_get_description</refname>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
|
|
|
<refpurpose>Retrieve fields from a credentials object</refpurpose>
|
|
|
|
</refnamediv>
|
|
|
|
|
|
|
|
<refsynopsisdiv>
|
|
|
|
<funcsynopsis>
|
|
|
|
<funcsynopsisinfo>#include <systemd/sd-bus.h></funcsynopsisinfo>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_pid</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>pid_t *<parameter>pid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_ppid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>pid_t *<parameter>ppid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2014-01-04 13:08:50 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_tid</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>pid_t *<parameter>tid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
2015-04-30 03:44:55 +08:00
|
|
|
<funcdef>int <function>sd_bus_creds_get_uid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>uid_t *<parameter>uid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_euid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>uid_t *<parameter>uid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_suid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>uid_t *<parameter>uid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_fsuid</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>uid_t *<parameter>uid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_gid</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>gid_t *<parameter>gid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_egid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>gid_t *<parameter>gid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_sgid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>gid_t *<parameter>gid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_fsgid</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>gid_t *<parameter>gid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_supplementary_gids</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>const gid_t **<parameter>gids</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2014-01-04 13:08:50 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_comm</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>comm</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_tid_comm</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>comm</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_exe</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>exe</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_cmdline</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>char ***<parameter>cmdline</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_cgroup</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>cgroup</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_unit</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>unit</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2015-06-24 02:42:57 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_slice</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>const char **<parameter>slice</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2014-01-04 13:08:50 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_user_unit</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>unit</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
2015-06-24 02:42:57 +08:00
|
|
|
<funcdef>int <function>sd_bus_creds_get_user_slice</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>slice</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_session</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>slice</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_owner_uid</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>uid_t *<parameter>uid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_has_effective_cap</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>int <parameter>capability</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_has_permitted_cap</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>int <parameter>capability</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_has_inheritable_cap</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>int <parameter>capability</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_has_bounding_cap</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>int <parameter>capability</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_selinux_context</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>context</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_audit_session_id</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>uint32_t *<parameter>sessionid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_audit_login_uid</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>uid_t *<parameter>loginuid</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_tty</function></funcdef>
|
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>const char **<parameter>tty</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2014-01-04 13:08:50 +08:00
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_unique_name</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>const char **<parameter>name</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
|
|
|
<funcprototype>
|
|
|
|
<funcdef>int <function>sd_bus_creds_get_well_known_names</function></funcdef>
|
2014-02-16 20:55:27 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
2014-01-04 13:08:50 +08:00
|
|
|
<paramdef>char ***<parameter>name</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2014-10-18 22:20:36 +08:00
|
|
|
<funcprototype>
|
2015-04-30 03:44:55 +08:00
|
|
|
<funcdef>int <function>sd_bus_creds_get_description</function></funcdef>
|
2014-10-18 22:20:36 +08:00
|
|
|
<paramdef>sd_bus_creds *<parameter>c</parameter></paramdef>
|
|
|
|
<paramdef>const char **<parameter>name</parameter></paramdef>
|
|
|
|
</funcprototype>
|
|
|
|
|
2014-01-04 13:08:50 +08:00
|
|
|
</funcsynopsis>
|
|
|
|
</refsynopsisdiv>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Description</title>
|
|
|
|
|
2015-06-24 02:42:57 +08:00
|
|
|
<para>These functions return credential information from an
|
|
|
|
<parameter>sd_bus_creds</parameter> object. Credential objects may
|
|
|
|
be created with
|
2014-01-04 13:08:50 +08:00
|
|
|
<citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
2015-04-30 03:44:55 +08:00
|
|
|
in which case they describe the credentials of the process
|
|
|
|
identified by the specified PID, with
|
|
|
|
<citerefentry><refentrytitle>sd_bus_get_name_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
in which case they describe the credentials of a bus peer
|
2015-06-12 20:33:48 +08:00
|
|
|
identified by the specified bus name, with
|
2014-10-23 01:17:24 +08:00
|
|
|
<citerefentry><refentrytitle>sd_bus_get_owner_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
2015-04-30 03:44:55 +08:00
|
|
|
in which case they describe the credentials of the creator of a
|
2015-06-12 20:33:48 +08:00
|
|
|
bus, or with
|
|
|
|
<citerefentry><refentrytitle>sd_bus_message_get_creds</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
2015-06-24 02:42:57 +08:00
|
|
|
in which case they describe the credentials of the sender of the
|
|
|
|
message.</para>
|
|
|
|
|
|
|
|
<para>Not all credential fields are part of every
|
|
|
|
<literal>sd_bus_creds</literal> object. Use
|
|
|
|
<citerefentry><refentrytitle>sd_bus_creds_get_mask</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
|
|
|
to determine the mask of fields available.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_pid()</function> will retrieve
|
2014-08-03 13:11:37 +08:00
|
|
|
the PID (process identifier). Similarly,
|
2015-04-30 03:44:55 +08:00
|
|
|
<function>sd_bus_creds_get_ppid()</function> will retrieve the
|
|
|
|
parent PID. Note that PID 1 has no parent process, in which case
|
|
|
|
-ENXIO is returned.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_tid()</function> will retrieve the
|
2014-01-04 13:08:50 +08:00
|
|
|
TID (thread identifier).</para>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_uid()</function> will retrieve
|
2014-08-03 13:11:37 +08:00
|
|
|
the numeric UID (user identifier). Similarly,
|
2015-04-30 03:44:55 +08:00
|
|
|
<function>sd_bus_creds_get_euid()</function> returns the effective
|
|
|
|
UID, <function>sd_bus_creds_get_suid()</function> the saved UID
|
|
|
|
and <function>sd_bus_creds_get_fsuid()</function> the file system
|
|
|
|
UID.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_gid()</function> will retrieve the
|
2014-08-03 13:11:37 +08:00
|
|
|
numeric GID (group identifier). Similarly,
|
2015-04-30 03:44:55 +08:00
|
|
|
<function>sd_bus_creds_get_egid()</function> returns the effective
|
|
|
|
GID, <function>sd_bus_creds_get_sgid()</function> the saved GID
|
|
|
|
and <function>sd_bus_creds_get_fsgid()</function> the file system
|
|
|
|
GID.</para>
|
|
|
|
|
|
|
|
<para><function>sd_bus_creds_get_supplementary_gids()</function>
|
|
|
|
will retrieve the supplementary GIDs list.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_comm()</function> will retrieve the
|
2014-02-17 09:49:45 +08:00
|
|
|
comm field (truncated name of the executable, as stored in
|
2014-01-04 13:08:50 +08:00
|
|
|
<filename>/proc/<replaceable>pid</replaceable>/comm</filename>).
|
|
|
|
</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_tid_comm()</function> will retrieve
|
2014-01-04 13:08:50 +08:00
|
|
|
the comm field of the thread (as stored in
|
|
|
|
<filename>/proc/<replaceable>pid</replaceable>/task/<replaceable>tid</replaceable>/comm</filename>).
|
|
|
|
</para>
|
|
|
|
|
2019-06-24 21:30:10 +08:00
|
|
|
<para><function>sd_bus_creds_get_exe()</function> will retrieve the path to the program executable (as
|
|
|
|
stored in the <filename>/proc/<replaceable>pid</replaceable>/exe</filename> link, but with the <literal>
|
|
|
|
(deleted)</literal> suffix removed). Note that kernel threads do not have an executable path, in which
|
|
|
|
case -ENXIO is returned. Note that this property should not be used for more than explanatory
|
|
|
|
information, in particular it should not be used for security-relevant decisions. That's because the
|
|
|
|
executable might have been replaced or removed by the time the value can be processed. Moreover, the
|
|
|
|
kernel exports this information in an ambiguous way (i.e. a deleted executable cannot be safely
|
2020-07-07 01:46:01 +08:00
|
|
|
distinguished from one whose name suffix is <literal> (deleted)</literal>).</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_cmdline()</function> will
|
|
|
|
retrieve an array of command line arguments (as stored in
|
|
|
|
<filename>/proc/<replaceable>pid</replaceable>/cmdline</filename>). Note
|
|
|
|
that kernel threads do not have a command line, in which case
|
|
|
|
-ENXIO is returned.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_cgroup()</function> will retrieve
|
2016-10-17 21:50:26 +08:00
|
|
|
the control group path. See <ulink
|
2018-01-16 17:29:35 +08:00
|
|
|
url="https://www.kernel.org/doc/Documentation/cgroup-v1/cgroups.txt">cgroups.txt</ulink>.
|
2014-01-04 13:08:50 +08:00
|
|
|
</para>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_unit()</function> will retrieve
|
|
|
|
the systemd unit name (in the system instance of systemd) that the
|
2014-08-03 13:11:37 +08:00
|
|
|
process is a part of. See
|
2015-04-30 03:44:55 +08:00
|
|
|
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
|
2014-08-03 13:11:12 +08:00
|
|
|
processes that are not part of a unit, returns -ENXIO.
|
2014-01-04 13:08:50 +08:00
|
|
|
</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_user_unit()</function> will
|
2014-01-04 13:08:50 +08:00
|
|
|
retrieve the systemd unit name (in the user instance of systemd)
|
2014-08-03 13:11:37 +08:00
|
|
|
that the process is a part of. See
|
2015-04-30 03:44:55 +08:00
|
|
|
<citerefentry><refentrytitle>systemd.unit</refentrytitle><manvolnum>5</manvolnum></citerefentry>. For
|
2014-08-03 13:11:12 +08:00
|
|
|
processes that are not part of a user unit, returns -ENXIO.
|
2014-01-04 13:08:50 +08:00
|
|
|
</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_slice()</function> will retrieve
|
2014-01-04 13:08:50 +08:00
|
|
|
the systemd slice (a unit in the system instance of systemd) that
|
2014-08-03 13:11:37 +08:00
|
|
|
the process is a part of. See
|
|
|
|
<citerefentry><refentrytitle>systemd.slice</refentrytitle><manvolnum>5</manvolnum></citerefentry>. Similarly,
|
2015-06-24 02:42:57 +08:00
|
|
|
<function>sd_bus_creds_get_user_slice()</function> retrieves the
|
|
|
|
systemd slice of the process, in the user instance of systemd.
|
2014-01-04 13:08:50 +08:00
|
|
|
</para>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_session()</function> will
|
2015-06-24 02:42:57 +08:00
|
|
|
retrieve the identifier of the login session that the process is
|
2017-09-17 21:11:20 +08:00
|
|
|
a part of. Please note the login session may be limited to a stub
|
|
|
|
process or two. User processes may instead be started from their
|
|
|
|
systemd user manager, e.g. GUI applications started using DBus
|
|
|
|
activation, as well as service processes which are shared between
|
|
|
|
multiple logins of the same user. For processes that are not part
|
|
|
|
of a session, returns -ENXIO.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_owner_uid()</function> will
|
|
|
|
retrieve the numeric UID (user identifier) of the user who owns
|
2017-09-17 21:11:20 +08:00
|
|
|
the user unit or login session that the process is a part of. See
|
2015-06-24 02:42:57 +08:00
|
|
|
<citerefentry><refentrytitle>systemd-logind.service</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
|
2017-09-17 21:11:20 +08:00
|
|
|
For processes that are not part of a user unit or session, returns
|
|
|
|
-ENXIO.
|
2014-01-04 13:08:50 +08:00
|
|
|
</para>
|
|
|
|
|
2016-02-13 06:29:57 +08:00
|
|
|
<para><function>sd_bus_creds_has_effective_cap()</function> will check whether the capability specified by
|
|
|
|
<parameter>capability</parameter> was set in the effective capabilities mask. A positive return value means that it
|
|
|
|
was set, zero means that it was not set, and a negative return value indicates an error. See <citerefentry
|
|
|
|
project='man-pages'><refentrytitle>capabilities</refentrytitle><manvolnum>7</manvolnum></citerefentry> and the
|
|
|
|
<varname>AmbientCapabilities=</varname> and <varname>CapabilityBoundingSet=</varname> settings in
|
2014-01-04 13:08:50 +08:00
|
|
|
<citerefentry><refentrytitle>systemd.exec</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
|
|
|
|
</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_has_permitted_cap()</function> is
|
|
|
|
similar to <function>sd_bus_creds_has_effective_cap()</function>,
|
2014-01-04 13:08:50 +08:00
|
|
|
but will check the permitted capabilities mask.</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_has_inheritable_cap()</function> is
|
|
|
|
similar to <function>sd_bus_creds_has_effective_cap()</function>,
|
2014-01-04 13:08:50 +08:00
|
|
|
but will check the inheritable capabilities mask.</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_has_bounding_cap()</function> is
|
|
|
|
similar to <function>sd_bus_creds_has_effective_cap()</function>,
|
2014-01-04 13:08:50 +08:00
|
|
|
but will check the bounding capabilities mask.</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_selinux_context()</function> will
|
2014-02-10 19:32:03 +08:00
|
|
|
retrieve the SELinux security context (label) of the process.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_audit_session_id()</function>
|
|
|
|
will retrieve the audit session identifier of the process. Returns
|
|
|
|
-ENXIO for processes that are not part of an audit session.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_audit_login_uid()</function> will
|
2014-01-04 13:08:50 +08:00
|
|
|
retrieve the audit user login identifier (the identifier of the
|
2015-04-30 03:44:55 +08:00
|
|
|
user who is "responsible" for the session). Returns -ENXIO for
|
|
|
|
processes that are not part of an audit session.</para>
|
|
|
|
|
|
|
|
<para><function>sd_bus_creds_get_tty()</function> will retrieve
|
2015-06-24 02:42:57 +08:00
|
|
|
the controlling TTY, without the prefixing "/dev/". Returns -ENXIO
|
|
|
|
for processes that have no controlling TTY.</para>
|
2014-01-04 13:08:50 +08:00
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_unique_name()</function> will
|
2014-01-04 13:08:50 +08:00
|
|
|
retrieve the D-Bus unique name. See <ulink
|
|
|
|
url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus">The
|
|
|
|
D-Bus specification</ulink>.</para>
|
|
|
|
|
2014-10-18 22:20:24 +08:00
|
|
|
<para><function>sd_bus_creds_get_well_known_names()</function> will
|
2014-01-04 13:08:50 +08:00
|
|
|
retrieve the set of D-Bus well-known names. See <ulink
|
|
|
|
url="http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus">The
|
|
|
|
D-Bus specification</ulink>.</para>
|
|
|
|
|
2015-04-30 03:44:55 +08:00
|
|
|
<para><function>sd_bus_creds_get_description()</function> will
|
2014-10-18 22:20:36 +08:00
|
|
|
retrieve a descriptive name of the bus connection of the
|
|
|
|
peer. This name is useful to discern multiple bus connections by
|
|
|
|
the same peer, and may be altered by the peer with the
|
2015-04-30 03:44:55 +08:00
|
|
|
<citerefentry><refentrytitle>sd_bus_set_description</refentrytitle><manvolnum>3</manvolnum></citerefentry>
|
2014-10-18 22:20:36 +08:00
|
|
|
call.</para>
|
|
|
|
|
2014-01-04 13:08:50 +08:00
|
|
|
<para>All functions that take a <parameter>const
|
|
|
|
char**</parameter> parameter will store the answer there as an
|
2020-11-12 15:58:00 +08:00
|
|
|
address of a <constant>NUL</constant>-terminated string. It will be valid as long as
|
2014-01-04 13:08:50 +08:00
|
|
|
<parameter>c</parameter> remains valid, and should not be freed or
|
|
|
|
modified by the caller.</para>
|
|
|
|
|
|
|
|
<para>All functions that take a <parameter>char***</parameter>
|
2015-12-27 01:25:49 +08:00
|
|
|
parameter will store the answer there as an address of an array
|
2020-11-12 15:58:00 +08:00
|
|
|
of strings. Each individual string is <constant>NUL</constant>-terminated, and the
|
|
|
|
array is <constant>NULL</constant>-terminated as a whole. It will be valid as long as
|
2014-01-04 13:08:50 +08:00
|
|
|
<parameter>c</parameter> remains valid, and should not be freed or
|
|
|
|
modified by the caller.</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>Return Value</title>
|
|
|
|
|
|
|
|
<para>On success, these calls return 0 or a positive integer. On
|
|
|
|
failure, these calls return a negative errno-style error code.
|
|
|
|
</para>
|
|
|
|
|
2019-03-21 21:53:00 +08:00
|
|
|
<refsect2>
|
|
|
|
<title>Errors</title>
|
|
|
|
|
|
|
|
<para>Returned errors may indicate the following problems:</para>
|
|
|
|
|
|
|
|
<variablelist>
|
|
|
|
<varlistentry>
|
|
|
|
<term><constant>-ENODATA</constant></term>
|
|
|
|
|
|
|
|
<listitem><para>The given field is not available in the credentials object
|
|
|
|
<parameter>c</parameter>.</para>
|
|
|
|
</listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><constant>-ENXIO</constant></term>
|
|
|
|
|
|
|
|
<listitem><para>The given field is not specified for the described process or peer. This will be
|
|
|
|
returned by <function>sd_bus_creds_get_unit()</function>,
|
|
|
|
<function>sd_bus_creds_get_slice()</function>, <function>sd_bus_creds_get_user_unit()</function>,
|
|
|
|
<function>sd_bus_creds_get_user_slice()</function>, and
|
|
|
|
<function>sd_bus_creds_get_session()</function> if the process is not part of a systemd system
|
|
|
|
unit, systemd user unit, systemd slice, or logind session. It will be returned by
|
|
|
|
<function>sd_bus_creds_get_owner_uid()</function> if the process is not part of a systemd user unit
|
|
|
|
or logind session. It will also be returned by <function>sd_bus_creds_get_exe()</function> and
|
|
|
|
<function>sd_bus_creds_get_cmdline()</function> for kernel threads (since these are not started
|
|
|
|
from an executable binary, nor have a command line), and by
|
|
|
|
<function>sd_bus_creds_get_audit_session_id()</function> and
|
|
|
|
<function>sd_bus_creds_get_audit_login_uid()</function> when the process is not part of an audit
|
|
|
|
session, and <function>sd_bus_creds_get_tty()</function> if the process has no controlling
|
|
|
|
TTY.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><constant>-EINVAL</constant></term>
|
|
|
|
|
|
|
|
<listitem><para>Specified pointer parameter is <constant>NULL</constant>.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
|
|
|
|
<varlistentry>
|
|
|
|
<term><constant>-ENOMEM</constant></term>
|
|
|
|
|
|
|
|
<listitem><para>Memory allocation failed.</para></listitem>
|
|
|
|
</varlistentry>
|
|
|
|
</variablelist>
|
|
|
|
</refsect2>
|
2014-01-04 13:08:50 +08:00
|
|
|
</refsect1>
|
|
|
|
|
2018-06-06 17:59:04 +08:00
|
|
|
<xi:include href="libsystemd-pkgconfig.xml" />
|
2014-01-04 13:08:50 +08:00
|
|
|
|
|
|
|
<refsect1>
|
|
|
|
<title>See Also</title>
|
|
|
|
|
|
|
|
<para>
|
|
|
|
<citerefentry><refentrytitle>systemd</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
|
<citerefentry><refentrytitle>sd-bus</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
2015-06-24 02:42:57 +08:00
|
|
|
<citerefentry><refentrytitle>sd_bus_creds_new_from_pid</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
|
|
|
|
<citerefentry project='man-pages'><refentrytitle>fork</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
|
|
|
|
<citerefentry project='man-pages'><refentrytitle>execve</refentrytitle><manvolnum>2</manvolnum></citerefentry>,
|
man: add a mapping for external manpages
It is annoying when we have dead links on fd.o.
Add project='man-pages|die-net|archlinux' to <citerefentry>-ies.
In generated html, add external links to
http://man7.org/linux/man-pages/man, http://linux.die.net/man/,
https://www.archlinux.org/.
By default, pages in sections 2 and 4 go to man7, since Michael
Kerrisk is the autorative source on kernel related stuff.
The rest of links goes to linux.die.net, because they have the
manpages.
Except for the pacman stuff, since it seems to be only available from
archlinux.org.
Poor gummiboot gets no link, because gummitboot(8) ain't to be found
on the net. According to common wisdom, that would mean that it does
not exist. But I have seen Kay using it, so I know it does, and
deserves to be found. Can somebody be nice and put it up somewhere?
2014-07-08 06:25:54 +08:00
|
|
|
<citerefentry project='man-pages'><refentrytitle>credentials</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
|
|
|
|
<citerefentry project='man-pages'><refentrytitle>free</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
|
|
|
|
<citerefentry project='man-pages'><refentrytitle>proc</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
|
2015-03-14 10:26:20 +08:00
|
|
|
<citerefentry><refentrytitle>systemd.journal-fields</refentrytitle><manvolnum>7</manvolnum></citerefentry>
|
2014-01-04 13:08:50 +08:00
|
|
|
</para>
|
|
|
|
</refsect1>
|
|
|
|
|
|
|
|
</refentry>
|