src/sd-login.h

   1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
   2
   3 #ifndef foosdloginhfoo
   4 #define foosdloginhfoo
   5
   6 /***
   7   This file is part of systemd.
   8
   9   Copyright 2011 Lennart Poettering
  10
  11   systemd is free software; you can redistribute it and/or modify it
  12   under the terms of the GNU General Public License as published by
  13   the Free Software Foundation; either version 2 of the License, or
  14   (at your option) any later version.
  15
  16   systemd is distributed in the hope that it will be useful, but
  17   WITHOUT ANY WARRANTY; without even the implied warranty of
  18   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  19   General Public License for more details.
  20
  21   You should have received a copy of the GNU General Public License
  22   along with systemd; If not, see <http://www.gnu.org/licenses/>.
  23 ***/
  24
  25 #include <sys/types.h>
  26
  27 /*
  28  * A few points:
  29  *
  30  * Instead of returning an empty string array or empty uid array, we
  31  * may return NULL.
  32  *
  33  * Free the data we return with libc free().
  34  *
  35  * We return error codes as negative errno, kernel-style.
  36  *
  37  * These functions access data in /proc, /sys/fs/cgroup and /run. All
  38  * of these are virtual file systems, hence the accesses are
  39  * relatively cheap.
  40  */
  41
  42 /* Get session from PID. Note that 'shared' processes of a user are
  43  * not attached to a session, but only attached to a user. This will
  44  * return an error for system processes and 'shared' processes of a
  45  * user. */
  46 int sd_pid_get_session(pid_t pid, char **session);
  47
  48 /* Get UID of the owner of the session of the PID (or in case the
  49  * process is a 'shared' user process the UID of that user is
  50  * returned). This will not return the UID of the process, but rather
  51  * the UID of the owner of the cgroup the process is in. This will
  52  * return an error for system processes. */
  53 int sd_pid_get_owner_uid(pid_t pid, uid_t *uid);
  54
  55 /* Get state from uid. Possible states: offline, lingering, online, active */
  56 int sd_uid_get_state(uid_t uid, char**state);
  57
  58 /* Return 1 if uid has session on seat. If require_active is true will
  59  * look for active sessions only. */
  60 int sd_uid_is_on_seat(uid_t uid, int require_active, const char *seat);
  61
  62 /* Return sessions of user. If require_active is true will look
  63  * for active sessions only. */
  64 int sd_uid_get_sessions(uid_t uid, int require_active, char ***sessions);
  65
  66 /* Return seats of user is on. If require_active is true will look for
  67  * active seats only.  */
  68 int sd_uid_get_seats(uid_t uid, int require_active, char ***seats);
  69
  70 /* Return 1 if the session is a active */
  71 int sd_session_is_active(const char *session);
  72
  73 /* Determine user id of session */
  74 int sd_session_get_uid(const char *session, uid_t *uid);
  75
  76 /* Determine seat of session */
  77 int sd_session_get_seat(const char *session, char **seat);
  78
  79 /* Return active session and user of seat */
  80 int sd_seat_get_active(const char *seat, char **session, uid_t *uid);
  81
  82 /* Return sessions and users on seat */
  83 int sd_seat_get_sessions(const char *seat, char ***sessions, uid_t **uid, unsigned *n_uids);
  84
  85 /* Get all seats */
  86 int sd_get_seats(char ***seats);
  87
  88 /* Get all sessions */
  89 int sd_get_sessions(char ***sessions);
  90
  91 /* Get all logged in users */
  92 int sd_get_uids(uid_t **users);
  93
  94 /* Monitor object */
  95 typedef struct sd_login_monitor sd_login_monitor;
  96
  97 /* Create a new monitor. Category must be NULL, "seat", "session",
  98  * "uid" to get monitor events for the specific category (or all). */
  99 int sd_login_monitor_new(const char *category, sd_login_monitor** ret);
 100
 101 /* Destroys the passed monitor. Returns NULL. */
 102 sd_login_monitor* sd_login_monitor_unref(sd_login_monitor *m);
 103
 104 /* Flushes the monitor */
 105 int sd_login_monitor_flush(sd_login_monitor *m);
 106
 107 /* Get FD from monitor */
 108 int sd_login_monitor_get_fd(sd_login_monitor *m);
 109
 110 #endif