diff options
Diffstat (limited to 'man/sd_bus_creds_get_pid.3')
| -rw-r--r-- | man/sd_bus_creds_get_pid.3 | 119 |
1 files changed, 81 insertions, 38 deletions
diff --git a/man/sd_bus_creds_get_pid.3 b/man/sd_bus_creds_get_pid.3 index b635d8c65e..251db016bd 100644 --- a/man/sd_bus_creds_get_pid.3 +++ b/man/sd_bus_creds_get_pid.3 @@ -1,5 +1,5 @@ '\" t -.TH "SD_BUS_CREDS_GET_PID" "3" "" "systemd 219" "sd_bus_creds_get_pid" +.TH "SD_BUS_CREDS_GET_PID" "3" "" "systemd 220" "sd_bus_creds_get_pid" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -20,7 +20,7 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -sd_bus_creds_get_pid, sd_bus_creds_get_tid, sd_bus_creds_get_uid, sd_bus_creds_get_gid, sd_bus_creds_get_comm, sd_bus_creds_get_tid_comm, sd_bus_creds_get_exe, sd_bus_creds_get_cmdline, sd_bus_creds_get_cgroup, sd_bus_creds_get_unit, sd_bus_creds_get_user_unit, sd_bus_creds_get_slice, sd_bus_creds_get_session, sd_bus_creds_get_owner_uid, sd_bus_creds_has_effective_cap, sd_bus_creds_has_permitted_cap, sd_bus_creds_has_inheritable_cap, sd_bus_creds_has_bounding_cap, sd_bus_creds_get_selinux_context, sd_bus_creds_get_audit_session_id, sd_bus_creds_get_audit_login_uid, sd_bus_creds_get_unique_name, sd_bus_creds_get_well_known_names, sd_bus_creds_get_connection_name \- Retrieve fields from a credentials object +sd_bus_creds_get_pid, sd_bus_creds_get_ppid, sd_bus_creds_get_tid, sd_bus_creds_get_uid, sd_bus_creds_get_euid, sd_bus_creds_get_suid, sd_bus_creds_get_fsuid, sd_bus_creds_get_gid, sd_bus_creds_get_egid, sd_bus_creds_get_sgid, sd_bus_creds_get_fsgid, sd_bus_creds_get_supplementary_gids, sd_bus_creds_get_comm, sd_bus_creds_get_tid_comm, sd_bus_creds_get_exe, sd_bus_creds_get_cmdline, sd_bus_creds_get_cgroup, sd_bus_creds_get_unit, sd_bus_creds_get_user_unit, sd_bus_creds_get_slice, sd_bus_creds_get_session, sd_bus_creds_get_owner_uid, sd_bus_creds_has_effective_cap, sd_bus_creds_has_permitted_cap, sd_bus_creds_has_inheritable_cap, sd_bus_creds_has_bounding_cap, sd_bus_creds_get_selinux_context, sd_bus_creds_get_audit_session_id, sd_bus_creds_get_audit_login_uid, sd_bus_creds_get_tty, sd_bus_creds_get_unique_name, sd_bus_creds_get_well_known_names, sd_bus_creds_get_description \- Retrieve fields from a credentials object .SH "SYNOPSIS" .sp .ft B @@ -30,12 +30,28 @@ sd_bus_creds_get_pid, sd_bus_creds_get_tid, sd_bus_creds_get_uid, sd_bus_creds_g .ft .HP \w'int\ sd_bus_creds_get_pid('u .BI "int sd_bus_creds_get_pid(sd_bus_creds\ *" "c" ", pid_t\ *" "pid" ");" +.HP \w'int\ sd_bus_creds_get_ppid('u +.BI "int sd_bus_creds_get_ppid(sd_bus_creds\ *" "c" ", pid_t\ *" "ppid" ");" .HP \w'int\ sd_bus_creds_get_tid('u .BI "int sd_bus_creds_get_tid(sd_bus_creds\ *" "c" ", pid_t\ *" "tid" ");" -.HP \w'int\ sd_bus_creds_get_pid('u -.BI "int sd_bus_creds_get_pid(sd_bus_creds\ *" "c" ", uid_t\ *" "uid" ");" +.HP \w'int\ sd_bus_creds_get_uid('u +.BI "int sd_bus_creds_get_uid(sd_bus_creds\ *" "c" ", uid_t\ *" "uid" ");" +.HP \w'int\ sd_bus_creds_get_euid('u +.BI "int sd_bus_creds_get_euid(sd_bus_creds\ *" "c" ", uid_t\ *" "uid" ");" +.HP \w'int\ sd_bus_creds_get_suid('u +.BI "int sd_bus_creds_get_suid(sd_bus_creds\ *" "c" ", uid_t\ *" "uid" ");" +.HP \w'int\ sd_bus_creds_get_fsuid('u +.BI "int sd_bus_creds_get_fsuid(sd_bus_creds\ *" "c" ", uid_t\ *" "uid" ");" .HP \w'int\ sd_bus_creds_get_gid('u .BI "int sd_bus_creds_get_gid(sd_bus_creds\ *" "c" ", gid_t\ *" "gid" ");" +.HP \w'int\ sd_bus_creds_get_egid('u +.BI "int sd_bus_creds_get_egid(sd_bus_creds\ *" "c" ", gid_t\ *" "gid" ");" +.HP \w'int\ sd_bus_creds_get_sgid('u +.BI "int sd_bus_creds_get_sgid(sd_bus_creds\ *" "c" ", gid_t\ *" "gid" ");" +.HP \w'int\ sd_bus_creds_get_fsgid('u +.BI "int sd_bus_creds_get_fsgid(sd_bus_creds\ *" "c" ", gid_t\ *" "gid" ");" +.HP \w'int\ sd_bus_creds_get_supplementary_gids('u +.BI "int sd_bus_creds_get_supplementary_gids(sd_bus_creds\ *" "c" ", const\ gid_t\ **" "gids" ");" .HP \w'int\ sd_bus_creds_get_comm('u .BI "int sd_bus_creds_get_comm(sd_bus_creds\ *" "c" ", const\ char\ **" "comm" ");" .HP \w'int\ sd_bus_creds_get_tid_comm('u @@ -70,31 +86,51 @@ sd_bus_creds_get_pid, sd_bus_creds_get_tid, sd_bus_creds_get_uid, sd_bus_creds_g .BI "int sd_bus_creds_get_audit_session_id(sd_bus_creds\ *" "c" ", uint32_t\ *" "sessionid" ");" .HP \w'int\ sd_bus_creds_get_audit_login_uid('u .BI "int sd_bus_creds_get_audit_login_uid(sd_bus_creds\ *" "c" ", uid_t\ *" "loginuid" ");" +.HP \w'int\ sd_bus_creds_get_tty('u +.BI "int sd_bus_creds_get_tty(sd_bus_creds\ *" "c" ", const\ char\ **" "tty" ");" .HP \w'int\ sd_bus_creds_get_unique_name('u .BI "int sd_bus_creds_get_unique_name(sd_bus_creds\ *" "c" ", const\ char\ **" "name" ");" .HP \w'int\ sd_bus_creds_get_well_known_names('u .BI "int sd_bus_creds_get_well_known_names(sd_bus_creds\ *" "c" ", char\ ***" "name" ");" -.HP \w'int\ sd_bus_creds_get_connection_name('u -.BI "int sd_bus_creds_get_connection_name(sd_bus_creds\ *" "c" ", const\ char\ **" "name" ");" +.HP \w'int\ sd_bus_creds_get_description('u +.BI "int sd_bus_creds_get_description(sd_bus_creds\ *" "c" ", const\ char\ **" "name" ");" .SH "DESCRIPTION" .PP These functions return information from an \fIsd_bus_creds\fR -object\&. It may be created with -\fBsd_bus_creds_new_from_pid\fR(3), in which case it will describe the specified process, or it may be created by -\fBsd_bus_get_owner_creds\fR(3), in which case it will describe the process at the other endpoint of a connection\&. +credential object\&. Credential objects may be created with +\fBsd_bus_creds_new_from_pid\fR(3), in which case they describe the credentials of the process identified by the specified PID, with +\fBsd_bus_get_name_creds\fR(3), in which case they describe the credentials of a bus peer identified by the specified bus name, or with +\fBsd_bus_get_owner_creds\fR(3), in which case they describe the credentials of the creator of a bus\&. .PP \fBsd_bus_creds_get_pid()\fR -will retrieve the PID (process identifier)\&. +will retrieve the PID (process identifier)\&. Similar, +\fBsd_bus_creds_get_ppid()\fR +will retrieve the parent PID\&. Note that PID 1 has no parent process, in which case \-ENXIO is returned\&. .PP \fBsd_bus_creds_get_tid()\fR will retrieve the TID (thread identifier)\&. .PP \fBsd_bus_creds_get_uid()\fR -will retrieve the numeric UID (user identifier)\&. +will retrieve the numeric UID (user identifier)\&. Similar, +\fBsd_bus_creds_get_euid()\fR +returns the effective UID, +\fBsd_bus_creds_get_suid()\fR +the saved UID and +\fBsd_bus_creds_get_fsuid()\fR +the file system UID\&. .PP \fBsd_bus_creds_get_gid()\fR -will retrieve the numeric GID (group identifier)\&. +will retrieve the numeric GID (group identifier)\&. Similar, +\fBsd_bus_creds_get_egid()\fR +returns the effective GID, +\fBsd_bus_creds_get_sgid()\fR +the saved GID and +\fBsd_bus_creds_get_fsgid()\fR +the file system GID\&. +.PP +\fBsd_bus_creds_get_supplementary_gids()\fR +will retrieve the supplementary GIDs list\&. .PP \fBsd_bus_creds_get_comm()\fR will retrieve the comm field (truncated name of the executable, as stored in @@ -105,15 +141,15 @@ will retrieve the comm field of the thread (as stored in /proc/\fIpid\fR/task/\fItid\fR/comm)\&. .PP \fBsd_bus_creds_get_exe()\fR -will retrieve the path to the program (as stored in the +will retrieve the path to the program executable (as stored in the /proc/\fIpid\fR/exe link, but with " (deleted)" -suffix removed)\&. +suffix removed)\&. Note that kernel threads do not have an executable path, in which case \-ENXIO is returned\&. .PP \fBsd_bus_creds_get_cmdline()\fR will retrieve an array of command line arguments (as stored in -/proc/\fIpid\fR/cmdline)\&. +/proc/\fIpid\fR/cmdline)\&. Note that kernel threads do not have a command line, in which case \-ENXIO is returned\&. .PP \fBsd_bus_creds_get_cgroup()\fR will retrieve the cgroup path\&. See @@ -121,11 +157,11 @@ will retrieve the cgroup path\&. See .PP \fBsd_bus_creds_get_unit()\fR will retrieve the systemd unit name (in the system instance of systemd) that the process is part of\&. See -\fBsystemd.unit\fR(5)\&. +\fBsystemd.unit\fR(5)\&. For processes that are not part of a unit returns \-ENXIO\&. .PP \fBsd_bus_creds_get_user_unit()\fR will retrieve the systemd unit name (in the user instance of systemd) that the process is part of\&. See -\fBsystemd.unit\fR(5)\&. +\fBsystemd.unit\fR(5)\&. For processes that are not part of a user unit returns \-ENXIO\&. .PP \fBsd_bus_creds_get_slice()\fR will retrieve the systemd slice (a unit in the system instance of systemd) that the process is part of\&. See @@ -133,11 +169,12 @@ will retrieve the systemd slice (a unit in the system instance of systemd) that .PP \fBsd_bus_creds_get_session()\fR will retrieve the logind session that the process is part of\&. See -\fBsystemd-logind.service\fR(8)\&. +\fBsystemd-logind.service\fR(8)\&. For processes that are not part of a session returns \-ENXIO\&. .PP \fBsd_bus_creds_get_owner_uid()\fR -will retrieve the numeric UID (user identifier) of the user who owns the slice that the process is part of\&. See -\fBsystemd.slice\fR(5)\&. +will retrieve the numeric UID (user identifier) of the user who owns the session that the process is part of\&. See +\fBsystemd.slice\fR(5) +For processes that are not part of a session returns \-ENXIO\&. .PP \fBsd_bus_creds_has_effective_cap()\fR will check whether the capability specified by @@ -167,10 +204,13 @@ is similar to will retrieve the SELinux security context (label) of the process\&. .PP \fBsd_bus_creds_get_audit_session_id()\fR -will retrieve the audit session identifier of the process\&. +will retrieve the audit session identifier of the process\&. Returns \-ENXIO for processes that are not part of an audit session\&. .PP \fBsd_bus_creds_get_audit_login_uid()\fR -will retrieve the audit user login identifier (the identifier of the user who is "responsible" for the session)\&. +will retrieve the audit user login identifier (the identifier of the user who is "responsible" for the session)\&. Returns \-ENXIO for processes that are not part of an audit session\&. +.PP +\fBsd_bus_creds_get_tty()\fR +will retrieve the controlling TTY\&. Returns \-ENXIO for processes that have no controlling TTY\&. .PP \fBsd_bus_creds_get_unique_name()\fR will retrieve the D\-Bus unique name\&. See @@ -180,9 +220,9 @@ will retrieve the D\-Bus unique name\&. See will retrieve the set of D\-Bus well\-known names\&. See \m[blue]\fBThe D\-Bus specification\fR\m[]\&\s-2\u[2]\d\s+2\&. .PP -\fBsd_bus_creds_get_connection_name()\fR +\fBsd_bus_creds_get_description()\fR will 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 -\fBsd_bus_set_name()\fR(3) +\fBsd_bus_set_description\fR(3) call\&. .PP All functions that take a @@ -193,7 +233,7 @@ remains valid, and should not be freed or modified by the caller\&. .PP All functions that take a \fIchar***\fR -parameter will store the answer there as an address of a an array of strings\&. Each invidividual string is NUL\-terminated, and the array is NULL\-terminated as a whole\&. It will be valid as long as +parameter will store the answer there as an address of a an array of strings\&. Each individual string is NUL\-terminated, and the array is NULL\-terminated as a whole\&. It will be valid as long as \fIc\fR remains valid, and should not be freed or modified by the caller\&. .SH "RETURN VALUE" @@ -205,26 +245,29 @@ Returned errors may indicate the following problems: .PP \fB\-ENODATA\fR .RS 4 -Given field is not available in +Given field is not available in the credentials object \fIc\fR\&. .RE .PP -\fB\-ENOENT\fR +\fB\-ENXIO\fR .RS 4 -Given field is not specified for the sender\&. This will be returned by +Given field is not specified for the described process or peer\&. This will be returned by \fBsd_bus_get_unit()\fR, \fBsd_bus_get_user_unit()\fR, \fBsd_bus_get_slice()\fR, \fBsd_bus_get_session()\fR, and -\fBsd_bus_get_name_creds_uid()\fR -if the sender is not part of a systemd system unit, systemd user unit, systemd slice, logind session, or a systemd user session\&. -.RE -.PP -\fB\-ENXIO\fR -.RS 4 -An error occurred in parsing cgroup paths\&. -libsystemd -might be out of sync with the running systemd version\&. +\fBsd_bus_get_owner_uid()\fR +if the process is not part of a systemd system unit, systemd user unit, systemd slice, or logind session\&. It will also be returned by +\fBsd_bus_creds_get_exe()\fR +and +\fBsd_bus_creds_get_cmdline()\fR +for kernel threads (since these aren\*(Aqt started from an executable binary or have a command line), +\fBsd_bus_creds_get_audit_session_id()\fR +and +\fBsd_bus_creds_get_audit_login_uid()\fR +when the process is not part of an audit session, and +\fBsd_bus_creds_get_tty()\fR +if the process has no controlling TTY\&. .RE .PP \fB\-EINVAL\fR @@ -252,7 +295,7 @@ file\&. \fBcredentials\fR(7), \fBfree\fR(3), \fBproc\fR(5), -\fBsystemd.journald-fields\fR(7) +\fBsystemd.journal-fields\fR(7) .SH "NOTES" .IP " 1." 4 cgroups.txt |