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 /* FIXME: We *really* should move the access() check into the
202 * daemons that spawn dbus-daemon, instead of forcing
203 * DBUS_SESSION_BUS_ADDRESS= here. */
205 s
= strjoin(runtime
, "/bus");
209 if (access(s
, F_OK
) < 0)
213 if (asprintf(&s
, DEFAULT_USER_BUS_ADDRESS_FMT
, runtime
) < 0)
216 r
= pam_misc_setenv(handle
, "DBUS_SESSION_BUS_ADDRESS", s
, 0);
217 if (r
!= PAM_SUCCESS
)
223 pam_syslog(handle
, LOG_ERR
, "Failed to set bus variable.");
227 static int append_session_memory_max(pam_handle_t
*handle
, sd_bus_message
*m
, const char *limit
) {
234 if (streq(limit
, "infinity")) {
235 r
= sd_bus_message_append(m
, "(sv)", "MemoryMax", "t", (uint64_t)-1);
237 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
241 r
= parse_permille(limit
);
243 r
= sd_bus_message_append(m
, "(sv)", "MemoryMaxScale", "u", (uint32_t) (((uint64_t) r
* UINT32_MAX
) / 1000U));
245 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
249 r
= parse_size(limit
, 1024, &val
);
251 r
= sd_bus_message_append(m
, "(sv)", "MemoryMax", "t", val
);
253 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
257 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.limit: %s, ignoring.", limit
);
264 static int append_session_tasks_max(pam_handle_t
*handle
, sd_bus_message
*m
, const char *limit
) {
268 /* No need to parse "infinity" here, it will be set unconditionally later in manager_start_scope() */
269 if (isempty(limit
) || streq(limit
, "infinity"))
272 r
= safe_atou64(limit
, &val
);
274 r
= sd_bus_message_append(m
, "(sv)", "TasksMax", "t", val
);
276 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
280 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.limit: %s, ignoring.", limit
);
285 static int append_session_cg_weight(pam_handle_t
*handle
, sd_bus_message
*m
, const char *limit
, const char *field
) {
292 r
= cg_weight_parse(limit
, &val
);
294 r
= sd_bus_message_append(m
, "(sv)", field
, "t", val
);
296 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
299 } else if (streq(field
, "CPUWeight"))
300 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.cpu_weight: %s, ignoring.", limit
);
302 pam_syslog(handle
, LOG_WARNING
, "Failed to parse systemd.io_weight: %s, ignoring.", limit
);
307 static const char* getenv_harder(pam_handle_t
*handle
, const char *key
, const char *fallback
) {
313 /* Looks for an environment variable, preferrably in the environment block associated with the specified PAM
314 * handle, falling back to the process' block instead. */
316 v
= pam_getenv(handle
, key
);
327 static int update_environment(pam_handle_t
*handle
, const char *key
, const char *value
) {
333 /* Updates the environment, but only if there's actually a value set. Also, log about errors */
338 r
= pam_misc_setenv(handle
, key
, value
, 0);
339 if (r
!= PAM_SUCCESS
)
340 pam_syslog(handle
, LOG_ERR
, "Failed to set environment variable %s.", key
);
345 static bool validate_runtime_directory(pam_handle_t
*handle
, const char *path
, uid_t uid
) {
350 /* Just some extra paranoia: let's not set $XDG_RUNTIME_DIR if the directory we'd set it to isn't actually set
351 * up properly for us. */
353 if (lstat(path
, &st
) < 0) {
354 pam_syslog(handle
, LOG_ERR
, "Failed to stat() runtime directory '%s': %s", path
, strerror(errno
));
358 if (!S_ISDIR(st
.st_mode
)) {
359 pam_syslog(handle
, LOG_ERR
, "Runtime directory '%s' is not actually a directory.", path
);
363 if (st
.st_uid
!= uid
) {
364 pam_syslog(handle
, LOG_ERR
, "Runtime directory '%s' is not owned by UID " UID_FMT
", as it should.", path
, uid
);
371 pam_syslog(handle
, LOG_WARNING
, "Not setting $XDG_RUNTIME_DIR, as the directory is not in order.");
375 _public_ PAM_EXTERN
int pam_sm_open_session(
376 pam_handle_t
*handle
,
378 int argc
, const char **argv
) {
380 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
381 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
383 *username
, *id
, *object_path
, *runtime_path
,
385 *tty
= NULL
, *display
= NULL
,
386 *remote_user
= NULL
, *remote_host
= NULL
,
388 *type
= NULL
, *class = NULL
,
389 *class_pam
= NULL
, *type_pam
= NULL
, *cvtnr
= NULL
, *desktop
= NULL
, *desktop_pam
= NULL
,
390 *memory_max
= NULL
, *tasks_max
= NULL
, *cpu_weight
= NULL
, *io_weight
= NULL
;
391 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
392 int session_fd
= -1, existing
, r
;
393 bool debug
= false, remote
;
400 /* Make this a NOP on non-logind systems */
401 if (!logind_running())
404 if (parse_argv(handle
,
410 return PAM_SESSION_ERR
;
413 pam_syslog(handle
, LOG_DEBUG
, "pam-systemd initializing");
415 r
= get_user_data(handle
, &username
, &pw
);
416 if (r
!= PAM_SUCCESS
) {
417 pam_syslog(handle
, LOG_ERR
, "Failed to get user data.");
421 /* Make sure we don't enter a loop by talking to
422 * systemd-logind when it is actually waiting for the
423 * background to finish start-up. If the service is
424 * "systemd-user" we simply set XDG_RUNTIME_DIR and
427 pam_get_item(handle
, PAM_SERVICE
, (const void**) &service
);
428 if (streq_ptr(service
, "systemd-user")) {
429 _cleanup_free_
char *rt
= NULL
;
431 if (asprintf(&rt
, "/run/user/"UID_FMT
, pw
->pw_uid
) < 0)
434 if (validate_runtime_directory(handle
, rt
, pw
->pw_uid
)) {
435 r
= pam_misc_setenv(handle
, "XDG_RUNTIME_DIR", rt
, 0);
436 if (r
!= PAM_SUCCESS
) {
437 pam_syslog(handle
, LOG_ERR
, "Failed to set runtime dir.");
442 r
= export_legacy_dbus_address(handle
, pw
->pw_uid
, rt
);
443 if (r
!= PAM_SUCCESS
)
449 /* Otherwise, we ask logind to create a session for us */
451 pam_get_item(handle
, PAM_XDISPLAY
, (const void**) &display
);
452 pam_get_item(handle
, PAM_TTY
, (const void**) &tty
);
453 pam_get_item(handle
, PAM_RUSER
, (const void**) &remote_user
);
454 pam_get_item(handle
, PAM_RHOST
, (const void**) &remote_host
);
456 seat
= getenv_harder(handle
, "XDG_SEAT", NULL
);
457 cvtnr
= getenv_harder(handle
, "XDG_VTNR", NULL
);
458 type
= getenv_harder(handle
, "XDG_SESSION_TYPE", type_pam
);
459 class = getenv_harder(handle
, "XDG_SESSION_CLASS", class_pam
);
460 desktop
= getenv_harder(handle
, "XDG_SESSION_DESKTOP", desktop_pam
);
464 if (strchr(tty
, ':')) {
465 /* A tty with a colon is usually an X11 display, placed there to show up in utmp. We rearrange things
466 * and don't pretend that an X display was a tty. */
467 if (isempty(display
))
471 } else if (streq(tty
, "cron")) {
472 /* cron is setting PAM_TTY to "cron" for some reason (the commit carries no information why, but
473 * probably because it wants to set it to something as pam_time/pam_access/… require PAM_TTY to be set
474 * (as they otherwise even try to update it!) — but cron doesn't actually allocate a TTY for its forked
476 type
= "unspecified";
477 class = "background";
480 } else if (streq(tty
, "ssh")) {
481 /* ssh has been setting PAM_TTY to "ssh" (for the same reason as cron does this, see above. For further
482 * details look for "PAM_TTY_KLUDGE" in the openssh sources). */
485 tty
= NULL
; /* This one is particularly sad, as this means that ssh sessions — even though usually
486 * associated with a pty — won't be tracked by their tty in logind. This is because ssh
487 * does the PAM session registration early for new connections, and registers a pty only
488 * much later (this is because it doesn't know yet if it needs one at all, as whether to
489 * register a pty or not is negotiated much later in the protocol). */
492 /* Chop off leading /dev prefix that some clients specify, but others do not. */
493 tty
= skip_dev_prefix(tty
);
495 /* If this fails vtnr will be 0, that's intended */
497 (void) safe_atou32(cvtnr
, &vtnr
);
499 if (!isempty(display
) && !vtnr
) {
501 (void) get_seat_from_display(display
, &seat
, &vtnr
);
502 else if (streq(seat
, "seat0"))
503 (void) get_seat_from_display(display
, NULL
, &vtnr
);
506 if (seat
&& !streq(seat
, "seat0") && vtnr
!= 0) {
508 pam_syslog(handle
, LOG_DEBUG
, "Ignoring vtnr %"PRIu32
" for %s which is not seat0", vtnr
, seat
);
513 type
= !isempty(display
) ? "x11" :
514 !isempty(tty
) ? "tty" : "unspecified";
517 class = streq(type
, "unspecified") ? "background" : "user";
519 remote
= !isempty(remote_host
) && !is_localhost(remote_host
);
521 (void) pam_get_data(handle
, "systemd.memory_max", (const void **)&memory_max
);
522 (void) pam_get_data(handle
, "systemd.tasks_max", (const void **)&tasks_max
);
523 (void) pam_get_data(handle
, "systemd.cpu_weight", (const void **)&cpu_weight
);
524 (void) pam_get_data(handle
, "systemd.io_weight", (const void **)&io_weight
);
526 /* Talk to logind over the message bus */
528 r
= sd_bus_open_system(&bus
);
530 pam_syslog(handle
, LOG_ERR
, "Failed to connect to system bus: %s", strerror(-r
));
531 return PAM_SESSION_ERR
;
535 pam_syslog(handle
, LOG_DEBUG
, "Asking logind to create session: "
536 "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",
537 pw
->pw_uid
, getpid_cached(),
539 type
, class, strempty(desktop
),
540 strempty(seat
), vtnr
, strempty(tty
), strempty(display
),
541 yes_no(remote
), strempty(remote_user
), strempty(remote_host
));
542 pam_syslog(handle
, LOG_DEBUG
, "Session limits: "
543 "memory_max=%s tasks_max=%s cpu_weight=%s io_weight=%s",
544 strna(memory_max
), strna(tasks_max
), strna(cpu_weight
), strna(io_weight
));
547 r
= sd_bus_message_new_method_call(
550 "org.freedesktop.login1",
551 "/org/freedesktop/login1",
552 "org.freedesktop.login1.Manager",
555 pam_syslog(handle
, LOG_ERR
, "Failed to create CreateSession method call: %s", strerror(-r
));
556 return PAM_SESSION_ERR
;
559 r
= sd_bus_message_append(m
, "uusssssussbss",
560 (uint32_t) pw
->pw_uid
,
574 pam_syslog(handle
, LOG_ERR
, "Failed to append to bus message: %s", strerror(-r
));
575 return PAM_SESSION_ERR
;
578 r
= sd_bus_message_open_container(m
, 'a', "(sv)");
580 pam_syslog(handle
, LOG_ERR
, "Failed to open message container: %s", strerror(-r
));
581 return PAM_SYSTEM_ERR
;
584 r
= append_session_memory_max(handle
, m
, memory_max
);
586 return PAM_SESSION_ERR
;
588 r
= append_session_tasks_max(handle
, m
, tasks_max
);
590 return PAM_SESSION_ERR
;
592 r
= append_session_cg_weight(handle
, m
, cpu_weight
, "CPUWeight");
594 return PAM_SESSION_ERR
;
596 r
= append_session_cg_weight(handle
, m
, io_weight
, "IOWeight");
598 return PAM_SESSION_ERR
;
600 r
= sd_bus_message_close_container(m
);
602 pam_syslog(handle
, LOG_ERR
, "Failed to close message container: %s", strerror(-r
));
603 return PAM_SYSTEM_ERR
;
606 r
= sd_bus_call(bus
, m
, 0, &error
, &reply
);
608 if (sd_bus_error_has_name(&error
, BUS_ERROR_SESSION_BUSY
)) {
610 pam_syslog(handle
, LOG_DEBUG
, "Cannot create session: %s", bus_error_message(&error
, r
));
613 pam_syslog(handle
, LOG_ERR
, "Failed to create session: %s", bus_error_message(&error
, r
));
614 return PAM_SYSTEM_ERR
;
618 r
= sd_bus_message_read(reply
,
629 pam_syslog(handle
, LOG_ERR
, "Failed to parse message: %s", strerror(-r
));
630 return PAM_SESSION_ERR
;
634 pam_syslog(handle
, LOG_DEBUG
, "Reply from logind: "
635 "id=%s object_path=%s runtime_path=%s session_fd=%d seat=%s vtnr=%u original_uid=%u",
636 id
, object_path
, runtime_path
, session_fd
, seat
, vtnr
, original_uid
);
638 r
= update_environment(handle
, "XDG_SESSION_ID", id
);
639 if (r
!= PAM_SUCCESS
)
642 if (original_uid
== pw
->pw_uid
) {
643 /* Don't set $XDG_RUNTIME_DIR if the user we now
644 * authenticated for does not match the original user
645 * of the session. We do this in order not to result
646 * in privileged apps clobbering the runtime directory
649 if (validate_runtime_directory(handle
, runtime_path
, pw
->pw_uid
)) {
650 r
= update_environment(handle
, "XDG_RUNTIME_DIR", runtime_path
);
651 if (r
!= PAM_SUCCESS
)
655 r
= export_legacy_dbus_address(handle
, pw
->pw_uid
, runtime_path
);
656 if (r
!= PAM_SUCCESS
)
660 /* Most likely we got the session/type/class from environment variables, but might have gotten the data
661 * somewhere else (for example PAM module parameters). Let's now update the environment variables, so that this
662 * data is inherited into the session processes, and programs can rely on them to be initialized. */
664 r
= update_environment(handle
, "XDG_SESSION_TYPE", type
);
665 if (r
!= PAM_SUCCESS
)
668 r
= update_environment(handle
, "XDG_SESSION_CLASS", class);
669 if (r
!= PAM_SUCCESS
)
672 r
= update_environment(handle
, "XDG_SESSION_DESKTOP", desktop
);
673 if (r
!= PAM_SUCCESS
)
676 r
= update_environment(handle
, "XDG_SEAT", seat
);
677 if (r
!= PAM_SUCCESS
)
681 char buf
[DECIMAL_STR_MAX(vtnr
)];
682 sprintf(buf
, "%u", vtnr
);
684 r
= update_environment(handle
, "XDG_VTNR", buf
);
685 if (r
!= PAM_SUCCESS
)
689 r
= pam_set_data(handle
, "systemd.existing", INT_TO_PTR(!!existing
), NULL
);
690 if (r
!= PAM_SUCCESS
) {
691 pam_syslog(handle
, LOG_ERR
, "Failed to install existing flag.");
695 if (session_fd
>= 0) {
696 session_fd
= fcntl(session_fd
, F_DUPFD_CLOEXEC
, 3);
697 if (session_fd
< 0) {
698 pam_syslog(handle
, LOG_ERR
, "Failed to dup session fd: %m");
699 return PAM_SESSION_ERR
;
702 r
= pam_set_data(handle
, "systemd.session-fd", FD_TO_PTR(session_fd
), NULL
);
703 if (r
!= PAM_SUCCESS
) {
704 pam_syslog(handle
, LOG_ERR
, "Failed to install session fd.");
705 safe_close(session_fd
);
713 _public_ PAM_EXTERN
int pam_sm_close_session(
714 pam_handle_t
*handle
,
716 int argc
, const char **argv
) {
718 _cleanup_(sd_bus_error_free
) sd_bus_error error
= SD_BUS_ERROR_NULL
;
719 _cleanup_(sd_bus_flush_close_unrefp
) sd_bus
*bus
= NULL
;
720 const void *existing
= NULL
;
726 /* Only release session if it wasn't pre-existing when we
727 * tried to create it */
728 (void) pam_get_data(handle
, "systemd.existing", &existing
);
730 id
= pam_getenv(handle
, "XDG_SESSION_ID");
731 if (id
&& !existing
) {
733 /* Before we go and close the FIFO we need to tell
734 * logind that this is a clean session shutdown, so
735 * that it doesn't just go and slaughter us
736 * immediately after closing the fd */
738 r
= sd_bus_open_system(&bus
);
740 pam_syslog(handle
, LOG_ERR
, "Failed to connect to system bus: %s", strerror(-r
));
741 return PAM_SESSION_ERR
;
744 r
= sd_bus_call_method(bus
,
745 "org.freedesktop.login1",
746 "/org/freedesktop/login1",
747 "org.freedesktop.login1.Manager",
754 pam_syslog(handle
, LOG_ERR
, "Failed to release session: %s", bus_error_message(&error
, r
));
755 return PAM_SESSION_ERR
;
759 /* Note that we are knowingly leaking the FIFO fd here. This
760 * way, logind can watch us die. If we closed it here it would
761 * not have any clue when that is completed. Given that one
762 * cannot really have multiple PAM sessions open from the same
763 * process this means we will leak one FD at max. */