src/systemd/sd-login.h

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 #ifndef foosdloginhfoo
   3 #define foosdloginhfoo
   4
   5 /***
   6
   7   systemd is free software; you can redistribute it and/or modify it
   8   under the terms of the GNU Lesser General Public License as published by
   9   the Free Software Foundation; either version 2.1 of the License, or
  10   (at your option) any later version.
  11
  12   systemd is distributed in the hope that it will be useful, but
  13   WITHOUT ANY WARRANTY; without even the implied warranty of
  14   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  15   Lesser General Public License for more details.
  16
  17   You should have received a copy of the GNU Lesser General Public License
  18   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  19 ***/
  20
  21 #include <inttypes.h>
  22 #include <sys/types.h>
  23
  24 #include "_sd-common.h"
  25
  26 /*
  27  * A few points:
  28  *
  29  * Instead of returning an empty string array or empty uid array, we
  30  * may return NULL.
  31  *
  32  * Free the data the library returns with libc free(). String arrays
  33  * are NULL terminated, and you need to free the array itself, in
  34  * addition to the strings contained.
  35  *
  36  * We return error codes as negative errno, kernel-style. On success, we
  37  * return 0 or positive.
  38  *
  39  * These functions access data in /proc, /sys/fs/cgroup, and /run. All
  40  * of these are virtual file systems; therefore, accesses are
  41  * relatively cheap.
  42  *
  43  * See sd-login(3) for more information.
  44  */
  45
  46 _SD_BEGIN_DECLARATIONS;
  47
  48 /* Get session from PID. Note that 'shared' processes of a user are
  49  * not attached to a session, but only attached to a user. This will
  50  * return an error for system processes and 'shared' processes of a
  51  * user. */
  52 int sd_pid_get_session(pid_t pid, char **session);
  53
  54 /* Get UID of the owner of the session of the PID (or in case the
  55  * process is a 'shared' user process, the UID of that user is
  56  * returned). This will not return the UID of the process, but rather
  57  * the UID of the owner of the cgroup that the process is in. This will
  58  * return an error for system processes. */
  59 int sd_pid_get_owner_uid(pid_t pid, uid_t *uid);
  60
  61 /* Get systemd non-slice unit (i.e. service) name from PID, for system
  62  * services. This will return an error for non-service processes. */
  63 int sd_pid_get_unit(pid_t pid, char **unit);
  64
  65 /* Get systemd non-slice unit (i.e. service) name from PID, for user
  66  * services. This will return an error for non-user-service
  67  * processes. */
  68 int sd_pid_get_user_unit(pid_t pid, char **unit);
  69
  70 /* Get slice name from PID. */
  71 int sd_pid_get_slice(pid_t pid, char **slice);
  72
  73 /* Get user slice name from PID. */
  74 int sd_pid_get_user_slice(pid_t pid, char **slice);
  75
  76 /* Get machine name from PID, for processes assigned to a VM or
  77  * container. This will return an error for non-machine processes. */
  78 int sd_pid_get_machine_name(pid_t pid, char **machine);
  79
  80 /* Get the control group from a PID, relative to the root of the
  81  * hierarchy. */
  82 int sd_pid_get_cgroup(pid_t pid, char **cgroup);
  83
  84 /* Similar to sd_pid_get_session(), but retrieves data about the peer
  85  * of a connected AF_UNIX socket */
  86 int sd_peer_get_session(int fd, char **session);
  87
  88 /* Similar to sd_pid_get_owner_uid(), but retrieves data about the peer of
  89  * a connected AF_UNIX socket */
  90 int sd_peer_get_owner_uid(int fd, uid_t *uid);
  91
  92 /* Similar to sd_pid_get_unit(), but retrieves data about the peer of
  93  * a connected AF_UNIX socket */
  94 int sd_peer_get_unit(int fd, char **unit);
  95
  96 /* Similar to sd_pid_get_user_unit(), but retrieves data about the peer of
  97  * a connected AF_UNIX socket */
  98 int sd_peer_get_user_unit(int fd, char **unit);
  99
 100 /* Similar to sd_pid_get_slice(), but retrieves data about the peer of
 101  * a connected AF_UNIX socket */
 102 int sd_peer_get_slice(int fd, char **slice);
 103
 104 /* Similar to sd_pid_get_user_slice(), but retrieves data about the peer of
 105  * a connected AF_UNIX socket */
 106 int sd_peer_get_user_slice(int fd, char **slice);
 107
 108 /* Similar to sd_pid_get_machine_name(), but retrieves data about the
 109  * peer of a connected AF_UNIX socket */
 110 int sd_peer_get_machine_name(int fd, char **machine);
 111
 112 /* Similar to sd_pid_get_cgroup(), but retrieves data about the peer
 113  * of a connected AF_UNIX socket. */
 114 int sd_peer_get_cgroup(pid_t pid, char **cgroup);
 115
 116 /* Get state from UID. Possible states: offline, lingering, online, active, closing */
 117 int sd_uid_get_state(uid_t uid, char **state);
 118
 119 /* Return primary session of user, if there is any */
 120 int sd_uid_get_display(uid_t uid, char **session);
 121
 122 /* Return 1 if UID has session on seat. If require_active is true, this will
 123  * look for active sessions only. */
 124 int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat);
 125
 126 /* Return sessions of user. If require_active is true, this will look for
 127  * active sessions only. Returns the number of sessions.
 128  * If sessions is NULL, this will just return the number of sessions. */
 129 int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions);
 130
 131 /* Return seats of user is on. If require_active is true, this will look for
 132  * active seats only. Returns the number of seats.
 133  * If seats is NULL, this will just return the number of seats. */
 134 int sd_uid_get_seats(uid_t uid, int require_active, char ***seats);
 135
 136 /* Return 1 if the session is active. */
 137 int sd_session_is_active(const char *session);
 138
 139 /* Return 1 if the session is remote. */
 140 int sd_session_is_remote(const char *session);
 141
 142 /* Get state from session. Possible states: online, active, closing.
 143  * This function is a more generic version of sd_session_is_active(). */
 144 int sd_session_get_state(const char *session, char **state);
 145
 146 /* Determine user ID of session */
 147 int sd_session_get_uid(const char *session, uid_t *uid);
 148
 149 /* Determine seat of session */
 150 int sd_session_get_seat(const char *session, char **seat);
 151
 152 /* Determine the (PAM) service name this session was registered by. */
 153 int sd_session_get_service(const char *session, char **service);
 154
 155 /* Determine the type of this session, i.e. one of "tty", "x11", "wayland", "mir" or "unspecified". */
 156 int sd_session_get_type(const char *session, char **type);
 157
 158 /* Determine the class of this session, i.e. one of "user", "greeter" or "lock-screen". */
 159 int sd_session_get_class(const char *session, char **clazz);
 160
 161 /* Determine the desktop brand of this session, i.e. something like "GNOME", "KDE" or "systemd-console". */
 162 int sd_session_get_desktop(const char *session, char **desktop);
 163
 164 /* Determine the X11 display of this session. */
 165 int sd_session_get_display(const char *session, char **display);
 166
 167 /* Determine the remote host of this session. */
 168 int sd_session_get_remote_host(const char *session, char **remote_host);
 169
 170 /* Determine the remote user of this session (if provided by PAM). */
 171 int sd_session_get_remote_user(const char *session, char **remote_user);
 172
 173 /* Determine the TTY of this session. */
 174 int sd_session_get_tty(const char *session, char **display);
 175
 176 /* Determine the VT number of this session. */
 177 int sd_session_get_vt(const char *session, unsigned *vtnr);
 178
 179 /* Return active session and user of seat */
 180 int sd_seat_get_active(const char *seat, char **session, uid_t *uid);
 181
 182 /* Return sessions and users on seat. Returns number of sessions.
 183  * If sessions is NULL, this returns only the number of sessions. */
 184 int sd_seat_get_sessions(const char *seat, char ***sessions, uid_t **uid, unsigned *n_uids);
 185
 186 /* Return whether the seat is multi-session capable */
 187 int sd_seat_can_multi_session(const char *seat);
 188
 189 /* Return whether the seat is TTY capable, i.e. suitable for showing console UIs */
 190 int sd_seat_can_tty(const char *seat);
 191
 192 /* Return whether the seat is graphics capable, i.e. suitable for showing graphical UIs */
 193 int sd_seat_can_graphical(const char *seat);
 194
 195 /* Return the class of machine */
 196 int sd_machine_get_class(const char *machine, char **clazz);
 197
 198 /* Return the list if host-side network interface indices of a machine */
 199 int sd_machine_get_ifindices(const char *machine, int **ifindices);
 200
 201 /* Get all seats, store in *seats. Returns the number of seats. If
 202  * seats is NULL, this only returns the number of seats. */
 203 int sd_get_seats(char ***seats);
 204
 205 /* Get all sessions, store in *sessions. Returns the number of
 206  * sessions. If sessions is NULL, this only returns the number of sessions. */
 207 int sd_get_sessions(char ***sessions);
 208
 209 /* Get all logged in users, store in *users. Returns the number of
 210  * users. If users is NULL, this only returns the number of users. */
 211 int sd_get_uids(uid_t **users);
 212
 213 /* Get all running virtual machines/containers */
 214 int sd_get_machine_names(char ***machines);
 215
 216 /* Monitor object */
 217 typedef struct sd_login_monitor sd_login_monitor;
 218
 219 /* Create a new monitor. Category must be NULL, "seat", "session",
 220  * "uid", or "machine" to get monitor events for the specific category
 221  * (or all). */
 222 int sd_login_monitor_new(const char *category, sd_login_monitor** ret);
 223
 224 /* Destroys the passed monitor. Returns NULL. */
 225 sd_login_monitor* sd_login_monitor_unref(sd_login_monitor *m);
 226
 227 /* Flushes the monitor */
 228 int sd_login_monitor_flush(sd_login_monitor *m);
 229
 230 /* Get FD from monitor */
 231 int sd_login_monitor_get_fd(sd_login_monitor *m);
 232
 233 /* Get poll() mask to monitor */
 234 int sd_login_monitor_get_events(sd_login_monitor *m);
 235
 236 /* Get timeout for poll(), as usec value relative to CLOCK_MONOTONIC's epoch */
 237 int sd_login_monitor_get_timeout(sd_login_monitor *m, uint64_t *timeout_usec);
 238
 239 _SD_DEFINE_POINTER_CLEANUP_FUNC(sd_login_monitor, sd_login_monitor_unref);
 240
 241 _SD_END_DECLARATIONS;
 242
 243 #endif