]> git.ipfire.org Git - thirdparty/systemd.git/blob - src/portable/portable.c
projects / thirdparty / systemd.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
portable: use parse_env_file_fd to keep FD valid
[thirdparty/systemd.git] / src / portable / portable.c
1 /* SPDX-License-Identifier: LGPL-2.1-or-later */
2
3 #include <linux/loop.h>
4
5 #include "bus-common-errors.h"
6 #include "bus-error.h"
7 #include "chase.h"
8 #include "conf-files.h"
9 #include "copy.h"
10 #include "data-fd-util.h"
11 #include "constants.h"
12 #include "dirent-util.h"
13 #include "discover-image.h"
14 #include "dissect-image.h"
15 #include "env-file.h"
16 #include "env-util.h"
17 #include "errno-list.h"
18 #include "escape.h"
19 #include "extension-release.h"
20 #include "fd-util.h"
21 #include "fileio.h"
22 #include "fs-util.h"
23 #include "install.h"
24 #include "io-util.h"
25 #include "locale-util.h"
26 #include "loop-util.h"
27 #include "mkdir.h"
28 #include "nulstr-util.h"
29 #include "os-util.h"
30 #include "path-lookup.h"
31 #include "portable.h"
32 #include "process-util.h"
33 #include "selinux-util.h"
34 #include "set.h"
35 #include "signal-util.h"
36 #include "socket-util.h"
37 #include "sort-util.h"
38 #include "string-table.h"
39 #include "strv.h"
40 #include "tmpfile-util.h"
41 #include "user-util.h"
42
43 /* Markers used in the first line of our 20-portable.conf unit file drop-in to determine, that a) the unit file was
44 * dropped there by the portable service logic and b) for which image it was dropped there. */
45 #define PORTABLE_DROPIN_MARKER_BEGIN "# Drop-in created for image '"
46 #define PORTABLE_DROPIN_MARKER_END "', do not edit."
47
48 static bool prefix_match(const char *unit, const char *prefix) {
49 const char *p;
50
51 p = startswith(unit, prefix);
52 if (!p)
53 return false;
54
55 /* Only respect prefixes followed by dash or dot or when there's a complete match */
56 return IN_SET(*p, '-', '.', '@', 0);
57 }
58
59 static bool unit_match(const char *unit, char **matches) {
60 const char *dot;
61
62 dot = strrchr(unit, '.');
63 if (!dot)
64 return false;
65
66 if (!STR_IN_SET(dot, ".service", ".socket", ".target", ".timer", ".path"))
67 return false;
68
69 /* Empty match expression means: everything */
70 if (strv_isempty(matches))
71 return true;
72
73 /* Otherwise, at least one needs to match */
74 STRV_FOREACH(i, matches)
75 if (prefix_match(unit, *i))
76 return true;
77
78 return false;
79 }
80
81 static PortableMetadata *portable_metadata_new(const char *name, const char *path, const char *selinux_label, int fd) {
82 PortableMetadata *m;
83
84 m = malloc0(offsetof(PortableMetadata, name) + strlen(name) + 1);
85 if (!m)
86 return NULL;
87
88 /* In case of a layered attach, we want to remember which image the unit came from */
89 if (path) {
90 m->image_path = strdup(path);
91 if (!m->image_path)
92 return mfree(m);
93 }
94
95 /* The metadata file might have SELinux labels, we need to carry them and reapply them */
96 if (!isempty(selinux_label)) {
97 m->selinux_label = strdup(selinux_label);
98 if (!m->selinux_label) {
99 free(m->image_path);
100 return mfree(m);
101 }
102 }
103
104 strcpy(m->name, name);
105 m->fd = fd;
106
107 return TAKE_PTR(m);
108 }
109
110 PortableMetadata *portable_metadata_unref(PortableMetadata *i) {
111 if (!i)
112 return NULL;
113
114 safe_close(i->fd);
115 free(i->source);
116 free(i->image_path);
117 free(i->selinux_label);
118
119 return mfree(i);
120 }
121
122 static int compare_metadata(PortableMetadata *const *x, PortableMetadata *const *y) {
123 return strcmp((*x)->name, (*y)->name);
124 }
125
126 int portable_metadata_hashmap_to_sorted_array(Hashmap *unit_files, PortableMetadata ***ret) {
127
128 _cleanup_free_ PortableMetadata **sorted = NULL;
129 PortableMetadata *item;
130 size_t k = 0;
131
132 sorted = new(PortableMetadata*, hashmap_size(unit_files));
133 if (!sorted)
134 return -ENOMEM;
135
136 HASHMAP_FOREACH(item, unit_files)
137 sorted[k++] = item;
138
139 assert(k == hashmap_size(unit_files));
140
141 typesafe_qsort(sorted, k, compare_metadata);
142
143 *ret = TAKE_PTR(sorted);
144 return 0;
145 }
146
147 static int send_one_fd_iov_with_data_fd(
148 int socket_fd,
149 const struct iovec *iov,
150 size_t iovlen,
151 int fd) {
152
153 _cleanup_close_ int data_fd = -EBADF;
154
155 assert(iov || iovlen == 0);
156 assert(socket_fd >= 0);
157 assert(fd >= 0);
158
159 data_fd = copy_data_fd(fd);
160 if (data_fd < 0)
161 return data_fd;
162
163 return send_one_fd_iov(socket_fd, data_fd, iov, iovlen, 0);
164 }
165
166 DEFINE_PRIVATE_HASH_OPS_WITH_VALUE_DESTRUCTOR(portable_metadata_hash_ops, char, string_hash_func, string_compare_func,
167 PortableMetadata, portable_metadata_unref);
168
169 static int extract_now(
170 const char *where,
171 char **matches,
172 const char *image_name,
173 bool path_is_extension,
174 bool relax_extension_release_check,
175 int socket_fd,
176 PortableMetadata **ret_os_release,
177 Hashmap **ret_unit_files) {
178
179 _cleanup_hashmap_free_ Hashmap *unit_files = NULL;
180 _cleanup_(portable_metadata_unrefp) PortableMetadata *os_release = NULL;
181 _cleanup_(lookup_paths_free) LookupPaths paths = {};
182 _cleanup_close_ int os_release_fd = -EBADF;
183 _cleanup_free_ char *os_release_path = NULL;
184 const char *os_release_id;
185 int r;
186
187 /* Extracts the metadata from a directory tree 'where'. Extracts two kinds of information: the /etc/os-release
188 * data, and all unit files matching the specified expression. Note that this function is called in two very
189 * different but also similar contexts. When the tool gets invoked on a directory tree, we'll process it
190 * directly, and in-process, and thus can return the requested data directly, via 'ret_os_release' and
191 * 'ret_unit_files'. However, if the tool is invoked on a raw disk image — which needs to be mounted first — we
192 * are invoked in a child process with private mounts and then need to send the collected data to our
193 * parent. To handle both cases in one call this function also gets a 'socket_fd' parameter, which when >= 0 is
194 * used to send the data to the parent. */
195
196 assert(where);
197
198 /* First, find os-release/extension-release and send it upstream (or just save it). */
199 if (path_is_extension) {
200 os_release_id = strjoina("/usr/lib/extension-release.d/extension-release.", image_name);
201 r = open_extension_release(where, image_name, relax_extension_release_check, &os_release_path, &os_release_fd);
202 } else {
203 os_release_id = "/etc/os-release";
204 r = open_os_release(where, &os_release_path, &os_release_fd);
205 }
206 if (r < 0)
207 log_debug_errno(r,
208 "Couldn't acquire %s file, ignoring: %m",
209 path_is_extension ? "extension-release " : "os-release");
210 else {
211 if (socket_fd >= 0) {
212 struct iovec iov[] = {
213 IOVEC_MAKE_STRING(os_release_id),
214 IOVEC_MAKE((char *)"\0", sizeof(char)),
215 };
216
217 r = send_one_fd_iov_with_data_fd(socket_fd, iov, ELEMENTSOF(iov), os_release_fd);
218 if (r < 0)
219 return log_debug_errno(r, "Failed to send os-release file: %m");
220 }
221
222 if (ret_os_release) {
223 os_release = portable_metadata_new(os_release_id, NULL, NULL, os_release_fd);
224 if (!os_release)
225 return -ENOMEM;
226
227 os_release_fd = -EBADF;
228 os_release->source = TAKE_PTR(os_release_path);
229 }
230 }
231
232 /* Then, send unit file data to the parent (or/and add it to the hashmap). For that we use our usual unit
233 * discovery logic. Note that we force looking inside of /lib/systemd/system/ for units too, as we mightbe
234 * compiled for a split-usr system but the image might be a legacy-usr one. */
235 r = lookup_paths_init(&paths, RUNTIME_SCOPE_SYSTEM, LOOKUP_PATHS_SPLIT_USR, where);
236 if (r < 0)
237 return log_debug_errno(r, "Failed to acquire lookup paths: %m");
238
239 unit_files = hashmap_new(&portable_metadata_hash_ops);
240 if (!unit_files)
241 return -ENOMEM;
242
243 STRV_FOREACH(i, paths.search_path) {
244 _cleanup_free_ char *resolved = NULL;
245 _cleanup_closedir_ DIR *d = NULL;
246
247 r = chase_and_opendir(*i, where, 0, &resolved, &d);
248 if (r < 0) {
249 log_debug_errno(r, "Failed to open unit path '%s', ignoring: %m", *i);
250 continue;
251 }
252
253 FOREACH_DIRENT(de, d, return log_debug_errno(errno, "Failed to read directory: %m")) {
254 _cleanup_(portable_metadata_unrefp) PortableMetadata *m = NULL;
255 _cleanup_(mac_selinux_freep) char *con = NULL;
256 _cleanup_close_ int fd = -EBADF;
257
258 if (!unit_name_is_valid(de->d_name, UNIT_NAME_ANY))
259 continue;
260
261 if (!unit_match(de->d_name, matches))
262 continue;
263
264 /* Filter out duplicates */
265 if (hashmap_get(unit_files, de->d_name))
266 continue;
267
268 if (!IN_SET(de->d_type, DT_LNK, DT_REG))
269 continue;
270
271 fd = openat(dirfd(d), de->d_name, O_CLOEXEC|O_RDONLY);
272 if (fd < 0) {
273 log_debug_errno(errno, "Failed to open unit file '%s', ignoring: %m", de->d_name);
274 continue;
275 }
276
277 #if HAVE_SELINUX
278 /* The units will be copied on the host's filesystem, so if they had a SELinux label
279 * we have to preserve it. Copy it out so that it can be applied later. */
280
281 r = fgetfilecon_raw(fd, &con);
282 if (r < 0 && !ERRNO_IS_XATTR_ABSENT(errno))
283 log_debug_errno(errno, "Failed to get SELinux file context from '%s', ignoring: %m", de->d_name);
284 #endif
285
286 if (socket_fd >= 0) {
287 struct iovec iov[] = {
288 IOVEC_MAKE_STRING(de->d_name),
289 IOVEC_MAKE((char *)"\0", sizeof(char)),
290 IOVEC_MAKE_STRING(strempty(con)),
291 };
292
293 r = send_one_fd_iov_with_data_fd(socket_fd, iov, ELEMENTSOF(iov), fd);
294 if (r < 0)
295 return log_debug_errno(r, "Failed to send unit metadata to parent: %m");
296 }
297
298 m = portable_metadata_new(de->d_name, where, con, fd);
299 if (!m)
300 return -ENOMEM;
301 fd = -EBADF;
302
303 m->source = path_join(resolved, de->d_name);
304 if (!m->source)
305 return -ENOMEM;
306
307 r = hashmap_put(unit_files, m->name, m);
308 if (r < 0)
309 return log_debug_errno(r, "Failed to add unit to hashmap: %m");
310 m = NULL;
311 }
312 }
313
314 if (ret_os_release)
315 *ret_os_release = TAKE_PTR(os_release);
316 if (ret_unit_files)
317 *ret_unit_files = TAKE_PTR(unit_files);
318
319 return 0;
320 }
321
322 static int portable_extract_by_path(
323 const char *path,
324 bool path_is_extension,
325 bool relax_extension_release_check,
326 char **matches,
327 PortableMetadata **ret_os_release,
328 Hashmap **ret_unit_files,
329 sd_bus_error *error) {
330
331 _cleanup_hashmap_free_ Hashmap *unit_files = NULL;
332 _cleanup_(portable_metadata_unrefp) PortableMetadata* os_release = NULL;
333 _cleanup_(loop_device_unrefp) LoopDevice *d = NULL;
334 int r;
335
336 assert(path);
337
338 r = loop_device_make_by_path(path, O_RDONLY, /* sector_size= */ UINT32_MAX, LO_FLAGS_PARTSCAN, LOCK_SH, &d);
339 if (r == -EISDIR) {
340 _cleanup_free_ char *image_name = NULL;
341
342 /* We can't turn this into a loop-back block device, and this returns EISDIR? Then this is a directory
343 * tree and not a raw device. It's easy then. */
344
345 r = path_extract_filename(path, &image_name);
346 if (r < 0)
347 return log_error_errno(r, "Failed to extract image name from path '%s': %m", path);
348
349 r = extract_now(path, matches, image_name, path_is_extension, /* relax_extension_release_check= */ false, -1, &os_release, &unit_files);
350 if (r < 0)
351 return r;
352
353 } else if (r < 0)
354 return log_debug_errno(r, "Failed to set up loopback device for %s: %m", path);
355 else {
356 _cleanup_(dissected_image_unrefp) DissectedImage *m = NULL;
357 _cleanup_(rmdir_and_freep) char *tmpdir = NULL;
358 _cleanup_(close_pairp) int seq[2] = PIPE_EBADF;
359 _cleanup_(sigkill_waitp) pid_t child = 0;
360
361 /* We now have a loopback block device, let's fork off a child in its own mount namespace, mount it
362 * there, and extract the metadata we need. The metadata is sent from the child back to us. */
363
364 BLOCK_SIGNALS(SIGCHLD);
365
366 r = mkdtemp_malloc("/tmp/inspect-XXXXXX", &tmpdir);
367 if (r < 0)
368 return log_debug_errno(r, "Failed to create temporary directory: %m");
369
370 r = dissect_loop_device(
371 d,
372 NULL, NULL,
373 DISSECT_IMAGE_READ_ONLY |
374 DISSECT_IMAGE_GENERIC_ROOT |
375 DISSECT_IMAGE_REQUIRE_ROOT |
376 DISSECT_IMAGE_DISCARD_ON_LOOP |
377 DISSECT_IMAGE_RELAX_VAR_CHECK |
378 DISSECT_IMAGE_USR_NO_ROOT |
379 DISSECT_IMAGE_ADD_PARTITION_DEVICES |
380 DISSECT_IMAGE_PIN_PARTITION_DEVICES,
381 &m);
382 if (r == -ENOPKG)
383 sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Couldn't identify a suitable partition table or file system in '%s'.", path);
384 else if (r == -EADDRNOTAVAIL)
385 sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "No root partition for specified root hash found in '%s'.", path);
386 else if (r == -ENOTUNIQ)
387 sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "Multiple suitable root partitions found in image '%s'.", path);
388 else if (r == -ENXIO)
389 sd_bus_error_setf(error, SD_BUS_ERROR_INVALID_ARGS, "No suitable root partition found in image '%s'.", path);
390 else if (r == -EPROTONOSUPPORT)
391 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);
392 if (r < 0)
393 return r;
394
395 if (socketpair(AF_UNIX, SOCK_SEQPACKET|SOCK_CLOEXEC, 0, seq) < 0)
396 return log_debug_errno(errno, "Failed to allocated SOCK_SEQPACKET socket: %m");
397
398 r = safe_fork("(sd-dissect)", FORK_RESET_SIGNALS|FORK_DEATHSIG|FORK_NEW_MOUNTNS|FORK_MOUNTNS_SLAVE|FORK_LOG, &child);
399 if (r < 0)
400 return r;
401 if (r == 0) {
402 DissectImageFlags flags = DISSECT_IMAGE_READ_ONLY;
403
404 seq[0] = safe_close(seq[0]);
405
406 if (path_is_extension)
407 flags |= DISSECT_IMAGE_VALIDATE_OS_EXT | (relax_extension_release_check ? DISSECT_IMAGE_RELAX_SYSEXT_CHECK : 0);
408 else
409 flags |= DISSECT_IMAGE_VALIDATE_OS;
410
411 r = dissected_image_mount(m, tmpdir, UID_INVALID, UID_INVALID, flags);
412 if (r < 0) {
413 log_debug_errno(r, "Failed to mount dissected image: %m");
414 goto child_finish;
415 }
416
417 r = extract_now(tmpdir, matches, m->image_name, path_is_extension, relax_extension_release_check, seq[1], NULL, NULL);
418
419 child_finish:
420 _exit(r < 0 ? EXIT_FAILURE : EXIT_SUCCESS);
421 }
422
423 seq[1] = safe_close(seq[1]);
424
425 unit_files = hashmap_new(&portable_metadata_hash_ops);
426 if (!unit_files)
427 return -ENOMEM;
428
429 for (;;) {
430 _cleanup_(portable_metadata_unrefp) PortableMetadata *add = NULL;
431 _cleanup_close_ int fd = -EBADF;
432 /* We use NAME_MAX space for the SELinux label here. The kernel currently enforces no limit, but
433 * according to suggestions from the SELinux people this will change and it will probably be
434 * identical to NAME_MAX. For now we use that, but this should be updated one day when the final
435 * limit is known. */
436 char iov_buffer[PATH_MAX + NAME_MAX + 2];
437 struct iovec iov = IOVEC_MAKE(iov_buffer, sizeof(iov_buffer));
438
439 ssize_t n = receive_one_fd_iov(seq[0], &iov, 1, 0, &fd);
440 if (n == -EIO)
441 break;
442 if (n < 0)
443 return log_debug_errno(n, "Failed to receive item: %m");
444 iov_buffer[n] = 0;
445
446 /* We can't really distinguish a zero-length datagram without any fds from EOF (both are signalled the
447 * same way by recvmsg()). Hence, accept either as end notification. */
448 if (isempty(iov_buffer) && fd < 0)
449 break;
450
451 if (isempty(iov_buffer) || fd < 0)
452 return log_debug_errno(SYNTHETIC_ERRNO(EINVAL),
453 "Invalid item sent from child.");
454
455 /* Given recvmsg cannot be used with multiple io vectors if you don't know the size in advance,
456 * use a marker to separate the name and the optional SELinux context. */
457 char *selinux_label = memchr(iov_buffer, 0, n);
458 assert(selinux_label);
459 selinux_label++;
460
461 add = portable_metadata_new(iov_buffer, path, selinux_label, fd);
462 if (!add)
463 return -ENOMEM;
464 fd = -EBADF;
465
466 /* Note that we do not initialize 'add->source' here, as the source path is not usable here as
467 * it refers to a path only valid in the short-living namespaced child process we forked
468 * here. */
469
470 if (PORTABLE_METADATA_IS_UNIT(add)) {
471 r = hashmap_put(unit_files, add->name, add);
472 if (r < 0)
473 return log_debug_errno(r, "Failed to add item to unit file list: %m");
474
475 add = NULL;
476
477 } else if (PORTABLE_METADATA_IS_OS_RELEASE(add) || PORTABLE_METADATA_IS_EXTENSION_RELEASE(add)) {
478
479 assert(!os_release);
480 os_release = TAKE_PTR(add);
481 } else
482 assert_not_reached();
483 }
484
485 r = wait_for_terminate_and_check("(sd-dissect)", child, 0);
486 if (r < 0)
487 return r;
488 child = 0;
489 }
490
491 if (!os_release)
492 return sd_bus_error_setf(error,
493 SD_BUS_ERROR_INVALID_ARGS,
494 "Image '%s' lacks %s data, refusing.",
495 path,
496 path_is_extension ? "extension-release" : "os-release");
497
498 if (ret_unit_files)
499 *ret_unit_files = TAKE_PTR(unit_files);
500
501 if (ret_os_release)
502 *ret_os_release = TAKE_PTR(os_release);
503
504 return 0;
505 }
506
507 static int extract_image_and_extensions(
508 const char *name_or_path,
509 char **matches,
510 char **extension_image_paths,
511 bool validate_sysext,
512 bool relax_extension_release_check,
513 Image **ret_image,
514 OrderedHashmap **ret_extension_images,
515 OrderedHashmap **ret_extension_releases,
516 PortableMetadata **ret_os_release,
517 Hashmap **ret_unit_files,
518 char ***ret_valid_prefixes,
519 sd_bus_error *error) {
520
521 _cleanup_free_ char *id = NULL, *version_id = NULL, *sysext_level = NULL;
522 _cleanup_(portable_metadata_unrefp) PortableMetadata *os_release = NULL;
523 _cleanup_ordered_hashmap_free_ OrderedHashmap *extension_images = NULL, *extension_releases = NULL;
524 _cleanup_hashmap_free_ Hashmap *unit_files = NULL;
525 _cleanup_strv_free_ char **valid_prefixes = NULL;
526 _cleanup_(image_unrefp) Image *image = NULL;
527 Image *ext;
528 int r;
529
530 assert(name_or_path);
531
532 r = image_find_harder(IMAGE_PORTABLE, name_or_path, NULL, &image);
533 if (r < 0)
534 return r;
535
536 if (!strv_isempty(extension_image_paths)) {
537 extension_images = ordered_hashmap_new(&image_hash_ops);
538 if (!extension_images)
539 return -ENOMEM;
540
541 if (ret_extension_releases) {
542 extension_releases = ordered_hashmap_new(&portable_metadata_hash_ops);
543 if (!extension_releases)
544 return -ENOMEM;
545 }
546
547 STRV_FOREACH(p, extension_image_paths) {
548 _cleanup_(image_unrefp) Image *new = NULL;
549
550 r = image_find_harder(IMAGE_PORTABLE, *p, NULL, &new);
551 if (r < 0)
552 return r;
553
554 r = ordered_hashmap_put(extension_images, new->name, new);
555 if (r < 0)
556 return r;
557 TAKE_PTR(new);
558 }
559 }
560
561 r = portable_extract_by_path(image->path, /* path_is_extension= */ false, /* relax_extension_release_check= */ false, matches, &os_release, &unit_files, error);
562 if (r < 0)
563 return r;
564
565 /* If we are layering extension images on top of a runtime image, check that the os-release and
566 * extension-release metadata match, otherwise reject it immediately as invalid, or it will fail when
567 * the units are started. Also, collect valid portable prefixes if caller requested that. */
568 if (validate_sysext || ret_valid_prefixes) {
569 _cleanup_free_ char *prefixes = NULL;
570
571 r = parse_env_file_fd(os_release->fd, os_release->name,
572 "ID", &id,
573 "VERSION_ID", &version_id,
574 "SYSEXT_LEVEL", &sysext_level,
575 "PORTABLE_PREFIXES", &prefixes);
576 if (r < 0)
577 return r;
578 if (isempty(id))
579 return sd_bus_error_set_errnof(error, SYNTHETIC_ERRNO(ESTALE), "Image %s os-release metadata lacks the ID field", name_or_path);
580
581 if (prefixes) {
582 valid_prefixes = strv_split(prefixes, WHITESPACE);
583 if (!valid_prefixes)
584 return -ENOMEM;
585 }
586 }
587
588 ORDERED_HASHMAP_FOREACH(ext, extension_images) {
589 _cleanup_(portable_metadata_unrefp) PortableMetadata *extension_release_meta = NULL;
590 _cleanup_hashmap_free_ Hashmap *extra_unit_files = NULL;
591 _cleanup_strv_free_ char **extension_release = NULL;
592 const char *e;
593
594 r = portable_extract_by_path(ext->path, /* path_is_extension= */ true, relax_extension_release_check, matches, &extension_release_meta, &extra_unit_files, error);
595 if (r < 0)
596 return r;
597
598 r = hashmap_move(unit_files, extra_unit_files);
599 if (r < 0)
600 return r;
601
602 if (!validate_sysext && !ret_valid_prefixes && !ret_extension_releases)
603 continue;
604
605 r = load_env_file_pairs_fd(extension_release_meta->fd, extension_release_meta->name, &extension_release);
606 if (r < 0)
607 return r;
608
609 if (validate_sysext) {
610 r = extension_release_validate(ext->path, id, version_id, sysext_level, "portable", extension_release);
611 if (r == 0)
612 return sd_bus_error_set_errnof(error, SYNTHETIC_ERRNO(ESTALE), "Image %s extension-release metadata does not match the root's", ext->path);
613 if (r < 0)
614 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);
615 }
616
617 e = strv_env_pairs_get(extension_release, "PORTABLE_PREFIXES");
618 if (e) {
619 _cleanup_strv_free_ char **l = NULL;
620
621 l = strv_split(e, WHITESPACE);
622 if (!l)
623 return -ENOMEM;
624
625 r = strv_extend_strv(&valid_prefixes, l, true);
626 if (r < 0)
627 return r;
628 }
629
630 if (ret_extension_releases) {
631 r = ordered_hashmap_put(extension_releases, ext->name, extension_release_meta);
632 if (r < 0)
633 return r;
634 TAKE_PTR(extension_release_meta);
635 }
636 }
637
638 strv_sort(valid_prefixes);
639
640 if (ret_image)
641 *ret_image = TAKE_PTR(image);
642 if (ret_extension_images)
643 *ret_extension_images = TAKE_PTR(extension_images);
644 if (ret_extension_releases)
645 *ret_extension_releases = TAKE_PTR(extension_releases);
646 if (ret_os_release)
647 *ret_os_release = TAKE_PTR(os_release);
648 if (ret_unit_files)
649 *ret_unit_files = TAKE_PTR(unit_files);
650 if (ret_valid_prefixes)
651 *ret_valid_prefixes = TAKE_PTR(valid_prefixes);
652
653 return 0;
654 }
655
656 int portable_extract(
657 const char *name_or_path,
658 char **matches,
659 char **extension_image_paths,
660 PortableFlags flags,
661 PortableMetadata **ret_os_release,
662 OrderedHashmap **ret_extension_releases,
663 Hashmap **ret_unit_files,
664 char ***ret_valid_prefixes,
665 sd_bus_error *error) {
666
667 _cleanup_(portable_metadata_unrefp) PortableMetadata *os_release = NULL;
668 _cleanup_ordered_hashmap_free_ OrderedHashmap *extension_images = NULL, *extension_releases = NULL;
669 _cleanup_hashmap_free_ Hashmap *unit_files = NULL;
670 _cleanup_(strv_freep) char **valid_prefixes = NULL;
671 _cleanup_(image_unrefp) Image *image = NULL;
672 int r;
673
674 assert(name_or_path);
675
676 r = extract_image_and_extensions(
677 name_or_path,
678 matches,
679 extension_image_paths,
680 /* validate_sysext= */ false,
681 /* relax_extension_release_check= */ FLAGS_SET(flags, PORTABLE_FORCE_SYSEXT),
682 &image,
683 &extension_images,
684 &extension_releases,
685 &os_release,
686 &unit_files,
687 ret_valid_prefixes ? &valid_prefixes : NULL,
688 error);
689 if (r < 0)
690 return r;
691
692 if (hashmap_isempty(unit_files)) {
693 _cleanup_free_ char *extensions = strv_join(extension_image_paths, ", ");
694 if (!extensions)
695 return -ENOMEM;
696
697 return sd_bus_error_setf(error,
698 SD_BUS_ERROR_INVALID_ARGS,
699 "Couldn't find any matching unit files in image '%s%s%s', refusing.",
700 image->path,
701 isempty(extensions) ? "" : "' or any of its extensions '",
702 isempty(extensions) ? "" : extensions);
703 }
704
705 if (ret_os_release)
706 *ret_os_release = TAKE_PTR(os_release);
707 if (ret_extension_releases)
708 *ret_extension_releases = TAKE_PTR(extension_releases);
709 if (ret_unit_files)
710 *ret_unit_files = TAKE_PTR(unit_files);
711 if (ret_valid_prefixes)
712 *ret_valid_prefixes = TAKE_PTR(valid_prefixes);
713
714 return 0;
715 }
716
717 static int unit_file_is_active(
718 sd_bus *bus,
719 const char *name,
720 sd_bus_error *error) {
721
722 static const char *const active_states[] = {
723 "activating",
724 "active",
725 "reloading",
726 "deactivating",
727 NULL,
728 };
729 int r;
730
731 if (!bus)
732 return false;
733
734 /* If we are looking at a plain or instance things are easy, we can just query the state */
735 if (unit_name_is_valid(name, UNIT_NAME_PLAIN|UNIT_NAME_INSTANCE)) {
736 _cleanup_free_ char *path = NULL, *buf = NULL;
737
738 path = unit_dbus_path_from_name(name);
739 if (!path)
740 return -ENOMEM;
741
742 r = sd_bus_get_property_string(
743 bus,
744 "org.freedesktop.systemd1",
745 path,
746 "org.freedesktop.systemd1.Unit",
747 "ActiveState",
748 error,
749 &buf);
750 if (r < 0)
751 return log_debug_errno(r, "Failed to retrieve unit state: %s", bus_error_message(error, r));
752
753 return strv_contains((char**) active_states, buf);
754 }
755
756 /* Otherwise we need to enumerate. But let's build the most restricted query we can */
757 if (unit_name_is_valid(name, UNIT_NAME_TEMPLATE)) {
758 _cleanup_(sd_bus_message_unrefp) sd_bus_message *m = NULL, *reply = NULL;
759 const char *at, *prefix, *joined;
760
761 r = sd_bus_message_new_method_call(
762 bus,
763 &m,
764 "org.freedesktop.systemd1",
765 "/org/freedesktop/systemd1",
766 "org.freedesktop.systemd1.Manager",
767 "ListUnitsByPatterns");
768 if (r < 0)
769 return r;
770
771 r = sd_bus_message_append_strv(m, (char**) active_states);
772 if (r < 0)
773 return r;
774
775 at = strchr(name, '@');
776 assert(at);
777
778 prefix = strndupa_safe(name, at + 1 - name);
779 joined = strjoina(prefix, "*", at + 1);
780
781 r = sd_bus_message_append_strv(m, STRV_MAKE(joined));
782 if (r < 0)
783 return r;
784
785 r = sd_bus_call(bus, m, 0, error, &reply);
786 if (r < 0)
787 return log_debug_errno(r, "Failed to list units: %s", bus_error_message(error, r));
788
789 r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_ARRAY, "(ssssssouso)");
790 if (r < 0)
791 return r;
792
793 r = sd_bus_message_enter_container(reply, SD_BUS_TYPE_STRUCT, "ssssssouso");
794 if (r < 0)
795 return r;
796
797 return r > 0;
798 }
799
800 return -EINVAL;
801 }
802
803 static int portable_changes_add(
804 PortableChange **changes,
805 size_t *n_changes,
806 int type_or_errno, /* PORTABLE_COPY, PORTABLE_SYMLINK, … if positive, or errno if negative */
807 const char *path,
808 const char *source) {
809
810 _cleanup_free_ char *p = NULL, *s = NULL;
811 PortableChange *c;
812
813 assert(path);
814 assert(!changes == !n_changes);
815
816 if (type_or_errno >= 0)
817 assert(type_or_errno < _PORTABLE_CHANGE_TYPE_MAX);
818 else
819 assert(type_or_errno >= -ERRNO_MAX);
820
821 if (!changes)
822 return 0;
823
824 c = reallocarray(*changes, *n_changes + 1, sizeof(PortableChange));
825 if (!c)
826 return -ENOMEM;
827 *changes = c;
828
829 p = strdup(path);
830 if (!p)
831 return -ENOMEM;
832
833 path_simplify(p);
834
835 if (source) {
836 s = strdup(source);
837 if (!s)
838 return -ENOMEM;
839
840 path_simplify(s);
841 }
842
843 c[(*n_changes)++] = (PortableChange) {
844 .type_or_errno = type_or_errno,
845 .path = TAKE_PTR(p),
846 .source = TAKE_PTR(s),
847 };
848
849 return 0;
850 }
851
852 static int portable_changes_add_with_prefix(
853 PortableChange **changes,
854 size_t *n_changes,
855 int type_or_errno,
856 const char *prefix,
857 const char *path,
858 const char *source) {
859
860 _cleanup_free_ char *path_buf = NULL, *source_buf = NULL;
861
862 assert(path);
863 assert(!changes == !n_changes);
864
865 if (!changes)
866 return 0;
867
868 if (prefix) {
869 path_buf = path_join(prefix, path);
870 if (!path_buf)
871 return -ENOMEM;
872
873 path = path_buf;
874
875 if (source) {
876 source_buf = path_join(prefix, source);
877 if (!source_buf)
878 return -ENOMEM;
879
880 source = source_buf;
881 }
882 }
883
884 return portable_changes_add(changes, n_changes, type_or_errno, path, source);
885 }
886
887 void portable_changes_free(PortableChange *changes, size_t n_changes) {
888 size_t i;
889
890 assert(changes || n_changes == 0);
891
892 for (i = 0; i < n_changes; i++) {
893 free(changes[i].path);
894 free(changes[i].source);
895 }
896
897 free(changes);
898 }
899
900 static const char *root_setting_from_image(ImageType type) {
901 return IN_SET(type, IMAGE_DIRECTORY, IMAGE_SUBVOLUME) ? "RootDirectory=" : "RootImage=";
902 }
903
904 static const char *extension_setting_from_image(ImageType type) {
905 return IN_SET(type, IMAGE_DIRECTORY, IMAGE_SUBVOLUME) ? "ExtensionDirectories=" : "ExtensionImages=";
906 }
907
908 static int make_marker_text(const char *image_path, OrderedHashmap *extension_images, char **ret_text) {
909 _cleanup_free_ char *text = NULL, *escaped_image_path = NULL;
910 Image *ext;
911
912 assert(image_path);
913 assert(ret_text);
914
915 escaped_image_path = xescape(image_path, ":");
916 if (!escaped_image_path)
917 return -ENOMEM;
918
919 /* If the image is layered, include all layers in the marker as a colon-separated
920 * list of paths, so that we can do exact matches on removal. */
921 text = strjoin(PORTABLE_DROPIN_MARKER_BEGIN, escaped_image_path);
922 if (!text)
923 return -ENOMEM;
924
925 ORDERED_HASHMAP_FOREACH(ext, extension_images) {
926 _cleanup_free_ char *escaped = NULL;
927
928 escaped = xescape(ext->path, ":");
929 if (!escaped)
930 return -ENOMEM;
931
932 if (!strextend(&text, ":", escaped))
933 return -ENOMEM;
934 }
935
936 if (!strextend(&text, PORTABLE_DROPIN_MARKER_END "\n"))
937 return -ENOMEM;
938
939 *ret_text = TAKE_PTR(text);
940 return 0;
941 }
942
943 static int install_chroot_dropin(
944 const char *image_path,
945 ImageType type,
946 OrderedHashmap *extension_images,
947 const PortableMetadata *m,
948 const char *dropin_dir,
949 PortableFlags flags,
950 char **ret_dropin,
951 PortableChange **changes,
952 size_t *n_changes) {
953
954 _cleanup_free_ char *text = NULL, *dropin = NULL;
955 int r;
956
957 assert(image_path);
958 assert(m);
959 assert(dropin_dir);
960
961 dropin = path_join(dropin_dir, "20-portable.conf");
962 if (!dropin)
963 return -ENOMEM;
964
965 r = make_marker_text(image_path, extension_images, &text);
966 if (r < 0)
967 return log_debug_errno(r, "Failed to generate marker string for portable drop-in: %m");
968
969 if (endswith(m->name, ".service")) {
970 const char *os_release_source, *root_type;
971 _cleanup_free_ char *base_name = NULL;
972 Image *ext;
973
974 root_type = root_setting_from_image(type);
975
976 if (access("/etc/os-release", F_OK) < 0) {
977 if (errno != ENOENT)
978 return log_debug_errno(errno, "Failed to check if /etc/os-release exists: %m");
979
980 os_release_source = "/usr/lib/os-release";
981 } else
982 os_release_source = "/etc/os-release";
983
984 r = path_extract_filename(m->image_path ?: image_path, &base_name);
985 if (r < 0)
986 return log_debug_errno(r, "Failed to extract basename from '%s': %m", m->image_path ?: image_path);
987
988 if (!strextend(&text,
989 "\n"
990 "[Service]\n",
991 root_type, image_path, "\n"
992 "Environment=PORTABLE=", base_name, "\n"
993 "BindReadOnlyPaths=", os_release_source, ":/run/host/os-release\n"
994 "LogExtraFields=PORTABLE=", base_name, "\n"))
995 return -ENOMEM;
996
997 if (m->image_path && !path_equal(m->image_path, image_path))
998 ORDERED_HASHMAP_FOREACH(ext, extension_images)
999 if (!strextend(&text,
1000 extension_setting_from_image(ext->type),
1001 ext->path,
1002 /* With --force tell PID1 to avoid enforcing that the image <name> and
1003 * extension-release.<name> have to match. */
1004 !IN_SET(type, IMAGE_DIRECTORY, IMAGE_SUBVOLUME) &&
1005 FLAGS_SET(flags, PORTABLE_FORCE_SYSEXT) ?
1006 ":x-systemd.relax-extension-release-check" :
1007 "",
1008 "\n"))
1009 return -ENOMEM;
1010 }
1011
1012 r = write_string_file(dropin, text, WRITE_STRING_FILE_CREATE|WRITE_STRING_FILE_ATOMIC);
1013 if (r < 0)
1014 return log_debug_errno(r, "Failed to write '%s': %m", dropin);
1015
1016 (void) portable_changes_add(changes, n_changes, PORTABLE_WRITE, dropin, NULL);
1017
1018 if (ret_dropin)
1019 *ret_dropin = TAKE_PTR(dropin);
1020
1021 return 0;
1022 }
1023
1024 static int install_profile_dropin(
1025 const char *image_path,
1026 const PortableMetadata *m,
1027 const char *dropin_dir,
1028 const char *profile,
1029 PortableFlags flags,
1030 char **ret_dropin,
1031 PortableChange **changes,
1032 size_t *n_changes) {
1033
1034 _cleanup_free_ char *dropin = NULL, *from = NULL;
1035 int r;
1036
1037 assert(image_path);
1038 assert(m);
1039 assert(dropin_dir);
1040
1041 if (!profile)
1042 return 0;
1043
1044 r = find_portable_profile(profile, m->name, &from);
1045 if (r < 0) {
1046 if (r != -ENOENT)
1047 return log_debug_errno(errno, "Profile '%s' is not accessible: %m", profile);
1048
1049 log_debug_errno(errno, "Skipping link to profile '%s', as it does not exist: %m", profile);
1050 return 0;
1051 }
1052
1053 dropin = path_join(dropin_dir, "10-profile.conf");
1054 if (!dropin)
1055 return -ENOMEM;
1056
1057 if (flags & PORTABLE_PREFER_COPY) {
1058
1059 r = copy_file_atomic(from, dropin, 0644, COPY_REFLINK);
1060 if (r < 0)
1061 return log_debug_errno(r, "Failed to copy %s %s %s: %m", from, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT), dropin);
1062
1063 (void) portable_changes_add(changes, n_changes, PORTABLE_COPY, dropin, from);
1064
1065 } else {
1066
1067 if (symlink(from, dropin) < 0)
1068 return log_debug_errno(errno, "Failed to link %s %s %s: %m", from, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT), dropin);
1069
1070 (void) portable_changes_add(changes, n_changes, PORTABLE_SYMLINK, dropin, from);
1071 }
1072
1073 if (ret_dropin)
1074 *ret_dropin = TAKE_PTR(dropin);
1075
1076 return 0;
1077 }
1078
1079 static const char *attached_path(const LookupPaths *paths, PortableFlags flags) {
1080 const char *where;
1081
1082 assert(paths);
1083
1084 if (flags & PORTABLE_RUNTIME)
1085 where = paths->runtime_attached;
1086 else
1087 where = paths->persistent_attached;
1088
1089 assert(where);
1090 return where;
1091 }
1092
1093 static int attach_unit_file(
1094 const LookupPaths *paths,
1095 const char *image_path,
1096 ImageType type,
1097 OrderedHashmap *extension_images,
1098 const PortableMetadata *m,
1099 const char *profile,
1100 PortableFlags flags,
1101 PortableChange **changes,
1102 size_t *n_changes) {
1103
1104 _cleanup_(unlink_and_freep) char *chroot_dropin = NULL, *profile_dropin = NULL;
1105 _cleanup_(rmdir_and_freep) char *dropin_dir = NULL;
1106 _cleanup_free_ char *path = NULL;
1107 const char *where;
1108 int r;
1109
1110 assert(paths);
1111 assert(image_path);
1112 assert(m);
1113 assert(PORTABLE_METADATA_IS_UNIT(m));
1114
1115 where = attached_path(paths, flags);
1116
1117 (void) mkdir_parents(where, 0755);
1118 if (mkdir(where, 0755) < 0) {
1119 if (errno != EEXIST)
1120 return log_debug_errno(errno, "Failed to create attach directory %s: %m", where);
1121 } else
1122 (void) portable_changes_add(changes, n_changes, PORTABLE_MKDIR, where, NULL);
1123
1124 path = path_join(where, m->name);
1125 if (!path)
1126 return -ENOMEM;
1127
1128 dropin_dir = strjoin(path, ".d");
1129 if (!dropin_dir)
1130 return -ENOMEM;
1131
1132 if (mkdir(dropin_dir, 0755) < 0) {
1133 if (errno != EEXIST)
1134 return log_debug_errno(errno, "Failed to create drop-in directory %s: %m", dropin_dir);
1135 } else
1136 (void) portable_changes_add(changes, n_changes, PORTABLE_MKDIR, dropin_dir, NULL);
1137
1138 /* We install the drop-ins first, and the actual unit file last to achieve somewhat atomic behaviour if PID 1
1139 * is reloaded while we are creating things here: as long as only the drop-ins exist the unit doesn't exist at
1140 * all for PID 1. */
1141
1142 r = install_chroot_dropin(image_path, type, extension_images, m, dropin_dir, flags, &chroot_dropin, changes, n_changes);
1143 if (r < 0)
1144 return r;
1145
1146 r = install_profile_dropin(image_path, m, dropin_dir, profile, flags, &profile_dropin, changes, n_changes);
1147 if (r < 0)
1148 return r;
1149
1150 if ((flags & PORTABLE_PREFER_SYMLINK) && m->source) {
1151
1152 if (symlink(m->source, path) < 0)
1153 return log_debug_errno(errno, "Failed to symlink unit file '%s': %m", path);
1154
1155 (void) portable_changes_add(changes, n_changes, PORTABLE_SYMLINK, path, m->source);
1156
1157 } else {
1158 _cleanup_(unlink_and_freep) char *tmp = NULL;
1159 _cleanup_close_ int fd = -EBADF;
1160
1161 (void) mac_selinux_create_file_prepare_label(path, m->selinux_label);
1162
1163 fd = open_tmpfile_linkable(path, O_WRONLY|O_CLOEXEC, &tmp);
1164 mac_selinux_create_file_clear(); /* Clear immediately in case of errors */
1165 if (fd < 0)
1166 return log_debug_errno(fd, "Failed to create unit file '%s': %m", path);
1167
1168 r = copy_bytes(m->fd, fd, UINT64_MAX, COPY_REFLINK);
1169 if (r < 0)
1170 return log_debug_errno(r, "Failed to copy unit file '%s': %m", path);
1171
1172 if (fchmod(fd, 0644) < 0)
1173 return log_debug_errno(errno, "Failed to change unit file access mode for '%s': %m", path);
1174
1175 r = link_tmpfile(fd, tmp, path, /* replace= */ false);
1176 if (r < 0)
1177 return log_debug_errno(r, "Failed to install unit file '%s': %m", path);
1178
1179 tmp = mfree(tmp);
1180
1181 (void) portable_changes_add(changes, n_changes, PORTABLE_COPY, path, m->source);
1182 }
1183
1184 /* All is established now, now let's disable any rollbacks */
1185 chroot_dropin = mfree(chroot_dropin);
1186 profile_dropin = mfree(profile_dropin);
1187 dropin_dir = mfree(dropin_dir);
1188
1189 return 0;
1190 }
1191
1192 static int image_symlink(
1193 const char *image_path,
1194 PortableFlags flags,
1195 char **ret) {
1196
1197 const char *fn, *where;
1198 char *joined = NULL;
1199
1200 assert(image_path);
1201 assert(ret);
1202
1203 fn = last_path_component(image_path);
1204
1205 if (flags & PORTABLE_RUNTIME)
1206 where = "/run/portables/";
1207 else
1208 where = "/etc/portables/";
1209
1210 joined = strjoin(where, fn);
1211 if (!joined)
1212 return -ENOMEM;
1213
1214 *ret = joined;
1215 return 0;
1216 }
1217
1218 static int install_image_symlink(
1219 const char *image_path,
1220 PortableFlags flags,
1221 PortableChange **changes,
1222 size_t *n_changes) {
1223
1224 _cleanup_free_ char *sl = NULL;
1225 int r;
1226
1227 assert(image_path);
1228
1229 /* If the image is outside of the image search also link it into it, so that it can be found with short image
1230 * names and is listed among the images. */
1231
1232 if (image_in_search_path(IMAGE_PORTABLE, NULL, image_path))
1233 return 0;
1234
1235 r = image_symlink(image_path, flags, &sl);
1236 if (r < 0)
1237 return log_debug_errno(r, "Failed to generate image symlink path: %m");
1238
1239 (void) mkdir_parents(sl, 0755);
1240
1241 if (symlink(image_path, sl) < 0)
1242 return log_debug_errno(errno, "Failed to link %s %s %s: %m", image_path, special_glyph(SPECIAL_GLYPH_ARROW_RIGHT), sl);
1243
1244 (void) portable_changes_add(changes, n_changes, PORTABLE_SYMLINK, sl, image_path);
1245 return 0;
1246 }
1247
1248 static int install_image_and_extensions_symlinks(
1249 const Image *image,
1250 OrderedHashmap *extension_images,
1251 PortableFlags flags,
1252 PortableChange **changes,
1253 size_t *n_changes) {
1254
1255 Image *ext;
1256 int r;
1257
1258 assert(image);
1259
1260 ORDERED_HASHMAP_FOREACH(ext, extension_images) {
1261 r = install_image_symlink(ext->path, flags, changes, n_changes);
1262 if (r < 0)
1263 return r;
1264 }
1265
1266 r = install_image_symlink(image->path, flags, changes, n_changes);
1267 if (r < 0)
1268 return r;
1269
1270 return 0;
1271 }
1272
1273 static bool prefix_matches_compatible(char **matches, char **valid_prefixes) {
1274 /* Checks if all 'matches' are included in the list of 'valid_prefixes' */
1275
1276 STRV_FOREACH(m, matches)
1277 if (!strv_contains(valid_prefixes, *m))
1278 return false;
1279
1280 return true;
1281 }
1282
1283 int portable_attach(
1284 sd_bus *bus,
1285 const char *name_or_path,
1286 char **matches,
1287 const char *profile,
1288 char **extension_image_paths,
1289 PortableFlags flags,
1290 PortableChange **changes,
1291 size_t *n_changes,
1292 sd_bus_error *error) {
1293
1294 _cleanup_ordered_hashmap_free_ OrderedHashmap *extension_images = NULL;
1295 _cleanup_hashmap_free_ Hashmap *unit_files = NULL;
1296 _cleanup_(lookup_paths_free) LookupPaths paths = {};
1297 _cleanup_strv_free_ char **valid_prefixes = NULL;
1298 _cleanup_(image_unrefp) Image *image = NULL;
1299 PortableMetadata *item;
1300 int r;
1301
1302 r = extract_image_and_extensions(
1303 name_or_path,
1304 matches,
1305 extension_image_paths,
1306 /* validate_sysext= */ true,
1307 /* relax_extension_release_check= */ FLAGS_SET(flags, PORTABLE_FORCE_SYSEXT),
1308 &image,
1309 &extension_images,
1310 /* extension_releases= */ NULL,
1311 /* os_release= */ NULL,
1312 &unit_files,
1313 &valid_prefixes,
1314 error);
1315 if (r < 0)
1316 return r;
1317
1318 if (valid_prefixes && !prefix_matches_compatible(matches, valid_prefixes)) {
1319 _cleanup_free_ char *matches_joined = NULL, *extensions_joined = NULL, *valid_prefixes_joined = NULL;
1320
1321 matches_joined = strv_join(matches, "', '");
1322 if (!matches_joined)
1323 return -ENOMEM;
1324
1325 extensions_joined = strv_join(extension_image_paths, ", ");
1326 if (!extensions_joined)
1327 return -ENOMEM;
1328
1329 valid_prefixes_joined = strv_join(valid_prefixes, ", ");
1330 if (!valid_prefixes_joined)
1331 return -ENOMEM;
1332
1333 return sd_bus_error_setf(
1334 error,
1335 SD_BUS_ERROR_INVALID_ARGS,
1336 "Selected matches '%s' are not compatible with portable service image '%s%s%s', refusing. (Acceptable prefix matches are: %s)",
1337 matches_joined,
1338 image->path,
1339 isempty(extensions_joined) ? "" : "' or any of its extensions '",
1340 strempty(extensions_joined),
1341 valid_prefixes_joined);
1342 }
1343
1344 if (hashmap_isempty(unit_files)) {
1345 _cleanup_free_ char *extensions_joined = strv_join(extension_image_paths, ", ");
1346 if (!extensions_joined)
1347 return -ENOMEM;
1348
1349 return sd_bus_error_setf(
1350 error,
1351 SD_BUS_ERROR_INVALID_ARGS,
1352 "Couldn't find any matching unit files in image '%s%s%s', refusing.",
1353 image->path,
1354 isempty(extensions_joined) ? "" : "' or any of its extensions '",
1355 strempty(extensions_joined));
1356 }
1357
1358 r = lookup_paths_init(&paths, RUNTIME_SCOPE_SYSTEM, LOOKUP_PATHS_SPLIT_USR, NULL);
1359 if (r < 0)
1360 return r;
1361
1362 if (!FLAGS_SET(flags, PORTABLE_REATTACH) && !FLAGS_SET(flags, PORTABLE_FORCE_ATTACH))
1363 HASHMAP_FOREACH(item, unit_files) {
1364 r = unit_file_exists(RUNTIME_SCOPE_SYSTEM, &paths, item->name);
1365 if (r < 0)
1366 return sd_bus_error_set_errnof(error, r, "Failed to determine whether unit '%s' exists on the host: %m", item->name);
1367 if (r > 0)
1368 return sd_bus_error_setf(error, BUS_ERROR_UNIT_EXISTS, "Unit file '%s' exists on the host already, refusing.", item->name);
1369
1370 r = unit_file_is_active(bus, item->name, error);
1371 if (r < 0)
1372 return r;
1373 if (r > 0)
1374 return sd_bus_error_setf(error, BUS_ERROR_UNIT_EXISTS, "Unit file '%s' is active already, refusing.", item->name);
1375 }
1376
1377 HASHMAP_FOREACH(item, unit_files) {
1378 r = attach_unit_file(&paths, image->path, image->type, extension_images,
1379 item, profile, flags, changes, n_changes);
1380 if (r < 0)
1381 return sd_bus_error_set_errnof(error, r, "Failed to attach unit '%s': %m", item->name);
1382 }
1383
1384 /* We don't care too much for the image symlink, it's just a convenience thing, it's not necessary for proper
1385 * operation otherwise. */
1386 (void) install_image_and_extensions_symlinks(image, extension_images, flags, changes, n_changes);
1387
1388 return 0;
1389 }
1390
1391 static bool marker_matches_images(const char *marker, const char *name_or_path, char **extension_image_paths) {
1392 _cleanup_strv_free_ char **root_and_extensions = NULL;
1393 const char *a;
1394 int r;
1395
1396 assert(marker);
1397 assert(name_or_path);
1398
1399 /* If extensions were used when attaching, the marker will be a colon-separated
1400 * list of images/paths. We enforce strict 1:1 matching, so that we are sure
1401 * we are detaching exactly what was attached.
1402 * For each image, starting with the root, we look for a token in the marker,
1403 * and return a negative answer on any non-matching combination. */
1404
1405 root_and_extensions = strv_new(name_or_path);
1406 if (!root_and_extensions)
1407 return -ENOMEM;
1408
1409 r = strv_extend_strv(&root_and_extensions, extension_image_paths, false);
1410 if (r < 0)
1411 return r;
1412
1413 STRV_FOREACH(image_name_or_path, root_and_extensions) {
1414 _cleanup_free_ char *image = NULL;
1415
1416 r = extract_first_word(&marker, &image, ":", EXTRACT_UNQUOTE|EXTRACT_RETAIN_ESCAPE);
1417 if (r < 0)
1418 return log_debug_errno(r, "Failed to parse marker: %s", marker);
1419 if (r == 0)
1420 return false;
1421
1422 a = last_path_component(image);
1423
1424 if (image_name_is_valid(*image_name_or_path)) {
1425 const char *e, *underscore;
1426
1427 /* We shall match against an image name. In that case let's compare the last component, and optionally
1428 * allow either a suffix of ".raw" or a series of "/".
1429 * But allow matching on a different version of the same image, when a "_" is used as a separator. */
1430 underscore = strchr(*image_name_or_path, '_');
1431 if (underscore) {
1432 if (strneq(a, *image_name_or_path, underscore - *image_name_or_path))
1433 continue;
1434 return false;
1435 }
1436
1437 e = startswith(a, *image_name_or_path);
1438 if (!e)
1439 return false;
1440
1441 if(!(e[strspn(e, "/")] == 0 || streq(e, ".raw")))
1442 return false;
1443 } else {
1444 const char *b, *underscore;
1445 size_t l;
1446
1447 /* We shall match against a path. Let's ignore any prefix here though, as often there are many ways to
1448 * reach the same file. However, in this mode, let's validate any file suffix.
1449 * But also ensure that we don't fail if both components don't have a '/' at all
1450 * (strcspn returns the full length of the string in that case, which might not
1451 * match as the versions might differ). */
1452
1453 l = strcspn(a, "/");
1454 b = last_path_component(*image_name_or_path);
1455
1456 if ((a[l] != '/') != !strchr(b, '/')) /* One is a directory, the other is not */
1457 return false;
1458
1459 if (a[l] != 0 && strcspn(b, "/") != l)
1460 return false;
1461
1462 underscore = strchr(b, '_');
1463 if (underscore)
1464 l = underscore - b;
1465 else { /* Either component could be versioned */
1466 underscore = strchr(a, '_');
1467 if (underscore)
1468 l = underscore - a;
1469 }
1470
1471 if (!strneq(a, b, l))
1472 return false;
1473 }
1474 }
1475
1476 return true;
1477 }
1478
1479 static int test_chroot_dropin(
1480 DIR *d,
1481 const char *where,
1482 const char *fname,
1483 const char *name_or_path,
1484 char **extension_image_paths,
1485 char **ret_marker) {
1486
1487 _cleanup_free_ char *line = NULL, *marker = NULL;
1488 _cleanup_fclose_ FILE *f = NULL;
1489 _cleanup_close_ int fd = -EBADF;
1490 const char *p, *e, *k;
1491 int r;
1492
1493 assert(d);
1494 assert(where);
1495 assert(fname);
1496
1497 /* We recognize unis created from portable images via the drop-in we created for them */
1498
1499 p = strjoina(fname, ".d/20-portable.conf");
1500 fd = openat(dirfd(d), p, O_RDONLY|O_CLOEXEC);
1501 if (fd < 0) {
1502 if (errno == ENOENT)
1503 return 0;
1504
1505 return log_debug_errno(errno, "Failed to open %s/%s: %m", where, p);
1506 }
1507
1508 r = take_fdopen_unlocked(&fd, "r", &f);
1509 if (r < 0)
1510 return log_debug_errno(r, "Failed to convert file handle: %m");
1511
1512 r = read_line(f, LONG_LINE_MAX, &line);
1513 if (r < 0)
1514 return log_debug_errno(r, "Failed to read from %s/%s: %m", where, p);
1515
1516 e = startswith(line, PORTABLE_DROPIN_MARKER_BEGIN);
1517 if (!e)
1518 return 0;
1519
1520 k = endswith(e, PORTABLE_DROPIN_MARKER_END);
1521 if (!k)
1522 return 0;
1523
1524 marker = strndup(e, k - e);
1525 if (!marker)
1526 return -ENOMEM;
1527
1528 if (!name_or_path)
1529 r = true;
1530 else
1531 r = marker_matches_images(marker, name_or_path, extension_image_paths);
1532
1533 if (ret_marker)
1534 *ret_marker = TAKE_PTR(marker);
1535
1536 return r;
1537 }
1538
1539 int portable_detach(
1540 sd_bus *bus,
1541 const char *name_or_path,
1542 char **extension_image_paths,
1543 PortableFlags flags,
1544 PortableChange **changes,
1545 size_t *n_changes,
1546 sd_bus_error *error) {
1547
1548 _cleanup_(lookup_paths_free) LookupPaths paths = {};
1549 _cleanup_set_free_ Set *unit_files = NULL, *markers = NULL;
1550 _cleanup_free_ char *extensions = NULL;
1551 _cleanup_closedir_ DIR *d = NULL;
1552 const char *where, *item;
1553 int ret = 0;
1554 int r;
1555
1556 assert(name_or_path);
1557
1558 r = lookup_paths_init(&paths, RUNTIME_SCOPE_SYSTEM, LOOKUP_PATHS_SPLIT_USR, NULL);
1559 if (r < 0)
1560 return r;
1561
1562 where = attached_path(&paths, flags);
1563
1564 d = opendir(where);
1565 if (!d) {
1566 if (errno == ENOENT)
1567 goto not_found;
1568
1569 return log_debug_errno(errno, "Failed to open '%s' directory: %m", where);
1570 }
1571
1572 FOREACH_DIRENT(de, d, return log_debug_errno(errno, "Failed to enumerate '%s' directory: %m", where)) {
1573 _cleanup_free_ char *marker = NULL, *unit_name = NULL;
1574 const char *dot;
1575
1576 /* When a portable service is enabled with "portablectl --copy=symlink --enable --now attach",
1577 * and is disabled with "portablectl --enable --now detach", which calls DisableUnitFilesWithFlags
1578 * DBus method, the main unit file is removed, but its drop-ins are not. Hence, here we need
1579 * to list both main unit files and drop-in directories (without the main unit files). */
1580
1581 dot = endswith(de->d_name, ".d");
1582 if (dot)
1583 unit_name = strndup(de->d_name, dot - de->d_name);
1584 else
1585 unit_name = strdup(de->d_name);
1586 if (!unit_name)
1587 return -ENOMEM;
1588
1589 if (!unit_name_is_valid(unit_name, UNIT_NAME_ANY))
1590 continue;
1591
1592 /* Filter out duplicates */
1593 if (set_contains(unit_files, unit_name))
1594 continue;
1595
1596 if (dot ? !IN_SET(de->d_type, DT_LNK, DT_DIR) : !IN_SET(de->d_type, DT_LNK, DT_REG))
1597 continue;
1598
1599 r = test_chroot_dropin(d, where, unit_name, name_or_path, extension_image_paths, &marker);
1600 if (r < 0)
1601 return r;
1602 if (r == 0)
1603 continue;
1604
1605 if (!FLAGS_SET(flags, PORTABLE_REATTACH) && !FLAGS_SET(flags, PORTABLE_FORCE_ATTACH)) {
1606 r = unit_file_is_active(bus, unit_name, error);
1607 if (r < 0)
1608 return r;
1609 if (r > 0)
1610 return sd_bus_error_setf(error, BUS_ERROR_UNIT_EXISTS, "Unit file '%s' is active, can't detach.", unit_name);
1611 }
1612
1613 r = set_ensure_consume(&unit_files, &string_hash_ops_free, TAKE_PTR(unit_name));
1614 if (r < 0)
1615 return log_oom_debug();
1616
1617 for (const char *p = marker;;) {
1618 _cleanup_free_ char *image = NULL;
1619
1620 r = extract_first_word(&p, &image, ":", EXTRACT_UNESCAPE_SEPARATORS|EXTRACT_RETAIN_ESCAPE);
1621 if (r < 0)
1622 return log_debug_errno(r, "Failed to parse marker: %s", p);
1623 if (r == 0)
1624 break;
1625
1626 if (path_is_absolute(image) && !image_in_search_path(IMAGE_PORTABLE, NULL, image)) {
1627 r = set_ensure_consume(&markers, &path_hash_ops_free, TAKE_PTR(image));
1628 if (r < 0)
1629 return r;
1630 }
1631 }
1632 }
1633
1634 if (set_isempty(unit_files))
1635 goto not_found;
1636
1637 SET_FOREACH(item, unit_files) {
1638 _cleanup_free_ char *md = NULL;
1639
1640 if (unlinkat(dirfd(d), item, 0) < 0) {
1641 log_debug_errno(errno, "Can't remove unit file %s/%s: %m", where, item);
1642
1643 if (errno != ENOENT && ret >= 0)
1644 ret = -errno;
1645 } else
1646 portable_changes_add_with_prefix(changes, n_changes, PORTABLE_UNLINK, where, item, NULL);
1647
1648 FOREACH_STRING(suffix, ".d/10-profile.conf", ".d/20-portable.conf") {
1649 _cleanup_free_ char *dropin = NULL;
1650
1651 dropin = strjoin(item, suffix);
1652 if (!dropin)
1653 return -ENOMEM;
1654
1655 if (unlinkat(dirfd(d), dropin, 0) < 0) {
1656 log_debug_errno(errno, "Can't remove drop-in %s/%s: %m", where, dropin);
1657
1658 if (errno != ENOENT && ret >= 0)
1659 ret = -errno;
1660 } else
1661 portable_changes_add_with_prefix(changes, n_changes, PORTABLE_UNLINK, where, dropin, NULL);
1662 }
1663
1664 md = strjoin(item, ".d");
1665 if (!md)
1666 return -ENOMEM;
1667
1668 if (unlinkat(dirfd(d), md, AT_REMOVEDIR) < 0) {
1669 log_debug_errno(errno, "Can't remove drop-in directory %s/%s: %m", where, md);
1670
1671 if (errno != ENOENT && ret >= 0)
1672 ret = -errno;
1673 } else
1674 portable_changes_add_with_prefix(changes, n_changes, PORTABLE_UNLINK, where, md, NULL);
1675 }
1676
1677 /* Now, also drop any image symlink, for images outside of the sarch path */
1678 SET_FOREACH(item, markers) {
1679 _cleanup_free_ char *sl = NULL;
1680 struct stat st;
1681
1682 r = image_symlink(item, flags, &sl);
1683 if (r < 0) {
1684 log_debug_errno(r, "Failed to determine image symlink for '%s', ignoring: %m", item);
1685 continue;
1686 }
1687
1688 if (lstat(sl, &st) < 0) {
1689 log_debug_errno(errno, "Failed to stat '%s', ignoring: %m", sl);
1690 continue;
1691 }
1692
1693 if (!S_ISLNK(st.st_mode)) {
1694 log_debug("Image '%s' is not a symlink, ignoring.", sl);
1695 continue;
1696 }
1697
1698 if (unlink(sl) < 0) {
1699 log_debug_errno(errno, "Can't remove image symlink '%s': %m", sl);
1700
1701 if (errno != ENOENT && ret >= 0)
1702 ret = -errno;
1703 } else
1704 portable_changes_add(changes, n_changes, PORTABLE_UNLINK, sl, NULL);
1705 }
1706
1707 /* Try to remove the unit file directory, if we can */
1708 if (rmdir(where) >= 0)
1709 portable_changes_add(changes, n_changes, PORTABLE_UNLINK, where, NULL);
1710
1711 return ret;
1712
1713 not_found:
1714 extensions = strv_join(extension_image_paths, ", ");
1715 if (!extensions)
1716 return -ENOMEM;
1717
1718 r = sd_bus_error_setf(error,
1719 BUS_ERROR_NO_SUCH_UNIT,
1720 "No unit files associated with '%s%s%s' found attached to the system. Image not attached?",
1721 name_or_path,
1722 isempty(extensions) ? "" : "' or any of its extensions '",
1723 isempty(extensions) ? "" : extensions);
1724 return log_debug_errno(r, "%s", error->message);
1725 }
1726
1727 static int portable_get_state_internal(
1728 sd_bus *bus,
1729 const char *name_or_path,
1730 char **extension_image_paths,
1731 PortableFlags flags,
1732 PortableState *ret,
1733 sd_bus_error *error) {
1734
1735 _cleanup_(lookup_paths_free) LookupPaths paths = {};
1736 bool found_enabled = false, found_running = false;
1737 _cleanup_set_free_ Set *unit_files = NULL;
1738 _cleanup_closedir_ DIR *d = NULL;
1739 const char *where;
1740 int r;
1741
1742 assert(name_or_path);
1743 assert(ret);
1744
1745 r = lookup_paths_init(&paths, RUNTIME_SCOPE_SYSTEM, LOOKUP_PATHS_SPLIT_USR, NULL);
1746 if (r < 0)
1747 return r;
1748
1749 where = attached_path(&paths, flags);
1750
1751 d = opendir(where);
1752 if (!d) {
1753 if (errno == ENOENT) {
1754 /* If the 'attached' directory doesn't exist at all, then we know for sure this image isn't attached. */
1755 *ret = PORTABLE_DETACHED;
1756 return 0;
1757 }
1758
1759 return log_debug_errno(errno, "Failed to open '%s' directory: %m", where);
1760 }
1761
1762 FOREACH_DIRENT(de, d, return log_debug_errno(errno, "Failed to enumerate '%s' directory: %m", where)) {
1763 UnitFileState state;
1764
1765 if (!unit_name_is_valid(de->d_name, UNIT_NAME_ANY))
1766 continue;
1767
1768 /* Filter out duplicates */
1769 if (set_contains(unit_files, de->d_name))
1770 continue;
1771
1772 if (!IN_SET(de->d_type, DT_LNK, DT_REG))
1773 continue;
1774
1775 r = test_chroot_dropin(d, where, de->d_name, name_or_path, extension_image_paths, NULL);
1776 if (r < 0)
1777 return r;
1778 if (r == 0)
1779 continue;
1780
1781 r = unit_file_lookup_state(RUNTIME_SCOPE_SYSTEM, &paths, de->d_name, &state);
1782 if (r < 0)
1783 return log_debug_errno(r, "Failed to determine unit file state of '%s': %m", de->d_name);
1784 if (!IN_SET(state, UNIT_FILE_STATIC, UNIT_FILE_DISABLED, UNIT_FILE_LINKED, UNIT_FILE_LINKED_RUNTIME))
1785 found_enabled = true;
1786
1787 r = unit_file_is_active(bus, de->d_name, error);
1788 if (r < 0)
1789 return r;
1790 if (r > 0)
1791 found_running = true;
1792
1793 r = set_put_strdup(&unit_files, de->d_name);
1794 if (r < 0)
1795 return log_debug_errno(r, "Failed to add unit name '%s' to set: %m", de->d_name);
1796 }
1797
1798 *ret = found_running ? (!set_isempty(unit_files) && (flags & PORTABLE_RUNTIME) ? PORTABLE_RUNNING_RUNTIME : PORTABLE_RUNNING) :
1799 found_enabled ? (flags & PORTABLE_RUNTIME ? PORTABLE_ENABLED_RUNTIME : PORTABLE_ENABLED) :
1800 !set_isempty(unit_files) ? (flags & PORTABLE_RUNTIME ? PORTABLE_ATTACHED_RUNTIME : PORTABLE_ATTACHED) : PORTABLE_DETACHED;
1801
1802 return 0;
1803 }
1804
1805 int portable_get_state(
1806 sd_bus *bus,
1807 const char *name_or_path,
1808 char **extension_image_paths,
1809 PortableFlags flags,
1810 PortableState *ret,
1811 sd_bus_error *error) {
1812
1813 PortableState state;
1814 int r;
1815
1816 assert(name_or_path);
1817 assert(ret);
1818
1819 /* We look for matching units twice: once in the regular directories, and once in the runtime directories — but
1820 * the latter only if we didn't find anything in the former. */
1821
1822 r = portable_get_state_internal(bus, name_or_path, extension_image_paths, flags & ~PORTABLE_RUNTIME, &state, error);
1823 if (r < 0)
1824 return r;
1825
1826 if (state == PORTABLE_DETACHED) {
1827 r = portable_get_state_internal(bus, name_or_path, extension_image_paths, flags | PORTABLE_RUNTIME, &state, error);
1828 if (r < 0)
1829 return r;
1830 }
1831
1832 *ret = state;
1833 return 0;
1834 }
1835
1836 int portable_get_profiles(char ***ret) {
1837 assert(ret);
1838
1839 return conf_files_list_nulstr(ret, NULL, NULL, CONF_FILES_DIRECTORY|CONF_FILES_BASENAME|CONF_FILES_FILTER_MASKED, PORTABLE_PROFILE_DIRS);
1840 }
1841
1842 static const char* const portable_change_type_table[_PORTABLE_CHANGE_TYPE_MAX] = {
1843 [PORTABLE_COPY] = "copy",
1844 [PORTABLE_MKDIR] = "mkdir",
1845 [PORTABLE_SYMLINK] = "symlink",
1846 [PORTABLE_UNLINK] = "unlink",
1847 [PORTABLE_WRITE] = "write",
1848 };
1849
1850 DEFINE_STRING_TABLE_LOOKUP(portable_change_type, int);
1851
1852 static const char* const portable_state_table[_PORTABLE_STATE_MAX] = {
1853 [PORTABLE_DETACHED] = "detached",
1854 [PORTABLE_ATTACHED] = "attached",
1855 [PORTABLE_ATTACHED_RUNTIME] = "attached-runtime",
1856 [PORTABLE_ENABLED] = "enabled",
1857 [PORTABLE_ENABLED_RUNTIME] = "enabled-runtime",
1858 [PORTABLE_RUNNING] = "running",
1859 [PORTABLE_RUNNING_RUNTIME] = "running-runtime",
1860 };
1861
1862 DEFINE_STRING_TABLE_LOOKUP(portable_state, PortableState);
Unnamed repository; edit this file 'description' to name the repository.