1 /* SPDX-License-Identifier: LGPL-2.1+ */
7 #include <security/_pam_macros.h>
8 #include <security/pam_ext.h>
9 #include <security/pam_misc.h>
10 #include <security/pam_modules.h>
11 #include <security/pam_modutil.h>
14 #include "alloc-util.h"
15 #include "audit-util.h"
16 #include "bus-common-errors.h"
17 #include "bus-error.h"
22 #include "format-util.h"
23 #include "hostname-util.h"
24 #include "login-util.h"
26 #include "parse-util.h"
27 #include "process-util.h"
28 #include "socket-util.h"
30 #include "terminal-util.h"
32 #include "path-util.h"
33 #include "cgroup-util.h"
35 static int parse_argv(
37 int argc, const char **argv,
45 assert(argc == 0 || argv);
47 for (i = 0; i < (unsigned) argc; i++) {
48 if (startswith(argv[i], "class=")) {
52 } else if (startswith(argv[i], "type=")) {
56 } else if (streq(argv[i], "debug")) {
60 } else if (startswith(argv[i], "debug=")) {
63 k = parse_boolean(argv[i] + 6);
65 pam_syslog(handle, LOG_WARNING, "Failed to parse debug= argument, ignoring.");
70 pam_syslog(handle, LOG_WARNING, "Unknown parameter '%s', ignoring", argv[i]);
76 static int get_user_data(
78 const char **ret_username,
79 struct passwd **ret_pw) {
81 const char *username = NULL;
82 struct passwd *pw = NULL;
89 r = pam_get_user(handle, &username, NULL);
90 if (r != PAM_SUCCESS) {
91 pam_syslog(handle, LOG_ERR, "Failed to get user name.");
95 if (isempty(username)) {
96 pam_syslog(handle, LOG_ERR, "User name not valid.");
100 pw = pam_modutil_getpwnam(handle, username);
102 pam_syslog(handle, LOG_ERR, "Failed to get user data.");
103 return PAM_USER_UNKNOWN;
107 *ret_username = username;
112 static int get_seat_from_display(const char *display, const char **seat, uint32_t *vtnr) {
113 union sockaddr_union sa = {
114 .un.sun_family = AF_UNIX,
116 _cleanup_free_ char *p = NULL, *tty = NULL;
117 _cleanup_close_ int fd = -1;
124 /* We deduce the X11 socket from the display name, then use
125 * SO_PEERCRED to determine the X11 server process, ask for
126 * the controlling tty of that and if it's a VC then we know
127 * the seat and the virtual terminal. Sounds ugly, is only
130 r = socket_from_display(display, &p);
133 strncpy(sa.un.sun_path, p, sizeof(sa.un.sun_path)-1);
135 fd = socket(AF_UNIX, SOCK_STREAM|SOCK_CLOEXEC, 0);
139 if (connect(fd, &sa.sa, SOCKADDR_UN_LEN(sa.un)) < 0)
142 r = getpeercred(fd, &ucred);
146 r = get_ctty(ucred.pid, NULL, &tty);
150 v = vtnr_from_tty(tty);
158 *vtnr = (uint32_t) v;
163 static int export_legacy_dbus_address(
164 pam_handle_t *handle,
166 const char *runtime) {
168 _cleanup_free_ char *s = NULL;
171 /* FIXME: We *really* should move the access() check into the
172 * daemons that spawn dbus-daemon, instead of forcing
173 * DBUS_SESSION_BUS_ADDRESS= here. */
175 s = strjoin(runtime, "/bus");
179 if (access(s, F_OK) < 0)
183 if (asprintf(&s, DEFAULT_USER_BUS_ADDRESS_FMT, runtime) < 0)
186 r = pam_misc_setenv(handle, "DBUS_SESSION_BUS_ADDRESS", s, 0);
187 if (r != PAM_SUCCESS)
193 pam_syslog(handle, LOG_ERR, "Failed to set bus variable.");
197 static int append_session_memory_max(pam_handle_t *handle, sd_bus_message *m, const char *limit) {
204 if (streq(limit, "infinity")) {
205 r = sd_bus_message_append(m, "(sv)", "MemoryMax", "t", (uint64_t)-1);
207 pam_syslog(handle, LOG_ERR, "Failed to append to bus message: %s", strerror(-r));
211 r = parse_percent(limit);
213 r = sd_bus_message_append(m, "(sv)", "MemoryMaxScale", "u", (uint32_t) (((uint64_t) UINT32_MAX * r) / 100U));
215 pam_syslog(handle, LOG_ERR, "Failed to append to bus message: %s", strerror(-r));
219 r = parse_size(limit, 1024, &val);
221 r = sd_bus_message_append(m, "(sv)", "MemoryMax", "t", val);
223 pam_syslog(handle, LOG_ERR, "Failed to append to bus message: %s", strerror(-r));
227 pam_syslog(handle, LOG_WARNING, "Failed to parse elogind.limit: %s, ignoring.", limit);
234 static int append_session_tasks_max(pam_handle_t *handle, sd_bus_message *m, const char *limit)
239 /* No need to parse "infinity" here, it will be set unconditionally later in manager_start_scope() */
240 if (isempty(limit) || streq(limit, "infinity"))
243 r = safe_atou64(limit, &val);
245 r = sd_bus_message_append(m, "(sv)", "TasksMax", "t", val);
247 pam_syslog(handle, LOG_ERR, "Failed to append to bus message: %s", strerror(-r));
251 pam_syslog(handle, LOG_WARNING, "Failed to parse elogind.limit: %s, ignoring.", limit);
256 static int append_session_cg_weight(pam_handle_t *handle, sd_bus_message *m, const char *limit, const char *field) {
260 if (!isempty(limit)) {
261 r = cg_weight_parse(limit, &val);
263 r = sd_bus_message_append(m, "(sv)", field, "t", val);
265 pam_syslog(handle, LOG_ERR, "Failed to append to bus message: %s", strerror(-r));
268 } else if (streq(field, "CPUWeight"))
269 pam_syslog(handle, LOG_WARNING, "Failed to parse elogind.cpu_weight: %s, ignoring.", limit);
271 pam_syslog(handle, LOG_WARNING, "Failed to parse elogind.io_weight: %s, ignoring.", limit);
277 _public_ PAM_EXTERN int pam_sm_open_session(
278 pam_handle_t *handle,
280 int argc, const char **argv) {
282 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
283 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL, *reply = NULL;
285 *username, *id, *object_path, *runtime_path,
287 *tty = NULL, *display = NULL,
288 *remote_user = NULL, *remote_host = NULL,
290 *type = NULL, *class = NULL,
291 *class_pam = NULL, *type_pam = NULL, *cvtnr = NULL, *desktop = NULL,
292 *memory_max = NULL, *tasks_max = NULL, *cpu_weight = NULL, *io_weight = NULL;
293 _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
294 int session_fd = -1, existing, r;
295 bool debug = false, remote;
302 #if 0 /// with elogind, it is always a "logind system".
303 /* Make this a NOP on non-logind systems */
304 if (!logind_running())
308 if (parse_argv(handle,
313 return PAM_SESSION_ERR;
316 pam_syslog(handle, LOG_DEBUG, "pam-elogind initializing");
318 r = get_user_data(handle, &username, &pw);
319 if (r != PAM_SUCCESS) {
320 pam_syslog(handle, LOG_ERR, "Failed to get user data.");
324 /* Make sure we don't enter a loop by talking to
325 * elogind when it is actually waiting for the
326 * background to finish start-up. If the service is
327 * "elogind-user" we simply set XDG_RUNTIME_DIR and
330 pam_get_item(handle, PAM_SERVICE, (const void**) &service);
331 if (streq_ptr(service, "elogind-user")) {
332 _cleanup_free_ char *rt = NULL;
334 if (asprintf(&rt, "/run/user/"UID_FMT, pw->pw_uid) < 0)
337 r = pam_misc_setenv(handle, "XDG_RUNTIME_DIR", rt, 0);
338 if (r != PAM_SUCCESS) {
339 pam_syslog(handle, LOG_ERR, "Failed to set runtime dir.");
343 r = export_legacy_dbus_address(handle, pw->pw_uid, rt);
344 if (r != PAM_SUCCESS)
350 /* Otherwise, we ask logind to create a session for us */
352 pam_get_item(handle, PAM_XDISPLAY, (const void**) &display);
353 pam_get_item(handle, PAM_TTY, (const void**) &tty);
354 pam_get_item(handle, PAM_RUSER, (const void**) &remote_user);
355 pam_get_item(handle, PAM_RHOST, (const void**) &remote_host);
357 seat = pam_getenv(handle, "XDG_SEAT");
359 seat = getenv("XDG_SEAT");
361 cvtnr = pam_getenv(handle, "XDG_VTNR");
363 cvtnr = getenv("XDG_VTNR");
365 type = pam_getenv(handle, "XDG_SESSION_TYPE");
367 type = getenv("XDG_SESSION_TYPE");
371 class = pam_getenv(handle, "XDG_SESSION_CLASS");
373 class = getenv("XDG_SESSION_CLASS");
377 desktop = pam_getenv(handle, "XDG_SESSION_DESKTOP");
378 if (isempty(desktop))
379 desktop = getenv("XDG_SESSION_DESKTOP");
383 if (strchr(tty, ':')) {
384 /* A tty with a colon is usually an X11 display,
385 * placed there to show up in utmp. We rearrange
386 * things and don't pretend that an X display was a
389 if (isempty(display))
392 } else if (streq(tty, "cron")) {
393 /* cron has been setting PAM_TTY to "cron" for a very
394 * long time and it probably shouldn't stop doing that
395 * for compatibility reasons. */
396 type = "unspecified";
397 class = "background";
399 } else if (streq(tty, "ssh")) {
400 /* ssh has been setting PAM_TTY to "ssh" for a very
401 * long time and probably shouldn't stop doing that
402 * for compatibility reasons. */
407 /* Chop off leading /dev prefix that some clients specify, but others do not. */
408 tty = skip_dev_prefix(tty);
410 /* If this fails vtnr will be 0, that's intended */
412 (void) safe_atou32(cvtnr, &vtnr);
414 if (!isempty(display) && !vtnr) {
416 get_seat_from_display(display, &seat, &vtnr);
417 else if (streq(seat, "seat0"))
418 get_seat_from_display(display, NULL, &vtnr);
421 if (seat && !streq(seat, "seat0") && vtnr != 0) {
422 pam_syslog(handle, LOG_DEBUG, "Ignoring vtnr %"PRIu32" for %s which is not seat0", vtnr, seat);
427 type = !isempty(display) ? "x11" :
428 !isempty(tty) ? "tty" : "unspecified";
431 class = streq(type, "unspecified") ? "background" : "user";
433 remote = !isempty(remote_host) && !is_localhost(remote_host);
435 (void) pam_get_data(handle, "elogind.memory_max", (const void **)&memory_max);
436 (void) pam_get_data(handle, "elogind.tasks_max", (const void **)&tasks_max);
437 (void) pam_get_data(handle, "elogind.cpu_weight", (const void **)&cpu_weight);
438 (void) pam_get_data(handle, "elogind.io_weight", (const void **)&io_weight);
440 /* Talk to logind over the message bus */
442 r = sd_bus_open_system(&bus);
444 pam_syslog(handle, LOG_ERR, "Failed to connect to system bus: %s", strerror(-r));
445 return PAM_SESSION_ERR;
449 pam_syslog(handle, LOG_DEBUG, "Asking logind to create session: "
450 "uid="UID_FMT" pid="PID_FMT" service=%s type=%s class=%s desktop=%s seat=%s vtnr=%"PRIu32" tty=%s display=%s remote=%s remote_user=%s remote_host=%s",
451 pw->pw_uid, getpid_cached(),
453 type, class, strempty(desktop),
454 strempty(seat), vtnr, strempty(tty), strempty(display),
455 yes_no(remote), strempty(remote_user), strempty(remote_host));
456 pam_syslog(handle, LOG_DEBUG, "Session limits: "
457 "memory_max=%s tasks_max=%s cpu_weight=%s io_weight=%s",
458 strna(memory_max), strna(tasks_max), strna(cpu_weight), strna(io_weight));
461 r = sd_bus_message_new_method_call(
464 "org.freedesktop.login1",
465 "/org/freedesktop/login1",
466 "org.freedesktop.login1.Manager",
469 pam_syslog(handle, LOG_ERR, "Failed to create CreateSession method call: %s", strerror(-r));
470 return PAM_SESSION_ERR;
473 r = sd_bus_message_append(m, "uusssssussbss",
474 (uint32_t) pw->pw_uid,
475 (uint32_t) getpid_cached(),
488 pam_syslog(handle, LOG_ERR, "Failed to append to bus message: %s", strerror(-r));
489 return PAM_SESSION_ERR;
492 r = sd_bus_message_open_container(m, 'a', "(sv)");
494 pam_syslog(handle, LOG_ERR, "Failed to open message container: %s", strerror(-r));
495 return PAM_SYSTEM_ERR;
498 r = append_session_memory_max(handle, m, memory_max);
500 return PAM_SESSION_ERR;
502 r = append_session_tasks_max(handle, m, tasks_max);
504 return PAM_SESSION_ERR;
506 r = append_session_cg_weight(handle, m, cpu_weight, "CPUWeight");
508 return PAM_SESSION_ERR;
510 r = append_session_cg_weight(handle, m, io_weight, "IOWeight");
512 return PAM_SESSION_ERR;
514 r = sd_bus_message_close_container(m);
516 pam_syslog(handle, LOG_ERR, "Failed to close message container: %s", strerror(-r));
517 return PAM_SYSTEM_ERR;
520 r = sd_bus_call(bus, m, 0, &error, &reply);
522 if (sd_bus_error_has_name(&error, BUS_ERROR_SESSION_BUSY)) {
523 pam_syslog(handle, LOG_DEBUG, "Cannot create session: %s", bus_error_message(&error, r));
526 pam_syslog(handle, LOG_ERR, "Failed to create session: %s", bus_error_message(&error, r));
527 return PAM_SYSTEM_ERR;
531 r = sd_bus_message_read(reply,
542 pam_syslog(handle, LOG_ERR, "Failed to parse message: %s", strerror(-r));
543 return PAM_SESSION_ERR;
547 pam_syslog(handle, LOG_DEBUG, "Reply from logind: "
548 "id=%s object_path=%s runtime_path=%s session_fd=%d seat=%s vtnr=%u original_uid=%u",
549 id, object_path, runtime_path, session_fd, seat, vtnr, original_uid);
551 r = pam_misc_setenv(handle, "XDG_SESSION_ID", id, 0);
552 if (r != PAM_SUCCESS) {
553 pam_syslog(handle, LOG_ERR, "Failed to set session id.");
557 if (original_uid == pw->pw_uid) {
558 /* Don't set $XDG_RUNTIME_DIR if the user we now
559 * authenticated for does not match the original user
560 * of the session. We do this in order not to result
561 * in privileged apps clobbering the runtime directory
564 r = pam_misc_setenv(handle, "XDG_RUNTIME_DIR", runtime_path, 0);
565 if (r != PAM_SUCCESS) {
566 pam_syslog(handle, LOG_ERR, "Failed to set runtime dir.");
570 r = export_legacy_dbus_address(handle, pw->pw_uid, runtime_path);
571 if (r != PAM_SUCCESS)
575 if (!isempty(seat)) {
576 r = pam_misc_setenv(handle, "XDG_SEAT", seat, 0);
577 if (r != PAM_SUCCESS) {
578 pam_syslog(handle, LOG_ERR, "Failed to set seat.");
584 char buf[DECIMAL_STR_MAX(vtnr)];
585 sprintf(buf, "%u", vtnr);
587 r = pam_misc_setenv(handle, "XDG_VTNR", buf, 0);
588 if (r != PAM_SUCCESS) {
589 pam_syslog(handle, LOG_ERR, "Failed to set virtual terminal number.");
594 r = pam_set_data(handle, "systemd.existing", INT_TO_PTR(!!existing), NULL);
595 if (r != PAM_SUCCESS) {
596 pam_syslog(handle, LOG_ERR, "Failed to install existing flag.");
600 if (session_fd >= 0) {
601 session_fd = fcntl(session_fd, F_DUPFD_CLOEXEC, 3);
602 if (session_fd < 0) {
603 pam_syslog(handle, LOG_ERR, "Failed to dup session fd: %m");
604 return PAM_SESSION_ERR;
607 r = pam_set_data(handle, "systemd.session-fd", FD_TO_PTR(session_fd), NULL);
608 if (r != PAM_SUCCESS) {
609 pam_syslog(handle, LOG_ERR, "Failed to install session fd.");
610 safe_close(session_fd);
618 _public_ PAM_EXTERN int pam_sm_close_session(
619 pam_handle_t *handle,
621 int argc, const char **argv) {
623 _cleanup_(sd_bus_error_free) sd_bus_error error = SD_BUS_ERROR_NULL;
624 _cleanup_(sd_bus_flush_close_unrefp) sd_bus *bus = NULL;
625 const void *existing = NULL;
631 /* Only release session if it wasn't pre-existing when we
632 * tried to create it */
633 pam_get_data(handle, "systemd.existing", &existing);
635 id = pam_getenv(handle, "XDG_SESSION_ID");
636 if (id && !existing) {
638 /* Before we go and close the FIFO we need to tell
639 * logind that this is a clean session shutdown, so
640 * that it doesn't just go and slaughter us
641 * immediately after closing the fd */
643 r = sd_bus_open_system(&bus);
645 pam_syslog(handle, LOG_ERR, "Failed to connect to system bus: %s", strerror(-r));
646 return PAM_SESSION_ERR;
649 r = sd_bus_call_method(bus,
650 "org.freedesktop.login1",
651 "/org/freedesktop/login1",
652 "org.freedesktop.login1.Manager",
659 pam_syslog(handle, LOG_ERR, "Failed to release session: %s", bus_error_message(&error, r));
660 return PAM_SESSION_ERR;
664 /* Note that we are knowingly leaking the FIFO fd here. This
665 * way, logind can watch us die. If we closed it here it would
666 * not have any clue when that is completed. Given that one
667 * cannot really have multiple PAM sessions open from the same
668 * process this means we will leak one FD at max. */