1 /* SPDX-License-Identifier: LGPL-2.1+ */
3 #include <linux/dm-ioctl.h>
4 #include <linux/loop.h>
12 #include "architecture.h"
13 #include "ask-password-api.h"
14 #include "blkid-util.h"
15 #include "blockdev-util.h"
17 #include "crypt-util.h"
19 #include "device-nodes.h"
20 #include "device-util.h"
21 #include "dissect-image.h"
27 #include "hexdecoct.h"
28 #include "hostname-util.h"
29 #include "id128-util.h"
31 #include "mount-util.h"
32 #include "mountpoint-util.h"
33 #include "nulstr-util.h"
35 #include "path-util.h"
36 #include "process-util.h"
37 #include "raw-clone.h"
38 #include "signal-util.h"
39 #include "stat-util.h"
40 #include "stdio-util.h"
41 #include "string-table.h"
42 #include "string-util.h"
44 #include "tmpfile-util.h"
45 #include "udev-util.h"
46 #include "user-util.h"
47 #include "xattr-util.h"
49 int probe_filesystem(const char *node
, char **ret_fstype
) {
50 /* Try to find device content type and return it in *ret_fstype. If nothing is found,
51 * 0/NULL will be returned. -EUCLEAN will be returned for ambigous results, and an
52 * different error otherwise. */
55 _cleanup_(blkid_free_probep
) blkid_probe b
= NULL
;
60 b
= blkid_new_probe_from_filename(node
);
62 return -errno
?: -ENOMEM
;
64 blkid_probe_enable_superblocks(b
, 1);
65 blkid_probe_set_superblocks_flags(b
, BLKID_SUBLKS_TYPE
);
68 r
= blkid_do_safeprobe(b
);
70 log_debug("No type detected on partition %s", node
);
74 log_debug("Results ambiguous for partition %s", node
);
78 return -errno
?: -EIO
;
80 (void) blkid_probe_lookup_value(b
, "TYPE", &fstype
, NULL
);
102 /* Detect RPMB and Boot partitions, which are not listed by blkid.
103 * See https://github.com/systemd/systemd/issues/5806. */
104 static bool device_is_mmc_special_partition(sd_device
*d
) {
109 if (sd_device_get_sysname(d
, &sysname
) < 0)
112 return startswith(sysname
, "mmcblk") &&
113 (endswith(sysname
, "rpmb") || endswith(sysname
, "boot0") || endswith(sysname
, "boot1"));
116 static bool device_is_block(sd_device
*d
) {
121 if (sd_device_get_subsystem(d
, &ss
) < 0)
124 return streq(ss
, "block");
127 static int enumerator_for_parent(sd_device
*d
, sd_device_enumerator
**ret
) {
128 _cleanup_(sd_device_enumerator_unrefp
) sd_device_enumerator
*e
= NULL
;
134 r
= sd_device_enumerator_new(&e
);
138 r
= sd_device_enumerator_allow_uninitialized(e
);
142 r
= sd_device_enumerator_add_match_parent(e
, d
);
150 /* how many times to wait for the device nodes to appear */
151 #define N_DEVICE_NODE_LIST_ATTEMPTS 10
153 static int wait_for_partitions_to_appear(
156 unsigned num_partitions
,
157 DissectImageFlags flags
,
158 sd_device_enumerator
**ret_enumerator
) {
160 _cleanup_(sd_device_enumerator_unrefp
) sd_device_enumerator
*e
= NULL
;
167 assert(ret_enumerator
);
169 r
= enumerator_for_parent(d
, &e
);
173 /* Count the partitions enumerated by the kernel */
175 FOREACH_DEVICE(e
, q
) {
176 if (sd_device_get_devnum(q
, NULL
) < 0)
178 if (!device_is_block(q
))
180 if (device_is_mmc_special_partition(q
))
183 if (!FLAGS_SET(flags
, DISSECT_IMAGE_NO_UDEV
)) {
184 r
= device_wait_for_initialization(q
, "block", NULL
);
192 if (n
== num_partitions
+ 1) {
193 *ret_enumerator
= TAKE_PTR(e
);
194 return 0; /* success! */
196 if (n
> num_partitions
+ 1)
197 return log_debug_errno(SYNTHETIC_ERRNO(EIO
),
198 "blkid and kernel partition lists do not match.");
200 /* The kernel has probed fewer partitions than blkid? Maybe the kernel prober is still running or it
201 * got EBUSY because udev already opened the device. Let's reprobe the device, which is a synchronous
202 * call that waits until probing is complete. */
204 for (unsigned j
= 0; ; j
++) {
208 if (ioctl(fd
, BLKRRPART
, 0) >= 0)
212 struct loop_info64 info
;
214 /* If we are running on a loop device that has partition scanning off, return
215 * an explicit recognizable error about this, so that callers can generate a
216 * proper message explaining the situation. */
218 if (ioctl(fd
, LOOP_GET_STATUS64
, &info
) >= 0 && (info
.lo_flags
& LO_FLAGS_PARTSCAN
) == 0) {
219 log_debug("Device is a loop device and partition scanning is off!");
220 return -EPROTONOSUPPORT
;
226 /* If something else has the device open, such as an udev rule, the ioctl will return
227 * EBUSY. Since there's no way to wait until it isn't busy anymore, let's just wait a bit,
230 * This is really something they should fix in the kernel! */
231 (void) usleep(50 * USEC_PER_MSEC
);
235 return -EAGAIN
; /* no success yet, try again */
238 static int loop_wait_for_partitions_to_appear(
241 unsigned num_partitions
,
242 DissectImageFlags flags
,
243 sd_device_enumerator
**ret_enumerator
) {
244 _cleanup_(sd_device_unrefp
) sd_device
*device
= NULL
;
249 assert(ret_enumerator
);
251 log_debug("Waiting for device (parent + %d partitions) to appear...", num_partitions
);
253 if (!FLAGS_SET(flags
, DISSECT_IMAGE_NO_UDEV
)) {
254 r
= device_wait_for_initialization(d
, "block", &device
);
258 device
= sd_device_ref(d
);
260 for (unsigned i
= 0; i
< N_DEVICE_NODE_LIST_ATTEMPTS
; i
++) {
261 r
= wait_for_partitions_to_appear(fd
, device
, num_partitions
, flags
, ret_enumerator
);
266 return log_debug_errno(SYNTHETIC_ERRNO(ENXIO
),
267 "Kernel partitions dit not appear within %d attempts",
268 N_DEVICE_NODE_LIST_ATTEMPTS
);
275 const void *root_hash
,
276 size_t root_hash_size
,
277 DissectImageFlags flags
,
278 DissectedImage
**ret
) {
281 sd_id128_t root_uuid
= SD_ID128_NULL
, verity_uuid
= SD_ID128_NULL
;
282 _cleanup_(sd_device_enumerator_unrefp
) sd_device_enumerator
*e
= NULL
;
283 bool is_gpt
, is_mbr
, generic_rw
, multiple_generic
= false;
284 _cleanup_(sd_device_unrefp
) sd_device
*d
= NULL
;
285 _cleanup_(dissected_image_unrefp
) DissectedImage
*m
= NULL
;
286 _cleanup_(blkid_free_probep
) blkid_probe b
= NULL
;
287 _cleanup_free_
char *generic_node
= NULL
;
288 sd_id128_t generic_uuid
= SD_ID128_NULL
;
289 const char *pttype
= NULL
;
298 assert(root_hash
|| root_hash_size
== 0);
300 /* Probes a disk image, and returns information about what it found in *ret.
302 * Returns -ENOPKG if no suitable partition table or file system could be found.
303 * Returns -EADDRNOTAVAIL if a root hash was specified but no matching root/verity partitions found. */
306 /* If a root hash is supplied, then we use the root partition that has a UUID that match the first
307 * 128bit of the root hash. And we use the verity partition that has a UUID that match the final
310 if (root_hash_size
< sizeof(sd_id128_t
))
313 memcpy(&root_uuid
, root_hash
, sizeof(sd_id128_t
));
314 memcpy(&verity_uuid
, (const uint8_t*) root_hash
+ root_hash_size
- sizeof(sd_id128_t
), sizeof(sd_id128_t
));
316 if (sd_id128_is_null(root_uuid
))
318 if (sd_id128_is_null(verity_uuid
))
322 if (fstat(fd
, &st
) < 0)
325 if (!S_ISBLK(st
.st_mode
))
328 b
= blkid_new_probe();
333 r
= blkid_probe_set_device(b
, fd
, 0, 0);
335 return -errno
?: -ENOMEM
;
337 if ((flags
& DISSECT_IMAGE_GPT_ONLY
) == 0) {
338 /* Look for file system superblocks, unless we only shall look for GPT partition tables */
339 blkid_probe_enable_superblocks(b
, 1);
340 blkid_probe_set_superblocks_flags(b
, BLKID_SUBLKS_TYPE
|BLKID_SUBLKS_USAGE
);
343 blkid_probe_enable_partitions(b
, 1);
344 blkid_probe_set_partitions_flags(b
, BLKID_PARTS_ENTRY_DETAILS
);
347 r
= blkid_do_safeprobe(b
);
348 if (IN_SET(r
, -2, 1))
349 return log_debug_errno(SYNTHETIC_ERRNO(ENOPKG
), "Failed to identify any partition table.");
351 return -errno
?: -EIO
;
353 m
= new0(DissectedImage
, 1);
357 r
= sd_device_new_from_devnum(&d
, 'b', st
.st_rdev
);
361 if (!(flags
& DISSECT_IMAGE_GPT_ONLY
) &&
362 (flags
& DISSECT_IMAGE_REQUIRE_ROOT
)) {
363 const char *usage
= NULL
;
365 (void) blkid_probe_lookup_value(b
, "USAGE", &usage
, NULL
);
366 if (STRPTR_IN_SET(usage
, "filesystem", "crypto")) {
367 _cleanup_free_
char *t
= NULL
, *n
= NULL
;
368 const char *fstype
= NULL
;
370 /* OK, we have found a file system, that's our root partition then. */
371 (void) blkid_probe_lookup_value(b
, "TYPE", &fstype
, NULL
);
379 r
= device_path_make_major_minor(st
.st_mode
, st
.st_rdev
, &n
);
383 m
->partitions
[PARTITION_ROOT
] = (DissectedPartition
) {
387 .architecture
= _ARCHITECTURE_INVALID
,
388 .fstype
= TAKE_PTR(t
),
392 m
->encrypted
= streq_ptr(fstype
, "crypto_LUKS");
394 r
= loop_wait_for_partitions_to_appear(fd
, d
, 0, flags
, &e
);
404 (void) blkid_probe_lookup_value(b
, "PTTYPE", &pttype
, NULL
);
408 is_gpt
= streq_ptr(pttype
, "gpt");
409 is_mbr
= streq_ptr(pttype
, "dos");
411 if (!is_gpt
&& ((flags
& DISSECT_IMAGE_GPT_ONLY
) || !is_mbr
))
415 pl
= blkid_probe_get_partitions(b
);
417 return -errno
?: -ENOMEM
;
419 r
= loop_wait_for_partitions_to_appear(fd
, d
, blkid_partlist_numof_partitions(pl
), flags
, &e
);
423 FOREACH_DEVICE(e
, q
) {
424 unsigned long long pflags
;
430 r
= sd_device_get_devnum(q
, &qn
);
434 if (st
.st_rdev
== qn
)
437 if (!device_is_block(q
))
440 if (device_is_mmc_special_partition(q
))
443 r
= sd_device_get_devname(q
, &node
);
447 pp
= blkid_partlist_devno_to_partition(pl
, qn
);
451 pflags
= blkid_partition_get_flags(pp
);
453 nr
= blkid_partition_get_partno(pp
);
458 int designator
= _PARTITION_DESIGNATOR_INVALID
, architecture
= _ARCHITECTURE_INVALID
;
459 const char *stype
, *sid
, *fstype
= NULL
;
460 sd_id128_t type_id
, id
;
463 sid
= blkid_partition_get_uuid(pp
);
466 if (sd_id128_from_string(sid
, &id
) < 0)
469 stype
= blkid_partition_get_type_string(pp
);
472 if (sd_id128_from_string(stype
, &type_id
) < 0)
475 if (sd_id128_equal(type_id
, GPT_HOME
)) {
477 if (pflags
& GPT_FLAG_NO_AUTO
)
480 designator
= PARTITION_HOME
;
481 rw
= !(pflags
& GPT_FLAG_READ_ONLY
);
482 } else if (sd_id128_equal(type_id
, GPT_SRV
)) {
484 if (pflags
& GPT_FLAG_NO_AUTO
)
487 designator
= PARTITION_SRV
;
488 rw
= !(pflags
& GPT_FLAG_READ_ONLY
);
489 } else if (sd_id128_equal(type_id
, GPT_ESP
)) {
491 /* Note that we don't check the GPT_FLAG_NO_AUTO flag for the ESP, as it is not defined
492 * there. We instead check the GPT_FLAG_NO_BLOCK_IO_PROTOCOL, as recommended by the
493 * UEFI spec (See "12.3.3 Number and Location of System Partitions"). */
495 if (pflags
& GPT_FLAG_NO_BLOCK_IO_PROTOCOL
)
498 designator
= PARTITION_ESP
;
501 } else if (sd_id128_equal(type_id
, GPT_XBOOTLDR
)) {
503 if (pflags
& GPT_FLAG_NO_AUTO
)
506 designator
= PARTITION_XBOOTLDR
;
507 rw
= !(pflags
& GPT_FLAG_READ_ONLY
);
509 #ifdef GPT_ROOT_NATIVE
510 else if (sd_id128_equal(type_id
, GPT_ROOT_NATIVE
)) {
512 if (pflags
& GPT_FLAG_NO_AUTO
)
515 /* If a root ID is specified, ignore everything but the root id */
516 if (!sd_id128_is_null(root_uuid
) && !sd_id128_equal(root_uuid
, id
))
519 designator
= PARTITION_ROOT
;
520 architecture
= native_architecture();
521 rw
= !(pflags
& GPT_FLAG_READ_ONLY
);
522 } else if (sd_id128_equal(type_id
, GPT_ROOT_NATIVE_VERITY
)) {
524 if (pflags
& GPT_FLAG_NO_AUTO
)
527 m
->can_verity
= true;
529 /* Ignore verity unless a root hash is specified */
530 if (sd_id128_is_null(verity_uuid
) || !sd_id128_equal(verity_uuid
, id
))
533 designator
= PARTITION_ROOT_VERITY
;
534 fstype
= "DM_verity_hash";
535 architecture
= native_architecture();
539 #ifdef GPT_ROOT_SECONDARY
540 else if (sd_id128_equal(type_id
, GPT_ROOT_SECONDARY
)) {
542 if (pflags
& GPT_FLAG_NO_AUTO
)
545 /* If a root ID is specified, ignore everything but the root id */
546 if (!sd_id128_is_null(root_uuid
) && !sd_id128_equal(root_uuid
, id
))
549 designator
= PARTITION_ROOT_SECONDARY
;
550 architecture
= SECONDARY_ARCHITECTURE
;
551 rw
= !(pflags
& GPT_FLAG_READ_ONLY
);
552 } else if (sd_id128_equal(type_id
, GPT_ROOT_SECONDARY_VERITY
)) {
554 if (pflags
& GPT_FLAG_NO_AUTO
)
557 m
->can_verity
= true;
559 /* Ignore verity unless root has is specified */
560 if (sd_id128_is_null(verity_uuid
) || !sd_id128_equal(verity_uuid
, id
))
563 designator
= PARTITION_ROOT_SECONDARY_VERITY
;
564 fstype
= "DM_verity_hash";
565 architecture
= SECONDARY_ARCHITECTURE
;
569 else if (sd_id128_equal(type_id
, GPT_SWAP
)) {
571 if (pflags
& GPT_FLAG_NO_AUTO
)
574 designator
= PARTITION_SWAP
;
576 } else if (sd_id128_equal(type_id
, GPT_LINUX_GENERIC
)) {
578 if (pflags
& GPT_FLAG_NO_AUTO
)
582 multiple_generic
= true;
585 generic_rw
= !(pflags
& GPT_FLAG_READ_ONLY
);
587 generic_node
= strdup(node
);
593 if (designator
!= _PARTITION_DESIGNATOR_INVALID
) {
594 _cleanup_free_
char *t
= NULL
, *n
= NULL
;
597 if (m
->partitions
[designator
].found
)
610 m
->partitions
[designator
] = (DissectedPartition
) {
614 .architecture
= architecture
,
616 .fstype
= TAKE_PTR(t
),
623 switch (blkid_partition_get_type(pp
)) {
625 case 0x83: /* Linux partition */
627 if (pflags
!= 0x80) /* Bootable flag */
631 multiple_generic
= true;
635 generic_node
= strdup(node
);
642 case 0xEA: { /* Boot Loader Spec extended $BOOT partition */
643 _cleanup_free_
char *n
= NULL
;
644 sd_id128_t id
= SD_ID128_NULL
;
648 if (m
->partitions
[PARTITION_XBOOTLDR
].found
)
651 sid
= blkid_partition_get_uuid(pp
);
653 (void) sd_id128_from_string(sid
, &id
);
659 m
->partitions
[PARTITION_XBOOTLDR
] = (DissectedPartition
) {
663 .architecture
= _ARCHITECTURE_INVALID
,
673 if (!m
->partitions
[PARTITION_ROOT
].found
) {
674 /* No root partition found? Then let's see if ther's one for the secondary architecture. And if not
675 * either, then check if there's a single generic one, and use that. */
677 if (m
->partitions
[PARTITION_ROOT_VERITY
].found
)
678 return -EADDRNOTAVAIL
;
680 if (m
->partitions
[PARTITION_ROOT_SECONDARY
].found
) {
681 m
->partitions
[PARTITION_ROOT
] = m
->partitions
[PARTITION_ROOT_SECONDARY
];
682 zero(m
->partitions
[PARTITION_ROOT_SECONDARY
]);
684 m
->partitions
[PARTITION_ROOT_VERITY
] = m
->partitions
[PARTITION_ROOT_SECONDARY_VERITY
];
685 zero(m
->partitions
[PARTITION_ROOT_SECONDARY_VERITY
]);
687 } else if (flags
& DISSECT_IMAGE_REQUIRE_ROOT
) {
689 /* If the root has was set, then we won't fallback to a generic node, because the root hash
692 return -EADDRNOTAVAIL
;
694 /* If we didn't find a generic node, then we can't fix this up either */
698 /* If we didn't find a properly marked root partition, but we did find a single suitable
699 * generic Linux partition, then use this as root partition, if the caller asked for it. */
700 if (multiple_generic
)
703 m
->partitions
[PARTITION_ROOT
] = (DissectedPartition
) {
706 .partno
= generic_nr
,
707 .architecture
= _ARCHITECTURE_INVALID
,
708 .node
= TAKE_PTR(generic_node
),
709 .uuid
= generic_uuid
,
715 if (!m
->partitions
[PARTITION_ROOT_VERITY
].found
|| !m
->partitions
[PARTITION_ROOT
].found
)
716 return -EADDRNOTAVAIL
;
718 /* If we found the primary root with the hash, then we definitely want to suppress any secondary root
719 * (which would be weird, after all the root hash should only be assigned to one pair of
721 m
->partitions
[PARTITION_ROOT_SECONDARY
].found
= false;
722 m
->partitions
[PARTITION_ROOT_SECONDARY_VERITY
].found
= false;
724 /* If we found a verity setup, then the root partition is necessarily read-only. */
725 m
->partitions
[PARTITION_ROOT
].rw
= false;
733 /* Fill in file system types if we don't know them yet. */
734 for (i
= 0; i
< _PARTITION_DESIGNATOR_MAX
; i
++) {
735 DissectedPartition
*p
= m
->partitions
+ i
;
740 if (!p
->fstype
&& p
->node
) {
741 r
= probe_filesystem(p
->node
, &p
->fstype
);
742 if (r
< 0 && r
!= -EUCLEAN
)
746 if (streq_ptr(p
->fstype
, "crypto_LUKS"))
749 if (p
->fstype
&& fstype_is_ro(p
->fstype
))
761 DissectedImage
* dissected_image_unref(DissectedImage
*m
) {
767 for (i
= 0; i
< _PARTITION_DESIGNATOR_MAX
; i
++) {
768 free(m
->partitions
[i
].fstype
);
769 free(m
->partitions
[i
].node
);
770 free(m
->partitions
[i
].decrypted_fstype
);
771 free(m
->partitions
[i
].decrypted_node
);
775 strv_free(m
->machine_info
);
776 strv_free(m
->os_release
);
781 static int is_loop_device(const char *path
) {
782 char s
[SYS_BLOCK_PATH_MAX("/../loop/")];
787 if (stat(path
, &st
) < 0)
790 if (!S_ISBLK(st
.st_mode
))
793 xsprintf_sys_block_path(s
, "/loop/", st
.st_dev
);
794 if (access(s
, F_OK
) < 0) {
798 /* The device itself isn't a loop device, but maybe it's a partition and its parent is? */
799 xsprintf_sys_block_path(s
, "/../loop/", st
.st_dev
);
800 if (access(s
, F_OK
) < 0)
801 return errno
== ENOENT
? false : -errno
;
807 static int mount_partition(
808 DissectedPartition
*m
,
810 const char *directory
,
812 DissectImageFlags flags
) {
814 _cleanup_free_
char *chased
= NULL
, *options
= NULL
;
815 const char *p
, *node
, *fstype
;
822 node
= m
->decrypted_node
?: m
->node
;
823 fstype
= m
->decrypted_fstype
?: m
->fstype
;
825 if (!m
->found
|| !node
|| !fstype
)
828 /* Stacked encryption? Yuck */
829 if (streq_ptr(fstype
, "crypto_LUKS"))
832 rw
= m
->rw
&& !(flags
& DISSECT_IMAGE_READ_ONLY
);
835 r
= chase_symlinks(directory
, where
, CHASE_PREFIX_ROOT
, &chased
);
843 /* If requested, turn on discard support. */
844 if (fstype_can_discard(fstype
) &&
845 ((flags
& DISSECT_IMAGE_DISCARD
) ||
846 ((flags
& DISSECT_IMAGE_DISCARD_ON_LOOP
) && is_loop_device(m
->node
)))) {
847 options
= strdup("discard");
852 if (uid_is_valid(uid_shift
) && uid_shift
!= 0 && fstype_can_uid_gid(fstype
)) {
853 _cleanup_free_
char *uid_option
= NULL
;
855 if (asprintf(&uid_option
, "uid=" UID_FMT
",gid=" GID_FMT
, uid_shift
, (gid_t
) uid_shift
) < 0)
858 if (!strextend_with_separator(&options
, ",", uid_option
, NULL
))
862 r
= mount_verbose(LOG_DEBUG
, node
, p
, fstype
, MS_NODEV
|(rw
? 0 : MS_RDONLY
), options
);
869 int dissected_image_mount(DissectedImage
*m
, const char *where
, uid_t uid_shift
, DissectImageFlags flags
) {
875 if (!m
->partitions
[PARTITION_ROOT
].found
)
878 if ((flags
& DISSECT_IMAGE_MOUNT_NON_ROOT_ONLY
) == 0) {
879 r
= mount_partition(m
->partitions
+ PARTITION_ROOT
, where
, NULL
, uid_shift
, flags
);
883 if (flags
& DISSECT_IMAGE_VALIDATE_OS
) {
884 r
= path_is_os_tree(where
);
892 if (flags
& DISSECT_IMAGE_MOUNT_ROOT_ONLY
)
895 r
= mount_partition(m
->partitions
+ PARTITION_HOME
, where
, "/home", uid_shift
, flags
);
899 r
= mount_partition(m
->partitions
+ PARTITION_SRV
, where
, "/srv", uid_shift
, flags
);
903 boot_mounted
= mount_partition(m
->partitions
+ PARTITION_XBOOTLDR
, where
, "/boot", uid_shift
, flags
);
904 if (boot_mounted
< 0)
907 if (m
->partitions
[PARTITION_ESP
].found
) {
908 /* Mount the ESP to /efi if it exists. If it doesn't exist, use /boot instead, but only if it
909 * exists and is empty, and we didn't already mount the XBOOTLDR partition into it. */
911 r
= chase_symlinks("/efi", where
, CHASE_PREFIX_ROOT
, NULL
);
913 r
= mount_partition(m
->partitions
+ PARTITION_ESP
, where
, "/efi", uid_shift
, flags
);
917 } else if (boot_mounted
<= 0) {
918 _cleanup_free_
char *p
= NULL
;
920 r
= chase_symlinks("/boot", where
, CHASE_PREFIX_ROOT
, &p
);
921 if (r
>= 0 && dir_is_empty(p
) > 0) {
922 r
= mount_partition(m
->partitions
+ PARTITION_ESP
, where
, "/boot", uid_shift
, flags
);
932 #if HAVE_LIBCRYPTSETUP
933 typedef struct DecryptedPartition
{
934 struct crypt_device
*device
;
937 } DecryptedPartition
;
939 struct DecryptedImage
{
940 DecryptedPartition
*decrypted
;
946 DecryptedImage
* decrypted_image_unref(DecryptedImage
* d
) {
947 #if HAVE_LIBCRYPTSETUP
954 for (i
= 0; i
< d
->n_decrypted
; i
++) {
955 DecryptedPartition
*p
= d
->decrypted
+ i
;
957 if (p
->device
&& p
->name
&& !p
->relinquished
) {
958 r
= crypt_deactivate(p
->device
, p
->name
);
960 log_debug_errno(r
, "Failed to deactivate encrypted partition %s", p
->name
);
964 crypt_free(p
->device
);
973 #if HAVE_LIBCRYPTSETUP
975 static int make_dm_name_and_node(const void *original_node
, const char *suffix
, char **ret_name
, char **ret_node
) {
976 _cleanup_free_
char *name
= NULL
, *node
= NULL
;
979 assert(original_node
);
984 base
= strrchr(original_node
, '/');
991 name
= strjoin(base
, suffix
);
994 if (!filename_is_valid(name
))
997 node
= strjoin(crypt_get_dir(), "/", name
);
1001 *ret_name
= TAKE_PTR(name
);
1002 *ret_node
= TAKE_PTR(node
);
1007 static int decrypt_partition(
1008 DissectedPartition
*m
,
1009 const char *passphrase
,
1010 DissectImageFlags flags
,
1011 DecryptedImage
*d
) {
1013 _cleanup_free_
char *node
= NULL
, *name
= NULL
;
1014 _cleanup_(crypt_freep
) struct crypt_device
*cd
= NULL
;
1020 if (!m
->found
|| !m
->node
|| !m
->fstype
)
1023 if (!streq(m
->fstype
, "crypto_LUKS"))
1029 r
= make_dm_name_and_node(m
->node
, "-decrypted", &name
, &node
);
1033 if (!GREEDY_REALLOC0(d
->decrypted
, d
->n_allocated
, d
->n_decrypted
+ 1))
1036 r
= crypt_init(&cd
, m
->node
);
1038 return log_debug_errno(r
, "Failed to initialize dm-crypt: %m");
1040 r
= crypt_load(cd
, CRYPT_LUKS
, NULL
);
1042 return log_debug_errno(r
, "Failed to load LUKS metadata: %m");
1044 r
= crypt_activate_by_passphrase(cd
, name
, CRYPT_ANY_SLOT
, passphrase
, strlen(passphrase
),
1045 ((flags
& DISSECT_IMAGE_READ_ONLY
) ? CRYPT_ACTIVATE_READONLY
: 0) |
1046 ((flags
& DISSECT_IMAGE_DISCARD_ON_CRYPTO
) ? CRYPT_ACTIVATE_ALLOW_DISCARDS
: 0));
1048 log_debug_errno(r
, "Failed to activate LUKS device: %m");
1049 return r
== -EPERM
? -EKEYREJECTED
: r
;
1052 d
->decrypted
[d
->n_decrypted
].name
= TAKE_PTR(name
);
1053 d
->decrypted
[d
->n_decrypted
].device
= TAKE_PTR(cd
);
1056 m
->decrypted_node
= TAKE_PTR(node
);
1061 static int verity_partition(
1062 DissectedPartition
*m
,
1063 DissectedPartition
*v
,
1064 const void *root_hash
,
1065 size_t root_hash_size
,
1066 DissectImageFlags flags
,
1067 DecryptedImage
*d
) {
1069 _cleanup_free_
char *node
= NULL
, *name
= NULL
;
1070 _cleanup_(crypt_freep
) struct crypt_device
*cd
= NULL
;
1079 if (!m
->found
|| !m
->node
|| !m
->fstype
)
1081 if (!v
->found
|| !v
->node
|| !v
->fstype
)
1084 if (!streq(v
->fstype
, "DM_verity_hash"))
1087 r
= make_dm_name_and_node(m
->node
, "-verity", &name
, &node
);
1091 if (!GREEDY_REALLOC0(d
->decrypted
, d
->n_allocated
, d
->n_decrypted
+ 1))
1094 r
= crypt_init(&cd
, v
->node
);
1098 r
= crypt_load(cd
, CRYPT_VERITY
, NULL
);
1102 r
= crypt_set_data_device(cd
, m
->node
);
1106 r
= crypt_activate_by_volume_key(cd
, name
, root_hash
, root_hash_size
, CRYPT_ACTIVATE_READONLY
);
1110 d
->decrypted
[d
->n_decrypted
].name
= TAKE_PTR(name
);
1111 d
->decrypted
[d
->n_decrypted
].device
= TAKE_PTR(cd
);
1114 m
->decrypted_node
= TAKE_PTR(node
);
1120 int dissected_image_decrypt(
1122 const char *passphrase
,
1123 const void *root_hash
,
1124 size_t root_hash_size
,
1125 DissectImageFlags flags
,
1126 DecryptedImage
**ret
) {
1128 #if HAVE_LIBCRYPTSETUP
1129 _cleanup_(decrypted_image_unrefp
) DecryptedImage
*d
= NULL
;
1135 assert(root_hash
|| root_hash_size
== 0);
1139 * = 0 → There was nothing to decrypt
1140 * > 0 → Decrypted successfully
1141 * -ENOKEY → There's something to decrypt but no key was supplied
1142 * -EKEYREJECTED → Passed key was not correct
1145 if (root_hash
&& root_hash_size
< sizeof(sd_id128_t
))
1148 if (!m
->encrypted
&& !m
->verity
) {
1153 #if HAVE_LIBCRYPTSETUP
1154 d
= new0(DecryptedImage
, 1);
1158 for (i
= 0; i
< _PARTITION_DESIGNATOR_MAX
; i
++) {
1159 DissectedPartition
*p
= m
->partitions
+ i
;
1165 r
= decrypt_partition(p
, passphrase
, flags
, d
);
1169 k
= PARTITION_VERITY_OF(i
);
1171 r
= verity_partition(p
, m
->partitions
+ k
, root_hash
, root_hash_size
, flags
, d
);
1176 if (!p
->decrypted_fstype
&& p
->decrypted_node
) {
1177 r
= probe_filesystem(p
->decrypted_node
, &p
->decrypted_fstype
);
1178 if (r
< 0 && r
!= -EUCLEAN
)
1191 int dissected_image_decrypt_interactively(
1193 const char *passphrase
,
1194 const void *root_hash
,
1195 size_t root_hash_size
,
1196 DissectImageFlags flags
,
1197 DecryptedImage
**ret
) {
1199 _cleanup_strv_free_erase_
char **z
= NULL
;
1206 r
= dissected_image_decrypt(m
, passphrase
, root_hash
, root_hash_size
, flags
, ret
);
1209 if (r
== -EKEYREJECTED
)
1210 log_error_errno(r
, "Incorrect passphrase, try again!");
1211 else if (r
!= -ENOKEY
)
1212 return log_error_errno(r
, "Failed to decrypt image: %m");
1215 return log_error_errno(SYNTHETIC_ERRNO(EKEYREJECTED
),
1216 "Too many retries.");
1220 r
= ask_password_auto("Please enter image passphrase:", NULL
, "dissect", "dissect", USEC_INFINITY
, 0, &z
);
1222 return log_error_errno(r
, "Failed to query for passphrase: %m");
1228 #if HAVE_LIBCRYPTSETUP
1229 static int deferred_remove(DecryptedPartition
*p
) {
1230 struct dm_ioctl dm
= {
1234 DM_VERSION_PATCHLEVEL
1236 .data_size
= sizeof(dm
),
1237 .flags
= DM_DEFERRED_REMOVE
,
1240 _cleanup_close_
int fd
= -1;
1244 /* Unfortunately, libcryptsetup doesn't provide a proper API for this, hence call the ioctl() directly. */
1246 fd
= open("/dev/mapper/control", O_RDWR
|O_CLOEXEC
);
1250 if (strlen(p
->name
) > sizeof(dm
.name
))
1251 return -ENAMETOOLONG
;
1253 strncpy(dm
.name
, p
->name
, sizeof(dm
.name
));
1255 if (ioctl(fd
, DM_DEV_REMOVE
, &dm
))
1262 int decrypted_image_relinquish(DecryptedImage
*d
) {
1264 #if HAVE_LIBCRYPTSETUP
1271 /* Turns on automatic removal after the last use ended for all DM devices of this image, and sets a boolean so
1272 * that we don't clean it up ourselves either anymore */
1274 #if HAVE_LIBCRYPTSETUP
1275 for (i
= 0; i
< d
->n_decrypted
; i
++) {
1276 DecryptedPartition
*p
= d
->decrypted
+ i
;
1278 if (p
->relinquished
)
1281 r
= deferred_remove(p
);
1283 return log_debug_errno(r
, "Failed to mark %s for auto-removal: %m", p
->name
);
1285 p
->relinquished
= true;
1292 int root_hash_load(const char *image
, void **ret
, size_t *ret_size
) {
1293 _cleanup_free_
char *text
= NULL
;
1294 _cleanup_free_
void *k
= NULL
;
1302 if (is_device_path(image
)) {
1303 /* If we are asked to load the root hash for a device node, exit early */
1309 r
= getxattr_malloc(image
, "user.verity.roothash", &text
, true);
1313 if (!IN_SET(r
, -ENODATA
, -EOPNOTSUPP
, -ENOENT
))
1316 fn
= newa(char, strlen(image
) + STRLEN(".roothash") + 1);
1317 n
= stpcpy(fn
, image
);
1318 e
= endswith(fn
, ".raw");
1322 strcpy(n
, ".roothash");
1324 r
= read_one_line_file(fn
, &text
);
1334 r
= unhexmem(text
, strlen(text
), &k
, &l
);
1337 if (l
< sizeof(sd_id128_t
))
1346 int dissected_image_acquire_metadata(DissectedImage
*m
) {
1356 static const char *const paths
[_META_MAX
] = {
1357 [META_HOSTNAME
] = "/etc/hostname\0",
1358 [META_MACHINE_ID
] = "/etc/machine-id\0",
1359 [META_MACHINE_INFO
] = "/etc/machine-info\0",
1360 [META_OS_RELEASE
] = "/etc/os-release\0/usr/lib/os-release\0",
1363 _cleanup_strv_free_
char **machine_info
= NULL
, **os_release
= NULL
;
1364 _cleanup_(rmdir_and_freep
) char *t
= NULL
;
1365 _cleanup_(sigkill_waitp
) pid_t child
= 0;
1366 sd_id128_t machine_id
= SD_ID128_NULL
;
1367 _cleanup_free_
char *hostname
= NULL
;
1368 unsigned n_meta_initialized
= 0, k
;
1369 int fds
[2 * _META_MAX
], r
;
1371 BLOCK_SIGNALS(SIGCHLD
);
1375 for (; n_meta_initialized
< _META_MAX
; n_meta_initialized
++)
1376 if (pipe2(fds
+ 2*n_meta_initialized
, O_CLOEXEC
) < 0) {
1381 r
= mkdtemp_malloc("/tmp/dissect-XXXXXX", &t
);
1385 r
= safe_fork("(sd-dissect)", FORK_RESET_SIGNALS
|FORK_DEATHSIG
|FORK_NEW_MOUNTNS
|FORK_MOUNTNS_SLAVE
, &child
);
1389 r
= dissected_image_mount(m
, t
, UID_INVALID
, DISSECT_IMAGE_READ_ONLY
|DISSECT_IMAGE_MOUNT_ROOT_ONLY
|DISSECT_IMAGE_VALIDATE_OS
);
1391 log_debug_errno(r
, "Failed to mount dissected image: %m");
1392 _exit(EXIT_FAILURE
);
1395 for (k
= 0; k
< _META_MAX
; k
++) {
1396 _cleanup_close_
int fd
= -1;
1399 fds
[2*k
] = safe_close(fds
[2*k
]);
1401 NULSTR_FOREACH(p
, paths
[k
]) {
1402 fd
= chase_symlinks_and_open(p
, t
, CHASE_PREFIX_ROOT
, O_RDONLY
|O_CLOEXEC
|O_NOCTTY
, NULL
);
1407 log_debug_errno(fd
, "Failed to read %s file of image, ignoring: %m", paths
[k
]);
1411 r
= copy_bytes(fd
, fds
[2*k
+1], (uint64_t) -1, 0);
1413 _exit(EXIT_FAILURE
);
1415 fds
[2*k
+1] = safe_close(fds
[2*k
+1]);
1418 _exit(EXIT_SUCCESS
);
1421 for (k
= 0; k
< _META_MAX
; k
++) {
1422 _cleanup_fclose_
FILE *f
= NULL
;
1424 fds
[2*k
+1] = safe_close(fds
[2*k
+1]);
1426 f
= fdopen(fds
[2*k
], "r");
1437 r
= read_etc_hostname_stream(f
, &hostname
);
1439 log_debug_errno(r
, "Failed to read /etc/hostname: %m");
1443 case META_MACHINE_ID
: {
1444 _cleanup_free_
char *line
= NULL
;
1446 r
= read_line(f
, LONG_LINE_MAX
, &line
);
1448 log_debug_errno(r
, "Failed to read /etc/machine-id: %m");
1450 r
= sd_id128_from_string(line
, &machine_id
);
1452 log_debug_errno(r
, "Image contains invalid /etc/machine-id: %s", line
);
1454 log_debug("/etc/machine-id file is empty.");
1456 log_debug("/etc/machine-id has unexpected length %i.", r
);
1461 case META_MACHINE_INFO
:
1462 r
= load_env_file_pairs(f
, "machine-info", &machine_info
);
1464 log_debug_errno(r
, "Failed to read /etc/machine-info: %m");
1468 case META_OS_RELEASE
:
1469 r
= load_env_file_pairs(f
, "os-release", &os_release
);
1471 log_debug_errno(r
, "Failed to read OS release file: %m");
1477 r
= wait_for_terminate_and_check("(sd-dissect)", child
, 0);
1481 if (r
!= EXIT_SUCCESS
)
1484 free_and_replace(m
->hostname
, hostname
);
1485 m
->machine_id
= machine_id
;
1486 strv_free_and_replace(m
->machine_info
, machine_info
);
1487 strv_free_and_replace(m
->os_release
, os_release
);
1490 for (k
= 0; k
< n_meta_initialized
; k
++)
1491 safe_close_pair(fds
+ 2*k
);
1496 int dissect_image_and_warn(
1499 const void *root_hash
,
1500 size_t root_hash_size
,
1501 DissectImageFlags flags
,
1502 DissectedImage
**ret
) {
1504 _cleanup_free_
char *buffer
= NULL
;
1508 r
= fd_get_path(fd
, &buffer
);
1515 r
= dissect_image(fd
, root_hash
, root_hash_size
, flags
, ret
);
1520 return log_error_errno(r
, "Dissecting images is not supported, compiled without blkid support.");
1523 return log_error_errno(r
, "Couldn't identify a suitable partition table or file system in '%s'.", name
);
1525 case -EADDRNOTAVAIL
:
1526 return log_error_errno(r
, "No root partition for specified root hash found in '%s'.", name
);
1529 return log_error_errno(r
, "Multiple suitable root partitions found in image '%s'.", name
);
1532 return log_error_errno(r
, "No suitable root partition found in image '%s'.", name
);
1534 case -EPROTONOSUPPORT
:
1535 return log_error_errno(r
, "Device '%s' is loopback block device with partition scanning turned off, please turn it on.", name
);
1539 return log_error_errno(r
, "Failed to dissect image '%s': %m", name
);
1545 static const char *const partition_designator_table
[] = {
1546 [PARTITION_ROOT
] = "root",
1547 [PARTITION_ROOT_SECONDARY
] = "root-secondary",
1548 [PARTITION_HOME
] = "home",
1549 [PARTITION_SRV
] = "srv",
1550 [PARTITION_ESP
] = "esp",
1551 [PARTITION_XBOOTLDR
] = "xbootldr",
1552 [PARTITION_SWAP
] = "swap",
1553 [PARTITION_ROOT_VERITY
] = "root-verity",
1554 [PARTITION_ROOT_SECONDARY_VERITY
] = "root-secondary-verity",
1557 DEFINE_STRING_TABLE_LOOKUP(partition_designator
, int);