1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
3 #include <linux/loop.h>
5 #include "bus-common-errors.h"
7 #include "bus-locator.h"
9 #include "conf-files.h"
11 #include "data-fd-util.h"
12 #include "constants.h"
13 #include "dirent-util.h"
14 #include "discover-image.h"
15 #include "dissect-image.h"
18 #include "errno-list.h"
20 #include "extension-util.h"
25 #include "iovec-util.h"
26 #include "locale-util.h"
27 #include "loop-util.h"
29 #include "nulstr-util.h"
31 #include "path-lookup.h"
33 #include "process-util.h"
34 #include "selinux-util.h"
36 #include "signal-util.h"
37 #include "socket-util.h"
38 #include "sort-util.h"
39 #include "string-table.h"
41 #include "tmpfile-util.h"
42 #include "user-util.h"
44 /* Markers used in the first line of our 20-portable.conf unit file drop-in to determine, that a) the unit file was
45 * dropped there by the portable service logic and b) for which image it was dropped there. */
46 #define PORTABLE_DROPIN_MARKER_BEGIN "# Drop-in created for image '"
47 #define PORTABLE_DROPIN_MARKER_END "', do not edit."
49 static bool prefix_match(const char *unit
, const char *prefix
) {
52 p
= startswith(unit
, prefix
);
56 /* Only respect prefixes followed by dash or dot or when there's a complete match */
57 return IN_SET(*p
, '-', '.', '@', 0);
60 static bool unit_match(const char *unit
, char **matches
) {
63 dot
= strrchr(unit
, '.');
67 if (!STR_IN_SET(dot
, ".service", ".socket", ".target", ".timer", ".path"))
70 /* Empty match expression means: everything */
71 if (strv_isempty(matches
))
74 /* Otherwise, at least one needs to match */
75 STRV_FOREACH(i
, matches
)
76 if (prefix_match(unit
, *i
))
82 static PortableMetadata
*portable_metadata_new(const char *name
, const char *path
, const char *selinux_label
, int fd
) {
85 m
= malloc0(offsetof(PortableMetadata
, name
) + strlen(name
) + 1);
89 /* In case of a layered attach, we want to remember which image the unit came from */
91 m
->image_path
= strdup(path
);
96 /* The metadata file might have SELinux labels, we need to carry them and reapply them */
97 if (!isempty(selinux_label
)) {
98 m
->selinux_label
= strdup(selinux_label
);
99 if (!m
->selinux_label
) {
105 strcpy(m
->name
, name
);
111 PortableMetadata
*portable_metadata_unref(PortableMetadata
*i
) {
118 free(i
->selinux_label
);
123 static int compare_metadata(PortableMetadata
*const *x
, PortableMetadata
*const *y
) {
124 return strcmp((*x
)->name
, (*y
)->name
);
127 int portable_metadata_hashmap_to_sorted_array(Hashmap
*unit_files
, PortableMetadata
***ret
) {
129 _cleanup_free_ PortableMetadata
**sorted
= NULL
;
130 PortableMetadata
*item
;
133 sorted
= new(PortableMetadata
*, hashmap_size(unit_files
));
137 HASHMAP_FOREACH(item
, unit_files
)
140 assert(k
== hashmap_size(unit_files
));
142 typesafe_qsort(sorted
, k
, compare_metadata
);
144 *ret
= TAKE_PTR(sorted
);
148 static int send_one_fd_iov_with_data_fd(
150 const struct iovec
*iov
,
154 _cleanup_close_
int data_fd
= -EBADF
;
156 assert(iov
|| iovlen
== 0);
157 assert(socket_fd
>= 0);
160 data_fd
= copy_data_fd(fd
);
164 return send_one_fd_iov(socket_fd
, data_fd
, iov
, iovlen
, 0);
167 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(portable_metadata_hash_ops
, char, string_hash_func
, string_compare_func
,
168 PortableMetadata
, portable_metadata_unref
);
170 static int extract_now(
173 const char *image_name
,
174 bool path_is_extension
,
175 bool relax_extension_release_check
,
177 PortableMetadata
**ret_os_release
,
178 Hashmap
**ret_unit_files
) {
180 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
181 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
182 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
183 _cleanup_close_
int os_release_fd
= -EBADF
;
184 _cleanup_free_
char *os_release_path
= NULL
;
185 const char *os_release_id
;
188 /* Extracts the metadata from a directory tree 'where'. Extracts two kinds of information: the /etc/os-release
189 * data, and all unit files matching the specified expression. Note that this function is called in two very
190 * different but also similar contexts. When the tool gets invoked on a directory tree, we'll process it
191 * directly, and in-process, and thus can return the requested data directly, via 'ret_os_release' and
192 * 'ret_unit_files'. However, if the tool is invoked on a raw disk image — which needs to be mounted first — we
193 * are invoked in a child process with private mounts and then need to send the collected data to our
194 * parent. To handle both cases in one call this function also gets a 'socket_fd' parameter, which when >= 0 is
195 * used to send the data to the parent. */
199 /* First, find os-release/extension-release and send it upstream (or just save it). */
200 if (path_is_extension
) {
201 os_release_id
= strjoina("/usr/lib/extension-release.d/extension-release.", image_name
);
202 r
= open_extension_release(where
, IMAGE_SYSEXT
, image_name
, relax_extension_release_check
, &os_release_path
, &os_release_fd
);
204 os_release_id
= "/etc/os-release";
205 r
= open_os_release(where
, &os_release_path
, &os_release_fd
);
209 "Couldn't acquire %s file, ignoring: %m",
210 path_is_extension
? "extension-release " : "os-release");
212 if (socket_fd
>= 0) {
213 struct iovec iov
[] = {
214 IOVEC_MAKE_STRING(os_release_id
),
215 IOVEC_MAKE((char *)"\0", sizeof(char)),
218 r
= send_one_fd_iov_with_data_fd(socket_fd
, iov
, ELEMENTSOF(iov
), os_release_fd
);
220 return log_debug_errno(r
, "Failed to send os-release file: %m");
223 if (ret_os_release
) {
224 os_release
= portable_metadata_new(os_release_id
, NULL
, NULL
, os_release_fd
);
228 os_release_fd
= -EBADF
;
229 os_release
->source
= TAKE_PTR(os_release_path
);
233 /* Then, send unit file data to the parent (or/and add it to the hashmap). For that we use our usual unit
234 * discovery logic. Note that we force looking inside of /lib/systemd/system/ for units too, as the
235 * image might have a legacy split-usr layout. */
236 r
= lookup_paths_init(&paths
, RUNTIME_SCOPE_SYSTEM
, LOOKUP_PATHS_SPLIT_USR
, where
);
238 return log_debug_errno(r
, "Failed to acquire lookup paths: %m");
240 unit_files
= hashmap_new(&portable_metadata_hash_ops
);
244 STRV_FOREACH(i
, paths
.search_path
) {
245 _cleanup_free_
char *resolved
= NULL
;
246 _cleanup_closedir_
DIR *d
= NULL
;
248 r
= chase_and_opendir(*i
, where
, 0, &resolved
, &d
);
250 log_debug_errno(r
, "Failed to open unit path '%s', ignoring: %m", *i
);
254 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to read directory: %m")) {
255 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*m
= NULL
;
256 _cleanup_(mac_selinux_freep
) char *con
= NULL
;
257 _cleanup_close_
int fd
= -EBADF
;
260 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
263 if (!unit_match(de
->d_name
, matches
))
266 /* Filter out duplicates */
267 if (hashmap_get(unit_files
, de
->d_name
))
270 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
273 fd
= openat(dirfd(d
), de
->d_name
, O_CLOEXEC
|O_RDONLY
);
275 log_debug_errno(errno
, "Failed to open unit file '%s', ignoring: %m", de
->d_name
);
279 /* Reject empty files, just in case */
280 if (fstat(fd
, &st
) < 0) {
281 log_debug_errno(errno
, "Failed to stat unit file '%s', ignoring: %m", de
->d_name
);
285 if (st
.st_size
<= 0) {
286 log_debug("Unit file '%s' is empty, ignoring.", de
->d_name
);
291 /* The units will be copied on the host's filesystem, so if they had a SELinux label
292 * we have to preserve it. Copy it out so that it can be applied later. */
294 r
= fgetfilecon_raw(fd
, &con
);
295 if (r
< 0 && !ERRNO_IS_XATTR_ABSENT(errno
))
296 log_debug_errno(errno
, "Failed to get SELinux file context from '%s', ignoring: %m", de
->d_name
);
299 if (socket_fd
>= 0) {
300 struct iovec iov
[] = {
301 IOVEC_MAKE_STRING(de
->d_name
),
302 IOVEC_MAKE((char *)"\0", sizeof(char)),
303 IOVEC_MAKE_STRING(strempty(con
)),
306 r
= send_one_fd_iov_with_data_fd(socket_fd
, iov
, ELEMENTSOF(iov
), fd
);
308 return log_debug_errno(r
, "Failed to send unit metadata to parent: %m");
311 m
= portable_metadata_new(de
->d_name
, where
, con
, fd
);
316 m
->source
= path_join(resolved
, de
->d_name
);
320 r
= hashmap_put(unit_files
, m
->name
, m
);
322 return log_debug_errno(r
, "Failed to add unit to hashmap: %m");
328 *ret_os_release
= TAKE_PTR(os_release
);
330 *ret_unit_files
= TAKE_PTR(unit_files
);
335 static int portable_extract_by_path(
337 bool path_is_extension
,
338 bool relax_extension_release_check
,
340 const ImagePolicy
*image_policy
,
341 PortableMetadata
**ret_os_release
,
342 Hashmap
**ret_unit_files
,
343 sd_bus_error
*error
) {
345 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
346 _cleanup_(portable_metadata_unrefp
) PortableMetadata
* os_release
= NULL
;
347 _cleanup_(loop_device_unrefp
) LoopDevice
*d
= NULL
;
352 r
= loop_device_make_by_path(path
, O_RDONLY
, /* sector_size= */ UINT32_MAX
, LO_FLAGS_PARTSCAN
, LOCK_SH
, &d
);
354 _cleanup_free_
char *image_name
= NULL
;
356 /* We can't turn this into a loop-back block device, and this returns EISDIR? Then this is a directory
357 * tree and not a raw device. It's easy then. */
359 r
= path_extract_filename(path
, &image_name
);
361 return log_error_errno(r
, "Failed to extract image name from path '%s': %m", path
);
363 r
= extract_now(path
, matches
, image_name
, path_is_extension
, /* relax_extension_release_check= */ false, -1, &os_release
, &unit_files
);
368 return log_debug_errno(r
, "Failed to set up loopback device for %s: %m", path
);
370 _cleanup_(dissected_image_unrefp
) DissectedImage
*m
= NULL
;
371 _cleanup_(rmdir_and_freep
) char *tmpdir
= NULL
;
372 _cleanup_close_pair_
int seq
[2] = EBADF_PAIR
;
373 _cleanup_(sigkill_waitp
) pid_t child
= 0;
375 /* We now have a loopback block device, let's fork off a child in its own mount namespace, mount it
376 * there, and extract the metadata we need. The metadata is sent from the child back to us. */
378 BLOCK_SIGNALS(SIGCHLD
);
380 r
= mkdtemp_malloc("/tmp/inspect-XXXXXX", &tmpdir
);
382 return log_debug_errno(r
, "Failed to create temporary directory: %m");
384 r
= dissect_loop_device(
387 /* mount_options= */ NULL
,
389 DISSECT_IMAGE_READ_ONLY
|
390 DISSECT_IMAGE_GENERIC_ROOT
|
391 DISSECT_IMAGE_REQUIRE_ROOT
|
392 DISSECT_IMAGE_DISCARD_ON_LOOP
|
393 DISSECT_IMAGE_RELAX_VAR_CHECK
|
394 DISSECT_IMAGE_USR_NO_ROOT
|
395 DISSECT_IMAGE_ADD_PARTITION_DEVICES
|
396 DISSECT_IMAGE_PIN_PARTITION_DEVICES
,
399 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Couldn't identify a suitable partition table or file system in '%s'.", path
);
400 else if (r
== -EADDRNOTAVAIL
)
401 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "No root partition for specified root hash found in '%s'.", path
);
402 else if (r
== -ENOTUNIQ
)
403 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Multiple suitable root partitions found in image '%s'.", path
);
404 else if (r
== -ENXIO
)
405 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "No suitable root partition found in image '%s'.", path
);
406 else if (r
== -EPROTONOSUPPORT
)
407 sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Device '%s' is loopback block device with partition scanning turned off, please turn it on.", path
);
411 if (socketpair(AF_UNIX
, SOCK_SEQPACKET
|SOCK_CLOEXEC
, 0, seq
) < 0)
412 return log_debug_errno(errno
, "Failed to allocated SOCK_SEQPACKET socket: %m");
414 r
= safe_fork("(sd-dissect)", FORK_RESET_SIGNALS
|FORK_DEATHSIG
|FORK_NEW_MOUNTNS
|FORK_MOUNTNS_SLAVE
|FORK_LOG
, &child
);
418 DissectImageFlags flags
= DISSECT_IMAGE_READ_ONLY
;
420 seq
[0] = safe_close(seq
[0]);
422 if (path_is_extension
)
423 flags
|= DISSECT_IMAGE_VALIDATE_OS_EXT
| (relax_extension_release_check
? DISSECT_IMAGE_RELAX_EXTENSION_CHECK
: 0);
425 flags
|= DISSECT_IMAGE_VALIDATE_OS
;
427 r
= dissected_image_mount(
430 /* uid_shift= */ UID_INVALID
,
431 /* uid_range= */ UID_INVALID
,
432 /* userns_fd= */ -EBADF
,
435 log_debug_errno(r
, "Failed to mount dissected image: %m");
439 r
= extract_now(tmpdir
, matches
, m
->image_name
, path_is_extension
, relax_extension_release_check
, seq
[1], NULL
, NULL
);
442 _exit(r
< 0 ? EXIT_FAILURE
: EXIT_SUCCESS
);
445 seq
[1] = safe_close(seq
[1]);
447 unit_files
= hashmap_new(&portable_metadata_hash_ops
);
452 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*add
= NULL
;
453 _cleanup_close_
int fd
= -EBADF
;
454 /* We use NAME_MAX space for the SELinux label here. The kernel currently enforces no limit, but
455 * according to suggestions from the SELinux people this will change and it will probably be
456 * identical to NAME_MAX. For now we use that, but this should be updated one day when the final
458 char iov_buffer
[PATH_MAX
+ NAME_MAX
+ 2];
459 struct iovec iov
= IOVEC_MAKE(iov_buffer
, sizeof(iov_buffer
));
461 ssize_t n
= receive_one_fd_iov(seq
[0], &iov
, 1, 0, &fd
);
465 return log_debug_errno(n
, "Failed to receive item: %m");
468 /* We can't really distinguish a zero-length datagram without any fds from EOF (both are signalled the
469 * same way by recvmsg()). Hence, accept either as end notification. */
470 if (isempty(iov_buffer
) && fd
< 0)
473 if (isempty(iov_buffer
) || fd
< 0)
474 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL
),
475 "Invalid item sent from child.");
477 /* Given recvmsg cannot be used with multiple io vectors if you don't know the size in advance,
478 * use a marker to separate the name and the optional SELinux context. */
479 char *selinux_label
= memchr(iov_buffer
, 0, n
);
480 assert(selinux_label
);
483 add
= portable_metadata_new(iov_buffer
, path
, selinux_label
, fd
);
488 /* Note that we do not initialize 'add->source' here, as the source path is not usable here as
489 * it refers to a path only valid in the short-living namespaced child process we forked
492 if (PORTABLE_METADATA_IS_UNIT(add
)) {
493 r
= hashmap_put(unit_files
, add
->name
, add
);
495 return log_debug_errno(r
, "Failed to add item to unit file list: %m");
499 } else if (PORTABLE_METADATA_IS_OS_RELEASE(add
) || PORTABLE_METADATA_IS_EXTENSION_RELEASE(add
)) {
502 os_release
= TAKE_PTR(add
);
504 assert_not_reached();
507 r
= wait_for_terminate_and_check("(sd-dissect)", child
, 0);
514 return sd_bus_error_setf(error
,
515 SD_BUS_ERROR_INVALID_ARGS
,
516 "Image '%s' lacks %s data, refusing.",
518 path_is_extension
? "extension-release" : "os-release");
521 *ret_unit_files
= TAKE_PTR(unit_files
);
524 *ret_os_release
= TAKE_PTR(os_release
);
529 static int extract_image_and_extensions(
530 const char *name_or_path
,
532 char **extension_image_paths
,
533 bool validate_sysext
,
534 bool relax_extension_release_check
,
535 const ImagePolicy
*image_policy
,
537 OrderedHashmap
**ret_extension_images
,
538 OrderedHashmap
**ret_extension_releases
,
539 PortableMetadata
**ret_os_release
,
540 Hashmap
**ret_unit_files
,
541 char ***ret_valid_prefixes
,
542 sd_bus_error
*error
) {
544 _cleanup_free_
char *id
= NULL
, *version_id
= NULL
, *sysext_level
= NULL
;
545 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
546 _cleanup_ordered_hashmap_free_ OrderedHashmap
*extension_images
= NULL
, *extension_releases
= NULL
;
547 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
548 _cleanup_strv_free_
char **valid_prefixes
= NULL
;
549 _cleanup_(image_unrefp
) Image
*image
= NULL
;
553 assert(name_or_path
);
555 r
= image_find_harder(IMAGE_PORTABLE
, name_or_path
, NULL
, &image
);
559 if (!strv_isempty(extension_image_paths
)) {
560 extension_images
= ordered_hashmap_new(&image_hash_ops
);
561 if (!extension_images
)
564 if (ret_extension_releases
) {
565 extension_releases
= ordered_hashmap_new(&portable_metadata_hash_ops
);
566 if (!extension_releases
)
570 STRV_FOREACH(p
, extension_image_paths
) {
571 _cleanup_(image_unrefp
) Image
*new = NULL
;
573 r
= image_find_harder(IMAGE_PORTABLE
, *p
, NULL
, &new);
577 r
= ordered_hashmap_put(extension_images
, new->name
, new);
584 r
= portable_extract_by_path(
586 /* path_is_extension= */ false,
587 /* relax_extension_release_check= */ false,
596 /* If we are layering extension images on top of a runtime image, check that the os-release and
597 * extension-release metadata match, otherwise reject it immediately as invalid, or it will fail when
598 * the units are started. Also, collect valid portable prefixes if caller requested that. */
599 if (validate_sysext
|| ret_valid_prefixes
) {
600 _cleanup_free_
char *prefixes
= NULL
;
602 r
= parse_env_file_fd(os_release
->fd
, os_release
->name
,
604 "VERSION_ID", &version_id
,
605 "SYSEXT_LEVEL", &sysext_level
,
606 "PORTABLE_PREFIXES", &prefixes
);
610 return sd_bus_error_set_errnof(error
, SYNTHETIC_ERRNO(ESTALE
), "Image %s os-release metadata lacks the ID field", name_or_path
);
613 valid_prefixes
= strv_split(prefixes
, WHITESPACE
);
619 ORDERED_HASHMAP_FOREACH(ext
, extension_images
) {
620 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*extension_release_meta
= NULL
;
621 _cleanup_hashmap_free_ Hashmap
*extra_unit_files
= NULL
;
622 _cleanup_strv_free_
char **extension_release
= NULL
;
625 r
= portable_extract_by_path(
627 /* path_is_extension= */ true,
628 relax_extension_release_check
,
631 &extension_release_meta
,
637 r
= hashmap_move(unit_files
, extra_unit_files
);
641 if (!validate_sysext
&& !ret_valid_prefixes
&& !ret_extension_releases
)
644 r
= load_env_file_pairs_fd(extension_release_meta
->fd
, extension_release_meta
->name
, &extension_release
);
648 if (validate_sysext
) {
649 r
= extension_release_validate(ext
->path
, id
, version_id
, sysext_level
, "portable", extension_release
, IMAGE_SYSEXT
);
651 return sd_bus_error_set_errnof(error
, SYNTHETIC_ERRNO(ESTALE
), "Image %s extension-release metadata does not match the root's", ext
->path
);
653 return sd_bus_error_set_errnof(error
, r
, "Failed to compare image %s extension-release metadata with the root's os-release: %m", ext
->path
);
656 e
= strv_env_pairs_get(extension_release
, "PORTABLE_PREFIXES");
658 _cleanup_strv_free_
char **l
= NULL
;
660 l
= strv_split(e
, WHITESPACE
);
664 r
= strv_extend_strv(&valid_prefixes
, l
, true);
669 if (ret_extension_releases
) {
670 r
= ordered_hashmap_put(extension_releases
, ext
->name
, extension_release_meta
);
673 TAKE_PTR(extension_release_meta
);
677 strv_sort(valid_prefixes
);
680 *ret_image
= TAKE_PTR(image
);
681 if (ret_extension_images
)
682 *ret_extension_images
= TAKE_PTR(extension_images
);
683 if (ret_extension_releases
)
684 *ret_extension_releases
= TAKE_PTR(extension_releases
);
686 *ret_os_release
= TAKE_PTR(os_release
);
688 *ret_unit_files
= TAKE_PTR(unit_files
);
689 if (ret_valid_prefixes
)
690 *ret_valid_prefixes
= TAKE_PTR(valid_prefixes
);
695 int portable_extract(
696 const char *name_or_path
,
698 char **extension_image_paths
,
699 const ImagePolicy
*image_policy
,
701 PortableMetadata
**ret_os_release
,
702 OrderedHashmap
**ret_extension_releases
,
703 Hashmap
**ret_unit_files
,
704 char ***ret_valid_prefixes
,
705 sd_bus_error
*error
) {
707 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
708 _cleanup_ordered_hashmap_free_ OrderedHashmap
*extension_images
= NULL
, *extension_releases
= NULL
;
709 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
710 _cleanup_strv_free_
char **valid_prefixes
= NULL
;
711 _cleanup_(image_unrefp
) Image
*image
= NULL
;
714 assert(name_or_path
);
716 r
= extract_image_and_extensions(
719 extension_image_paths
,
720 /* validate_sysext= */ false,
721 /* relax_extension_release_check= */ FLAGS_SET(flags
, PORTABLE_FORCE_SYSEXT
),
728 ret_valid_prefixes
? &valid_prefixes
: NULL
,
733 if (hashmap_isempty(unit_files
)) {
734 _cleanup_free_
char *extensions
= strv_join(extension_image_paths
, ", ");
738 return sd_bus_error_setf(error
,
739 SD_BUS_ERROR_INVALID_ARGS
,
740 "Couldn't find any matching unit files in image '%s%s%s', refusing.",
742 isempty(extensions
) ? "" : "' or any of its extensions '",
743 isempty(extensions
) ? "" : extensions
);
747 *ret_os_release
= TAKE_PTR(os_release
);
748 if (ret_extension_releases
)
749 *ret_extension_releases
= TAKE_PTR(extension_releases
);
751 *ret_unit_files
= TAKE_PTR(unit_files
);
752 if (ret_valid_prefixes
)
753 *ret_valid_prefixes
= TAKE_PTR(valid_prefixes
);
758 static int unit_file_is_active(
761 sd_bus_error
*error
) {
763 static const char *const active_states
[] = {
775 /* If we are looking at a plain or instance things are easy, we can just query the state */
776 if (unit_name_is_valid(name
, UNIT_NAME_PLAIN
|UNIT_NAME_INSTANCE
)) {
777 _cleanup_free_
char *path
= NULL
, *buf
= NULL
;
779 path
= unit_dbus_path_from_name(name
);
783 r
= sd_bus_get_property_string(
785 "org.freedesktop.systemd1",
787 "org.freedesktop.systemd1.Unit",
792 return log_debug_errno(r
, "Failed to retrieve unit state: %s", bus_error_message(error
, r
));
794 return strv_contains((char**) active_states
, buf
);
797 /* Otherwise we need to enumerate. But let's build the most restricted query we can */
798 if (unit_name_is_valid(name
, UNIT_NAME_TEMPLATE
)) {
799 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*m
= NULL
, *reply
= NULL
;
800 const char *at
, *prefix
, *joined
;
802 r
= bus_message_new_method_call(bus
, &m
, bus_systemd_mgr
, "ListUnitsByPatterns");
806 r
= sd_bus_message_append_strv(m
, (char**) active_states
);
810 at
= strchr(name
, '@');
813 prefix
= strndupa_safe(name
, at
+ 1 - name
);
814 joined
= strjoina(prefix
, "*", at
+ 1);
816 r
= sd_bus_message_append_strv(m
, STRV_MAKE(joined
));
820 r
= sd_bus_call(bus
, m
, 0, error
, &reply
);
822 return log_debug_errno(r
, "Failed to list units: %s", bus_error_message(error
, r
));
824 r
= sd_bus_message_enter_container(reply
, SD_BUS_TYPE_ARRAY
, "(ssssssouso)");
828 r
= sd_bus_message_enter_container(reply
, SD_BUS_TYPE_STRUCT
, "ssssssouso");
838 static int portable_changes_add(
839 PortableChange
**changes
,
841 int type_or_errno
, /* PORTABLE_COPY, PORTABLE_SYMLINK, … if positive, or errno if negative */
843 const char *source
) {
845 _cleanup_free_
char *p
= NULL
, *s
= NULL
;
850 assert(!changes
== !n_changes
);
852 if (type_or_errno
>= 0)
853 assert(type_or_errno
< _PORTABLE_CHANGE_TYPE_MAX
);
855 assert(type_or_errno
>= -ERRNO_MAX
);
860 c
= reallocarray(*changes
, *n_changes
+ 1, sizeof(PortableChange
));
865 r
= path_simplify_alloc(path
, &p
);
869 r
= path_simplify_alloc(source
, &s
);
873 c
[(*n_changes
)++] = (PortableChange
) {
874 .type_or_errno
= type_or_errno
,
876 .source
= TAKE_PTR(s
),
882 static int portable_changes_add_with_prefix(
883 PortableChange
**changes
,
888 const char *source
) {
890 _cleanup_free_
char *path_buf
= NULL
, *source_buf
= NULL
;
893 assert(!changes
== !n_changes
);
899 path_buf
= path_join(prefix
, path
);
906 source_buf
= path_join(prefix
, source
);
914 return portable_changes_add(changes
, n_changes
, type_or_errno
, path
, source
);
917 void portable_changes_free(PortableChange
*changes
, size_t n_changes
) {
920 assert(changes
|| n_changes
== 0);
922 for (i
= 0; i
< n_changes
; i
++) {
923 free(changes
[i
].path
);
924 free(changes
[i
].source
);
930 static const char *root_setting_from_image(ImageType type
) {
931 return IN_SET(type
, IMAGE_DIRECTORY
, IMAGE_SUBVOLUME
) ? "RootDirectory=" : "RootImage=";
934 static const char *extension_setting_from_image(ImageType type
) {
935 return IN_SET(type
, IMAGE_DIRECTORY
, IMAGE_SUBVOLUME
) ? "ExtensionDirectories=" : "ExtensionImages=";
938 static int make_marker_text(const char *image_path
, OrderedHashmap
*extension_images
, char **ret_text
) {
939 _cleanup_free_
char *text
= NULL
, *escaped_image_path
= NULL
;
945 escaped_image_path
= xescape(image_path
, ":");
946 if (!escaped_image_path
)
949 /* If the image is layered, include all layers in the marker as a colon-separated
950 * list of paths, so that we can do exact matches on removal. */
951 text
= strjoin(PORTABLE_DROPIN_MARKER_BEGIN
, escaped_image_path
);
955 ORDERED_HASHMAP_FOREACH(ext
, extension_images
) {
956 _cleanup_free_
char *escaped
= NULL
;
958 escaped
= xescape(ext
->path
, ":");
962 if (!strextend(&text
, ":", escaped
))
966 if (!strextend(&text
, PORTABLE_DROPIN_MARKER_END
"\n"))
969 *ret_text
= TAKE_PTR(text
);
973 static int append_release_log_fields(
975 const PortableMetadata
*release
,
977 const char *field_name
) {
979 static const char *const field_versions
[_IMAGE_CLASS_MAX
][4]= {
980 [IMAGE_PORTABLE
] = { "IMAGE_VERSION", "VERSION_ID", "BUILD_ID", NULL
},
981 [IMAGE_SYSEXT
] = { "SYSEXT_IMAGE_VERSION", "SYSEXT_VERSION_ID", "SYSEXT_BUILD_ID", NULL
},
983 static const char *const field_ids
[_IMAGE_CLASS_MAX
][3]= {
984 [IMAGE_PORTABLE
] = { "IMAGE_ID", "ID", NULL
},
985 [IMAGE_SYSEXT
] = { "SYSEXT_IMAGE_ID", "SYSEXT_ID", NULL
},
987 _cleanup_strv_free_
char **fields
= NULL
;
988 const char *id
= NULL
, *version
= NULL
;
991 assert(IN_SET(type
, IMAGE_PORTABLE
, IMAGE_SYSEXT
));
992 assert(!strv_isempty((char *const *)field_ids
[type
]));
993 assert(!strv_isempty((char *const *)field_versions
[type
]));
998 return 0; /* Nothing to do. */
1000 r
= load_env_file_pairs_fd(release
->fd
, release
->name
, &fields
);
1002 return log_debug_errno(r
, "Failed to parse '%s': %m", release
->name
);
1004 /* Find an ID first, in order of preference from more specific to less specific: IMAGE_ID -> ID */
1005 id
= strv_find_first_field((char *const *)field_ids
[type
], fields
);
1007 /* Then the version, same logic, prefer the more specific one */
1008 version
= strv_find_first_field((char *const *)field_versions
[type
], fields
);
1010 /* If there's no valid version to be found, simply omit it. */
1011 if (!id
&& !version
)
1014 if (!strextend(text
,
1019 id
&& version
? "_" : "",
1027 static int install_chroot_dropin(
1028 const char *image_path
,
1030 OrderedHashmap
*extension_images
,
1031 OrderedHashmap
*extension_releases
,
1032 const PortableMetadata
*m
,
1033 const PortableMetadata
*os_release
,
1034 const char *dropin_dir
,
1035 PortableFlags flags
,
1037 PortableChange
**changes
,
1038 size_t *n_changes
) {
1040 _cleanup_free_
char *text
= NULL
, *dropin
= NULL
;
1047 dropin
= path_join(dropin_dir
, "20-portable.conf");
1051 r
= make_marker_text(image_path
, extension_images
, &text
);
1053 return log_debug_errno(r
, "Failed to generate marker string for portable drop-in: %m");
1055 if (endswith(m
->name
, ".service")) {
1056 const char *root_type
;
1057 _cleanup_free_
char *base_name
= NULL
;
1060 root_type
= root_setting_from_image(type
);
1062 r
= path_extract_filename(m
->image_path
?: image_path
, &base_name
);
1064 return log_debug_errno(r
, "Failed to extract basename from '%s': %m", m
->image_path
?: image_path
);
1066 if (!strextend(&text
,
1069 root_type
, image_path
, "\n"
1070 "Environment=PORTABLE=", base_name
, "\n"
1071 "LogExtraFields=PORTABLE=", base_name
, "\n"))
1074 /* If we have a single image then PORTABLE= will point to it, so we add
1075 * PORTABLE_NAME_AND_VERSION= with the os-release fields and we are done. But if we have
1076 * extensions, PORTABLE= will point to the image where the current unit was found in. So we
1077 * also list PORTABLE_ROOT= and PORTABLE_ROOT_NAME_AND_VERSION= for the base image, and
1078 * PORTABLE_EXTENSION= and PORTABLE_EXTENSION_NAME_AND_VERSION= for each extension, so that
1079 * all needed metadata is available. */
1080 if (ordered_hashmap_isempty(extension_images
))
1081 r
= append_release_log_fields(&text
, os_release
, IMAGE_PORTABLE
, "PORTABLE_NAME_AND_VERSION");
1083 _cleanup_free_
char *root_base_name
= NULL
;
1085 r
= path_extract_filename(image_path
, &root_base_name
);
1087 return log_debug_errno(r
, "Failed to extract basename from '%s': %m", image_path
);
1089 if (!strextend(&text
,
1090 "Environment=PORTABLE_ROOT=", root_base_name
, "\n",
1091 "LogExtraFields=PORTABLE_ROOT=", root_base_name
, "\n"))
1094 r
= append_release_log_fields(&text
, os_release
, IMAGE_PORTABLE
, "PORTABLE_ROOT_NAME_AND_VERSION");
1099 if (m
->image_path
&& !path_equal(m
->image_path
, image_path
))
1100 ORDERED_HASHMAP_FOREACH(ext
, extension_images
) {
1101 _cleanup_free_
char *extension_base_name
= NULL
;
1103 r
= path_extract_filename(ext
->path
, &extension_base_name
);
1105 return log_debug_errno(r
, "Failed to extract basename from '%s': %m", ext
->path
);
1107 if (!strextend(&text
,
1109 extension_setting_from_image(ext
->type
),
1111 /* With --force tell PID1 to avoid enforcing that the image <name> and
1112 * extension-release.<name> have to match. */
1113 !IN_SET(type
, IMAGE_DIRECTORY
, IMAGE_SUBVOLUME
) &&
1114 FLAGS_SET(flags
, PORTABLE_FORCE_SYSEXT
) ?
1115 ":x-systemd.relax-extension-release-check\n" :
1117 /* In PORTABLE= we list the 'main' image name for this unit
1118 * (the image where the unit was extracted from), but we are
1119 * stacking multiple images, so list those too. */
1120 "LogExtraFields=PORTABLE_EXTENSION=", extension_base_name
, "\n"))
1123 /* Look for image/version identifiers in the extension release files. We
1124 * look for all possible IDs, but typically only 1 or 2 will be set, so
1125 * the number of fields added shouldn't be too large. We prefix the DDI
1126 * name to the value, so that we can add the same field multiple times and
1127 * still be able to identify what applies to what. */
1128 r
= append_release_log_fields(&text
,
1129 ordered_hashmap_get(extension_releases
, ext
->name
),
1131 "PORTABLE_EXTENSION_NAME_AND_VERSION");
1137 r
= write_string_file(dropin
, text
, WRITE_STRING_FILE_CREATE
|WRITE_STRING_FILE_ATOMIC
|WRITE_STRING_FILE_SYNC
);
1139 return log_debug_errno(r
, "Failed to write '%s': %m", dropin
);
1141 (void) portable_changes_add(changes
, n_changes
, PORTABLE_WRITE
, dropin
, NULL
);
1144 *ret_dropin
= TAKE_PTR(dropin
);
1149 static int install_profile_dropin(
1150 const char *image_path
,
1151 const PortableMetadata
*m
,
1152 const char *dropin_dir
,
1153 const char *profile
,
1154 PortableFlags flags
,
1156 PortableChange
**changes
,
1157 size_t *n_changes
) {
1159 _cleanup_free_
char *dropin
= NULL
, *from
= NULL
;
1169 r
= find_portable_profile(profile
, m
->name
, &from
);
1172 return log_debug_errno(errno
, "Profile '%s' is not accessible: %m", profile
);
1174 log_debug_errno(errno
, "Skipping link to profile '%s', as it does not exist: %m", profile
);
1178 dropin
= path_join(dropin_dir
, "10-profile.conf");
1182 if (flags
& PORTABLE_PREFER_COPY
) {
1184 r
= copy_file_atomic(from
, dropin
, 0644, COPY_REFLINK
|COPY_FSYNC
);
1186 return log_debug_errno(r
, "Failed to copy %s %s %s: %m", from
, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT
), dropin
);
1188 (void) portable_changes_add(changes
, n_changes
, PORTABLE_COPY
, dropin
, from
);
1192 if (symlink(from
, dropin
) < 0)
1193 return log_debug_errno(errno
, "Failed to link %s %s %s: %m", from
, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT
), dropin
);
1195 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, dropin
, from
);
1199 *ret_dropin
= TAKE_PTR(dropin
);
1204 static const char *attached_path(const LookupPaths
*paths
, PortableFlags flags
) {
1209 if (flags
& PORTABLE_RUNTIME
)
1210 where
= paths
->runtime_attached
;
1212 where
= paths
->persistent_attached
;
1218 static int attach_unit_file(
1219 const LookupPaths
*paths
,
1220 const char *image_path
,
1222 OrderedHashmap
*extension_images
,
1223 OrderedHashmap
*extension_releases
,
1224 const PortableMetadata
*m
,
1225 const PortableMetadata
*os_release
,
1226 const char *profile
,
1227 PortableFlags flags
,
1228 PortableChange
**changes
,
1229 size_t *n_changes
) {
1231 _cleanup_(unlink_and_freep
) char *chroot_dropin
= NULL
, *profile_dropin
= NULL
;
1232 _cleanup_(rmdir_and_freep
) char *dropin_dir
= NULL
;
1233 _cleanup_free_
char *path
= NULL
;
1240 assert(PORTABLE_METADATA_IS_UNIT(m
));
1242 where
= attached_path(paths
, flags
);
1244 (void) mkdir_parents(where
, 0755);
1245 if (mkdir(where
, 0755) < 0) {
1246 if (errno
!= EEXIST
)
1247 return log_debug_errno(errno
, "Failed to create attach directory %s: %m", where
);
1249 (void) portable_changes_add(changes
, n_changes
, PORTABLE_MKDIR
, where
, NULL
);
1251 path
= path_join(where
, m
->name
);
1255 dropin_dir
= strjoin(path
, ".d");
1259 if (mkdir(dropin_dir
, 0755) < 0) {
1260 if (errno
!= EEXIST
)
1261 return log_debug_errno(errno
, "Failed to create drop-in directory %s: %m", dropin_dir
);
1263 (void) portable_changes_add(changes
, n_changes
, PORTABLE_MKDIR
, dropin_dir
, NULL
);
1265 /* We install the drop-ins first, and the actual unit file last to achieve somewhat atomic behaviour if PID 1
1266 * is reloaded while we are creating things here: as long as only the drop-ins exist the unit doesn't exist at
1269 r
= install_chroot_dropin(image_path
, type
, extension_images
, extension_releases
, m
, os_release
, dropin_dir
, flags
, &chroot_dropin
, changes
, n_changes
);
1273 r
= install_profile_dropin(image_path
, m
, dropin_dir
, profile
, flags
, &profile_dropin
, changes
, n_changes
);
1277 if ((flags
& PORTABLE_PREFER_SYMLINK
) && m
->source
) {
1279 if (symlink(m
->source
, path
) < 0)
1280 return log_debug_errno(errno
, "Failed to symlink unit file '%s': %m", path
);
1282 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, path
, m
->source
);
1285 _cleanup_(unlink_and_freep
) char *tmp
= NULL
;
1286 _cleanup_close_
int fd
= -EBADF
;
1288 (void) mac_selinux_create_file_prepare_label(path
, m
->selinux_label
);
1290 fd
= open_tmpfile_linkable(path
, O_WRONLY
|O_CLOEXEC
, &tmp
);
1291 mac_selinux_create_file_clear(); /* Clear immediately in case of errors */
1293 return log_debug_errno(fd
, "Failed to create unit file '%s': %m", path
);
1295 r
= copy_bytes(m
->fd
, fd
, UINT64_MAX
, COPY_REFLINK
);
1297 return log_debug_errno(r
, "Failed to copy unit file '%s': %m", path
);
1299 if (fchmod(fd
, 0644) < 0)
1300 return log_debug_errno(errno
, "Failed to change unit file access mode for '%s': %m", path
);
1302 r
= link_tmpfile(fd
, tmp
, path
, LINK_TMPFILE_SYNC
);
1304 return log_debug_errno(r
, "Failed to install unit file '%s': %m", path
);
1308 (void) portable_changes_add(changes
, n_changes
, PORTABLE_COPY
, path
, m
->source
);
1311 /* All is established now, now let's disable any rollbacks */
1312 chroot_dropin
= mfree(chroot_dropin
);
1313 profile_dropin
= mfree(profile_dropin
);
1314 dropin_dir
= mfree(dropin_dir
);
1319 static int image_symlink(
1320 const char *image_path
,
1321 PortableFlags flags
,
1324 const char *fn
, *where
;
1325 char *joined
= NULL
;
1330 fn
= last_path_component(image_path
);
1332 if (flags
& PORTABLE_RUNTIME
)
1333 where
= "/run/portables/";
1335 where
= "/etc/portables/";
1337 joined
= strjoin(where
, fn
);
1345 static int install_image_symlink(
1346 const char *image_path
,
1347 PortableFlags flags
,
1348 PortableChange
**changes
,
1349 size_t *n_changes
) {
1351 _cleanup_free_
char *sl
= NULL
;
1356 /* If the image is outside of the image search also link it into it, so that it can be found with short image
1357 * names and is listed among the images. */
1359 if (image_in_search_path(IMAGE_PORTABLE
, NULL
, image_path
))
1362 r
= image_symlink(image_path
, flags
, &sl
);
1364 return log_debug_errno(r
, "Failed to generate image symlink path: %m");
1366 (void) mkdir_parents(sl
, 0755);
1368 if (symlink(image_path
, sl
) < 0)
1369 return log_debug_errno(errno
, "Failed to link %s %s %s: %m", image_path
, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT
), sl
);
1371 (void) portable_changes_add(changes
, n_changes
, PORTABLE_SYMLINK
, sl
, image_path
);
1375 static int install_image_and_extensions_symlinks(
1377 OrderedHashmap
*extension_images
,
1378 PortableFlags flags
,
1379 PortableChange
**changes
,
1380 size_t *n_changes
) {
1387 ORDERED_HASHMAP_FOREACH(ext
, extension_images
) {
1388 r
= install_image_symlink(ext
->path
, flags
, changes
, n_changes
);
1393 r
= install_image_symlink(image
->path
, flags
, changes
, n_changes
);
1400 static bool prefix_matches_compatible(char **matches
, char **valid_prefixes
) {
1401 /* Checks if all 'matches' are included in the list of 'valid_prefixes' */
1403 STRV_FOREACH(m
, matches
)
1404 if (!strv_contains(valid_prefixes
, *m
))
1410 int portable_attach(
1412 const char *name_or_path
,
1414 const char *profile
,
1415 char **extension_image_paths
,
1416 const ImagePolicy
*image_policy
,
1417 PortableFlags flags
,
1418 PortableChange
**changes
,
1420 sd_bus_error
*error
) {
1422 _cleanup_ordered_hashmap_free_ OrderedHashmap
*extension_images
= NULL
, *extension_releases
= NULL
;
1423 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
1424 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
1425 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1426 _cleanup_strv_free_
char **valid_prefixes
= NULL
;
1427 _cleanup_(image_unrefp
) Image
*image
= NULL
;
1428 PortableMetadata
*item
;
1431 r
= extract_image_and_extensions(
1434 extension_image_paths
,
1435 /* validate_sysext= */ true,
1436 /* relax_extension_release_check= */ FLAGS_SET(flags
, PORTABLE_FORCE_SYSEXT
),
1440 &extension_releases
,
1448 if (valid_prefixes
&& !prefix_matches_compatible(matches
, valid_prefixes
)) {
1449 _cleanup_free_
char *matches_joined
= NULL
, *extensions_joined
= NULL
, *valid_prefixes_joined
= NULL
;
1451 matches_joined
= strv_join(matches
, "', '");
1452 if (!matches_joined
)
1455 extensions_joined
= strv_join(extension_image_paths
, ", ");
1456 if (!extensions_joined
)
1459 valid_prefixes_joined
= strv_join(valid_prefixes
, ", ");
1460 if (!valid_prefixes_joined
)
1463 return sd_bus_error_setf(
1465 SD_BUS_ERROR_INVALID_ARGS
,
1466 "Selected matches '%s' are not compatible with portable service image '%s%s%s', refusing. (Acceptable prefix matches are: %s)",
1469 isempty(extensions_joined
) ? "" : "' or any of its extensions '",
1470 strempty(extensions_joined
),
1471 valid_prefixes_joined
);
1474 if (hashmap_isempty(unit_files
)) {
1475 _cleanup_free_
char *extensions_joined
= strv_join(extension_image_paths
, ", ");
1476 if (!extensions_joined
)
1479 return sd_bus_error_setf(
1481 SD_BUS_ERROR_INVALID_ARGS
,
1482 "Couldn't find any matching unit files in image '%s%s%s', refusing.",
1484 isempty(extensions_joined
) ? "" : "' or any of its extensions '",
1485 strempty(extensions_joined
));
1488 r
= lookup_paths_init(&paths
, RUNTIME_SCOPE_SYSTEM
, /* flags= */ 0, NULL
);
1492 if (!FLAGS_SET(flags
, PORTABLE_REATTACH
) && !FLAGS_SET(flags
, PORTABLE_FORCE_ATTACH
))
1493 HASHMAP_FOREACH(item
, unit_files
) {
1494 r
= unit_file_exists(RUNTIME_SCOPE_SYSTEM
, &paths
, item
->name
);
1496 return sd_bus_error_set_errnof(error
, r
, "Failed to determine whether unit '%s' exists on the host: %m", item
->name
);
1498 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' exists on the host already, refusing.", item
->name
);
1500 r
= unit_file_is_active(bus
, item
->name
, error
);
1504 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is active already, refusing.", item
->name
);
1507 HASHMAP_FOREACH(item
, unit_files
) {
1508 r
= attach_unit_file(&paths
, image
->path
, image
->type
, extension_images
, extension_releases
,
1509 item
, os_release
, profile
, flags
, changes
, n_changes
);
1511 return sd_bus_error_set_errnof(error
, r
, "Failed to attach unit '%s': %m", item
->name
);
1514 /* We don't care too much for the image symlink, it's just a convenience thing, it's not necessary for proper
1515 * operation otherwise. */
1516 (void) install_image_and_extensions_symlinks(image
, extension_images
, flags
, changes
, n_changes
);
1521 static bool marker_matches_images(const char *marker
, const char *name_or_path
, char **extension_image_paths
) {
1522 _cleanup_strv_free_
char **root_and_extensions
= NULL
;
1527 assert(name_or_path
);
1529 /* If extensions were used when attaching, the marker will be a colon-separated
1530 * list of images/paths. We enforce strict 1:1 matching, so that we are sure
1531 * we are detaching exactly what was attached.
1532 * For each image, starting with the root, we look for a token in the marker,
1533 * and return a negative answer on any non-matching combination. */
1535 root_and_extensions
= strv_new(name_or_path
);
1536 if (!root_and_extensions
)
1539 r
= strv_extend_strv(&root_and_extensions
, extension_image_paths
, false);
1543 STRV_FOREACH(image_name_or_path
, root_and_extensions
) {
1544 _cleanup_free_
char *image
= NULL
;
1546 r
= extract_first_word(&marker
, &image
, ":", EXTRACT_UNQUOTE
|EXTRACT_RETAIN_ESCAPE
);
1548 return log_debug_errno(r
, "Failed to parse marker: %s", marker
);
1552 a
= last_path_component(image
);
1554 if (image_name_is_valid(*image_name_or_path
)) {
1555 const char *e
, *underscore
;
1557 /* We shall match against an image name. In that case let's compare the last component, and optionally
1558 * allow either a suffix of ".raw" or a series of "/".
1559 * But allow matching on a different version of the same image, when a "_" is used as a separator. */
1560 underscore
= strchr(*image_name_or_path
, '_');
1562 if (strneq(a
, *image_name_or_path
, underscore
- *image_name_or_path
))
1567 e
= startswith(a
, *image_name_or_path
);
1571 if(!(e
[strspn(e
, "/")] == 0 || streq(e
, ".raw")))
1574 const char *b
, *underscore
;
1577 /* We shall match against a path. Let's ignore any prefix here though, as often there are many ways to
1578 * reach the same file. However, in this mode, let's validate any file suffix.
1579 * But also ensure that we don't fail if both components don't have a '/' at all
1580 * (strcspn returns the full length of the string in that case, which might not
1581 * match as the versions might differ). */
1583 l
= strcspn(a
, "/");
1584 b
= last_path_component(*image_name_or_path
);
1586 if ((a
[l
] != '/') != !strchr(b
, '/')) /* One is a directory, the other is not */
1589 if (a
[l
] != 0 && strcspn(b
, "/") != l
)
1592 underscore
= strchr(b
, '_');
1595 else { /* Either component could be versioned */
1596 underscore
= strchr(a
, '_');
1601 if (!strneq(a
, b
, l
))
1609 static int test_chroot_dropin(
1613 const char *name_or_path
,
1614 char **extension_image_paths
,
1615 char **ret_marker
) {
1617 _cleanup_free_
char *line
= NULL
, *marker
= NULL
;
1618 _cleanup_fclose_
FILE *f
= NULL
;
1619 _cleanup_close_
int fd
= -EBADF
;
1620 const char *p
, *e
, *k
;
1627 /* We recognize unis created from portable images via the drop-in we created for them */
1629 p
= strjoina(fname
, ".d/20-portable.conf");
1630 fd
= openat(dirfd(d
), p
, O_RDONLY
|O_CLOEXEC
);
1632 if (errno
== ENOENT
)
1635 return log_debug_errno(errno
, "Failed to open %s/%s: %m", where
, p
);
1638 r
= take_fdopen_unlocked(&fd
, "r", &f
);
1640 return log_debug_errno(r
, "Failed to convert file handle: %m");
1642 r
= read_line(f
, LONG_LINE_MAX
, &line
);
1644 return log_debug_errno(r
, "Failed to read from %s/%s: %m", where
, p
);
1646 e
= startswith(line
, PORTABLE_DROPIN_MARKER_BEGIN
);
1650 k
= endswith(e
, PORTABLE_DROPIN_MARKER_END
);
1654 marker
= strndup(e
, k
- e
);
1661 r
= marker_matches_images(marker
, name_or_path
, extension_image_paths
);
1664 *ret_marker
= TAKE_PTR(marker
);
1669 int portable_detach(
1671 const char *name_or_path
,
1672 char **extension_image_paths
,
1673 PortableFlags flags
,
1674 PortableChange
**changes
,
1676 sd_bus_error
*error
) {
1678 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1679 _cleanup_set_free_ Set
*unit_files
= NULL
, *markers
= NULL
;
1680 _cleanup_free_
char *extensions
= NULL
;
1681 _cleanup_closedir_
DIR *d
= NULL
;
1682 const char *where
, *item
;
1686 assert(name_or_path
);
1688 r
= lookup_paths_init(&paths
, RUNTIME_SCOPE_SYSTEM
, /* flags= */ 0, NULL
);
1692 where
= attached_path(&paths
, flags
);
1696 if (errno
== ENOENT
)
1699 return log_debug_errno(errno
, "Failed to open '%s' directory: %m", where
);
1702 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to enumerate '%s' directory: %m", where
)) {
1703 _cleanup_free_
char *marker
= NULL
, *unit_name
= NULL
;
1706 /* When a portable service is enabled with "portablectl --copy=symlink --enable --now attach",
1707 * and is disabled with "portablectl --enable --now detach", which calls DisableUnitFilesWithFlags
1708 * DBus method, the main unit file is removed, but its drop-ins are not. Hence, here we need
1709 * to list both main unit files and drop-in directories (without the main unit files). */
1711 dot
= endswith(de
->d_name
, ".d");
1713 unit_name
= strndup(de
->d_name
, dot
- de
->d_name
);
1715 unit_name
= strdup(de
->d_name
);
1719 if (!unit_name_is_valid(unit_name
, UNIT_NAME_ANY
))
1722 /* Filter out duplicates */
1723 if (set_contains(unit_files
, unit_name
))
1726 if (dot
? !IN_SET(de
->d_type
, DT_LNK
, DT_DIR
) : !IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
1729 r
= test_chroot_dropin(d
, where
, unit_name
, name_or_path
, extension_image_paths
, &marker
);
1735 if (!FLAGS_SET(flags
, PORTABLE_REATTACH
) && !FLAGS_SET(flags
, PORTABLE_FORCE_ATTACH
)) {
1736 r
= unit_file_is_active(bus
, unit_name
, error
);
1740 return sd_bus_error_setf(error
, BUS_ERROR_UNIT_EXISTS
, "Unit file '%s' is active, can't detach.", unit_name
);
1743 r
= set_ensure_consume(&unit_files
, &string_hash_ops_free
, TAKE_PTR(unit_name
));
1745 return log_oom_debug();
1747 for (const char *p
= marker
;;) {
1748 _cleanup_free_
char *image
= NULL
;
1750 r
= extract_first_word(&p
, &image
, ":", EXTRACT_UNESCAPE_SEPARATORS
|EXTRACT_RETAIN_ESCAPE
);
1752 return log_debug_errno(r
, "Failed to parse marker: %s", p
);
1756 if (path_is_absolute(image
) && !image_in_search_path(IMAGE_PORTABLE
, NULL
, image
)) {
1757 r
= set_ensure_consume(&markers
, &path_hash_ops_free
, TAKE_PTR(image
));
1764 if (set_isempty(unit_files
))
1767 SET_FOREACH(item
, unit_files
) {
1768 _cleanup_free_
char *md
= NULL
;
1770 if (unlinkat(dirfd(d
), item
, 0) < 0) {
1771 log_debug_errno(errno
, "Can't remove unit file %s/%s: %m", where
, item
);
1773 if (errno
!= ENOENT
&& ret
>= 0)
1776 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, item
, NULL
);
1778 FOREACH_STRING(suffix
, ".d/10-profile.conf", ".d/20-portable.conf") {
1779 _cleanup_free_
char *dropin
= NULL
;
1781 dropin
= strjoin(item
, suffix
);
1785 if (unlinkat(dirfd(d
), dropin
, 0) < 0) {
1786 log_debug_errno(errno
, "Can't remove drop-in %s/%s: %m", where
, dropin
);
1788 if (errno
!= ENOENT
&& ret
>= 0)
1791 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, dropin
, NULL
);
1794 md
= strjoin(item
, ".d");
1798 if (unlinkat(dirfd(d
), md
, AT_REMOVEDIR
) < 0) {
1799 log_debug_errno(errno
, "Can't remove drop-in directory %s/%s: %m", where
, md
);
1801 if (errno
!= ENOENT
&& ret
>= 0)
1804 portable_changes_add_with_prefix(changes
, n_changes
, PORTABLE_UNLINK
, where
, md
, NULL
);
1807 /* Now, also drop any image symlink, for images outside of the sarch path */
1808 SET_FOREACH(item
, markers
) {
1809 _cleanup_free_
char *sl
= NULL
;
1812 r
= image_symlink(item
, flags
, &sl
);
1814 log_debug_errno(r
, "Failed to determine image symlink for '%s', ignoring: %m", item
);
1818 if (lstat(sl
, &st
) < 0) {
1819 log_debug_errno(errno
, "Failed to stat '%s', ignoring: %m", sl
);
1823 if (!S_ISLNK(st
.st_mode
)) {
1824 log_debug("Image '%s' is not a symlink, ignoring.", sl
);
1828 if (unlink(sl
) < 0) {
1829 log_debug_errno(errno
, "Can't remove image symlink '%s': %m", sl
);
1831 if (errno
!= ENOENT
&& ret
>= 0)
1834 portable_changes_add(changes
, n_changes
, PORTABLE_UNLINK
, sl
, NULL
);
1837 /* Try to remove the unit file directory, if we can */
1838 if (rmdir(where
) >= 0)
1839 portable_changes_add(changes
, n_changes
, PORTABLE_UNLINK
, where
, NULL
);
1844 extensions
= strv_join(extension_image_paths
, ", ");
1848 r
= sd_bus_error_setf(error
,
1849 BUS_ERROR_NO_SUCH_UNIT
,
1850 "No unit files associated with '%s%s%s' found attached to the system. Image not attached?",
1852 isempty(extensions
) ? "" : "' or any of its extensions '",
1853 isempty(extensions
) ? "" : extensions
);
1854 return log_debug_errno(r
, "%s", error
->message
);
1857 static int portable_get_state_internal(
1859 const char *name_or_path
,
1860 char **extension_image_paths
,
1861 PortableFlags flags
,
1863 sd_bus_error
*error
) {
1865 _cleanup_(lookup_paths_free
) LookupPaths paths
= {};
1866 bool found_enabled
= false, found_running
= false;
1867 _cleanup_set_free_ Set
*unit_files
= NULL
;
1868 _cleanup_closedir_
DIR *d
= NULL
;
1872 assert(name_or_path
);
1875 r
= lookup_paths_init(&paths
, RUNTIME_SCOPE_SYSTEM
, /* flags= */ 0, NULL
);
1879 where
= attached_path(&paths
, flags
);
1883 if (errno
== ENOENT
) {
1884 /* If the 'attached' directory doesn't exist at all, then we know for sure this image isn't attached. */
1885 *ret
= PORTABLE_DETACHED
;
1889 return log_debug_errno(errno
, "Failed to open '%s' directory: %m", where
);
1892 FOREACH_DIRENT(de
, d
, return log_debug_errno(errno
, "Failed to enumerate '%s' directory: %m", where
)) {
1893 UnitFileState state
;
1895 if (!unit_name_is_valid(de
->d_name
, UNIT_NAME_ANY
))
1898 /* Filter out duplicates */
1899 if (set_contains(unit_files
, de
->d_name
))
1902 if (!IN_SET(de
->d_type
, DT_LNK
, DT_REG
))
1905 r
= test_chroot_dropin(d
, where
, de
->d_name
, name_or_path
, extension_image_paths
, NULL
);
1911 r
= unit_file_lookup_state(RUNTIME_SCOPE_SYSTEM
, &paths
, de
->d_name
, &state
);
1913 return log_debug_errno(r
, "Failed to determine unit file state of '%s': %m", de
->d_name
);
1914 if (!IN_SET(state
, UNIT_FILE_STATIC
, UNIT_FILE_DISABLED
, UNIT_FILE_LINKED
, UNIT_FILE_LINKED_RUNTIME
))
1915 found_enabled
= true;
1917 r
= unit_file_is_active(bus
, de
->d_name
, error
);
1921 found_running
= true;
1923 r
= set_put_strdup(&unit_files
, de
->d_name
);
1925 return log_debug_errno(r
, "Failed to add unit name '%s' to set: %m", de
->d_name
);
1928 *ret
= found_running
? (!set_isempty(unit_files
) && (flags
& PORTABLE_RUNTIME
) ? PORTABLE_RUNNING_RUNTIME
: PORTABLE_RUNNING
) :
1929 found_enabled
? (flags
& PORTABLE_RUNTIME
? PORTABLE_ENABLED_RUNTIME
: PORTABLE_ENABLED
) :
1930 !set_isempty(unit_files
) ? (flags
& PORTABLE_RUNTIME
? PORTABLE_ATTACHED_RUNTIME
: PORTABLE_ATTACHED
) : PORTABLE_DETACHED
;
1935 int portable_get_state(
1937 const char *name_or_path
,
1938 char **extension_image_paths
,
1939 PortableFlags flags
,
1941 sd_bus_error
*error
) {
1943 PortableState state
;
1946 assert(name_or_path
);
1949 /* We look for matching units twice: once in the regular directories, and once in the runtime directories — but
1950 * the latter only if we didn't find anything in the former. */
1952 r
= portable_get_state_internal(bus
, name_or_path
, extension_image_paths
, flags
& ~PORTABLE_RUNTIME
, &state
, error
);
1956 if (state
== PORTABLE_DETACHED
) {
1957 r
= portable_get_state_internal(bus
, name_or_path
, extension_image_paths
, flags
| PORTABLE_RUNTIME
, &state
, error
);
1966 int portable_get_profiles(char ***ret
) {
1969 return conf_files_list_nulstr(ret
, NULL
, NULL
, CONF_FILES_DIRECTORY
|CONF_FILES_BASENAME
|CONF_FILES_FILTER_MASKED
, PORTABLE_PROFILE_DIRS
);
1972 static const char* const portable_change_type_table
[_PORTABLE_CHANGE_TYPE_MAX
] = {
1973 [PORTABLE_COPY
] = "copy",
1974 [PORTABLE_MKDIR
] = "mkdir",
1975 [PORTABLE_SYMLINK
] = "symlink",
1976 [PORTABLE_UNLINK
] = "unlink",
1977 [PORTABLE_WRITE
] = "write",
1980 DEFINE_STRING_TABLE_LOOKUP(portable_change_type
, int);
1982 static const char* const portable_state_table
[_PORTABLE_STATE_MAX
] = {
1983 [PORTABLE_DETACHED
] = "detached",
1984 [PORTABLE_ATTACHED
] = "attached",
1985 [PORTABLE_ATTACHED_RUNTIME
] = "attached-runtime",
1986 [PORTABLE_ENABLED
] = "enabled",
1987 [PORTABLE_ENABLED_RUNTIME
] = "enabled-runtime",
1988 [PORTABLE_RUNNING
] = "running",
1989 [PORTABLE_RUNNING_RUNTIME
] = "running-runtime",
1992 DEFINE_STRING_TABLE_LOOKUP(portable_state
, PortableState
);