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"
19 #include "cgroup-util.h"
23 #include "format-util.h"
24 #include "hostname-util.h"
25 #include "login-util.h"
27 #include "parse-util.h"
28 #include "path-util.h"
29 #include "process-util.h"
30 #include "socket-util.h"
32 #include "terminal-util.h"
35 static int parse_argv(
37 int argc
, const char **argv
,
46 assert(argc
== 0 || argv
);
48 for (i
= 0; i
< (unsigned) argc
; i
++) {
49 if (startswith(argv
[i
], "class=")) {
53 } else if (startswith(argv
[i
], "type=")) {
57 } else if (startswith(argv
[i
], "desktop=")) {
59 *desktop
= argv
[i
] + 8;
61 } else if (streq(argv
[i
], "debug")) {
65 } else if (startswith(argv
[i
], "debug=")) {
68 k
= parse_boolean(argv
[i
] + 6);
70 pam_syslog(handle
, LOG_WARNING
, "Failed to parse debug= argument, ignoring.");
75 pam_syslog(handle
, LOG_WARNING
, "Unknown parameter '%s', ignoring", argv
[i
]);
81 static int get_user_data(
83 const char **ret_username
,
84 struct passwd
**ret_pw
) {
86 const char *username
= NULL
;
87 struct passwd
*pw
= NULL
;
94 r
= pam_get_user(handle
, &username
, NULL
);
95 if (r
!= PAM_SUCCESS
) {
96 pam_syslog(handle
, LOG_ERR
, "Failed to get user name.");
100 if (isempty(username
)) {
101 pam_syslog(handle
, LOG_ERR
, "User name not valid.");
105 pw
= pam_modutil_getpwnam(handle
, username
);
107 pam_syslog(handle
, LOG_ERR
, "Failed to get user data.");
108 return PAM_USER_UNKNOWN
;
112 *ret_username
= username
;
117 static int socket_from_display(const char *display
, char **path
) {
124 if (!display_is_local(display
))
127 k
= strspn(display
+1, "0123456789");
129 f
= new(char, STRLEN("/tmp/.X11-unix/X") + k
+ 1);
133 c
= stpcpy(f
, "/tmp/.X11-unix/X");
134 memcpy(c
, display
+1, k
);
142 static int get_seat_from_display(const char *display
, const char **seat
, uint32_t *vtnr
) {
143 union sockaddr_union sa
= {};
144 _cleanup_free_
char *p
= NULL
, *tty
= NULL
;
145 _cleanup_close_
int fd
= -1;
152 /* We deduce the X11 socket from the display name, then use
153 * SO_PEERCRED to determine the X11 server process, ask for
154 * the controlling tty of that and if it's a VC then we know
155 * the seat and the virtual terminal. Sounds ugly, is only
158 r
= socket_from_display(display
, &p
);
161 salen
= sockaddr_un_set_path(&sa
.un
, p
);
165 fd
= socket(AF_UNIX
, SOCK_STREAM
|SOCK_CLOEXEC
, 0);
169 if (connect(fd
, &sa
.sa
, salen
) < 0)
172 r
= getpeercred(fd
, &ucred
);
176 r
= get_ctty(ucred
.pid
, NULL
, &tty
);
180 v
= vtnr_from_tty(tty
);
188 *vtnr
= (uint32_t) v
;
193 static int export_legacy_dbus_address(
194 pam_handle_t
*handle
,
196 const char *runtime
) {
198 _cleanup_free_
char *s
= NULL
;
201 if (asprintf(&s
, DEFAULT_USER_BUS_ADDRESS_FMT
, runtime
) < 0)
204 r
= pam_misc_setenv(handle
, "DBUS_SESSION_BUS_ADDRESS", s
, 0);
205 if (r
!= PAM_SUCCESS
)
211 pam_syslog(handle
, LOG_ERR
, "Failed to set bus variable.");
215 static int append_session_memory_max(pam_handle_t
*handle
, sd_bus_message
*m
, const char *limit
) {
222 if (streq(limit
, "infinity")) {
223 r
= sd_bus_message_append(m
, "(sv)", "MemoryMax", "t", (uint64_t)-1);
225 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
229 r
= parse_permille(limit
);
231 r
= sd_bus_message_append(m
, "(sv)", "MemoryMaxScale", "u", (uint32_t) (((uint64_t) r
* UINT32_MAX
) / 1000U));
233 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
237 r
= parse_size(limit
, 1024, &val
);
239 r
= sd_bus_message_append(m
, "(sv)", "MemoryMax", "t", val
);
241 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
245 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.limit: %s, ignoring.", limit
);
252 static int append_session_tasks_max(pam_handle_t
*handle
, sd_bus_message
*m
, const char *limit
) {
256 /* No need to parse "infinity" here, it will be set unconditionally later in manager_start_scope() */
257 if (isempty(limit
) || streq(limit
, "infinity"))
260 r
= safe_atou64(limit
, &val
);
262 r
= sd_bus_message_append(m
, "(sv)", "TasksMax", "t", val
);
264 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
268 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.limit: %s, ignoring.", limit
);
273 static int append_session_cg_weight(pam_handle_t
*handle
, sd_bus_message
*m
, const char *limit
, const char *field
) {
280 r
= cg_weight_parse(limit
, &val
);
282 r
= sd_bus_message_append(m
, "(sv)", field
, "t", val
);
284 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
287 } else if (streq(field
, "CPUWeight"))
288 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.cpu_weight: %s, ignoring.", limit
);
290 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.io_weight: %s, ignoring.", limit
);
295 static const char* getenv_harder(pam_handle_t
*handle
, const char *key
, const char *fallback
) {
301 /* Looks for an environment variable, preferrably in the environment block associated with the specified PAM
302 * handle, falling back to the process' block instead. */
304 v
= pam_getenv(handle
, key
);
315 static int update_environment(pam_handle_t
*handle
, const char *key
, const char *value
) {
321 /* Updates the environment, but only if there's actually a value set. Also, log about errors */
326 r
= pam_misc_setenv(handle
, key
, value
, 0);
327 if (r
!= PAM_SUCCESS
)
328 pam_syslog(handle
, LOG_ERR
, "Failed to set environment variable %s.", key
);
333 static bool validate_runtime_directory(pam_handle_t
*handle
, const char *path
, uid_t uid
) {
338 /* Just some extra paranoia: let's not set $XDG_RUNTIME_DIR if the directory we'd set it to isn't actually set
339 * up properly for us. */
341 if (lstat(path
, &st
) < 0) {
342 pam_syslog(handle
, LOG_ERR
, "Failed to stat() runtime directory '%s': %s", path
, strerror(errno
));
346 if (!S_ISDIR(st
.st_mode
)) {
347 pam_syslog(handle
, LOG_ERR
, "Runtime directory '%s' is not actually a directory.", path
);
351 if (st
.st_uid
!= uid
) {
352 pam_syslog(handle
, LOG_ERR
, "Runtime directory '%s' is not owned by UID " UID_FMT
", as it should.", path
, uid
);
359 pam_syslog(handle
, LOG_WARNING
, "Not setting $XDG_RUNTIME_DIR, as the directory is not in order.");
363 _public_ PAM_EXTERN
int pam_sm_open_session(
364 pam_handle_t
*handle
,
366 int argc
, const char **argv
) {
368 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
369 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
371 *username
, *id
, *object_path
, *runtime_path
,
373 *tty
= NULL
, *display
= NULL
,
374 *remote_user
= NULL
, *remote_host
= NULL
,
376 *type
= NULL
, *class = NULL
,
377 *class_pam
= NULL
, *type_pam
= NULL
, *cvtnr
= NULL
, *desktop
= NULL
, *desktop_pam
= NULL
,
378 *memory_max
= NULL
, *tasks_max
= NULL
, *cpu_weight
= NULL
, *io_weight
= NULL
;
379 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
380 int session_fd
= -1, existing
, r
;
381 bool debug
= false, remote
;
388 /* Make this a NOP on non-logind systems */
389 if (!logind_running())
392 if (parse_argv(handle
,
398 return PAM_SESSION_ERR
;
401 pam_syslog(handle
, LOG_DEBUG
, "pam-systemd initializing");
403 r
= get_user_data(handle
, &username
, &pw
);
404 if (r
!= PAM_SUCCESS
) {
405 pam_syslog(handle
, LOG_ERR
, "Failed to get user data.");
409 /* Make sure we don't enter a loop by talking to
410 * systemd-logind when it is actually waiting for the
411 * background to finish start-up. If the service is
412 * "systemd-user" we simply set XDG_RUNTIME_DIR and
415 pam_get_item(handle
, PAM_SERVICE
, (const void**) &service
);
416 if (streq_ptr(service
, "systemd-user")) {
417 _cleanup_free_
char *rt
= NULL
;
419 if (asprintf(&rt
, "/run/user/"UID_FMT
, pw
->pw_uid
) < 0)
422 if (validate_runtime_directory(handle
, rt
, pw
->pw_uid
)) {
423 r
= pam_misc_setenv(handle
, "XDG_RUNTIME_DIR", rt
, 0);
424 if (r
!= PAM_SUCCESS
) {
425 pam_syslog(handle
, LOG_ERR
, "Failed to set runtime dir.");
430 r
= export_legacy_dbus_address(handle
, pw
->pw_uid
, rt
);
431 if (r
!= PAM_SUCCESS
)
437 /* Otherwise, we ask logind to create a session for us */
439 pam_get_item(handle
, PAM_XDISPLAY
, (const void**) &display
);
440 pam_get_item(handle
, PAM_TTY
, (const void**) &tty
);
441 pam_get_item(handle
, PAM_RUSER
, (const void**) &remote_user
);
442 pam_get_item(handle
, PAM_RHOST
, (const void**) &remote_host
);
444 seat
= getenv_harder(handle
, "XDG_SEAT", NULL
);
445 cvtnr
= getenv_harder(handle
, "XDG_VTNR", NULL
);
446 type
= getenv_harder(handle
, "XDG_SESSION_TYPE", type_pam
);
447 class = getenv_harder(handle
, "XDG_SESSION_CLASS", class_pam
);
448 desktop
= getenv_harder(handle
, "XDG_SESSION_DESKTOP", desktop_pam
);
452 if (strchr(tty
, ':')) {
453 /* A tty with a colon is usually an X11 display, placed there to show up in utmp. We rearrange things
454 * and don't pretend that an X display was a tty. */
455 if (isempty(display
))
459 } else if (streq(tty
, "cron")) {
460 /* cron is setting PAM_TTY to "cron" for some reason (the commit carries no information why, but
461 * probably because it wants to set it to something as pam_time/pam_access/… require PAM_TTY to be set
462 * (as they otherwise even try to update it!) — but cron doesn't actually allocate a TTY for its forked
464 type
= "unspecified";
465 class = "background";
468 } else if (streq(tty
, "ssh")) {
469 /* ssh has been setting PAM_TTY to "ssh" (for the same reason as cron does this, see above. For further
470 * details look for "PAM_TTY_KLUDGE" in the openssh sources). */
473 tty
= NULL
; /* This one is particularly sad, as this means that ssh sessions — even though usually
474 * associated with a pty — won't be tracked by their tty in logind. This is because ssh
475 * does the PAM session registration early for new connections, and registers a pty only
476 * much later (this is because it doesn't know yet if it needs one at all, as whether to
477 * register a pty or not is negotiated much later in the protocol). */
480 /* Chop off leading /dev prefix that some clients specify, but others do not. */
481 tty
= skip_dev_prefix(tty
);
483 /* If this fails vtnr will be 0, that's intended */
485 (void) safe_atou32(cvtnr
, &vtnr
);
487 if (!isempty(display
) && !vtnr
) {
489 (void) get_seat_from_display(display
, &seat
, &vtnr
);
490 else if (streq(seat
, "seat0"))
491 (void) get_seat_from_display(display
, NULL
, &vtnr
);
494 if (seat
&& !streq(seat
, "seat0") && vtnr
!= 0) {
496 pam_syslog(handle
, LOG_DEBUG
, "Ignoring vtnr %"PRIu32
" for %s which is not seat0", vtnr
, seat
);
501 type
= !isempty(display
) ? "x11" :
502 !isempty(tty
) ? "tty" : "unspecified";
505 class = streq(type
, "unspecified") ? "background" : "user";
507 remote
= !isempty(remote_host
) && !is_localhost(remote_host
);
509 (void) pam_get_data(handle
, "systemd.memory_max", (const void **)&memory_max
);
510 (void) pam_get_data(handle
, "systemd.tasks_max", (const void **)&tasks_max
);
511 (void) pam_get_data(handle
, "systemd.cpu_weight", (const void **)&cpu_weight
);
512 (void) pam_get_data(handle
, "systemd.io_weight", (const void **)&io_weight
);
514 /* Talk to logind over the message bus */
516 r
= sd_bus_open_system(&bus
);
518 pam_syslog(handle
, LOG_ERR
, "Failed to connect to system bus: %s", strerror(-r
));
519 return PAM_SESSION_ERR
;
523 pam_syslog(handle
, LOG_DEBUG
, "Asking logind to create session: "
524 "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",
525 pw
->pw_uid
, getpid_cached(),
527 type
, class, strempty(desktop
),
528 strempty(seat
), vtnr
, strempty(tty
), strempty(display
),
529 yes_no(remote
), strempty(remote_user
), strempty(remote_host
));
530 pam_syslog(handle
, LOG_DEBUG
, "Session limits: "
531 "memory_max=%s tasks_max=%s cpu_weight=%s io_weight=%s",
532 strna(memory_max
), strna(tasks_max
), strna(cpu_weight
), strna(io_weight
));
535 r
= sd_bus_message_new_method_call(
538 "org.freedesktop.login1",
539 "/org/freedesktop/login1",
540 "org.freedesktop.login1.Manager",
543 pam_syslog(handle
, LOG_ERR
, "Failed to create CreateSession method call: %s", strerror(-r
));
544 return PAM_SESSION_ERR
;
547 r
= sd_bus_message_append(m
, "uusssssussbss",
548 (uint32_t) pw
->pw_uid
,
562 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
563 return PAM_SESSION_ERR
;
566 r
= sd_bus_message_open_container(m
, 'a', "(sv)");
568 pam_syslog(handle
, LOG_ERR
, "Failed to open message container: %s", strerror(-r
));
569 return PAM_SYSTEM_ERR
;
572 r
= append_session_memory_max(handle
, m
, memory_max
);
574 return PAM_SESSION_ERR
;
576 r
= append_session_tasks_max(handle
, m
, tasks_max
);
578 return PAM_SESSION_ERR
;
580 r
= append_session_cg_weight(handle
, m
, cpu_weight
, "CPUWeight");
582 return PAM_SESSION_ERR
;
584 r
= append_session_cg_weight(handle
, m
, io_weight
, "IOWeight");
586 return PAM_SESSION_ERR
;
588 r
= sd_bus_message_close_container(m
);
590 pam_syslog(handle
, LOG_ERR
, "Failed to close message container: %s", strerror(-r
));
591 return PAM_SYSTEM_ERR
;
594 r
= sd_bus_call(bus
, m
, 0, &error
, &reply
);
596 if (sd_bus_error_has_name(&error
, BUS_ERROR_SESSION_BUSY
)) {
598 pam_syslog(handle
, LOG_DEBUG
, "Not creating session: %s", bus_error_message(&error
, r
));
601 pam_syslog(handle
, LOG_ERR
, "Failed to create session: %s", bus_error_message(&error
, r
));
602 return PAM_SYSTEM_ERR
;
606 r
= sd_bus_message_read(reply
,
617 pam_syslog(handle
, LOG_ERR
, "Failed to parse message: %s", strerror(-r
));
618 return PAM_SESSION_ERR
;
622 pam_syslog(handle
, LOG_DEBUG
, "Reply from logind: "
623 "id=%s object_path=%s runtime_path=%s session_fd=%d seat=%s vtnr=%u original_uid=%u",
624 id
, object_path
, runtime_path
, session_fd
, seat
, vtnr
, original_uid
);
626 r
= update_environment(handle
, "XDG_SESSION_ID", id
);
627 if (r
!= PAM_SUCCESS
)
630 if (original_uid
== pw
->pw_uid
) {
631 /* Don't set $XDG_RUNTIME_DIR if the user we now
632 * authenticated for does not match the original user
633 * of the session. We do this in order not to result
634 * in privileged apps clobbering the runtime directory
637 if (validate_runtime_directory(handle
, runtime_path
, pw
->pw_uid
)) {
638 r
= update_environment(handle
, "XDG_RUNTIME_DIR", runtime_path
);
639 if (r
!= PAM_SUCCESS
)
643 r
= export_legacy_dbus_address(handle
, pw
->pw_uid
, runtime_path
);
644 if (r
!= PAM_SUCCESS
)
648 /* Most likely we got the session/type/class from environment variables, but might have gotten the data
649 * somewhere else (for example PAM module parameters). Let's now update the environment variables, so that this
650 * data is inherited into the session processes, and programs can rely on them to be initialized. */
652 r
= update_environment(handle
, "XDG_SESSION_TYPE", type
);
653 if (r
!= PAM_SUCCESS
)
656 r
= update_environment(handle
, "XDG_SESSION_CLASS", class);
657 if (r
!= PAM_SUCCESS
)
660 r
= update_environment(handle
, "XDG_SESSION_DESKTOP", desktop
);
661 if (r
!= PAM_SUCCESS
)
664 r
= update_environment(handle
, "XDG_SEAT", seat
);
665 if (r
!= PAM_SUCCESS
)
669 char buf
[DECIMAL_STR_MAX(vtnr
)];
670 sprintf(buf
, "%u", vtnr
);
672 r
= update_environment(handle
, "XDG_VTNR", buf
);
673 if (r
!= PAM_SUCCESS
)
677 r
= pam_set_data(handle
, "systemd.existing", INT_TO_PTR(!!existing
), NULL
);
678 if (r
!= PAM_SUCCESS
) {
679 pam_syslog(handle
, LOG_ERR
, "Failed to install existing flag.");
683 if (session_fd
>= 0) {
684 session_fd
= fcntl(session_fd
, F_DUPFD_CLOEXEC
, 3);
685 if (session_fd
< 0) {
686 pam_syslog(handle
, LOG_ERR
, "Failed to dup session fd: %m");
687 return PAM_SESSION_ERR
;
690 r
= pam_set_data(handle
, "systemd.session-fd", FD_TO_PTR(session_fd
), NULL
);
691 if (r
!= PAM_SUCCESS
) {
692 pam_syslog(handle
, LOG_ERR
, "Failed to install session fd.");
693 safe_close(session_fd
);
701 _public_ PAM_EXTERN
int pam_sm_close_session(
702 pam_handle_t
*handle
,
704 int argc
, const char **argv
) {
706 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
707 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
708 const void *existing
= NULL
;
714 /* Only release session if it wasn't pre-existing when we
715 * tried to create it */
716 (void) pam_get_data(handle
, "systemd.existing", &existing
);
718 id
= pam_getenv(handle
, "XDG_SESSION_ID");
719 if (id
&& !existing
) {
721 /* Before we go and close the FIFO we need to tell
722 * logind that this is a clean session shutdown, so
723 * that it doesn't just go and slaughter us
724 * immediately after closing the fd */
726 r
= sd_bus_open_system(&bus
);
728 pam_syslog(handle
, LOG_ERR
, "Failed to connect to system bus: %s", strerror(-r
));
729 return PAM_SESSION_ERR
;
732 r
= sd_bus_call_method(bus
,
733 "org.freedesktop.login1",
734 "/org/freedesktop/login1",
735 "org.freedesktop.login1.Manager",
742 pam_syslog(handle
, LOG_ERR
, "Failed to release session: %s", bus_error_message(&error
, r
));
743 return PAM_SESSION_ERR
;
747 /* Note that we are knowingly leaking the FIFO fd here. This
748 * way, logind can watch us die. If we closed it here it would
749 * not have any clue when that is completed. Given that one
750 * cannot really have multiple PAM sessions open from the same
751 * process this means we will leak one FD at max. */