1 /* SPDX-License-Identifier: LGPL-2.1+ */
8 #include "alloc-util.h"
9 #include "bus-common-errors.h"
10 #include "bus-label.h"
15 #include "machine-image.h"
16 #include "missing_capability.h"
18 #include "portabled-bus.h"
19 #include "portabled-image-bus.h"
20 #include "portabled-image.h"
21 #include "portabled.h"
22 #include "process-util.h"
24 #include "user-util.h"
26 static BUS_DEFINE_PROPERTY_GET_ENUM(property_get_type
, image_type
, ImageType
);
28 int bus_image_common_get_os_release(
30 sd_bus_message
*message
,
31 const char *name_or_path
,
33 sd_bus_error
*error
) {
37 assert(name_or_path
|| image
);
45 r
= bus_image_acquire(m
,
49 BUS_IMAGE_AUTHENTICATE_BY_PATH
,
50 "org.freedesktop.portable1.inspect-images",
55 if (r
== 0) /* Will call us back */
58 if (!image
->metadata_valid
) {
59 r
= image_read_metadata(image
);
61 return sd_bus_error_set_errnof(error
, r
, "Failed to read image metadata: %m");
64 return bus_reply_pair_array(message
, image
->os_release
);
67 static int bus_image_method_get_os_release(sd_bus_message
*message
, void *userdata
, sd_bus_error
*error
) {
68 return bus_image_common_get_os_release(NULL
, message
, NULL
, userdata
, error
);
71 static int append_fd(sd_bus_message
*m
, PortableMetadata
*d
) {
72 _cleanup_fclose_
FILE *f
= NULL
;
73 _cleanup_free_
char *buf
= NULL
;
81 f
= fdopen(d
->fd
, "r");
87 r
= read_full_stream(f
, &buf
, &n
);
91 return sd_bus_message_append_array(m
, 'y', buf
, n
);
94 int bus_image_common_get_metadata(
96 sd_bus_message
*message
,
97 const char *name_or_path
,
99 sd_bus_error
*error
) {
101 _cleanup_(portable_metadata_unrefp
) PortableMetadata
*os_release
= NULL
;
102 _cleanup_hashmap_free_ Hashmap
*unit_files
= NULL
;
103 _cleanup_(sd_bus_message_unrefp
) sd_bus_message
*reply
= NULL
;
104 _cleanup_free_ PortableMetadata
**sorted
= NULL
;
105 _cleanup_strv_free_
char **matches
= NULL
;
109 assert(name_or_path
|| image
);
117 r
= sd_bus_message_read_strv(message
, &matches
);
121 r
= bus_image_acquire(m
,
125 BUS_IMAGE_AUTHENTICATE_BY_PATH
,
126 "org.freedesktop.portable1.inspect-images",
131 if (r
== 0) /* Will call us back */
134 r
= portable_extract(
143 r
= portable_metadata_hashmap_to_sorted_array(unit_files
, &sorted
);
147 r
= sd_bus_message_new_method_return(message
, &reply
);
151 r
= sd_bus_message_append(reply
, "s", image
->path
);
155 r
= append_fd(reply
, os_release
);
159 r
= sd_bus_message_open_container(reply
, 'a', "{say}");
163 for (i
= 0; i
< hashmap_size(unit_files
); i
++) {
165 r
= sd_bus_message_open_container(reply
, 'e', "say");
169 r
= sd_bus_message_append(reply
, "s", sorted
[i
]->name
);
173 r
= append_fd(reply
, sorted
[i
]);
177 r
= sd_bus_message_close_container(reply
);
182 r
= sd_bus_message_close_container(reply
);
186 return sd_bus_send(NULL
, reply
, NULL
);
189 static int bus_image_method_get_metadata(sd_bus_message
*message
, void *userdata
, sd_bus_error
*error
) {
190 return bus_image_common_get_metadata(NULL
, message
, NULL
, userdata
, error
);
193 static int bus_image_method_get_state(
194 sd_bus_message
*message
,
196 sd_bus_error
*error
) {
198 Image
*image
= userdata
;
205 r
= portable_get_state(
206 sd_bus_message_get_bus(message
),
214 return sd_bus_reply_method_return(message
, "s", portable_state_to_string(state
));
217 int bus_image_common_attach(
219 sd_bus_message
*message
,
220 const char *name_or_path
,
222 sd_bus_error
*error
) {
224 _cleanup_strv_free_
char **matches
= NULL
;
225 PortableChange
*changes
= NULL
;
226 PortableFlags flags
= 0;
227 const char *profile
, *copy_mode
;
228 size_t n_changes
= 0;
232 assert(name_or_path
|| image
);
239 r
= sd_bus_message_read_strv(message
, &matches
);
243 r
= sd_bus_message_read(message
, "sbs", &profile
, &runtime
, ©_mode
);
247 if (streq(copy_mode
, "symlink"))
248 flags
|= PORTABLE_PREFER_SYMLINK
;
249 else if (streq(copy_mode
, "copy"))
250 flags
|= PORTABLE_PREFER_COPY
;
251 else if (!isempty(copy_mode
))
252 return sd_bus_reply_method_errorf(message
, SD_BUS_ERROR_INVALID_ARGS
, "Unknown copy mode '%s'", copy_mode
);
255 flags
|= PORTABLE_RUNTIME
;
257 r
= bus_image_acquire(m
,
261 BUS_IMAGE_AUTHENTICATE_ALL
,
262 "org.freedesktop.portable1.attach-images",
267 if (r
== 0) /* Will call us back */
271 sd_bus_message_get_bus(message
),
282 r
= reply_portable_changes(message
, changes
, n_changes
);
285 portable_changes_free(changes
, n_changes
);
289 static int bus_image_method_attach(sd_bus_message
*message
, void *userdata
, sd_bus_error
*error
) {
290 return bus_image_common_attach(NULL
, message
, NULL
, userdata
, error
);
293 static int bus_image_method_detach(
294 sd_bus_message
*message
,
296 sd_bus_error
*error
) {
298 PortableChange
*changes
= NULL
;
299 Image
*image
= userdata
;
300 Manager
*m
= image
->userdata
;
301 size_t n_changes
= 0;
308 r
= sd_bus_message_read(message
, "b", &runtime
);
312 r
= bus_verify_polkit_async(
315 "org.freedesktop.portable1.attach-images",
324 return 1; /* Will call us back */
327 sd_bus_message_get_bus(message
),
329 runtime
? PORTABLE_RUNTIME
: 0,
336 r
= reply_portable_changes(message
, changes
, n_changes
);
339 portable_changes_free(changes
, n_changes
);
343 int bus_image_common_remove(
345 sd_bus_message
*message
,
346 const char *name_or_path
,
348 sd_bus_error
*error
) {
350 _cleanup_close_pair_
int errno_pipe_fd
[2] = { -1, -1 };
351 _cleanup_(sigkill_waitp
) pid_t child
= 0;
356 assert(name_or_path
|| image
);
363 if (m
->n_operations
>= OPERATIONS_MAX
)
364 return sd_bus_error_setf(error
, SD_BUS_ERROR_LIMITS_EXCEEDED
, "Too many ongoing operations.");
366 r
= bus_image_acquire(m
,
370 BUS_IMAGE_AUTHENTICATE_ALL
,
371 "org.freedesktop.portable1.manage-images",
377 return 1; /* Will call us back */
379 r
= portable_get_state(
380 sd_bus_message_get_bus(message
),
388 if (state
!= PORTABLE_DETACHED
)
389 return sd_bus_error_set_errnof(error
, EBUSY
, "Image '%s' is not detached, refusing.", image
->path
);
391 if (pipe2(errno_pipe_fd
, O_CLOEXEC
|O_NONBLOCK
) < 0)
392 return sd_bus_error_set_errnof(error
, errno
, "Failed to create pipe: %m");
394 r
= safe_fork("(sd-imgrm)", FORK_RESET_SIGNALS
, &child
);
396 return sd_bus_error_set_errnof(error
, r
, "Failed to fork(): %m");
398 errno_pipe_fd
[0] = safe_close(errno_pipe_fd
[0]);
400 r
= image_remove(image
);
402 (void) write(errno_pipe_fd
[1], &r
, sizeof(r
));
409 errno_pipe_fd
[1] = safe_close(errno_pipe_fd
[1]);
411 r
= operation_new(m
, child
, message
, errno_pipe_fd
[0], NULL
);
416 errno_pipe_fd
[0] = -1;
421 static int bus_image_method_remove(sd_bus_message
*message
, void *userdata
, sd_bus_error
*error
) {
422 return bus_image_common_remove(NULL
, message
, NULL
, userdata
, error
);
425 int bus_image_common_mark_read_only(
427 sd_bus_message
*message
,
428 const char *name_or_path
,
430 sd_bus_error
*error
) {
435 assert(name_or_path
|| image
);
442 r
= sd_bus_message_read(message
, "b", &read_only
);
446 r
= bus_image_acquire(m
,
450 BUS_IMAGE_AUTHENTICATE_ALL
,
451 "org.freedesktop.portable1.manage-images",
457 return 1; /* Will call us back */
459 r
= image_read_only(image
, read_only
);
463 return sd_bus_reply_method_return(message
, NULL
);
466 static int bus_image_method_mark_read_only(sd_bus_message
*message
, void *userdata
, sd_bus_error
*error
) {
467 return bus_image_common_mark_read_only(NULL
, message
, NULL
, userdata
, error
);
470 int bus_image_common_set_limit(
472 sd_bus_message
*message
,
473 const char *name_or_path
,
475 sd_bus_error
*error
) {
481 assert(name_or_path
|| image
);
488 r
= sd_bus_message_read(message
, "t", &limit
);
491 if (!FILE_SIZE_VALID_OR_INFINITY(limit
))
492 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "New limit out of range");
494 r
= bus_image_acquire(m
,
498 BUS_IMAGE_AUTHENTICATE_ALL
,
499 "org.freedesktop.portable1.manage-images",
505 return 1; /* Will call us back */
507 r
= image_set_limit(image
, limit
);
511 return sd_bus_reply_method_return(message
, NULL
);
514 static int bus_image_method_set_limit(sd_bus_message
*message
, void *userdata
, sd_bus_error
*error
) {
515 return bus_image_common_set_limit(NULL
, message
, NULL
, userdata
, error
);
518 const sd_bus_vtable image_vtable
[] = {
519 SD_BUS_VTABLE_START(0),
520 SD_BUS_PROPERTY("Name", "s", NULL
, offsetof(Image
, name
), 0),
521 SD_BUS_PROPERTY("Path", "s", NULL
, offsetof(Image
, path
), 0),
522 SD_BUS_PROPERTY("Type", "s", property_get_type
, offsetof(Image
, type
), 0),
523 SD_BUS_PROPERTY("ReadOnly", "b", bus_property_get_bool
, offsetof(Image
, read_only
), 0),
524 SD_BUS_PROPERTY("CreationTimestamp", "t", NULL
, offsetof(Image
, crtime
), 0),
525 SD_BUS_PROPERTY("ModificationTimestamp", "t", NULL
, offsetof(Image
, mtime
), 0),
526 SD_BUS_PROPERTY("Usage", "t", NULL
, offsetof(Image
, usage
), 0),
527 SD_BUS_PROPERTY("Limit", "t", NULL
, offsetof(Image
, limit
), 0),
528 SD_BUS_PROPERTY("UsageExclusive", "t", NULL
, offsetof(Image
, usage_exclusive
), 0),
529 SD_BUS_PROPERTY("LimitExclusive", "t", NULL
, offsetof(Image
, limit_exclusive
), 0),
530 SD_BUS_METHOD("GetOSRelease", NULL
, "a{ss}", bus_image_method_get_os_release
, SD_BUS_VTABLE_UNPRIVILEGED
),
531 SD_BUS_METHOD("GetMetadata", "as", "saya{say}", bus_image_method_get_metadata
, SD_BUS_VTABLE_UNPRIVILEGED
),
532 SD_BUS_METHOD("GetState", NULL
, "s", bus_image_method_get_state
, SD_BUS_VTABLE_UNPRIVILEGED
),
533 SD_BUS_METHOD("Attach", "assbs", "a(sss)", bus_image_method_attach
, SD_BUS_VTABLE_UNPRIVILEGED
),
534 SD_BUS_METHOD("Detach", "b", "a(sss)", bus_image_method_detach
, SD_BUS_VTABLE_UNPRIVILEGED
),
535 SD_BUS_METHOD("Remove", NULL
, NULL
, bus_image_method_remove
, SD_BUS_VTABLE_UNPRIVILEGED
),
536 SD_BUS_METHOD("MarkReadOnly", "b", NULL
, bus_image_method_mark_read_only
, SD_BUS_VTABLE_UNPRIVILEGED
),
537 SD_BUS_METHOD("SetLimit", "t", NULL
, bus_image_method_set_limit
, SD_BUS_VTABLE_UNPRIVILEGED
),
541 int bus_image_path(Image
*image
, char **ret
) {
545 if (!image
->discoverable
)
548 return sd_bus_path_encode("/org/freedesktop/portable1/image", image
->name
, ret
);
551 int bus_image_acquire(
553 sd_bus_message
*message
,
554 const char *name_or_path
,
556 ImageAcquireMode mode
,
557 const char *polkit_action
,
559 sd_bus_error
*error
) {
561 _cleanup_(image_unrefp
) Image
*loaded
= NULL
;
567 assert(name_or_path
|| image
);
569 assert(mode
< _BUS_IMAGE_ACQUIRE_MODE_MAX
);
570 assert(polkit_action
|| mode
== BUS_IMAGE_REFUSE_BY_PATH
);
573 /* Acquires an 'Image' object if not acquired yet, and enforces necessary authentication while doing so. */
575 if (mode
== BUS_IMAGE_AUTHENTICATE_ALL
) {
576 r
= bus_verify_polkit_async(
587 if (r
== 0) { /* Will call us back */
593 /* Already passed in? */
599 /* Let's see if this image is already cached? */
600 cached
= manager_image_cache_get(m
, name_or_path
);
606 if (image_name_is_valid(name_or_path
)) {
608 /* If it's a short name, let's search for it */
609 r
= image_find(IMAGE_PORTABLE
, name_or_path
, &loaded
);
611 return sd_bus_error_setf(error
, BUS_ERROR_NO_SUCH_PORTABLE_IMAGE
, "No image '%s' found.", name_or_path
);
613 /* other errors are handled below… */
615 /* Don't accept path if this is always forbidden */
616 if (mode
== BUS_IMAGE_REFUSE_BY_PATH
)
617 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Expected image name, not path in place of '%s'.", name_or_path
);
619 if (!path_is_absolute(name_or_path
))
620 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Image name '%s' is not valid or not a valid path.", name_or_path
);
622 if (!path_is_normalized(name_or_path
))
623 return sd_bus_error_setf(error
, SD_BUS_ERROR_INVALID_ARGS
, "Image path '%s' is not normalized.", name_or_path
);
625 if (mode
== BUS_IMAGE_AUTHENTICATE_BY_PATH
) {
626 r
= bus_verify_polkit_async(
637 if (r
== 0) { /* Will call us back */
643 r
= image_from_path(name_or_path
, &loaded
);
645 if (r
== -EMEDIUMTYPE
) {
646 sd_bus_error_setf(error
, BUS_ERROR_BAD_PORTABLE_IMAGE_TYPE
, "Typ of image '%s' not recognized; supported image types are directories/btrfs subvolumes, block devices, and raw disk image files with suffix '.raw'.", name_or_path
);
652 /* Add what we just loaded to the cache. This has as side-effect that the object stays in memory until the
653 * cache is purged again, i.e. at least for the current event loop iteration, which is all we need, and which
654 * means we don't actually need to ref the return object. */
655 r
= manager_image_cache_add(m
, loaded
);
663 int bus_image_object_find(
666 const char *interface
,
669 sd_bus_error
*error
) {
671 _cleanup_free_
char *e
= NULL
;
672 Manager
*m
= userdata
;
681 r
= sd_bus_path_decode(path
, "/org/freedesktop/portable1/image", &e
);
687 r
= bus_image_acquire(m
, sd_bus_get_current_message(bus
), e
, NULL
, BUS_IMAGE_REFUSE_BY_PATH
, NULL
, &image
, error
);
701 int bus_image_node_enumerator(sd_bus
*bus
, const char *path
, void *userdata
, char ***nodes
, sd_bus_error
*error
) {
702 _cleanup_hashmap_free_ Hashmap
*images
= NULL
;
703 _cleanup_strv_free_
char **l
= NULL
;
704 size_t n_allocated
= 0, n
= 0;
705 Manager
*m
= userdata
;
714 images
= hashmap_new(&image_hash_ops
);
718 r
= manager_image_cache_discover(m
, images
, error
);
722 HASHMAP_FOREACH(image
, images
, i
) {
725 r
= bus_image_path(image
, &p
);
729 if (!GREEDY_REALLOC(l
, n_allocated
, n
+2)) {
738 *nodes
= TAKE_PTR(l
);