1 /* SPDX-License-Identifier: LGPL-2.1+ */
6 #include "chown-recursive.h"
10 #include "home-util.h"
11 #include "homework-cifs.h"
12 #include "homework-directory.h"
13 #include "homework-fscrypt.h"
14 #include "homework-luks.h"
15 #include "homework-mount.h"
16 #include "homework-pkcs11.h"
18 #include "main-func.h"
19 #include "memory-util.h"
20 #include "missing_magic.h"
21 #include "mount-util.h"
22 #include "path-util.h"
23 #include "pkcs11-util.h"
25 #include "stat-util.h"
27 #include "tmpfile-util.h"
28 #include "user-util.h"
31 /* Make sure a bad password always results in a 3s delay, no matter what */
32 #define BAD_PASSWORD_DELAY_USEC (3 * USEC_PER_SEC)
34 int user_record_authenticate(
37 char ***pkcs11_decrypted_passwords
) {
39 bool need_password
= false, need_token
= false, need_pin
= false, need_protected_authentication_path_permitted
= false,
40 pin_locked
= false, pin_incorrect
= false, pin_incorrect_few_tries_left
= false, pin_incorrect_one_try_left
= false;
47 /* Tries to authenticate a user record with the supplied secrets. i.e. checks whether at least one
48 * supplied plaintext passwords matches a hashed password field of the user record. Or if a
49 * configured PKCS#11 token is around and can unlock the record.
51 * Note that the pkcs11_decrypted_passwords parameter is both an input and and output parameter: it
52 * is a list of configured, decrypted PKCS#11 passwords. We typically have to call this function
53 * multiple times over the course of an operation (think: on login we authenticate the host user
54 * record, the record embedded in the LUKS record and the one embedded in $HOME). Hence we keep a
55 * list of passwords we already decrypted, so that we don't have to do the (slow an potentially
56 * interactive) PKCS#11 dance for the relevant token again and again. */
58 /* First, let's see if the supplied plain-text passwords work? */
59 r
= user_record_test_secret(h
, secret
);
61 log_info_errno(r
, "None of the supplied plaintext passwords unlocks the user record's hashed passwords.");
63 } else if (r
== -ENXIO
)
64 log_debug_errno(r
, "User record has no hashed passwords, plaintext passwords not tested.");
66 return log_error_errno(r
, "Failed to validate password of record: %m");
68 log_info("Provided password unlocks user record.");
72 /* Second, let's see if any of the PKCS#11 security tokens are plugged in and help us */
73 for (n
= 0; n
< h
->n_pkcs11_encrypted_key
; n
++) {
75 _cleanup_(pkcs11_callback_data_release
) struct pkcs11_callback_data data
= {
78 .encrypted_key
= h
->pkcs11_encrypted_key
+ n
,
82 /* See if any of the previously calculated passwords work */
83 STRV_FOREACH(pp
, *pkcs11_decrypted_passwords
) {
84 r
= test_password_one(data
.encrypted_key
->hashed_password
, *pp
);
86 return log_error_errno(r
, "Failed to check supplied PKCS#11 password: %m");
88 log_info("Previously acquired PKCS#11 password unlocks user record.");
93 r
= pkcs11_find_token(data
.encrypted_key
->uri
, pkcs11_callback
, &data
);
102 need_protected_authentication_path_permitted
= true;
108 pin_incorrect
= true;
111 pin_incorrect
= pin_incorrect_few_tries_left
= true;
114 pin_incorrect
= pin_incorrect_few_tries_left
= pin_incorrect_one_try_left
= true;
120 r
= test_password_one(data
.encrypted_key
->hashed_password
, data
.decrypted_password
);
122 return log_error_errno(r
, "Failed to test PKCS#11 password: %m");
124 return log_error_errno(SYNTHETIC_ERRNO(EPERM
), "Configured PKCS#11 security token %s does not decrypt encrypted key correctly.", data
.encrypted_key
->uri
);
126 log_info("Decrypted password from PKCS#11 security token %s unlocks user record.", data
.encrypted_key
->uri
);
128 r
= strv_extend(pkcs11_decrypted_passwords
, data
.decrypted_password
);
140 /* Ordered by "relevance", i.e. the most "important" or "interesting" error condition is returned. */
141 if (pin_incorrect_one_try_left
)
143 if (pin_incorrect_few_tries_left
)
144 return -ETOOMANYREFS
;
149 if (need_protected_authentication_path_permitted
)
158 /* Hmm, this means neither PCKS#11 nor classic hashed passwords were supplied, we cannot authenticate this reasonably */
159 return log_debug_errno(SYNTHETIC_ERRNO(EKEYREVOKED
), "No hashed passwords and no PKCS#11 tokens defined, cannot authenticate user record.");
162 int home_setup_undo(HomeSetup
*setup
) {
167 setup
->root_fd
= safe_close(setup
->root_fd
);
169 if (setup
->undo_mount
) {
170 q
= umount_verbose("/run/systemd/user-home-mount");
175 if (setup
->undo_dm
&& setup
->crypt_device
&& setup
->dm_name
) {
176 q
= crypt_deactivate(setup
->crypt_device
, setup
->dm_name
);
181 setup
->undo_mount
= false;
182 setup
->undo_dm
= false;
184 setup
->dm_name
= mfree(setup
->dm_name
);
185 setup
->dm_node
= mfree(setup
->dm_node
);
187 setup
->loop
= loop_device_unref(setup
->loop
);
188 crypt_free(setup
->crypt_device
);
189 setup
->crypt_device
= NULL
;
191 explicit_bzero_safe(setup
->volume_key
, setup
->volume_key_size
);
192 setup
->volume_key
= mfree(setup
->volume_key
);
193 setup
->volume_key_size
= 0;
200 bool already_activated
,
201 char ***pkcs11_decrypted_passwords
,
203 UserRecord
**ret_header_home
) {
209 assert(!setup
->loop
);
210 assert(!setup
->crypt_device
);
211 assert(setup
->root_fd
< 0);
212 assert(!setup
->undo_dm
);
213 assert(!setup
->undo_mount
);
215 /* Makes a home directory accessible (through the root_fd file descriptor, not by path!). */
217 switch (user_record_storage(h
)) {
220 return home_prepare_luks(h
, already_activated
, NULL
, pkcs11_decrypted_passwords
, setup
, ret_header_home
);
224 r
= home_prepare_directory(h
, already_activated
, setup
);
228 r
= home_prepare_fscrypt(h
, already_activated
, pkcs11_decrypted_passwords
, setup
);
232 r
= home_prepare_cifs(h
, already_activated
, setup
);
236 return log_error_errno(SYNTHETIC_ERRNO(ENOLINK
), "Processing home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
243 *ret_header_home
= NULL
;
248 int home_sync_and_statfs(int root_fd
, struct statfs
*ret
) {
249 assert(root_fd
>= 0);
251 /* Let's sync this to disk, so that the disk space reported by fstatfs() below is accurate (for file
252 * systems such as btrfs where this is determined lazily). */
254 if (syncfs(root_fd
) < 0)
255 return log_error_errno(errno
, "Failed to synchronize file system: %m");
258 if (fstatfs(root_fd
, ret
) < 0)
259 return log_error_errno(errno
, "Failed to statfs() file system: %m");
261 log_info("Synchronized disk.");
266 static int read_identity_file(int root_fd
, JsonVariant
**ret
) {
267 _cleanup_(fclosep
) FILE *identity_file
= NULL
;
268 _cleanup_close_
int identity_fd
= -1;
269 unsigned line
, column
;
272 assert(root_fd
>= 0);
275 identity_fd
= openat(root_fd
, ".identity", O_RDONLY
|O_CLOEXEC
|O_NOCTTY
|O_NOFOLLOW
|O_NONBLOCK
);
277 return log_error_errno(errno
, "Failed to open .identity file in home directory: %m");
279 r
= fd_verify_regular(identity_fd
);
281 return log_error_errno(r
, "Embedded identity file is not a regular file, refusing: %m");
283 identity_file
= fdopen(identity_fd
, "r");
289 r
= json_parse_file(identity_file
, ".identity", JSON_PARSE_SENSITIVE
, ret
, &line
, &column
);
291 return log_error_errno(r
, "[.identity:%u:%u] Failed to parse JSON data: %m", line
, column
);
293 log_info("Read embedded .identity file.");
298 static int write_identity_file(int root_fd
, JsonVariant
*v
, uid_t uid
) {
299 _cleanup_(json_variant_unrefp
) JsonVariant
*normalized
= NULL
;
300 _cleanup_(fclosep
) FILE *identity_file
= NULL
;
301 _cleanup_close_
int identity_fd
= -1;
302 _cleanup_free_
char *fn
= NULL
;
305 assert(root_fd
>= 0);
308 normalized
= json_variant_ref(v
);
310 r
= json_variant_normalize(&normalized
);
312 log_warning_errno(r
, "Failed to normalize user record, ignoring: %m");
314 r
= tempfn_random(".identity", NULL
, &fn
);
318 identity_fd
= openat(root_fd
, fn
, O_WRONLY
|O_CREAT
|O_EXCL
|O_CLOEXEC
|O_NOCTTY
|O_NOFOLLOW
, 0600);
320 return log_error_errno(errno
, "Failed to create .identity file in home directory: %m");
322 identity_file
= fdopen(identity_fd
, "w");
323 if (!identity_file
) {
330 json_variant_dump(normalized
, JSON_FORMAT_PRETTY
, identity_file
, NULL
);
332 r
= fflush_and_check(identity_file
);
334 log_error_errno(r
, "Failed to write .identity file: %m");
338 if (fchown(fileno(identity_file
), uid
, uid
) < 0) {
339 log_error_errno(r
, "Failed to change ownership of identity file: %m");
343 if (renameat(root_fd
, fn
, root_fd
, ".identity") < 0) {
344 r
= log_error_errno(errno
, "Failed to move identity file into place: %m");
348 log_info("Wrote embedded .identity file.");
353 (void) unlinkat(root_fd
, fn
, 0);
357 int home_load_embedded_identity(
360 UserRecord
*header_home
,
361 UserReconcileMode mode
,
362 char ***pkcs11_decrypted_passwords
,
363 UserRecord
**ret_embedded_home
,
364 UserRecord
**ret_new_home
) {
366 _cleanup_(user_record_unrefp
) UserRecord
*embedded_home
= NULL
, *intermediate_home
= NULL
, *new_home
= NULL
;
367 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
371 assert(root_fd
>= 0);
373 r
= read_identity_file(root_fd
, &v
);
377 embedded_home
= user_record_new();
381 r
= user_record_load(embedded_home
, v
, USER_RECORD_LOAD_EMBEDDED
);
385 if (!user_record_compatible(h
, embedded_home
))
386 return log_error_errno(SYNTHETIC_ERRNO(EREMCHG
), "Embedded home record not compatible with host record, refusing.");
388 /* Insist that credentials the user supplies also unlocks any embedded records. */
389 r
= user_record_authenticate(embedded_home
, h
, pkcs11_decrypted_passwords
);
393 /* At this point we have three records to deal with:
395 * · The record we got passed from the host
396 * · The record included in the LUKS header (only if LUKS is used)
397 * · The record in the home directory itself (~.identity)
399 * Now we have to reconcile all three, and let the newest one win. */
402 /* Note we relax the requirements here. Instead of insisting that the host record is strictly
403 * newer, let's also be OK if its equally new. If it is, we'll however insist that the
404 * embedded record must be newer, so that we update at least one of the two. */
406 r
= user_record_reconcile(h
, header_home
, mode
== USER_RECONCILE_REQUIRE_NEWER
? USER_RECONCILE_REQUIRE_NEWER_OR_EQUAL
: mode
, &intermediate_home
);
407 if (r
== -EREMCHG
) /* this was supposed to be checked earlier already, but let's check this again */
408 return log_error_errno(r
, "Identity stored on host and in header don't match, refusing.");
410 return log_error_errno(r
, "Embedded identity record is newer than supplied record, refusing.");
412 return log_error_errno(r
, "Failed to reconcile host and header identities: %m");
413 if (r
== USER_RECONCILE_EMBEDDED_WON
)
414 log_info("Reconciling header user identity completed (header version was newer).");
415 else if (r
== USER_RECONCILE_HOST_WON
) {
416 log_info("Reconciling header user identity completed (host version was newer).");
418 if (mode
== USER_RECONCILE_REQUIRE_NEWER
) /* Host version is newer than the header
419 * version, hence we'll update
420 * something. This means we can relax the
421 * requirements on the embedded
423 mode
= USER_RECONCILE_REQUIRE_NEWER_OR_EQUAL
;
425 assert(r
== USER_RECONCILE_IDENTICAL
);
426 log_info("Reconciling user identities completed (host and header version were identical).");
429 h
= intermediate_home
;
432 r
= user_record_reconcile(h
, embedded_home
, mode
, &new_home
);
434 return log_error_errno(r
, "Identity stored on host and in home don't match, refusing.");
436 return log_error_errno(r
, "Embedded identity record is equally new or newer than supplied record, refusing.");
438 return log_error_errno(r
, "Failed to reconcile host and embedded identities: %m");
439 if (r
== USER_RECONCILE_EMBEDDED_WON
)
440 log_info("Reconciling embedded user identity completed (embedded version was newer).");
441 else if (r
== USER_RECONCILE_HOST_WON
)
442 log_info("Reconciling embedded user identity completed (host version was newer).");
444 assert(r
== USER_RECONCILE_IDENTICAL
);
445 log_info("Reconciling embedded user identity completed (host and embedded version were identical).");
448 if (ret_embedded_home
)
449 *ret_embedded_home
= TAKE_PTR(embedded_home
);
452 *ret_new_home
= TAKE_PTR(new_home
);
457 int home_store_embedded_identity(UserRecord
*h
, int root_fd
, uid_t uid
, UserRecord
*old_home
) {
458 _cleanup_(user_record_unrefp
) UserRecord
*embedded
= NULL
;
462 assert(root_fd
>= 0);
463 assert(uid_is_valid(uid
));
465 r
= user_record_clone(h
, USER_RECORD_EXTRACT_EMBEDDED
, &embedded
);
467 return log_error_errno(r
, "Failed to determine new embedded record: %m");
469 if (old_home
&& user_record_equal(old_home
, embedded
)) {
470 log_debug("Not updating embedded home record.");
474 /* The identity has changed, let's update it in the image */
475 r
= write_identity_file(root_fd
, embedded
->json
, h
->uid
);
482 static const char *file_system_type_fd(int fd
) {
487 if (fstatfs(fd
, &sfs
) < 0) {
488 log_debug_errno(errno
, "Failed to statfs(): %m");
492 if (is_fs_type(&sfs
, XFS_SB_MAGIC
))
494 if (is_fs_type(&sfs
, EXT4_SUPER_MAGIC
))
496 if (is_fs_type(&sfs
, BTRFS_SUPER_MAGIC
))
502 int home_extend_embedded_identity(UserRecord
*h
, UserRecord
*used
, HomeSetup
*setup
) {
509 r
= user_record_add_binding(
511 user_record_storage(used
),
512 user_record_image_path(used
),
513 setup
->found_partition_uuid
,
514 setup
->found_luks_uuid
,
515 setup
->found_fs_uuid
,
516 setup
->crypt_device
? crypt_get_cipher(setup
->crypt_device
) : NULL
,
517 setup
->crypt_device
? crypt_get_cipher_mode(setup
->crypt_device
) : NULL
,
518 setup
->crypt_device
? luks_volume_key_size_convert(setup
->crypt_device
) : UINT64_MAX
,
519 file_system_type_fd(setup
->root_fd
),
520 user_record_home_directory(used
),
524 return log_error_errno(r
, "Failed to update binding in record: %m");
529 static int chown_recursive_directory(int root_fd
, uid_t uid
) {
532 assert(root_fd
>= 0);
533 assert(uid_is_valid(uid
));
535 r
= fd_chown_recursive(root_fd
, uid
, (gid_t
) uid
, 0777);
537 return log_error_errno(r
, "Failed to change ownership of files and directories: %m");
539 log_info("Recursive changing of ownership not necessary, skipped.");
541 log_info("Recursive changing of ownership completed.");
549 UserRecord
*header_home
,
550 char ***pkcs11_decrypted_passwords
,
551 struct statfs
*ret_statfs
,
552 UserRecord
**ret_new_home
) {
554 _cleanup_(user_record_unrefp
) UserRecord
*embedded_home
= NULL
, *new_home
= NULL
;
559 assert(ret_new_home
);
561 /* When activating a home directory, does the identity work: loads the identity from the $HOME
562 * directory, reconciles it with our idea, chown()s everything. */
564 r
= home_load_embedded_identity(h
, setup
->root_fd
, header_home
, USER_RECONCILE_ANY
, pkcs11_decrypted_passwords
, &embedded_home
, &new_home
);
568 r
= home_store_header_identity_luks(new_home
, setup
, header_home
);
572 r
= home_store_embedded_identity(new_home
, setup
->root_fd
, h
->uid
, embedded_home
);
576 r
= chown_recursive_directory(setup
->root_fd
, h
->uid
);
580 r
= home_sync_and_statfs(setup
->root_fd
, ret_statfs
);
584 *ret_new_home
= TAKE_PTR(new_home
);
588 static int home_activate(UserRecord
*h
, UserRecord
**ret_home
) {
589 _cleanup_(strv_free_erasep
) char **pkcs11_decrypted_passwords
= NULL
;
590 _cleanup_(user_record_unrefp
) UserRecord
*new_home
= NULL
;
596 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks user name, refusing.");
597 if (!uid_is_valid(h
->uid
))
598 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks UID, refusing.");
599 if (!IN_SET(user_record_storage(h
), USER_LUKS
, USER_DIRECTORY
, USER_SUBVOLUME
, USER_FSCRYPT
, USER_CIFS
))
600 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Activating home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
602 r
= user_record_authenticate(h
, h
, &pkcs11_decrypted_passwords
);
606 r
= user_record_test_home_directory_and_warn(h
);
609 if (r
== USER_TEST_MOUNTED
)
610 return log_error_errno(SYNTHETIC_ERRNO(EALREADY
), "Home directory %s is already mounted, refusing.", user_record_home_directory(h
));
612 r
= user_record_test_image_path_and_warn(h
);
615 if (r
== USER_TEST_ABSENT
)
616 return log_error_errno(SYNTHETIC_ERRNO(ENOENT
), "Image path %s is missing, refusing.", user_record_image_path(h
));
618 switch (user_record_storage(h
)) {
621 r
= home_activate_luks(h
, &pkcs11_decrypted_passwords
, &new_home
);
630 r
= home_activate_directory(h
, &pkcs11_decrypted_passwords
, &new_home
);
637 r
= home_activate_cifs(h
, &pkcs11_decrypted_passwords
, &new_home
);
644 assert_not_reached("unexpected type");
647 /* Note that the returned object might either be a reference to an updated version of the existing
648 * home object, or a reference to a newly allocated home object. The caller has to be able to deal
649 * with both, and consider the old object out-of-date. */
650 if (user_record_equal(h
, new_home
)) {
652 return 0; /* no identity change */
655 *ret_home
= TAKE_PTR(new_home
);
656 return 1; /* identity updated */
659 static int home_deactivate(UserRecord
*h
, bool force
) {
666 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record incomplete, refusing.");
667 if (!IN_SET(user_record_storage(h
), USER_LUKS
, USER_DIRECTORY
, USER_SUBVOLUME
, USER_FSCRYPT
, USER_CIFS
))
668 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Deactivating home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
670 r
= user_record_test_home_directory_and_warn(h
);
673 if (r
== USER_TEST_MOUNTED
) {
674 if (umount2(user_record_home_directory(h
), UMOUNT_NOFOLLOW
| (force
? MNT_FORCE
|MNT_DETACH
: 0)) < 0)
675 return log_error_errno(errno
, "Failed to unmount %s: %m", user_record_home_directory(h
));
677 log_info("Unmounting completed.");
680 log_info("Directory %s is already unmounted.", user_record_home_directory(h
));
682 if (user_record_storage(h
) == USER_LUKS
) {
683 r
= home_deactivate_luks(h
);
691 return log_error_errno(SYNTHETIC_ERRNO(ENOEXEC
), "Home is not active.");
693 log_info("Everything completed.");
697 static int copy_skel(int root_fd
, const char *skel
) {
700 assert(root_fd
>= 0);
702 r
= copy_tree_at(AT_FDCWD
, skel
, root_fd
, ".", UID_INVALID
, GID_INVALID
, COPY_MERGE
|COPY_REPLACE
);
704 log_info("Skeleton directory %s missing, ignoring.", skel
);
708 return log_error_errno(r
, "Failed to copy in %s: %m", skel
);
710 log_info("Copying in %s completed.", skel
);
714 static int change_access_mode(int root_fd
, mode_t m
) {
715 assert(root_fd
>= 0);
717 if (fchmod(root_fd
, m
) < 0)
718 return log_error_errno(errno
, "Failed to change access mode of top-level directory: %m");
720 log_info("Changed top-level directory access mode to 0%o.", m
);
724 int home_populate(UserRecord
*h
, int dir_fd
) {
730 r
= copy_skel(dir_fd
, user_record_skeleton_directory(h
));
734 r
= home_store_embedded_identity(h
, dir_fd
, h
->uid
, NULL
);
738 r
= chown_recursive_directory(dir_fd
, h
->uid
);
742 r
= change_access_mode(dir_fd
, user_record_access_mode(h
));
749 static int user_record_compile_effective_passwords(
751 char ***ret_effective_passwords
,
752 char ***ret_pkcs11_decrypted_passwords
) {
754 _cleanup_(strv_free_erasep
) char **effective
= NULL
, **pkcs11_passwords
= NULL
;
761 /* We insist on at least one classic hashed password to be defined in addition to any PKCS#11 one, as
762 * a safe fallback, but also to simplify the password changing algorithm: there we require providing
763 * the old literal password only (and do not care for the old PKCS#11 token) */
765 if (strv_isempty(h
->hashed_password
))
766 return log_error_errno(EINVAL
, "User record has no hashed passwords, refusing.");
768 /* Generates the list of plaintext passwords to propagate to LUKS/fscrypt devices, and checks whether
769 * we have a plaintext password for each hashed one. If we are missing one we'll fail, since we
770 * couldn't sync fscrypt/LUKS to the login account properly. */
772 STRV_FOREACH(i
, h
->hashed_password
) {
776 log_debug("Looking for plaintext password for: %s", *i
);
778 /* Let's scan all provided plaintext passwords */
779 STRV_FOREACH(j
, h
->password
) {
780 r
= test_password_one(*i
, *j
);
782 return log_error_errno(r
, "Failed to test plain text password: %m");
784 if (ret_effective_passwords
) {
785 r
= strv_extend(&effective
, *j
);
790 log_debug("Found literal plaintext password.");
797 return log_error_errno(SYNTHETIC_ERRNO(ENOKEY
), "Missing plaintext password for defined hashed password");
800 for (n
= 0; n
< h
->n_pkcs11_encrypted_key
; n
++) {
802 _cleanup_(pkcs11_callback_data_release
) struct pkcs11_callback_data data
= {
805 .encrypted_key
= h
->pkcs11_encrypted_key
+ n
,
808 r
= pkcs11_find_token(data
.encrypted_key
->uri
, pkcs11_callback
, &data
);
814 r
= test_password_one(data
.encrypted_key
->hashed_password
, data
.decrypted_password
);
816 return log_error_errno(r
, "Failed to test PKCS#11 password: %m");
818 return log_error_errno(SYNTHETIC_ERRNO(EPERM
), "Decrypted password from token is not correct, refusing.");
820 if (ret_effective_passwords
) {
821 r
= strv_extend(&effective
, data
.decrypted_password
);
826 if (ret_pkcs11_decrypted_passwords
) {
827 r
= strv_extend(&pkcs11_passwords
, data
.decrypted_password
);
836 if (ret_effective_passwords
)
837 *ret_effective_passwords
= TAKE_PTR(effective
);
838 if (ret_pkcs11_decrypted_passwords
)
839 *ret_pkcs11_decrypted_passwords
= TAKE_PTR(pkcs11_passwords
);
844 static int home_create(UserRecord
*h
, UserRecord
**ret_home
) {
845 _cleanup_(strv_free_erasep
) char **effective_passwords
= NULL
, **pkcs11_decrypted_passwords
= NULL
;
846 _cleanup_(user_record_unrefp
) UserRecord
*new_home
= NULL
;
852 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks name, refusing.");
853 if (!uid_is_valid(h
->uid
))
854 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks UID, refusing.");
856 r
= user_record_compile_effective_passwords(h
, &effective_passwords
, &pkcs11_decrypted_passwords
);
860 r
= user_record_test_home_directory_and_warn(h
);
863 if (r
!= USER_TEST_ABSENT
)
864 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
), "Home directory %s already exists, refusing.", user_record_home_directory(h
));
866 /* When the user didn't specify the storage type to use, fix it to be LUKS -- unless we run in a
867 * container where loopback devices and LUKS/DM are not available. Note that we typically default to
868 * the assumption of "classic" storage for most operations. However, if we create a new home, then
869 * let's user LUKS if nothing is specified. */
870 if (h
->storage
< 0) {
871 UserStorage new_storage
;
873 r
= detect_container();
875 return log_error_errno(r
, "Failed to determine whether we are in a container: %m");
877 new_storage
= USER_DIRECTORY
;
879 r
= path_is_fs_type("/home", BTRFS_SUPER_MAGIC
);
881 log_debug_errno(r
, "Failed to determine file system of /home, ignoring: %m");
883 new_storage
= r
> 0 ? USER_SUBVOLUME
: USER_DIRECTORY
;
885 new_storage
= USER_LUKS
;
887 r
= user_record_add_binding(
902 return log_error_errno(r
, "Failed to change storage type to LUKS: %m");
904 if (!h
->image_path_auto
) {
905 h
->image_path_auto
= strjoin("/home/", user_record_user_name_and_realm(h
), new_storage
== USER_LUKS
? ".home" : ".homedir");
906 if (!h
->image_path_auto
)
911 r
= user_record_test_image_path_and_warn(h
);
914 if (!IN_SET(r
, USER_TEST_ABSENT
, USER_TEST_UNDEFINED
, USER_TEST_MAYBE
))
915 return log_error_errno(SYNTHETIC_ERRNO(EEXIST
), "Image path %s already exists, refusing.", user_record_image_path(h
));
917 switch (user_record_storage(h
)) {
920 r
= home_create_luks(h
, pkcs11_decrypted_passwords
, effective_passwords
, &new_home
);
925 r
= home_create_directory_or_subvolume(h
, &new_home
);
929 r
= home_create_fscrypt(h
, effective_passwords
, &new_home
);
933 r
= home_create_cifs(h
, &new_home
);
937 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
),
938 "Creating home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
943 if (user_record_equal(h
, new_home
)) {
948 *ret_home
= TAKE_PTR(new_home
);
952 static int home_remove(UserRecord
*h
) {
953 bool deleted
= false;
960 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks user name, refusing.");
961 if (!IN_SET(user_record_storage(h
), USER_LUKS
, USER_DIRECTORY
, USER_SUBVOLUME
, USER_FSCRYPT
, USER_CIFS
))
962 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Removing home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
964 hd
= user_record_home_directory(h
);
966 r
= user_record_test_home_directory_and_warn(h
);
969 if (r
== USER_TEST_MOUNTED
)
970 return log_error_errno(SYNTHETIC_ERRNO(EBUSY
), "Directory %s is still mounted, refusing.", hd
);
974 r
= user_record_test_image_path_and_warn(h
);
978 ip
= user_record_image_path(h
);
980 switch (user_record_storage(h
)) {
987 if (stat(ip
, &st
) < 0) {
988 if (errno
!= -ENOENT
)
989 return log_error_errno(errno
, "Failed to stat() %s: %m", ip
);
992 if (S_ISREG(st
.st_mode
)) {
993 if (unlink(ip
) < 0) {
995 return log_error_errno(errno
, "Failed to remove %s: %m", ip
);
999 } else if (S_ISBLK(st
.st_mode
))
1000 log_info("Not removing file system on block device %s.", ip
);
1002 return log_error_errno(SYNTHETIC_ERRNO(ENOTBLK
), "Image file %s is neither block device, nor regular, refusing removal.", ip
);
1008 case USER_SUBVOLUME
:
1009 case USER_DIRECTORY
:
1013 r
= rm_rf(ip
, REMOVE_ROOT
|REMOVE_PHYSICAL
|REMOVE_SUBVOLUME
);
1016 return log_warning_errno(r
, "Failed to remove %s: %m", ip
);
1020 /* If the image path and the home directory are the same invalidate the home directory, so
1021 * that we don't remove it anymore */
1022 if (path_equal(ip
, hd
))
1028 /* Nothing else to do here: we won't remove remote stuff. */
1029 log_info("Not removing home directory on remote server.");
1033 assert_not_reached("unknown storage type");
1037 if (rmdir(hd
) < 0) {
1038 if (errno
!= ENOENT
)
1039 return log_error_errno(errno
, "Failed to remove %s, ignoring: %m", hd
);
1045 log_info("Everything completed.");
1047 log_notice("Nothing to remove.");
1054 static int home_validate_update(UserRecord
*h
, HomeSetup
*setup
) {
1055 bool has_mount
= false;
1062 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks user name, refusing.");
1063 if (!uid_is_valid(h
->uid
))
1064 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record lacks UID, refusing.");
1065 if (!IN_SET(user_record_storage(h
), USER_LUKS
, USER_DIRECTORY
, USER_SUBVOLUME
, USER_FSCRYPT
, USER_CIFS
))
1066 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Processing home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
1068 r
= user_record_test_home_directory_and_warn(h
);
1072 has_mount
= r
== USER_TEST_MOUNTED
;
1074 r
= user_record_test_image_path_and_warn(h
);
1077 if (r
== USER_TEST_ABSENT
)
1078 return log_error_errno(SYNTHETIC_ERRNO(ENOENT
), "Image path %s does not exist", user_record_image_path(h
));
1080 switch (user_record_storage(h
)) {
1082 case USER_DIRECTORY
:
1083 case USER_SUBVOLUME
:
1089 r
= home_validate_update_luks(h
, setup
);
1092 if ((r
> 0) != has_mount
)
1093 return log_error_errno(SYNTHETIC_ERRNO(EBUSY
), "Home mount incompletely set up.");
1099 assert_not_reached("unexpected storage type");
1102 return has_mount
; /* return true if the home record is already active */
1105 static int home_update(UserRecord
*h
, UserRecord
**ret
) {
1106 _cleanup_(user_record_unrefp
) UserRecord
*new_home
= NULL
, *header_home
= NULL
, *embedded_home
= NULL
;
1107 _cleanup_(strv_free_erasep
) char **pkcs11_decrypted_passwords
= NULL
;
1108 _cleanup_(home_setup_undo
) HomeSetup setup
= HOME_SETUP_INIT
;
1109 bool already_activated
= false;
1115 r
= user_record_authenticate(h
, h
, &pkcs11_decrypted_passwords
);
1119 r
= home_validate_update(h
, &setup
);
1123 already_activated
= r
> 0;
1125 r
= home_prepare(h
, already_activated
, &pkcs11_decrypted_passwords
, &setup
, &header_home
);
1129 r
= home_load_embedded_identity(h
, setup
.root_fd
, header_home
, USER_RECONCILE_REQUIRE_NEWER
, &pkcs11_decrypted_passwords
, &embedded_home
, &new_home
);
1133 r
= home_store_header_identity_luks(new_home
, &setup
, header_home
);
1137 r
= home_store_embedded_identity(new_home
, setup
.root_fd
, h
->uid
, embedded_home
);
1141 r
= home_extend_embedded_identity(new_home
, h
, &setup
);
1145 r
= home_sync_and_statfs(setup
.root_fd
, NULL
);
1149 r
= home_setup_undo(&setup
);
1153 log_info("Everything completed.");
1155 *ret
= TAKE_PTR(new_home
);
1159 static int home_resize(UserRecord
*h
, UserRecord
**ret
) {
1160 _cleanup_(home_setup_undo
) HomeSetup setup
= HOME_SETUP_INIT
;
1161 _cleanup_(strv_free_erasep
) char **pkcs11_decrypted_passwords
= NULL
;
1162 bool already_activated
= false;
1168 if (h
->disk_size
== UINT64_MAX
)
1169 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "No target size specified, refusing.");
1171 r
= user_record_authenticate(h
, h
, &pkcs11_decrypted_passwords
);
1175 r
= home_validate_update(h
, &setup
);
1179 already_activated
= r
> 0;
1181 switch (user_record_storage(h
)) {
1184 return home_resize_luks(h
, already_activated
, &pkcs11_decrypted_passwords
, &setup
, ret
);
1186 case USER_DIRECTORY
:
1187 case USER_SUBVOLUME
:
1189 return home_resize_directory(h
, already_activated
, &pkcs11_decrypted_passwords
, &setup
, ret
);
1192 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Resizing home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
1196 static int home_passwd(UserRecord
*h
, UserRecord
**ret_home
) {
1197 _cleanup_(user_record_unrefp
) UserRecord
*header_home
= NULL
, *embedded_home
= NULL
, *new_home
= NULL
;
1198 _cleanup_(strv_free_erasep
) char **effective_passwords
= NULL
, **pkcs11_decrypted_passwords
= NULL
;
1199 _cleanup_(home_setup_undo
) HomeSetup setup
= HOME_SETUP_INIT
;
1200 bool already_activated
= false;
1206 if (!IN_SET(user_record_storage(h
), USER_LUKS
, USER_DIRECTORY
, USER_SUBVOLUME
, USER_FSCRYPT
))
1207 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Changing password of home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
1209 r
= user_record_compile_effective_passwords(h
, &effective_passwords
, &pkcs11_decrypted_passwords
);
1213 r
= home_validate_update(h
, &setup
);
1217 already_activated
= r
> 0;
1219 r
= home_prepare(h
, already_activated
, &pkcs11_decrypted_passwords
, &setup
, &header_home
);
1223 r
= home_load_embedded_identity(h
, setup
.root_fd
, header_home
, USER_RECONCILE_REQUIRE_NEWER_OR_EQUAL
, &pkcs11_decrypted_passwords
, &embedded_home
, &new_home
);
1227 switch (user_record_storage(h
)) {
1230 r
= home_passwd_luks(h
, &setup
, pkcs11_decrypted_passwords
, effective_passwords
);
1236 r
= home_passwd_fscrypt(h
, &setup
, pkcs11_decrypted_passwords
, effective_passwords
);
1245 r
= home_store_header_identity_luks(new_home
, &setup
, header_home
);
1249 r
= home_store_embedded_identity(new_home
, setup
.root_fd
, h
->uid
, embedded_home
);
1253 r
= home_extend_embedded_identity(new_home
, h
, &setup
);
1257 r
= home_sync_and_statfs(setup
.root_fd
, NULL
);
1261 r
= home_setup_undo(&setup
);
1265 log_info("Everything completed.");
1267 *ret_home
= TAKE_PTR(new_home
);
1271 static int home_inspect(UserRecord
*h
, UserRecord
**ret_home
) {
1272 _cleanup_(user_record_unrefp
) UserRecord
*header_home
= NULL
, *new_home
= NULL
;
1273 _cleanup_(home_setup_undo
) HomeSetup setup
= HOME_SETUP_INIT
;
1274 _cleanup_(strv_free_erasep
) char **pkcs11_decrypted_passwords
= NULL
;
1275 bool already_activated
= false;
1281 r
= user_record_authenticate(h
, h
, &pkcs11_decrypted_passwords
);
1285 r
= home_validate_update(h
, &setup
);
1289 already_activated
= r
> 0;
1291 r
= home_prepare(h
, already_activated
, &pkcs11_decrypted_passwords
, &setup
, &header_home
);
1295 r
= home_load_embedded_identity(h
, setup
.root_fd
, header_home
, USER_RECONCILE_ANY
, &pkcs11_decrypted_passwords
, NULL
, &new_home
);
1299 r
= home_extend_embedded_identity(new_home
, h
, &setup
);
1303 r
= home_setup_undo(&setup
);
1307 log_info("Everything completed.");
1309 *ret_home
= TAKE_PTR(new_home
);
1313 static int home_lock(UserRecord
*h
) {
1319 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record incomplete, refusing.");
1320 if (user_record_storage(h
) != USER_LUKS
)
1321 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Locking home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
1323 r
= user_record_test_home_directory_and_warn(h
);
1326 if (r
!= USER_TEST_MOUNTED
)
1327 return log_error_errno(SYNTHETIC_ERRNO(ENOEXEC
), "Home directory of %s is not mounted, can't lock.", h
->user_name
);
1329 r
= home_lock_luks(h
);
1333 log_info("Everything completed.");
1337 static int home_unlock(UserRecord
*h
) {
1338 _cleanup_(strv_free_erasep
) char **pkcs11_decrypted_passwords
= NULL
;
1344 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "User record incomplete, refusing.");
1345 if (user_record_storage(h
) != USER_LUKS
)
1346 return log_error_errno(SYNTHETIC_ERRNO(ENOTTY
), "Unlocking home directories of type '%s' currently not supported.", user_storage_to_string(user_record_storage(h
)));
1348 /* Note that we don't check if $HOME is actually mounted, since we want to avoid disk accesses on
1349 * that mount until we have resumed the device. */
1351 r
= user_record_authenticate(h
, h
, &pkcs11_decrypted_passwords
);
1355 r
= home_unlock_luks(h
, &pkcs11_decrypted_passwords
);
1359 log_info("Everything completed.");
1363 static int run(int argc
, char *argv
[]) {
1364 _cleanup_(user_record_unrefp
) UserRecord
*home
= NULL
, *new_home
= NULL
;
1365 _cleanup_(json_variant_unrefp
) JsonVariant
*v
= NULL
;
1366 _cleanup_(fclosep
) FILE *opened_file
= NULL
;
1367 unsigned line
= 0, column
= 0;
1368 const char *json_path
= NULL
;
1373 start
= now(CLOCK_MONOTONIC
);
1375 log_setup_service();
1379 if (argc
< 2 || argc
> 3)
1380 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "This program takes one or two arguments.");
1383 json_path
= argv
[2];
1385 opened_file
= fopen(json_path
, "re");
1387 return log_error_errno(errno
, "Failed to open %s: %m", json_path
);
1389 json_file
= opened_file
;
1391 json_path
= "<stdin>";
1395 r
= json_parse_file(json_file
, json_path
, JSON_PARSE_SENSITIVE
, &v
, &line
, &column
);
1397 return log_error_errno(r
, "[%s:%u:%u] Failed to parse JSON data: %m", json_path
, line
, column
);
1399 home
= user_record_new();
1403 r
= user_record_load(home
, v
, USER_RECORD_LOAD_FULL
|USER_RECORD_LOG
);
1407 /* Well known return values of these operations, that systemd-homed knows and converts to proper D-Bus errors:
1409 * EMSGSIZE → file systems of this type cannnot be shrinked
1410 * ETXTBSY → file systems of this type can only be shrinked offline
1411 * ERANGE → file system size too small
1412 * ENOLINK → system does not support selected storage backend
1413 * EPROTONOSUPPORT → system does not support selected file system
1414 * ENOTTY → operation not support on this storage
1415 * ESOCKTNOSUPPORT → operation not support on this file system
1416 * ENOKEY → password incorrect (or not sufficient, or not supplied)
1417 * EBADSLT → similar, but PKCS#11 device is defined and might be able to provide password, if it was plugged in which it is not
1418 * ENOANO → suitable PKCS#11 device found, but PIN is missing to unlock it
1419 * ERFKILL → suitable PKCS#11 device found, but OK to ask for on-device interactive authentication not given
1420 * EOWNERDEAD → suitable PKCS#11 device found, but its PIN is locked
1421 * ENOLCK → suitable PKCS#11 device found, but PIN incorrect
1422 * ETOOMANYREFS → suitable PKCS#11 device found, but PIN incorrect, and only few tries left
1423 * EUCLEAN → suitable PKCS#11 device found, but PIN incorrect, and only one try left
1424 * EBUSY → file system is currently active
1425 * ENOEXEC → file system is currently not active
1426 * ENOSPC → not enough disk space for operation
1429 if (streq(argv
[1], "activate"))
1430 r
= home_activate(home
, &new_home
);
1431 else if (streq(argv
[1], "deactivate"))
1432 r
= home_deactivate(home
, false);
1433 else if (streq(argv
[1], "deactivate-force"))
1434 r
= home_deactivate(home
, true);
1435 else if (streq(argv
[1], "create"))
1436 r
= home_create(home
, &new_home
);
1437 else if (streq(argv
[1], "remove"))
1438 r
= home_remove(home
);
1439 else if (streq(argv
[1], "update"))
1440 r
= home_update(home
, &new_home
);
1441 else if (streq(argv
[1], "resize"))
1442 r
= home_resize(home
, &new_home
);
1443 else if (streq(argv
[1], "passwd"))
1444 r
= home_passwd(home
, &new_home
);
1445 else if (streq(argv
[1], "inspect"))
1446 r
= home_inspect(home
, &new_home
);
1447 else if (streq(argv
[1], "lock"))
1448 r
= home_lock(home
);
1449 else if (streq(argv
[1], "unlock"))
1450 r
= home_unlock(home
);
1452 return log_error_errno(SYNTHETIC_ERRNO(EINVAL
), "Unknown verb '%s'.", argv
[1]);
1453 if (r
== -ENOKEY
&& !strv_isempty(home
->password
)) { /* There were passwords specified but they were incorrect */
1456 /* Make sure bad password replies always take at least 3s, and if longer multiples of 3s, so
1457 * that it's not clear how long we actually needed for our calculations. */
1458 n
= now(CLOCK_MONOTONIC
);
1461 d
= usec_sub_unsigned(n
, start
);
1462 if (d
> BAD_PASSWORD_DELAY_USEC
)
1463 end
= start
+ DIV_ROUND_UP(d
, BAD_PASSWORD_DELAY_USEC
) * BAD_PASSWORD_DELAY_USEC
;
1465 end
= start
+ BAD_PASSWORD_DELAY_USEC
;
1468 (void) usleep(usec_sub_unsigned(end
, n
));
1473 /* We always pass the new record back, regardless if it changed or not. This allows our caller to
1474 * prepare a fresh record, send to us, and only if it works use it without having to keep a local
1477 json_variant_dump(new_home
->json
, JSON_FORMAT_NEWLINE
, stdout
, NULL
);
1482 DEFINE_MAIN_FUNCTION(run
);