1 /*-*- Mode: C; c-basic-offset: 8; indent-tabs-mode: nil -*-*/
4 This file is part of systemd.
6 Copyright 2010 Lennart Poettering
8 systemd is free software; you can redistribute it and/or modify it
9 under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2 of the License, or
11 (at your option) any later version.
13 systemd is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with systemd; If not, see <http://www.gnu.org/licenses/>.
28 #include <security/pam_modules.h>
29 #include <security/_pam_macros.h>
30 #include <security/pam_modutil.h>
31 #include <security/pam_ext.h>
32 #include <security/pam_misc.h>
35 #include "cgroup-util.h"
37 #include "sd-daemon.h"
40 static int parse_argv(pam_handle_t *handle,
41 int argc, const char **argv,
46 char ***reset_controllers,
47 char ***kill_only_users,
48 char ***kill_exclude_users) {
51 bool reset_controller_set = false;
52 bool kill_exclude_users_set = false;
55 assert(argc == 0 || argv);
57 for (i = 0; i < (unsigned) argc; i++) {
60 if (startswith(argv[i], "create-session=")) {
61 if ((k = parse_boolean(argv[i] + 15)) < 0) {
62 pam_syslog(handle, LOG_ERR, "Failed to parse create-session= argument.");
69 } else if (startswith(argv[i], "kill-session=")) {
70 if ((k = parse_boolean(argv[i] + 13)) < 0) {
71 pam_syslog(handle, LOG_ERR, "Failed to parse kill-session= argument.");
78 } else if (startswith(argv[i], "kill-user=")) {
79 if ((k = parse_boolean(argv[i] + 10)) < 0) {
80 pam_syslog(handle, LOG_ERR, "Failed to parse kill-user= argument.");
87 } else if (startswith(argv[i], "controllers=")) {
92 if (!(l = strv_split(argv[i] + 12, ","))) {
93 pam_syslog(handle, LOG_ERR, "Out of memory.");
97 strv_free(*controllers);
101 } else if (startswith(argv[i], "reset-controllers=")) {
103 if (reset_controllers) {
106 if (!(l = strv_split(argv[i] + 18, ","))) {
107 pam_syslog(handle, LOG_ERR, "Out of memory.");
111 strv_free(*reset_controllers);
112 *reset_controllers = l;
115 reset_controller_set = true;
117 } else if (startswith(argv[i], "kill-only-users=")) {
119 if (kill_only_users) {
122 if (!(l = strv_split(argv[i] + 16, ","))) {
123 pam_syslog(handle, LOG_ERR, "Out of memory.");
127 strv_free(*kill_only_users);
128 *kill_only_users = l;
131 } else if (startswith(argv[i], "kill-exclude-users=")) {
133 if (kill_exclude_users) {
136 if (!(l = strv_split(argv[i] + 19, ","))) {
137 pam_syslog(handle, LOG_ERR, "Out of memory.");
141 strv_free(*kill_exclude_users);
142 *kill_exclude_users = l;
145 kill_exclude_users_set = true;
148 pam_syslog(handle, LOG_ERR, "Unknown parameter '%s'.", argv[i]);
153 if (!reset_controller_set && reset_controllers) {
156 if (!(l = strv_new("cpu", NULL))) {
157 pam_syslog(handle, LOG_ERR, "Out of memory");
161 *reset_controllers = l;
165 strv_remove(*controllers, "name=systemd");
167 if (reset_controllers)
168 strv_remove(*reset_controllers, "name=systemd");
170 if (kill_session && *kill_session && kill_user)
173 if (!kill_exclude_users_set && kill_exclude_users) {
176 if (!(l = strv_new("root", NULL))) {
177 pam_syslog(handle, LOG_ERR, "Out of memory");
181 *kill_exclude_users = l;
187 static int open_file_and_lock(const char *fn) {
192 if ((fd = open(fn, O_RDWR|O_CLOEXEC|O_NOCTTY|O_NOFOLLOW|O_CREAT, 0600)) < 0)
195 /* The BSD socket semantics are a lot nicer than those of
196 * POSIX locks. Which is why we use flock() here. BSD locking
197 * does not work across NFS which however is not needed here
198 * as the filesystems in question should be local, and only
199 * locally accessible, and most likely even tmpfs. */
201 if (flock(fd, LOCK_EX) < 0)
208 SESSION_ID_AUDIT = 'a',
209 SESSION_ID_COUNTER = 'c',
210 SESSION_ID_RANDOM = 'r'
213 static uint64_t get_session_id(int *mode) {
219 /* First attempt: let's use the session ID of the audit
220 * system, if it is available. */
221 if (read_one_line_file("/proc/self/sessionid", &s) >= 0) {
225 r = safe_atou32(s, &u);
228 if (r >= 0 && u != (uint32_t) -1 && u > 0) {
229 *mode = SESSION_ID_AUDIT;
234 /* Second attempt, use our own counter. */
235 if ((fd = open_file_and_lock(RUNTIME_DIR "/user/.pam-systemd-session")) >= 0) {
239 /* We do a bit of endianess swapping here, just to be
240 * sure. /var should be machine specific anyway, and
241 * /var/run even mounted from tmpfs, so this
242 * byteswapping should really not be necessary. But
243 * then again, you never know, so let's avoid any
246 if (loop_read(fd, &counter, sizeof(counter), false) != sizeof(counter))
249 counter = le64toh(counter) + 1;
251 if (lseek(fd, 0, SEEK_SET) == 0) {
252 uint64_t swapped = htole64(counter);
254 r = loop_write(fd, &swapped, sizeof(swapped), false);
256 if (r != sizeof(swapped))
261 close_nointr_nofail(fd);
264 *mode = SESSION_ID_COUNTER;
269 *mode = SESSION_ID_RANDOM;
271 /* Last attempt, pick a random value */
272 return (uint64_t) random_ull();
274 static int get_user_data(
275 pam_handle_t *handle,
276 const char **ret_username,
277 struct passwd **ret_pw) {
279 const char *username = NULL;
280 struct passwd *pw = NULL;
282 bool have_loginuid = false;
286 assert(ret_username);
289 if (read_one_line_file("/proc/self/loginuid", &s) >= 0) {
292 r = safe_atou32(s, &u);
295 if (r >= 0 && u != (uint32_t) -1 && u > 0) {
296 have_loginuid = true;
297 pw = pam_modutil_getpwuid(handle, u);
301 if (!have_loginuid) {
302 if ((r = pam_get_user(handle, &username, NULL)) != PAM_SUCCESS) {
303 pam_syslog(handle, LOG_ERR, "Failed to get user name.");
307 if (!username || !*username) {
308 pam_syslog(handle, LOG_ERR, "User name not valid.");
312 pw = pam_modutil_getpwnam(handle, username);
316 pam_syslog(handle, LOG_ERR, "Failed to get user data.");
317 return PAM_USER_UNKNOWN;
321 *ret_username = username ? username : pw->pw_name;
326 static int create_user_group(
327 pam_handle_t *handle,
328 const char *controller,
340 r = cg_create_and_attach(controller, group, 0);
342 r = cg_create(controller, group);
345 pam_syslog(handle, LOG_ERR, "Failed to create cgroup: %s", strerror(-r));
346 return PAM_SESSION_ERR;
349 if (r > 0 && remember) {
350 /* Remember that it was us who created this group, and
351 * that hence we need to remove it too. This is a
352 * protection against removing the cgroup when run
354 if ((r = pam_set_data(handle, "systemd.created", INT_TO_PTR(1), NULL)) != PAM_SUCCESS) {
355 pam_syslog(handle, LOG_ERR, "Failed to install created variable.");
360 if ((r = cg_set_task_access(controller, group, 0644, pw->pw_uid, pw->pw_gid)) < 0 ||
361 (r = cg_set_group_access(controller, group, 0755, pw->pw_uid, pw->pw_gid)) < 0) {
362 pam_syslog(handle, LOG_ERR, "Failed to change access modes: %s", strerror(-r));
363 return PAM_SESSION_ERR;
369 static int reset_group(
370 pam_handle_t *handle,
371 const char *controller) {
377 if ((r = cg_attach(controller, "/", 0)) < 0) {
378 pam_syslog(handle, LOG_ERR, "Failed to reset cgroup for controller %s: %s", controller, strerror(-r));
379 return PAM_SESSION_ERR;
385 _public_ PAM_EXTERN int pam_sm_open_session(
386 pam_handle_t *handle,
388 int argc, const char **argv) {
390 const char *username = NULL;
395 bool create_session = true;
396 char **controllers = NULL, **reset_controllers = NULL, **c;
400 /* pam_syslog(handle, LOG_DEBUG, "pam-systemd initializing"); */
402 /* Make this a NOP on non-systemd systems */
403 if (sd_booted() <= 0)
406 if (parse_argv(handle,
408 &create_session, NULL, NULL,
409 &controllers, &reset_controllers,
411 return PAM_SESSION_ERR;
413 if ((r = get_user_data(handle, &username, &pw)) != PAM_SUCCESS)
416 if (safe_mkdir(RUNTIME_DIR "/user", 0755, 0, 0) < 0) {
417 pam_syslog(handle, LOG_ERR, "Failed to create runtime directory: %m");
422 if ((lock_fd = open_file_and_lock(RUNTIME_DIR "/user/.pam-systemd-lock")) < 0) {
423 pam_syslog(handle, LOG_ERR, "Failed to lock runtime directory: %m");
428 /* Create /var/run/$USER */
430 if (asprintf(&buf, RUNTIME_DIR "/user/%s", username) < 0) {
435 if (safe_mkdir(buf, 0700, pw->pw_uid, pw->pw_gid) < 0) {
436 pam_syslog(handle, LOG_WARNING, "Failed to create runtime directory: %m");
439 } else if ((r = pam_misc_setenv(handle, "XDG_RUNTIME_DIR", buf, 0)) != PAM_SUCCESS) {
440 pam_syslog(handle, LOG_ERR, "Failed to set runtime dir.");
447 if (create_session) {
450 /* Reuse or create XDG session ID */
451 if (!(id = pam_getenv(handle, "XDG_SESSION_ID"))) {
454 if (asprintf(&buf, "%llux", (unsigned long long) get_session_id(&mode)) < 0) {
459 /* To avoid id clashes we add the session id
460 * source to our session ids. Note that the
461 * session id source might change during
462 * runtime, because a filesystem became
463 * writable or the system reconfigured. */
465 mode != SESSION_ID_AUDIT ? (char) mode : 0;
467 if ((r = pam_misc_setenv(handle, "XDG_SESSION_ID", buf, 0)) != PAM_SUCCESS) {
468 pam_syslog(handle, LOG_ERR, "Failed to set session id.");
472 if (!(id = pam_getenv(handle, "XDG_SESSION_ID"))) {
473 pam_syslog(handle, LOG_ERR, "Failed to get session id.");
479 r = asprintf(&buf, "/user/%s/%s", username, id);
481 r = asprintf(&buf, "/user/%s/master", username);
488 pam_syslog(handle, LOG_INFO, "Moving new user session for %s into control group %s.", username, buf);
490 if ((r = create_user_group(handle, SYSTEMD_CGROUP_CONTROLLER, buf, pw, true, true)) != PAM_SUCCESS)
493 /* The additional controllers don't really matter, so we
494 * ignore the return value */
495 STRV_FOREACH(c, controllers)
496 create_user_group(handle, *c, buf, pw, true, false);
498 STRV_FOREACH(c, reset_controllers)
499 reset_group(handle, *c);
507 close_nointr_nofail(lock_fd);
509 strv_free(controllers);
510 strv_free(reset_controllers);
515 static int session_remains(pam_handle_t *handle, const char *user_path) {
517 bool remains = false;
521 if ((r = cg_enumerate_subgroups(SYSTEMD_CGROUP_CONTROLLER, user_path, &d)) < 0)
524 while ((r = cg_read_subgroup(d, &subgroup)) > 0) {
526 remains = !streq(subgroup, "master");
541 static bool check_user_lists(
542 pam_handle_t *handle,
544 char **kill_only_users,
545 char **kill_exclude_users) {
547 const char *name = NULL;
553 name = "root"; /* Avoid obvious NSS requests, to suppress network traffic */
557 if ((pw = pam_modutil_getpwuid(handle, uid)))
561 STRV_FOREACH(l, kill_exclude_users) {
564 if (safe_atou32(*l, &id) >= 0)
565 if ((uid_t) id == uid)
568 if (name && streq(name, *l))
572 if (strv_isempty(kill_only_users))
575 STRV_FOREACH(l, kill_only_users) {
578 if (safe_atou32(*l, &id) >= 0)
579 if ((uid_t) id == uid)
582 if (name && streq(name, *l))
589 _public_ PAM_EXTERN int pam_sm_close_session(
590 pam_handle_t *handle,
592 int argc, const char **argv) {
594 const char *username = NULL;
595 bool kill_session = false;
596 bool kill_user = false;
598 char *session_path = NULL, *nosession_path = NULL, *user_path = NULL;
601 const void *created = NULL;
602 char **controllers = NULL, **c, **kill_only_users = NULL, **kill_exclude_users = NULL;
606 /* Make this a NOP on non-systemd systems */
607 if (sd_booted() <= 0)
610 if (parse_argv(handle,
612 NULL, &kill_session, &kill_user,
614 &kill_only_users, &kill_exclude_users) < 0)
615 return PAM_SESSION_ERR;
617 if ((r = get_user_data(handle, &username, &pw)) != PAM_SUCCESS)
620 if ((lock_fd = open_file_and_lock(RUNTIME_DIR "/user/.pam-systemd-lock")) < 0) {
621 pam_syslog(handle, LOG_ERR, "Failed to lock runtime directory: %m");
626 /* We are probably still in some session/user dir. Move ourselves out of the way as first step */
627 if ((r = cg_attach(SYSTEMD_CGROUP_CONTROLLER, "/user", 0)) < 0)
628 pam_syslog(handle, LOG_ERR, "Failed to move us away: %s", strerror(-r));
630 STRV_FOREACH(c, controllers)
631 if ((r = cg_attach(*c, "/user", 0)) < 0)
632 pam_syslog(handle, LOG_ERR, "Failed to move us away in %s hierarchy: %s", *c, strerror(-r));
634 if (asprintf(&user_path, "/user/%s", username) < 0) {
639 pam_get_data(handle, "systemd.created", &created);
641 if ((id = pam_getenv(handle, "XDG_SESSION_ID")) && created) {
643 if (asprintf(&session_path, "/user/%s/%s", username, id) < 0 ||
644 asprintf(&nosession_path, "/user/%s/master", username) < 0) {
649 if (kill_session && check_user_lists(handle, pw->pw_uid, kill_only_users, kill_exclude_users)) {
650 pam_syslog(handle, LOG_INFO, "Killing remaining processes of user session %s of %s.", id, username);
652 /* Kill processes in session cgroup, and delete it */
653 if ((r = cg_kill_recursive_and_wait(SYSTEMD_CGROUP_CONTROLLER, session_path, true)) < 0)
654 pam_syslog(handle, LOG_ERR, "Failed to kill session cgroup: %s", strerror(-r));
656 pam_syslog(handle, LOG_INFO, "Moving remaining processes of user session %s of %s into control group %s.", id, username, nosession_path);
658 /* Migrate processes from session to user
659 * cgroup. First, try to create the user group
660 * in case it doesn't exist yet. Also, delete
661 * the session group. */
662 create_user_group(handle, SYSTEMD_CGROUP_CONTROLLER, nosession_path, pw, false, false);
664 if ((r = cg_migrate_recursive(SYSTEMD_CGROUP_CONTROLLER, session_path, nosession_path, false, true)) < 0)
665 pam_syslog(handle, LOG_ERR, "Failed to migrate session cgroup: %s", strerror(-r));
668 STRV_FOREACH(c, controllers) {
669 create_user_group(handle, *c, nosession_path, pw, false, false);
671 if ((r = cg_migrate_recursive(*c, session_path, nosession_path, false, true)) < 0)
672 pam_syslog(handle, LOG_ERR, "Failed to migrate session cgroup in hierarchy %s: %s", *c, strerror(-r));
677 cg_trim(SYSTEMD_CGROUP_CONTROLLER, user_path, false);
679 if ((r = session_remains(handle, user_path)) < 0)
680 pam_syslog(handle, LOG_ERR, "Failed to determine whether a session remains: %s", strerror(-r));
682 /* Kill user processes not attached to any session */
683 if (kill_user && r == 0 && check_user_lists(handle, pw->pw_uid, kill_only_users, kill_exclude_users)) {
685 /* Kill user cgroup */
686 if ((r = cg_kill_recursive_and_wait(SYSTEMD_CGROUP_CONTROLLER, user_path, true)) < 0)
687 pam_syslog(handle, LOG_ERR, "Failed to kill user cgroup: %s", strerror(-r));
690 if ((r = cg_is_empty_recursive(SYSTEMD_CGROUP_CONTROLLER, user_path, true)) < 0)
691 pam_syslog(handle, LOG_ERR, "Failed to check user cgroup: %s", strerror(-r));
693 /* Remove user cgroup */
695 if ((r = cg_delete(SYSTEMD_CGROUP_CONTROLLER, user_path)) < 0)
696 pam_syslog(handle, LOG_ERR, "Failed to delete user cgroup: %s", strerror(-r));
698 /* If we managed to find somebody, don't cleanup the cgroup. */
703 STRV_FOREACH(c, controllers)
704 cg_trim(*c, user_path, true);
707 const char *runtime_dir;
709 if ((runtime_dir = pam_getenv(handle, "XDG_RUNTIME_DIR")))
710 if ((r = rm_rf(runtime_dir, false, true)) < 0)
711 pam_syslog(handle, LOG_ERR, "Failed to remove runtime directory: %s", strerror(-r));
714 /* pam_syslog(handle, LOG_DEBUG, "pam-systemd done"); */
720 close_nointr_nofail(lock_fd);
723 free(nosession_path);
726 strv_free(controllers);
727 strv_free(kill_exclude_users);
728 strv_free(kill_only_users);